From 569d828e80e5d77a7192d2861187ec8a4da5e027 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 6 Jan 2023 11:18:42 +0100 Subject: [PATCH 001/180] new http exceptions --- .../Http/HttpBadRequestException.php | 45 +++++++ src/Exception/Http/HttpConflictException.php | 44 ++++++ src/Exception/Http/HttpException.php | 57 ++++++++ src/Exception/Http/HttpExceptionInterface.php | 34 +++++ .../Http/HttpExpectationFailedException.php | 44 ++++++ .../Http/HttpFailedDependencyException.php | 42 ++++++ src/Exception/Http/HttpForbiddenException.php | 45 +++++++ src/Exception/Http/HttpGoneException.php | 47 +++++++ .../Http/HttpInternalServerErrorException.php | 44 ++++++ .../Http/HttpLengthRequiredException.php | 44 ++++++ src/Exception/Http/HttpLockedException.php | 42 ++++++ .../Http/HttpMethodNotAllowedException.php | 126 ++++++++++++++++++ .../Http/HttpMisdirectedRequestException.php | 43 ++++++ .../Http/HttpNotAcceptableException.php | 45 +++++++ src/Exception/Http/HttpNotFoundException.php | 47 +++++++ .../Http/HttpPayloadTooLargeException.php | 45 +++++++ .../Http/HttpPaymentRequiredException.php | 45 +++++++ .../Http/HttpPreconditionFailedException.php | 44 ++++++ .../HttpPreconditionRequiredException.php | 46 +++++++ ...tpProxyAuthenticationRequiredException.php | 44 ++++++ .../Http/HttpRangeNotSatisfiableException.php | 45 +++++++ ...tpRequestHeaderFieldsTooLargeException.php | 45 +++++++ .../Http/HttpRequestTimeoutException.php | 47 +++++++ .../Http/HttpServiceUnavailableException.php | 48 +++++++ src/Exception/Http/HttpTooEarlyException.php | 44 ++++++ .../Http/HttpTooManyRequestsException.php | 44 ++++++ .../Http/HttpUnauthorizedException.php | 45 +++++++ ...ttpUnavailableForLegalReasonsException.php | 45 +++++++ .../Http/HttpUnprocessableEntityException.php | 44 ++++++ .../HttpUnsupportedMediaTypeException.php | 121 +++++++++++++++++ .../Http/HttpUpgradeRequiredException.php | 46 +++++++ .../Http/HttpUriTooLongException.php | 44 ++++++ 32 files changed, 1591 insertions(+) create mode 100644 src/Exception/Http/HttpBadRequestException.php create mode 100644 src/Exception/Http/HttpConflictException.php create mode 100644 src/Exception/Http/HttpException.php create mode 100644 src/Exception/Http/HttpExceptionInterface.php create mode 100644 src/Exception/Http/HttpExpectationFailedException.php create mode 100644 src/Exception/Http/HttpFailedDependencyException.php create mode 100644 src/Exception/Http/HttpForbiddenException.php create mode 100644 src/Exception/Http/HttpGoneException.php create mode 100644 src/Exception/Http/HttpInternalServerErrorException.php create mode 100644 src/Exception/Http/HttpLengthRequiredException.php create mode 100644 src/Exception/Http/HttpLockedException.php create mode 100644 src/Exception/Http/HttpMethodNotAllowedException.php create mode 100644 src/Exception/Http/HttpMisdirectedRequestException.php create mode 100644 src/Exception/Http/HttpNotAcceptableException.php create mode 100644 src/Exception/Http/HttpNotFoundException.php create mode 100644 src/Exception/Http/HttpPayloadTooLargeException.php create mode 100644 src/Exception/Http/HttpPaymentRequiredException.php create mode 100644 src/Exception/Http/HttpPreconditionFailedException.php create mode 100644 src/Exception/Http/HttpPreconditionRequiredException.php create mode 100644 src/Exception/Http/HttpProxyAuthenticationRequiredException.php create mode 100644 src/Exception/Http/HttpRangeNotSatisfiableException.php create mode 100644 src/Exception/Http/HttpRequestHeaderFieldsTooLargeException.php create mode 100644 src/Exception/Http/HttpRequestTimeoutException.php create mode 100644 src/Exception/Http/HttpServiceUnavailableException.php create mode 100644 src/Exception/Http/HttpTooEarlyException.php create mode 100644 src/Exception/Http/HttpTooManyRequestsException.php create mode 100644 src/Exception/Http/HttpUnauthorizedException.php create mode 100644 src/Exception/Http/HttpUnavailableForLegalReasonsException.php create mode 100644 src/Exception/Http/HttpUnprocessableEntityException.php create mode 100644 src/Exception/Http/HttpUnsupportedMediaTypeException.php create mode 100644 src/Exception/Http/HttpUpgradeRequiredException.php create mode 100644 src/Exception/Http/HttpUriTooLongException.php diff --git a/src/Exception/Http/HttpBadRequestException.php b/src/Exception/Http/HttpBadRequestException.php new file mode 100644 index 00000000..efdd06bd --- /dev/null +++ b/src/Exception/Http/HttpBadRequestException.php @@ -0,0 +1,45 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Bad Request Exception + * + * The server cannot or will not process the request due to something that is perceived to be a client error (e.g., + * malformed request syntax, invalid request message framing, or deceptive request routing). + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400 + * + * @since 3.0.0 + */ +class HttpBadRequestException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Bad Request'; + + parent::__construct(self::STATUS_BAD_REQUEST, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpConflictException.php b/src/Exception/Http/HttpConflictException.php new file mode 100644 index 00000000..6e5115fa --- /dev/null +++ b/src/Exception/Http/HttpConflictException.php @@ -0,0 +1,44 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Conflict Exception + * + * This response is sent when a request conflicts with the current state of the server. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409 + * + * @since 3.0.0 + */ +class HttpConflictException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Conflict'; + + parent::__construct(self::STATUS_CONFLICT, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpException.php b/src/Exception/Http/HttpException.php new file mode 100644 index 00000000..4987e8dd --- /dev/null +++ b/src/Exception/Http/HttpException.php @@ -0,0 +1,57 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Exception; +use Throwable; + +/** + * Base HTTP exception + * + * @since 3.0.0 + */ +class HttpException extends Exception implements HttpExceptionInterface +{ + + /** + * HTTP status code + * + * @var int + */ + private int $statusCode; + + /** + * Constructor of the class + * + * @param int $statusCode + * @param string $message + * @param int $errorCode + * @param ?Throwable $previous + */ + public function __construct(int $statusCode, string $message, int $errorCode = 0, ?Throwable $previous = null) + { + parent::__construct($message, $errorCode, $previous); + + $this->statusCode = $statusCode; + } + + /** + * {@inheritdoc} + */ + final public function getStatusCode(): int + { + return $this->statusCode; + } +} diff --git a/src/Exception/Http/HttpExceptionInterface.php b/src/Exception/Http/HttpExceptionInterface.php new file mode 100644 index 00000000..f56a38a7 --- /dev/null +++ b/src/Exception/Http/HttpExceptionInterface.php @@ -0,0 +1,34 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Fig\Http\Message\StatusCodeInterface; +use Sunrise\Http\Router\Exception\ExceptionInterface; + +/** + * Base HTTP exception interface + * + * @since 3.0.0 + */ +interface HttpExceptionInterface extends ExceptionInterface, StatusCodeInterface +{ + + /** + * Gets HTTP status code + * + * @return int + */ + public function getStatusCode(): int; +} diff --git a/src/Exception/Http/HttpExpectationFailedException.php b/src/Exception/Http/HttpExpectationFailedException.php new file mode 100644 index 00000000..4d976867 --- /dev/null +++ b/src/Exception/Http/HttpExpectationFailedException.php @@ -0,0 +1,44 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Expectation Failed Exception + * + * This response code means the expectation indicated by the Expect request header field cannot be met by the server. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/417 + * + * @since 3.0.0 + */ +class HttpExpectationFailedException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Expectation Failed'; + + parent::__construct(self::STATUS_EXPECTATION_FAILED, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpFailedDependencyException.php b/src/Exception/Http/HttpFailedDependencyException.php new file mode 100644 index 00000000..c895fd6a --- /dev/null +++ b/src/Exception/Http/HttpFailedDependencyException.php @@ -0,0 +1,42 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Failed Dependency Exception + * + * The request failed due to failure of a previous request. + * + * @since 3.0.0 + */ +class HttpFailedDependencyException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Failed Dependency'; + + parent::__construct(self::STATUS_FAILED_DEPENDENCY, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpForbiddenException.php b/src/Exception/Http/HttpForbiddenException.php new file mode 100644 index 00000000..a1b03951 --- /dev/null +++ b/src/Exception/Http/HttpForbiddenException.php @@ -0,0 +1,45 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Forbidden Exception + * + * The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give + * the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/403 + * + * @since 3.0.0 + */ +class HttpForbiddenException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Forbidden'; + + parent::__construct(self::STATUS_FORBIDDEN, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpGoneException.php b/src/Exception/Http/HttpGoneException.php new file mode 100644 index 00000000..0eae223b --- /dev/null +++ b/src/Exception/Http/HttpGoneException.php @@ -0,0 +1,47 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Gone Exception + * + * This response is sent when the requested content has been permanently deleted from server, with no forwarding + * address. Clients are expected to remove their caches and links to the resource. The HTTP specification intends this + * status code to be used for "limited-time, promotional services". APIs should not feel compelled to indicate resources + * that have been deleted with this status code. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/410 + * + * @since 3.0.0 + */ +class HttpGoneException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Gone'; + + parent::__construct(self::STATUS_GONE, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpInternalServerErrorException.php b/src/Exception/Http/HttpInternalServerErrorException.php new file mode 100644 index 00000000..9f43458e --- /dev/null +++ b/src/Exception/Http/HttpInternalServerErrorException.php @@ -0,0 +1,44 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Internal Server Error Exception + * + * The server has encountered a situation it does not know how to handle. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500 + * + * @since 3.0.0 + */ +class HttpInternalServerErrorException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Internal Server Error'; + + parent::__construct(self::STATUS_INTERNAL_SERVER_ERROR, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpLengthRequiredException.php b/src/Exception/Http/HttpLengthRequiredException.php new file mode 100644 index 00000000..bf1e58cf --- /dev/null +++ b/src/Exception/Http/HttpLengthRequiredException.php @@ -0,0 +1,44 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Length Required Exception + * + * Server rejected the request because the Content-Length header field is not defined and the server requires it. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/411 + * + * @since 3.0.0 + */ +class HttpLengthRequiredException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Length Required'; + + parent::__construct(self::STATUS_LENGTH_REQUIRED, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpLockedException.php b/src/Exception/Http/HttpLockedException.php new file mode 100644 index 00000000..6b280521 --- /dev/null +++ b/src/Exception/Http/HttpLockedException.php @@ -0,0 +1,42 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Locked Exception + * + * The resource that is being accessed is locked. + * + * @since 3.0.0 + */ +class HttpLockedException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Locked'; + + parent::__construct(self::STATUS_LOCKED, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpMethodNotAllowedException.php b/src/Exception/Http/HttpMethodNotAllowedException.php new file mode 100644 index 00000000..b70663cc --- /dev/null +++ b/src/Exception/Http/HttpMethodNotAllowedException.php @@ -0,0 +1,126 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * Import functions + */ +use function join; + +/** + * HTTP Method Not Allowed Exception + * + * The request method is known by the server but is not supported by the target resource. For example, an API may not + * allow calling DELETE to remove a resource. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/405 + * + * @since 3.0.0 + */ +class HttpMethodNotAllowedException extends HttpException +{ + + /** + * Unallowed HTTP method + * + * @var string + */ + private string $unallowedMethod; + + /** + * Allowed HTTP methods + * + * @var list + */ + private array $allowedMethods; + + /** + * Constructor of the class + * + * @param string $unallowedMethod + * @param list $allowedMethods + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct( + string $unallowedMethod, + array $allowedMethods, + ?string $message = null, + int $code = 0, + ?Throwable $previous = null + ) { + $message ??= 'Method Not Allowed'; + + parent::__construct(self::STATUS_METHOD_NOT_ALLOWED, $message, $code, $previous); + + $this->unallowedMethod = $unallowedMethod; + $this->allowedMethods = $allowedMethods; + } + + /** + * Gets unallowed HTTP method + * + * @return string + */ + final public function getMethod(): string + { + return $this->unallowedMethod; + } + + /** + * Gets allowed HTTP methods + * + * @return list + */ + final public function getAllowedMethods(): array + { + return $this->allowedMethods; + } + + /** + * Gets joined allowed HTTP methods + * + * @return string + */ + final public function getJoinedAllowedMethods(): string + { + return join(',', $this->getAllowedMethods()); + } + + /** + * Gets arguments for an Allow header field + * + * The server must generate an Allow header field in a 405 status code response. + * + * The field must contain a list of methods that the target resource currently supports. + * + * Returns an array where key 0 contains the header name and key 1 contains its value. + * + * + * $response = $response + * ->withStatus($e->getStatusCode()) + * ->withHeader(...$e->getAllowHeaderArguments()); + * + * + * @return array{0: string, 1: string} + */ + final public function getAllowHeaderArguments(): array + { + return ['Allow', $this->getJoinedAllowedMethods()]; + } +} diff --git a/src/Exception/Http/HttpMisdirectedRequestException.php b/src/Exception/Http/HttpMisdirectedRequestException.php new file mode 100644 index 00000000..14228d90 --- /dev/null +++ b/src/Exception/Http/HttpMisdirectedRequestException.php @@ -0,0 +1,43 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Misdirected Request Exception + * + * The request was directed at a server that is not able to produce a response. This can be sent by a server that is not + * configured to produce responses for the combination of scheme and authority that are included in the request URI. + * + * @since 3.0.0 + */ +class HttpMisdirectedRequestException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Misdirected Request'; + + parent::__construct(self::STATUS_MISDIRECTED_REQUEST, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpNotAcceptableException.php b/src/Exception/Http/HttpNotAcceptableException.php new file mode 100644 index 00000000..b0eb0f19 --- /dev/null +++ b/src/Exception/Http/HttpNotAcceptableException.php @@ -0,0 +1,45 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Not Acceptable Exception + * + * This response is sent when the web server, after performing server-driven content negotiation, doesn't find any + * content that conforms to the criteria given by the user agent. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/406 + * + * @since 3.0.0 + */ +class HttpNotAcceptableException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Not Acceptable'; + + parent::__construct(self::STATUS_NOT_ACCEPTABLE, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpNotFoundException.php b/src/Exception/Http/HttpNotFoundException.php new file mode 100644 index 00000000..8ee9fada --- /dev/null +++ b/src/Exception/Http/HttpNotFoundException.php @@ -0,0 +1,47 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Not Found Exception + * + * The server cannot find the requested resource. In the browser, this means the URL is not recognized. In an API, this + * can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response + * instead of 403 Forbidden to hide the existence of a resource from an unauthorized client. This response code is + * probably the most well known due to its frequent occurrence on the web. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404 + * + * @since 3.0.0 + */ +class HttpNotFoundException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Not Found'; + + parent::__construct(self::STATUS_NOT_FOUND, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpPayloadTooLargeException.php b/src/Exception/Http/HttpPayloadTooLargeException.php new file mode 100644 index 00000000..6a411a43 --- /dev/null +++ b/src/Exception/Http/HttpPayloadTooLargeException.php @@ -0,0 +1,45 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Payload Too Large Exception + * + * Request entity is larger than limits defined by server. The server might close the connection or return an + * Retry-After header field. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/413 + * + * @since 3.0.0 + */ +class HttpPayloadTooLargeException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Payload Too Large'; + + parent::__construct(self::STATUS_PAYLOAD_TOO_LARGE, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpPaymentRequiredException.php b/src/Exception/Http/HttpPaymentRequiredException.php new file mode 100644 index 00000000..d5684ef7 --- /dev/null +++ b/src/Exception/Http/HttpPaymentRequiredException.php @@ -0,0 +1,45 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Payment Required Exception + * + * This response code is reserved for future use. The initial aim for creating this code was using it for digital + * payment systems, however this status code is used very rarely and no standard convention exists. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402 + * + * @since 3.0.0 + */ +class HttpPaymentRequiredException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Payment Required'; + + parent::__construct(self::STATUS_PAYMENT_REQUIRED, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpPreconditionFailedException.php b/src/Exception/Http/HttpPreconditionFailedException.php new file mode 100644 index 00000000..18ab7ba3 --- /dev/null +++ b/src/Exception/Http/HttpPreconditionFailedException.php @@ -0,0 +1,44 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Precondition Failed Exception + * + * The server does not meet one of the preconditions that the requester put on the request header fields. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/412 + * + * @since 3.0.0 + */ +class HttpPreconditionFailedException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Precondition Failed'; + + parent::__construct(self::STATUS_PRECONDITION_FAILED, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpPreconditionRequiredException.php b/src/Exception/Http/HttpPreconditionRequiredException.php new file mode 100644 index 00000000..44eb6c51 --- /dev/null +++ b/src/Exception/Http/HttpPreconditionRequiredException.php @@ -0,0 +1,46 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Precondition Required Exception + * + * The origin server requires the request to be conditional. This response is intended to prevent the 'lost update' + * problem, where a client GETs a resource's state, modifies it and PUTs it back to the server, when meanwhile a third + * party has modified the state on the server, leading to a conflict. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/428 + * + * @since 3.0.0 + */ +class HttpPreconditionRequiredException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Precondition Required'; + + parent::__construct(self::STATUS_PRECONDITION_REQUIRED, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpProxyAuthenticationRequiredException.php b/src/Exception/Http/HttpProxyAuthenticationRequiredException.php new file mode 100644 index 00000000..0fed38a5 --- /dev/null +++ b/src/Exception/Http/HttpProxyAuthenticationRequiredException.php @@ -0,0 +1,44 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Proxy Authentication Required Exception + * + * This is similar to 401 Unauthorized but authentication is needed to be done by a proxy. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/407 + * + * @since 3.0.0 + */ +class HttpProxyAuthenticationRequiredException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Proxy Authentication Required'; + + parent::__construct(self::STATUS_PROXY_AUTHENTICATION_REQUIRED, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpRangeNotSatisfiableException.php b/src/Exception/Http/HttpRangeNotSatisfiableException.php new file mode 100644 index 00000000..66bb81ad --- /dev/null +++ b/src/Exception/Http/HttpRangeNotSatisfiableException.php @@ -0,0 +1,45 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Range Not Satisfiable Exception + * + * The range specified by the Range header field in the request cannot be fulfilled. It's possible that the range is + * outside the size of the target URI's data. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/416 + * + * @since 3.0.0 + */ +class HttpRangeNotSatisfiableException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Range Not Satisfiable'; + + parent::__construct(self::STATUS_RANGE_NOT_SATISFIABLE, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpRequestHeaderFieldsTooLargeException.php b/src/Exception/Http/HttpRequestHeaderFieldsTooLargeException.php new file mode 100644 index 00000000..c0c31e8b --- /dev/null +++ b/src/Exception/Http/HttpRequestHeaderFieldsTooLargeException.php @@ -0,0 +1,45 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Request Header Fields Too Large Exception + * + * The server is unwilling to process the request because its header fields are too large. The request may be + * resubmitted after reducing the size of the request header fields. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/431 + * + * @since 3.0.0 + */ +class HttpRequestHeaderFieldsTooLargeException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Request Header Fields Too Large'; + + parent::__construct(self::STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpRequestTimeoutException.php b/src/Exception/Http/HttpRequestTimeoutException.php new file mode 100644 index 00000000..f667cb26 --- /dev/null +++ b/src/Exception/Http/HttpRequestTimeoutException.php @@ -0,0 +1,47 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Request Timeout Exception + * + * This response is sent on an idle connection by some servers, even without any previous request by the client. It + * means that the server would like to shut down this unused connection. This response is used much more since some + * browsers, like Chrome, Firefox 27+, or IE9, use HTTP pre-connection mechanisms to speed up surfing. Also note that + * some servers merely shut down the connection without sending this message. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408 + * + * @since 3.0.0 + */ +class HttpRequestTimeoutException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Request Timeout'; + + parent::__construct(self::STATUS_REQUEST_TIMEOUT, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpServiceUnavailableException.php b/src/Exception/Http/HttpServiceUnavailableException.php new file mode 100644 index 00000000..fc974870 --- /dev/null +++ b/src/Exception/Http/HttpServiceUnavailableException.php @@ -0,0 +1,48 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Service Unavailable Exception + * + * The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is + * overloaded. Note that together with this response, a user-friendly page explaining the problem should be sent. This + * response should be used for temporary conditions and the Retry-After HTTP header should, if possible, contain the + * estimated time before the recovery of the service. The webmaster must also take care about the caching-related + * headers that are sent along with this response, as these temporary condition responses should usually not be cached. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503 + * + * @since 3.0.0 + */ +class HttpServiceUnavailableException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Service Unavailable'; + + parent::__construct(self::STATUS_SERVICE_UNAVAILABLE, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpTooEarlyException.php b/src/Exception/Http/HttpTooEarlyException.php new file mode 100644 index 00000000..e2837cc2 --- /dev/null +++ b/src/Exception/Http/HttpTooEarlyException.php @@ -0,0 +1,44 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Too Early Exception + * + * Indicates that the server is unwilling to risk processing a request that might be replayed. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/425 + * + * @since 3.0.0 + */ +class HttpTooEarlyException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Too Early'; + + parent::__construct(self::STATUS_TOO_EARLY, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpTooManyRequestsException.php b/src/Exception/Http/HttpTooManyRequestsException.php new file mode 100644 index 00000000..812cb313 --- /dev/null +++ b/src/Exception/Http/HttpTooManyRequestsException.php @@ -0,0 +1,44 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Too Many Requests Exception + * + * The user has sent too many requests in a given amount of time ("rate limiting"). + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429 + * + * @since 3.0.0 + */ +class HttpTooManyRequestsException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Too Many Requests'; + + parent::__construct(self::STATUS_TOO_MANY_REQUESTS, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpUnauthorizedException.php b/src/Exception/Http/HttpUnauthorizedException.php new file mode 100644 index 00000000..c6e2a006 --- /dev/null +++ b/src/Exception/Http/HttpUnauthorizedException.php @@ -0,0 +1,45 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Unauthorized Exception + * + * Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the + * client must authenticate itself to get the requested response. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401 + * + * @since 3.0.0 + */ +class HttpUnauthorizedException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Unauthorized'; + + parent::__construct(self::STATUS_UNAUTHORIZED, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpUnavailableForLegalReasonsException.php b/src/Exception/Http/HttpUnavailableForLegalReasonsException.php new file mode 100644 index 00000000..728e0bff --- /dev/null +++ b/src/Exception/Http/HttpUnavailableForLegalReasonsException.php @@ -0,0 +1,45 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Unavailable For Legal Reasons Exception + * + * The server is unwilling to process the request because its header fields are too large. The request may be + * resubmitted after reducing the size of the request header fields. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/451 + * + * @since 3.0.0 + */ +class HttpUnavailableForLegalReasonsException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Unavailable For Legal Reasons'; + + parent::__construct(self::STATUS_UNAVAILABLE_FOR_LEGAL_REASONS, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpUnprocessableEntityException.php b/src/Exception/Http/HttpUnprocessableEntityException.php new file mode 100644 index 00000000..34f8f121 --- /dev/null +++ b/src/Exception/Http/HttpUnprocessableEntityException.php @@ -0,0 +1,44 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Unprocessable Entity Exception + * + * The request was well-formed but was unable to be followed due to semantic errors. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422 + * + * @since 3.0.0 + */ +class HttpUnprocessableEntityException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Unprocessable Entity'; + + parent::__construct(self::STATUS_UNPROCESSABLE_ENTITY, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpUnsupportedMediaTypeException.php b/src/Exception/Http/HttpUnsupportedMediaTypeException.php new file mode 100644 index 00000000..6c31d2ff --- /dev/null +++ b/src/Exception/Http/HttpUnsupportedMediaTypeException.php @@ -0,0 +1,121 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * Import functions + */ +use function join; + +/** + * HTTP Unsupported Media Type Exception + * + * The media format of the requested data is not supported by the server, so the server is rejecting the request. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/415 + * + * @since 3.0.0 + */ +class HttpUnsupportedMediaTypeException extends HttpException +{ + + /** + * Unsupported media type + * + * @var string + */ + private string $unsupportedMediaType; + + /** + * Supported media types + * + * @var list + */ + private array $supportedMediaTypes; + + /** + * Constructor of the class + * + * @param string $unsupportedMediaType + * @param list $supportedMediaTypes + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct( + string $unsupportedMediaType, + array $supportedMediaTypes, + ?string $message = null, + int $code = 0, + ?Throwable $previous = null + ) { + $message ??= 'Unsupported Media Type'; + + parent::__construct(self::STATUS_UNSUPPORTED_MEDIA_TYPE, $message, $code, $previous); + + $this->unsupportedMediaType = $unsupportedMediaType; + $this->supportedMediaTypes = $supportedMediaTypes; + } + + /** + * Gets unsupported media type + * + * @return string + */ + final public function getType(): string + { + return $this->unsupportedMediaType; + } + + /** + * Gets supported media types + * + * @return list + */ + final public function getSupportedTypes(): array + { + return $this->supportedMediaTypes; + } + + /** + * Gets joined supported media types + * + * @return string + */ + final public function getJoinedSupportedTypes(): string + { + return join(',', $this->getSupportedTypes()); + } + + /** + * Gets arguments for an Accept header field + * + * Returns an array where key 0 contains the header name and key 1 contains its value. + * + * + * $response = $response + * ->withStatus($e->getStatusCode()) + * ->withHeader(...$e->getAcceptHeaderArguments()); + * + * + * @return array{0: string, 1: string} + */ + final public function getAcceptHeaderArguments(): array + { + return ['Accept', $this->getJoinedSupportedTypes()]; + } +} diff --git a/src/Exception/Http/HttpUpgradeRequiredException.php b/src/Exception/Http/HttpUpgradeRequiredException.php new file mode 100644 index 00000000..4d0d4d88 --- /dev/null +++ b/src/Exception/Http/HttpUpgradeRequiredException.php @@ -0,0 +1,46 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP Upgrade Required Exception + * + * The server refuses to perform the request using the current protocol but might be willing to do so after the client + * upgrades to a different protocol. The server sends an Upgrade header in a 426 response to indicate the required + * protocol(s). + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/426 + * + * @since 3.0.0 + */ +class HttpUpgradeRequiredException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'Upgrade Required'; + + parent::__construct(self::STATUS_UPGRADE_REQUIRED, $message, $code, $previous); + } +} diff --git a/src/Exception/Http/HttpUriTooLongException.php b/src/Exception/Http/HttpUriTooLongException.php new file mode 100644 index 00000000..5b92cce5 --- /dev/null +++ b/src/Exception/Http/HttpUriTooLongException.php @@ -0,0 +1,44 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception\Http; + +/** + * Import classes + */ +use Throwable; + +/** + * HTTP URI Too Long Exception + * + * The URI requested by the client is longer than the server is willing to interpret. + * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/414 + * + * @since 3.0.0 + */ +class HttpUriTooLongException extends HttpException +{ + + /** + * Constructor of the class + * + * @param ?string $message + * @param int $code + * @param ?Throwable $previous + */ + public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'URI Too Long'; + + parent::__construct(self::STATUS_URI_TOO_LONG, $message, $code, $previous); + } +} From 5301636f43ed27f2399a3d72f287222522380dd3 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 14:27:23 +0100 Subject: [PATCH 002/180] Delete config.yml --- .circleci/config.yml | 64 -------------------------------------------- 1 file changed, 64 deletions(-) delete mode 100644 .circleci/config.yml diff --git a/.circleci/config.yml b/.circleci/config.yml deleted file mode 100644 index 706d6406..00000000 --- a/.circleci/config.yml +++ /dev/null @@ -1,64 +0,0 @@ -# PHP CircleCI 2.0 configuration file -# -# Check https://circleci.com/docs/2.0/language-php/ for more details -# -version: 2 -jobs: - php71: - docker: - - image: cimg/php:7.1 - steps: - - checkout - - run: php -v - - run: composer install --no-interaction - - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text - php72: - docker: - - image: cimg/php:7.2 - steps: - - checkout - - run: php -v - - run: composer install --no-interaction - - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text - php73: - docker: - - image: cimg/php:7.3 - steps: - - checkout - - run: php -v - - run: composer install --no-interaction - - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text - php74: - docker: - - image: cimg/php:7.4 - steps: - - checkout - - run: php -v - - run: composer install --no-interaction - - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text - php80: - docker: - - image: cimg/php:8.0 - steps: - - checkout - - run: php -v - - run: composer install --no-interaction - - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text - php81: - docker: - - image: cimg/php:8.1 - steps: - - checkout - - run: php -v - - run: composer install --no-interaction - - run: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-text -workflows: - version: 2 - build: - jobs: - - php71 - - php72 - - php73 - - php74 - - php80 - - php81 From 8a93367d2ff1b93138bef0ca8d678966611821d8 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 14:27:30 +0100 Subject: [PATCH 003/180] Update FUNDING.yml --- .github/FUNDING.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 1e976c3a..52a1ded1 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,7 +1,7 @@ # These are supported funding model platforms github: fenric # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] -patreon: # Replace with a single Patreon username +patreon: afenric open_collective: # Replace with a single Open Collective username ko_fi: # Replace with a single Ko-fi username tidelift: "packagist/sunrise/http-router" # Replace with a single Tidelift platform-name/package-name e.g., npm/babel From 4ad388adcd98ea15ce19ffc4e9fa15901f55cb64 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 14:27:33 +0100 Subject: [PATCH 004/180] Update .scrutinizer.yml --- .scrutinizer.yml | 44 +++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 41 insertions(+), 3 deletions(-) diff --git a/.scrutinizer.yml b/.scrutinizer.yml index 1e6a96fc..44be2791 100644 --- a/.scrutinizer.yml +++ b/.scrutinizer.yml @@ -1,16 +1,54 @@ build: - environment: - php: - version: '8.0' + image: default-bionic nodes: analysis: + environment: + php: 8.2 tests: override: - php-scrutinizer-run coverage: + environment: + php: 8.2 tests: override: - command: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-clover coverage.xml coverage: file: coverage.xml format: clover + php81: + environment: + php: 8.1 + tests: + override: + - command: php vendor/bin/phpunit + php80: + environment: + php: 8.0 + tests: + override: + - command: php vendor/bin/phpunit + php74: + environment: + php: 7.4 + tests: + override: + - command: php vendor/bin/phpunit + php73: + environment: + php: 7.3 + tests: + override: + - command: php vendor/bin/phpunit + php72: + environment: + php: 7.2 + tests: + override: + - command: php vendor/bin/phpunit + php71: + environment: + php: 7.1 + tests: + override: + - command: php vendor/bin/phpunit From 381e657fadd6dcabde36e7d9caa0f63c87289d2e Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 19:40:41 +0100 Subject: [PATCH 005/180] Type declarations for properties --- src/Annotation/Host.php | 6 +-- src/Annotation/Middleware.php | 11 ++--- src/Annotation/Postfix.php | 6 +-- src/Annotation/Prefix.php | 6 +-- src/Annotation/Route.php | 84 ++++++++++++++++++----------------- 5 files changed, 58 insertions(+), 55 deletions(-) diff --git a/src/Annotation/Host.php b/src/Annotation/Host.php index 209c4f5c..4b4f9c8d 100644 --- a/src/Annotation/Host.php +++ b/src/Annotation/Host.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -38,7 +38,7 @@ final class Host * * @var string */ - public $value; + public string $value; /** * Constructor of the class diff --git a/src/Annotation/Middleware.php b/src/Annotation/Middleware.php index eba445c1..1d339476 100644 --- a/src/Annotation/Middleware.php +++ b/src/Annotation/Middleware.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -15,6 +15,7 @@ * Import classes */ use Attribute; +use Psr\Http\Server\MiddlewareInterface; /** * @Annotation @@ -36,14 +37,14 @@ final class Middleware /** * The attribute value * - * @var string + * @var class-string */ - public $value; + public string $value; /** * Constructor of the class * - * @param string $value + * @param class-string $value */ public function __construct(string $value) { diff --git a/src/Annotation/Postfix.php b/src/Annotation/Postfix.php index 53f7ab82..c2bb2a7d 100644 --- a/src/Annotation/Postfix.php +++ b/src/Annotation/Postfix.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -38,7 +38,7 @@ final class Postfix * * @var string */ - public $value; + public string $value; /** * Constructor of the class diff --git a/src/Annotation/Prefix.php b/src/Annotation/Prefix.php index 84fdfc5c..71f3baa8 100644 --- a/src/Annotation/Prefix.php +++ b/src/Annotation/Prefix.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -38,7 +38,7 @@ final class Prefix * * @var string */ - public $value; + public string $value; /** * Constructor of the class diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index 1b7d5c7b..f2fce7b2 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -15,6 +15,8 @@ * Import classes */ use Attribute; +use Fig\Http\Message\RequestMethodInterface; +use Psr\Http\Server\MiddlewareInterface; /** * @Annotation @@ -38,102 +40,102 @@ * }) */ #[Attribute(Attribute::TARGET_CLASS|Attribute::TARGET_METHOD)] -final class Route +final class Route implements RequestMethodInterface { /** * The descriptor holder * - * @var mixed + * @var class-string|array{0: class-string, 1: string}|null * * @internal */ - public $holder; + public $holder = null; /** - * A route name + * The route name * * @var string */ - public $name; + public string $name; /** - * A route host + * The route host * * @var string|null */ - public $host; + public ?string $host; /** - * A route path + * The route path * * @var string */ - public $path; + public string $path; /** - * A route methods + * The route methods * - * @var string[] + * @var list */ - public $methods; + public array $methods; /** - * A route middlewares + * The route middlewares * - * @var string[] + * @var list> */ - public $middlewares; + public array $middlewares; /** - * A route attributes + * The route attributes * - * @var array + * @var array */ - public $attributes; + public array $attributes; /** - * A route summary + * The route summary * * @var string */ - public $summary; + public string $summary; /** - * A route description + * The route description * * @var string */ - public $description; + public string $description; /** - * A route tags + * The route tags * - * @var string[] + * @var list */ - public $tags; + public array $tags; /** - * A route priority + * The route priority * * @var int */ - public $priority; + public int $priority; /** * Constructor of the class * - * @param string $name The route name - * @param string|null $host The route host - * @param string $path The route path - * @param string|null $method The route method - * @param string[] $methods The route methods - * @param string[] $middlewares The route middlewares - * @param array $attributes The route attributes - * @param string $summary The route summary - * @param string $description The route description - * @param string[] $tags The route tags - * @param int $priority The route priority (default 0) + * @param string $name The route name + * @param string|null $host The route host + * @param string $path The route path + * @param string|null $method The route method + * @param list $methods The route methods + * @param list> $middlewares The route middlewares + * @param array $attributes The route attributes + * @param string $summary The route summary + * @param string $description The route description + * @param list $tags The route tags + * @param int $priority The route priority (default 0) */ public function __construct( string $name, @@ -155,7 +157,7 @@ public function __construct( // if no methods are specified, // such a route is a GET route. if (empty($methods)) { - $methods[] = 'GET'; + $methods[] = self::METHOD_GET; } $this->name = $name; From 41884261532f4d312643d93fe527b58cd9f2d89e Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 19:43:28 +0100 Subject: [PATCH 006/180] New attribute to mark DTO --- src/Annotation/Body.php | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 src/Annotation/Body.php diff --git a/src/Annotation/Body.php b/src/Annotation/Body.php new file mode 100644 index 00000000..ad90075c --- /dev/null +++ b/src/Annotation/Body.php @@ -0,0 +1,25 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Annotation; + +/** + * Import classes + */ +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_PARAMETER)] +final class Body +{ +} From 74aeb7e465464cc2d09c78f7a7efc993a4b69121 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 19:47:38 +0100 Subject: [PATCH 007/180] Improved code 1. Removed static properties; 2. Involved the configure method; 3. RuntimeException was replaced with LogicException. --- src/Command/RouteListCommand.php | 49 ++++++++++++++------------------ 1 file changed, 22 insertions(+), 27 deletions(-) diff --git a/src/Command/RouteListCommand.php b/src/Command/RouteListCommand.php index 15c7aff3..b6f6a678 100644 --- a/src/Command/RouteListCommand.php +++ b/src/Command/RouteListCommand.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -14,7 +14,7 @@ /** * Import classes */ -use RuntimeException; +use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\Router; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Helper\Table; @@ -31,33 +31,21 @@ /** * This command will list all routes in your application * - * If you cannot pass the router to the constructor + * If you can't pass the router to the constructor, * or your architecture has problems with autowiring, - * then just inherit this class and override the getRouter method. + * just inherit this class and override the getRouter method. * * @since 2.9.0 */ class RouteListCommand extends Command { - /** - * {@inheritdoc} - */ - protected static $defaultName = 'router:route-list'; - - /** - * {@inheritdoc} - * - * @var string - */ - protected static $defaultDescription = 'Lists all routes in your application'; - /** * The router instance populated with routes * * @var Router|null */ - private $router; + private ?Router $router; /** * Constructor of the class @@ -68,28 +56,35 @@ public function __construct(?Router $router = null) { parent::__construct(); - $this->setName(static::$defaultName); - $this->setDescription(static::$defaultDescription); - $this->router = $router; } + /** + * {@inheritdoc} + */ + protected function configure(): void + { + $this->setName('router:route-list'); + $this->setDescription('Lists all routes in your application'); + } + /** * Gets the router instance populated with routes * * @return Router * - * @throws RuntimeException + * @throws LogicException * If the command doesn't contain the router instance. * * @since 2.11.0 */ - protected function getRouter() : Router + protected function getRouter(): Router { - if (null === $this->router) { - throw new RuntimeException(sprintf( + if (!isset($this->router)) { + throw new LogicException(sprintf( 'The %2$s() method MUST return the %1$s class instance. ' . - 'Pass the %1$s class instance to the constructor, or override the %2$s() method.', + 'Pass the %1$s class instance to the constructor, ' . + 'or override the %2$s() method.', Router::class, __METHOD__ )); @@ -101,7 +96,7 @@ protected function getRouter() : Router /** * {@inheritdoc} */ - final protected function execute(InputInterface $input, OutputInterface $output) : int + final protected function execute(InputInterface $input, OutputInterface $output): int { $table = new Table($output); From 0ed647e9d1eb3ece4baae2521ca9853718654dd3 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 19:48:06 +0100 Subject: [PATCH 008/180] Type declarations for properties --- src/Event/RouteEvent.php | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/Event/RouteEvent.php b/src/Event/RouteEvent.php index 08bda16c..cd5f6f36 100644 --- a/src/Event/RouteEvent.php +++ b/src/Event/RouteEvent.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -34,12 +34,12 @@ final class RouteEvent extends Event /** * @var RouteInterface */ - private $route; + private RouteInterface $route; /** * @var ServerRequestInterface */ - private $request; + private ServerRequestInterface $request; /** * Constructor of the class @@ -56,7 +56,7 @@ public function __construct(RouteInterface $route, ServerRequestInterface $reque /** * @return RouteInterface */ - public function getRoute() : RouteInterface + public function getRoute(): RouteInterface { return $this->route; } @@ -64,7 +64,7 @@ public function getRoute() : RouteInterface /** * @return ServerRequestInterface */ - public function getRequest() : ServerRequestInterface + public function getRequest(): ServerRequestInterface { return $this->request; } @@ -74,7 +74,7 @@ public function getRequest() : ServerRequestInterface * * @return void */ - public function setRequest(ServerRequestInterface $request) : void + public function setRequest(ServerRequestInterface $request): void { $this->request = $request; } From 4f883b9f92788d40633886e69868ae3996970ece Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 19:49:49 +0100 Subject: [PATCH 009/180] Update psalm.xml.dist --- psalm.xml.dist | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/psalm.xml.dist b/psalm.xml.dist index 3becd9ba..38cce4cf 100644 --- a/psalm.xml.dist +++ b/psalm.xml.dist @@ -1,6 +1,6 @@ Date: Sun, 8 Jan 2023 19:49:55 +0100 Subject: [PATCH 010/180] Update phpunit.xml.dist --- phpunit.xml.dist | 1 + 1 file changed, 1 insertion(+) diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 66c8dba8..0ac15159 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -5,6 +5,7 @@ > + ./functions ./src From 72946071ca37da90c03f555835000c1c7044509c Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 19:50:34 +0100 Subject: [PATCH 011/180] removed deprecated loaders --- src/Loader/AnnotationDirectoryLoader.php | 21 --------------------- src/Loader/CollectableFileLoader.php | 21 --------------------- src/Loader/DescriptorDirectoryLoader.php | 21 --------------------- 3 files changed, 63 deletions(-) delete mode 100644 src/Loader/AnnotationDirectoryLoader.php delete mode 100644 src/Loader/CollectableFileLoader.php delete mode 100644 src/Loader/DescriptorDirectoryLoader.php diff --git a/src/Loader/AnnotationDirectoryLoader.php b/src/Loader/AnnotationDirectoryLoader.php deleted file mode 100644 index 06985a40..00000000 --- a/src/Loader/AnnotationDirectoryLoader.php +++ /dev/null @@ -1,21 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Fenric - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Loader; - -/** - * AnnotationDirectoryLoader - * - * @deprecated 2.6.0 Use the DescriptorLoader class. - */ -class AnnotationDirectoryLoader extends DescriptorLoader -{ -} diff --git a/src/Loader/CollectableFileLoader.php b/src/Loader/CollectableFileLoader.php deleted file mode 100644 index e1b22879..00000000 --- a/src/Loader/CollectableFileLoader.php +++ /dev/null @@ -1,21 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Fenric - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Loader; - -/** - * CollectableFileLoader - * - * @deprecated 2.10.0 Use the ConfigLoader class. - */ -class CollectableFileLoader extends ConfigLoader -{ -} diff --git a/src/Loader/DescriptorDirectoryLoader.php b/src/Loader/DescriptorDirectoryLoader.php deleted file mode 100644 index 93614634..00000000 --- a/src/Loader/DescriptorDirectoryLoader.php +++ /dev/null @@ -1,21 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Fenric - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Loader; - -/** - * DescriptorDirectoryLoader - * - * @deprecated 2.10.0 Use the DescriptorLoader class. - */ -class DescriptorDirectoryLoader extends DescriptorLoader -{ -} From c2140c39164d20a051ede046fb353576d61a9161 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 19:53:18 +0100 Subject: [PATCH 012/180] Update ConfigLoader.php 1. Type declarations for properties; 2. New methods getResponseResolver and setResponseResolver; 3. Improved a resource validation; 4. Code style. --- src/Loader/ConfigLoader.php | 96 +++++++++++++++++++++++++------------ 1 file changed, 65 insertions(+), 31 deletions(-) diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index f57dfb1a..96cdc357 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -18,6 +18,7 @@ use Sunrise\Http\Router\Exception\InvalidLoaderResourceException; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; +use Sunrise\Http\Router\ResponseResolverInterface; use Sunrise\Http\Router\RouteCollectionFactory; use Sunrise\Http\Router\RouteCollectionFactoryInterface; use Sunrise\Http\Router\RouteCollectionInterface; @@ -31,7 +32,7 @@ use function glob; use function is_dir; use function is_file; -use function sprintf; +use function is_string; /** * ConfigLoader @@ -40,24 +41,24 @@ class ConfigLoader implements LoaderInterface { /** - * @var string[] + * @var list */ - private $resources = []; + private array $resources = []; /** * @var RouteCollectionFactoryInterface */ - private $collectionFactory; + private RouteCollectionFactoryInterface $collectionFactory; /** * @var RouteFactoryInterface */ - private $routeFactory; + private RouteFactoryInterface $routeFactory; /** * @var ReferenceResolverInterface */ - private $referenceResolver; + private ReferenceResolverInterface $referenceResolver; /** * Constructor of the class @@ -83,7 +84,7 @@ public function __construct( * * @since 2.9.0 */ - public function getContainer() : ?ContainerInterface + public function getContainer(): ?ContainerInterface { return $this->referenceResolver->getContainer(); } @@ -97,40 +98,75 @@ public function getContainer() : ?ContainerInterface * * @since 2.9.0 */ - public function setContainer(?ContainerInterface $container) : void + public function setContainer(?ContainerInterface $container): void { $this->referenceResolver->setContainer($container); } + /** + * Gets the loader response resolver + * + * @return ResponseResolverInterface|null + * + * @since 3.0.0 + */ + public function getResponseResolver(): ?ResponseResolverInterface + { + return $this->referenceResolver->getResponseResolver(); + } + + /** + * Sets the given response resolver to the loader + * + * @param ResponseResolverInterface|null $responseResolver + * + * @return void + * + * @since 3.0.0 + */ + public function setResponseResolver(?ResponseResolverInterface $responseResolver): void + { + $this->referenceResolver->setResponseResolver($responseResolver); + } + /** * {@inheritdoc} */ - public function attach($resource) : void + public function attach($resource): void { - if (is_dir($resource)) { - $fileNames = glob($resource . '/*.php'); - foreach ($fileNames as $fileName) { - $this->resources[] = $fileName; - } + if (!is_string($resource)) { + throw new InvalidLoaderResourceException( + 'Config route loader only expects string resources' + ); + } + if (is_file($resource)) { + $this->resources[] = $resource; return; } - if (!is_file($resource)) { - throw new InvalidLoaderResourceException(sprintf( - 'The resource "%s" is not found.', - $resource - )); + if (is_dir($resource)) { + $filenames = glob($resource . '/*.php'); + foreach ($filenames as $filename) { + $this->resources[] = $filename; + } + + return; } - $this->resources[] = $resource; + throw new InvalidLoaderResourceException(sprintf( + 'Config route loader only handles file or directory paths, ' . + 'however the given resource "%s" is not as expected', + $resource + )); } /** * {@inheritdoc} */ - public function attachArray(array $resources) : void + public function attachArray(array $resources): void { + /** @psalm-suppress MixedAssignment */ foreach ($resources as $resource) { $this->attach($resource); } @@ -139,7 +175,7 @@ public function attachArray(array $resources) : void /** * {@inheritdoc} */ - public function load() : RouteCollectionInterface + public function load(): RouteCollectionInterface { $collector = new RouteCollector( $this->collectionFactory, @@ -147,13 +183,11 @@ public function load() : RouteCollectionInterface $this->referenceResolver ); - foreach ($this->resources as $resource) { - (function () use ($resource) { - /** - * @psalm-suppress UnresolvableInclude - */ - require $resource; - })->call($collector); + foreach ($this->resources as $filename) { + (function (string $filename) { + /** @psalm-suppress UnresolvableInclude */ + require $filename; + })->call($collector, $filename); } return $collector->getCollection(); From 128c4384c8482d9322c163437f934970dd96c283 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 19:57:02 +0100 Subject: [PATCH 013/180] Update DescriptorLoader.php 1. Type declarations for properties; 2. Annotation support for PHP 8 is no longer automatically enabled; 3. New methods getResponseResolver, setResponseResolver, getAnnotationReader, setAnnotationReader, useDefaultAnnotationReader; 4. Improved resources validation; 5. Code style. --- src/Loader/DescriptorLoader.php | 260 +++++++++++++++++++++----------- 1 file changed, 172 insertions(+), 88 deletions(-) diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 12ef0caa..a8237386 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -14,7 +14,8 @@ /** * Import classes */ -use Doctrine\Common\Annotations\SimpleAnnotationReader; +use Doctrine\Common\Annotations\AnnotationReader; +use Doctrine\Common\Annotations\Reader as AnnotationReaderInterface; use Psr\Container\ContainerInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; @@ -25,19 +26,23 @@ use Sunrise\Http\Router\Annotation\Prefix; use Sunrise\Http\Router\Annotation\Route; use Sunrise\Http\Router\Exception\InvalidLoaderResourceException; -use Sunrise\Http\Router\Exception\UnresolvableReferenceException; +use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; +use Sunrise\Http\Router\ResponseResolverInterface; use Sunrise\Http\Router\RouteCollectionFactory; use Sunrise\Http\Router\RouteCollectionFactoryInterface; use Sunrise\Http\Router\RouteCollectionInterface; use Sunrise\Http\Router\RouteFactory; use Sunrise\Http\Router\RouteFactoryInterface; +use Iterator; use RecursiveDirectoryIterator; use RecursiveIteratorIterator; +use ReflectionAttribute; use ReflectionClass; use ReflectionMethod; use Reflector; +use SplFileInfo; /** * Import functions @@ -47,7 +52,7 @@ use function get_declared_classes; use function hash; use function is_dir; -use function sprintf; +use function is_string; use function usort; /** @@ -62,39 +67,39 @@ class DescriptorLoader implements LoaderInterface { /** - * @var class-string[] + * @var list */ - private $resources = []; + private array $resources = []; /** * @var RouteCollectionFactoryInterface */ - private $collectionFactory; + private RouteCollectionFactoryInterface $collectionFactory; /** * @var RouteFactoryInterface */ - private $routeFactory; + private RouteFactoryInterface $routeFactory; /** * @var ReferenceResolverInterface */ - private $referenceResolver; + private ReferenceResolverInterface $referenceResolver; /** - * @var SimpleAnnotationReader|null + * @var AnnotationReaderInterface|null */ - private $annotationReader = null; + private ?AnnotationReaderInterface $annotationReader = null; /** * @var CacheInterface|null */ - private $cache = null; + private ?CacheInterface $cache = null; /** * @var string|null */ - private $cacheKey = null; + private ?string $cacheKey = null; /** * Constructor of the class @@ -112,10 +117,8 @@ public function __construct( $this->routeFactory = $routeFactory ?? new RouteFactory(); $this->referenceResolver = $referenceResolver ?? new ReferenceResolver(); - // the "doctrine/annotations" package must be installed manually - if (class_exists(SimpleAnnotationReader::class)) { - $this->annotationReader = /** @scrutinizer ignore-deprecated */ new SimpleAnnotationReader(); - $this->annotationReader->addNamespace('Sunrise\Http\Router\Annotation'); + if (8 > PHP_MAJOR_VERSION) { + $this->useDefaultAnnotationReader(); } } @@ -124,43 +127,83 @@ public function __construct( * * @return ContainerInterface|null */ - public function getContainer() : ?ContainerInterface + public function getContainer(): ?ContainerInterface { return $this->referenceResolver->getContainer(); } /** - * Gets the loader cache + * Sets the given container to the loader * - * @return CacheInterface|null + * @param ContainerInterface|null $container + * + * @return void */ - public function getCache() : ?CacheInterface + public function setContainer(?ContainerInterface $container): void { - return $this->cache; + $this->referenceResolver->setContainer($container); } /** - * Gets the loader cache key + * Gets the loader response resolver * - * @return string|null + * @return ResponseResolverInterface|null * - * @since 2.10.0 + * @since 3.0.0 */ - public function getCacheKey() : ?string + public function getResponseResolver(): ?ResponseResolverInterface { - return $this->cacheKey; + return $this->referenceResolver->getResponseResolver(); } /** - * Sets the given container to the loader + * Sets the given response resolver to the loader * - * @param ContainerInterface|null $container + * @param ResponseResolverInterface|null $responseResolver * * @return void + * + * @since 3.0.0 */ - public function setContainer(?ContainerInterface $container) : void + public function setResponseResolver(?ResponseResolverInterface $responseResolver): void { - $this->referenceResolver->setContainer($container); + $this->referenceResolver->setResponseResolver($responseResolver); + } + + /** + * Gets the loader annotation reader + * + * @return AnnotationReaderInterface|null + * + * @since 3.0.0 + */ + public function getAnnotationReader(): ?AnnotationReaderInterface + { + return $this->annotationReader; + } + + /** + * Sets the given annotation reader to the loader + * + * @param AnnotationReaderInterface|null $annotationReader + * + * @return void + * + * @since 3.0.0 + */ + public function setAnnotationReader(?AnnotationReaderInterface $annotationReader): void + { + $this->annotationReader = $annotationReader; + } + + /** + * Gets the loader cache + * + * @return CacheInterface|null + */ + public function getCache(): ?CacheInterface + { + return $this->cache; } /** @@ -170,11 +213,23 @@ public function setContainer(?ContainerInterface $container) : void * * @return void */ - public function setCache(?CacheInterface $cache) : void + public function setCache(?CacheInterface $cache): void { $this->cache = $cache; } + /** + * Gets the loader cache key + * + * @return string + * + * @since 2.10.0 + */ + public function getCacheKey(): string + { + return $this->cacheKey ??= hash('md5', 'router:descriptors'); + } + /** * Sets the given cache key to the loader * @@ -184,16 +239,49 @@ public function setCache(?CacheInterface $cache) : void * * @since 2.10.0 */ - public function setCacheKey(?string $cacheKey) : void + public function setCacheKey(?string $cacheKey): void { $this->cacheKey = $cacheKey; } + /** + * Uses the default annotation reader + * + * @return void + * + * @throws LogicException + * If the doctrine/annotations package isn't installed. + * + * @since 3.0.0 + */ + public function useDefaultAnnotationReader(): void + { + if (!class_exists(AnnotationReader::class)) { + throw new LogicException( + 'Loading routes from descriptors requires the "doctrine/annotations" package that is not installed, ' . + 'run the command "composer install doctrine/annotations" and try again' + ); + } + + $this->setAnnotationReader(new AnnotationReader()); + } + /** * {@inheritdoc} */ - public function attach($resource) : void + public function attach($resource): void { + if (!is_string($resource)) { + throw new InvalidLoaderResourceException( + 'Descriptor route loader only expects string resources' + ); + } + + if (class_exists($resource)) { + $this->resources[] = $resource; + return; + } + if (is_dir($resource)) { $classNames = $this->scandir($resource); foreach ($classNames as $className) { @@ -203,21 +291,19 @@ public function attach($resource) : void return; } - if (!class_exists($resource)) { - throw new InvalidLoaderResourceException(sprintf( - 'The resource "%s" is not found.', - $resource - )); - } - - $this->resources[] = $resource; + throw new InvalidLoaderResourceException(sprintf( + 'Descriptor route loader only handles class names or directory paths, ' . + 'however the given resource "%s" is not as expected', + $resource + )); } /** * {@inheritdoc} */ - public function attachArray(array $resources) : void + public function attachArray(array $resources): void { + /** @psalm-suppress MixedAssignment */ foreach ($resources as $resource) { $this->attach($resource); } @@ -225,27 +311,19 @@ public function attachArray(array $resources) : void /** * {@inheritdoc} - * - * @throws UnresolvableReferenceException - * If one of the found middlewares cannot be resolved. */ - public function load() : RouteCollectionInterface + public function load(): RouteCollectionInterface { - $descriptors = $this->getCachedDescriptors(); + $descriptors = $this->getDescriptors(); $routes = []; foreach ($descriptors as $descriptor) { - $middlewares = []; - foreach ($descriptor->middlewares as $className) { - $middlewares[] = $this->referenceResolver->toMiddleware($className); - } - $routes[] = $this->routeFactory->createRoute( $descriptor->name, $descriptor->path, $descriptor->methods, $this->referenceResolver->toRequestHandler($descriptor->holder), - $middlewares, + $this->referenceResolver->toMiddlewares($descriptor->middlewares), $descriptor->attributes ) ->setHost($descriptor->host) @@ -260,33 +338,34 @@ public function load() : RouteCollectionInterface /** * Gets descriptors from the cache if they are stored in it, * otherwise collects them from the loader resources, - * and then tries to cache them + * and then tries to cache and return them * - * @return Route[] + * @return list */ - private function getCachedDescriptors() : array + private function getDescriptors(): array { - $key = $this->cacheKey ?? hash('md5', 'router:descriptors'); + $cacheKey = $this->getCacheKey(); - if ($this->cache && $this->cache->has($key)) { - return $this->cache->get($key); + if (isset($this->cache) && $this->cache->has($cacheKey)) { + /** @var list */ + return $this->cache->get($cacheKey); } - $result = $this->collectDescriptors(); + $descriptors = $this->collectDescriptors(); - if ($this->cache) { - $this->cache->set($key, $result); + if (isset($this->cache)) { + $this->cache->set($cacheKey, $descriptors); } - return $result; + return $descriptors; } /** - * Collects descriptors from the loader resources + * Collects and returns descriptors from the loader resources * - * @return Route[] + * @return list */ - private function collectDescriptors() : array + private function collectDescriptors(): array { $result = []; foreach ($this->resources as $resource) { @@ -297,7 +376,7 @@ private function collectDescriptors() : array } } - usort($result, function (Route $a, Route $b) : int { + usort($result, function (Route $a, Route $b): int { return $b->priority <=> $a->priority; }); @@ -309,15 +388,17 @@ private function collectDescriptors() : array * * @param ReflectionClass $class * - * @return Route[] + * @return list */ - private function getClassDescriptors(ReflectionClass $class) : array + private function getClassDescriptors(ReflectionClass $class): array { - if ($class->isAbstract()) { + // e.g., interfaces, traits, enums, abstract classes, + // classes with private constructor... + if (!$class->isInstantiable()) { return []; } - $result = []; + $descriptors = []; if ($class->isSubclassOf(RequestHandlerInterface::class)) { $annotations = $this->getAnnotations($class, Route::class); @@ -325,15 +406,13 @@ private function getClassDescriptors(ReflectionClass $class) : array $descriptor = $annotations[0]; $this->supplementDescriptor($descriptor, $class); $descriptor->holder = $class->getName(); - $result[] = $descriptor; + $descriptors[] = $descriptor; } } foreach ($class->getMethods() as $method) { // ignore non-available methods... - if ($method->isStatic() || - $method->isPrivate() || - $method->isProtected()) { + if (!$method->isPublic() || $method->isStatic()) { continue; } @@ -343,16 +422,20 @@ private function getClassDescriptors(ReflectionClass $class) : array $this->supplementDescriptor($descriptor, $class); $this->supplementDescriptor($descriptor, $method); $descriptor->holder = [$class->getName(), $method->getName()]; - $result[] = $descriptor; + $descriptors[] = $descriptor; } } - return $result; + return $descriptors; } /** * Supplements the given descriptor from the given class or method with data such as: - * host, path prefix, path postfix and middlewares + * + * - host + * - path prefix + * - path postfix + * - middlewares * * ```php * #[Prefix('/api/v1')] @@ -375,7 +458,7 @@ private function getClassDescriptors(ReflectionClass $class) : array * * @return void */ - private function supplementDescriptor(Route $descriptor, Reflector $reflector) : void + private function supplementDescriptor(Route $descriptor, Reflector $reflector): void { $annotations = $this->getAnnotations($reflector, Host::class); if (isset($annotations[0])) { @@ -404,22 +487,24 @@ private function supplementDescriptor(Route $descriptor, Reflector $reflector) : * @param ReflectionClass|ReflectionMethod $reflector * @param class-string $annotationName * - * @return T[] + * @return list * * @template T */ - private function getAnnotations(Reflector $reflector, string $annotationName) : array + private function getAnnotations(Reflector $reflector, string $annotationName): array { $result = []; if (8 === PHP_MAJOR_VERSION) { + /** @var ReflectionAttribute[] */ $attributes = $reflector->getAttributes($annotationName); foreach ($attributes as $attribute) { + /** @var T */ $result[] = $attribute->newInstance(); } } - if (empty($result) and isset($this->annotationReader)) { + if (isset($this->annotationReader) && empty($result)) { $annotations = ($reflector instanceof ReflectionClass) ? $this->annotationReader->getClassAnnotations($reflector) : $this->annotationReader->getMethodAnnotations($reflector); @@ -441,8 +526,9 @@ private function getAnnotations(Reflector $reflector, string $annotationName) : * * @return class-string[] */ - private function scandir(string $directory) : array + private function scandir(string $directory): array { + /** @var Iterator */ $files = new RecursiveIteratorIterator( new RecursiveDirectoryIterator($directory) ); @@ -451,9 +537,7 @@ private function scandir(string $directory) : array foreach ($files as $file) { if ('php' === $file->getExtension()) { - /** - * @psalm-suppress UnresolvableInclude - */ + /** @psalm-suppress UnresolvableInclude */ require_once $file->getPathname(); } } From 52a9ce8913206ae0acd2d0841852d8bc20ddcc3f Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 19:57:18 +0100 Subject: [PATCH 014/180] cs --- src/Loader/LoaderInterface.php | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/Loader/LoaderInterface.php b/src/Loader/LoaderInterface.php index 750a4aa4..b268edc4 100644 --- a/src/Loader/LoaderInterface.php +++ b/src/Loader/LoaderInterface.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -33,24 +33,24 @@ interface LoaderInterface * @throws InvalidLoaderResourceException * If the given resource isn't valid. */ - public function attach($resource) : void; + public function attach($resource): void; /** * Attaches the given resources to the loader * - * @param array $resources + * @param array $resources * * @return void * * @throws InvalidLoaderResourceException * If one of the given resources isn't valid. */ - public function attachArray(array $resources) : void; + public function attachArray(array $resources): void; /** * Loads routes from previously attached resources * * @return RouteCollectionInterface */ - public function load() : RouteCollectionInterface; + public function load(): RouteCollectionInterface; } From 4f639db9b269411eb5112953f85a98b48d319ef9 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 19:57:30 +0100 Subject: [PATCH 015/180] cs --- src/Middleware/CallableMiddleware.php | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/src/Middleware/CallableMiddleware.php b/src/Middleware/CallableMiddleware.php index ab2bef18..a7eeccbb 100644 --- a/src/Middleware/CallableMiddleware.php +++ b/src/Middleware/CallableMiddleware.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -51,7 +51,7 @@ public function __construct(callable $callback) * * @since 2.10.0 */ - public function getCallback() : callable + public function getCallback(): callable { return $this->callback; } @@ -59,8 +59,11 @@ public function getCallback() : callable /** * {@inheritdoc} */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler) : ResponseInterface + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - return ($this->callback)($request, $handler); + /** @var ResponseInterface */ + $response = ($this->callback)($request, $handler); + + return $response; } } From 750f5bcd30768fb50895efb0b015554e300a55fb Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 19:58:19 +0100 Subject: [PATCH 016/180] Update JsonPayloadDecodingMiddleware.php 1. New constant JSON_MAXIMAL_DEPTH; 2. Code style. --- .../JsonPayloadDecodingMiddleware.php | 65 ++++++++++++------- 1 file changed, 42 insertions(+), 23 deletions(-) diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index b758dce4..ddf5d6ce 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -14,18 +14,19 @@ /** * Import classes */ +use JsonException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\UndecodablePayloadException; +use Sunrise\Http\Router\Exception\InvalidPayloadException; /** * Import functions */ +use function is_array; +use function is_object; use function json_decode; -use function json_last_error; -use function json_last_error_msg; use function rtrim; use function strpos; use function substr; @@ -34,7 +35,8 @@ * Import constants */ use const JSON_BIGINT_AS_STRING; -use const JSON_ERROR_NONE; +use const JSON_OBJECT_AS_ARRAY; +use const JSON_THROW_ON_ERROR; /** * JsonPayloadDecodingMiddleware @@ -45,7 +47,7 @@ class JsonPayloadDecodingMiddleware implements MiddlewareInterface { /** - * JSON Media Type + * JSON media type * * @var string * @@ -53,6 +55,13 @@ class JsonPayloadDecodingMiddleware implements MiddlewareInterface */ private const JSON_MEDIA_TYPE = 'application/json'; + /** + * JSON maximal depth + * + * @var int + */ + protected const JSON_MAXIMAL_DEPTH = 512; + /** * JSON decoding options * @@ -60,20 +69,19 @@ class JsonPayloadDecodingMiddleware implements MiddlewareInterface * * @link https://www.php.net/manual/ru/json.constants.php */ - protected const JSON_DECODING_OPTIONS = JSON_BIGINT_AS_STRING; + protected const JSON_DECODING_OPTIONS = JSON_BIGINT_AS_STRING | JSON_OBJECT_AS_ARRAY; /** * {@inheritdoc} */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler) : ResponseInterface + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if (!$this->isSupportedRequest($request)) { - return $handler->handle($request); + if ($this->isSupportedRequest($request)) { + $data = $this->decodeRequestJsonPayload($request); + $request = $request->withParsedBody($data); } - $parsedBody = $this->decodeRequestJsonPayload($request); - - return $handler->handle($request->withParsedBody($parsedBody)); + return $handler->handle($request); } /** @@ -83,13 +91,13 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface * * @return bool */ - private function isSupportedRequest(ServerRequestInterface $request) : bool + private function isSupportedRequest(ServerRequestInterface $request): bool { return self::JSON_MEDIA_TYPE === $this->getRequestMediaType($request); } /** - * Gets Media Type from the given request + * Gets media type from the given request * * @param ServerRequestInterface $request * @@ -97,7 +105,7 @@ private function isSupportedRequest(ServerRequestInterface $request) : bool * * @link https://tools.ietf.org/html/rfc7231#section-3.1.1.1 */ - private function getRequestMediaType(ServerRequestInterface $request) : ?string + private function getRequestMediaType(ServerRequestInterface $request): ?string { if (!$request->hasHeader('Content-Type')) { return null; @@ -119,19 +127,30 @@ private function getRequestMediaType(ServerRequestInterface $request) : ?string * * @param ServerRequestInterface $request * - * @return mixed + * @return array|object|null * - * @throws UndecodablePayloadException + * @throws InvalidPayloadException * If the request's payload cannot be decoded. */ private function decodeRequestJsonPayload(ServerRequestInterface $request) { - json_decode(''); - $result = json_decode($request->getBody()->__toString(), true, 512, static::JSON_DECODING_OPTIONS); - if (JSON_ERROR_NONE === json_last_error()) { + /** @var int */ + $depth = static::JSON_MAXIMAL_DEPTH; + + /** @var int */ + $flags = static::JSON_DECODING_OPTIONS; + + try { + /** @var mixed */ + $result = json_decode($request->getBody()->__toString(), null, $depth, $flags | JSON_THROW_ON_ERROR); + } catch (JsonException $e) { + throw new InvalidPayloadException(sprintf('Invalid Payload: %s', $e->getMessage()), 0, $e); + } + + if (is_array($result) || is_object($result)) { return $result; } - throw new UndecodablePayloadException(sprintf('Invalid Payload: %s', json_last_error_msg())); + return null; } } From 94df5e06a4a9fa81b1fd045e06f346463906fb65 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 20:00:12 +0100 Subject: [PATCH 017/180] New middleware for mapping request body --- .../ParsedBodyMappingMiddleware.php | 154 ++++++++++++++++++ 1 file changed, 154 insertions(+) create mode 100644 src/Middleware/ParsedBodyMappingMiddleware.php diff --git a/src/Middleware/ParsedBodyMappingMiddleware.php b/src/Middleware/ParsedBodyMappingMiddleware.php new file mode 100644 index 00000000..f7f25804 --- /dev/null +++ b/src/Middleware/ParsedBodyMappingMiddleware.php @@ -0,0 +1,154 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Middleware; + +/** + * Import classes + */ +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\Annotation\Body; +use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; +use Sunrise\Http\Router\RouteInterface; +use Sunrise\Hydrator\Exception\InvalidValueException; +use Sunrise\Hydrator\Exception\InvalidObjectException; +use Sunrise\Hydrator\HydratorInterface; +use Sunrise\Hydrator\Hydrator; +use ReflectionNamedType; + +/** + * Import functions + */ +use function class_exists; +use function sprintf; + +/** + * Import constants + */ +use const PHP_MAJOR_VERSION; + +/** + * ParsedBodyMappingMiddleware + * + * @link https://github.com/sunrise-php/hydrator + * + * @since 3.0.0 + */ +class ParsedBodyMappingMiddleware implements MiddlewareInterface +{ + + /** + * Objects hydrator + * + * @var HydratorInterface + */ + private HydratorInterface $objectHydrator; + + /** + * Constructor of the class + * + * @param HydratorInterface|null $objectHydrator + * + * @throws LogicException + * If the PHP version less than 8. + */ + public function __construct(?HydratorInterface $objectHydrator = null) + { + if (PHP_MAJOR_VERSION < 8) { + throw new LogicException('Parsed body mapping requires PHP version 8'); + } + + $this->objectHydrator = $objectHydrator ?? new Hydrator(); + } + + /** + * {@inheritdoc} + * + * @throws LogicException + * If something went wrong... + * + * @throws HttpUnprocessableEntityException + * If the request body isn't valid. + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + $route = $request->getAttribute(RouteInterface::ATTR_ROUTE); + if (!($route instanceof RouteInterface)) { + throw new LogicException(sprintf( + 'The "%s" middleware must be related with a route', + __CLASS__ + )); + } + + $routeRequestHandler = $route->getRequestHandler(); + if (!($routeRequestHandler instanceof CallableRequestHandler)) { + throw new LogicException(sprintf( + 'The "%s" route cannot be related with the "%s" middleware', + $route->getName(), + __CLASS__ + )); + } + + $routeRequestHandlerProcessableParameter = $routeRequestHandler->getAttributedParameter(Body::class); + if (!isset($routeRequestHandlerProcessableParameter)) { + return $handler->handle($request); + } + + $routeRequestHandlerProcessableParameterType = $routeRequestHandlerProcessableParameter->getType(); + if (!($routeRequestHandlerProcessableParameterType instanceof ReflectionNamedType)) { + throw new LogicException(sprintf( + 'The "%s" parameter of the "%s" route request handler cannot be hydrated ' . + 'because its type is not supported, do not use union or intersection types', + $routeRequestHandlerProcessableParameter->getName(), + $route->getName() + )); + } + + $routeRequestHandlerProcessableParameterClassName = $routeRequestHandlerProcessableParameterType->getName(); + if (!class_exists($routeRequestHandlerProcessableParameterClassName)) { + throw new LogicException(sprintf( + 'The "%s" parameter of the "%s" route request handler cannot be hydrated ' . + 'because its refers to the "%s" class that cannot be found', + $routeRequestHandlerProcessableParameter->getName(), + $route->getName(), + $routeRequestHandlerProcessableParameterType->getName() + )); + } + + try { + $hydratedObject = $this->objectHydrator->hydrate( + $routeRequestHandlerProcessableParameterClassName, + (array) $request->getParsedBody() + ); + } catch (InvalidObjectException $e) { + throw new LogicException(sprintf( + 'The "%s" parameter of the "%s" route request handler cannot be hydrated ' . + 'because its refers to an invalid DTO: %s', + $routeRequestHandlerProcessableParameter->getName(), + $route->getName(), + $e->getMessage() + ), 0, $e); + } catch (InvalidValueException $e) { + throw new HttpUnprocessableEntityException($e->getMessage(), 0, $e); + } + + $routeRequestHandlerArguments = $routeRequestHandler->getArguments(); + $routeRequestHandlerArguments[$routeRequestHandlerProcessableParameter->getPosition()] = $hydratedObject; + $route->setRequestHandler($routeRequestHandler->withArguments($routeRequestHandlerArguments)); + + return $handler->handle($request); + } +} From 8bf270830d8237ca5ce47c34263f0f5a068b5a9c Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 20:01:45 +0100 Subject: [PATCH 018/180] Update ReferenceResolver.php 1. Type declarations for properties; 2. New methods: getResponseResolver, setResponseResolver and toMiddlewares; 3. Code style. --- src/ReferenceResolver.php | 94 ++++++++++++++++++++++++++++----------- 1 file changed, 68 insertions(+), 26 deletions(-) diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index b0461b78..30a3c658 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -17,7 +17,7 @@ use Psr\Container\ContainerInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\UnresolvableReferenceException; +use Sunrise\Http\Router\Exception\InvalidReferenceException; use Sunrise\Http\Router\Middleware\CallableMiddleware; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use Closure; @@ -45,12 +45,19 @@ class ReferenceResolver implements ReferenceResolverInterface * * @var ContainerInterface|null */ - private $container = null; + private ?ContainerInterface $container = null; + + /** + * The reference resolver's response resolver + * + * @var ResponseResolverInterface|null + */ + private ?ResponseResolverInterface $responseResolver = null; /** * {@inheritdoc} */ - public function getContainer() : ?ContainerInterface + public function getContainer(): ?ContainerInterface { return $this->container; } @@ -58,7 +65,7 @@ public function getContainer() : ?ContainerInterface /** * {@inheritdoc} */ - public function setContainer(?ContainerInterface $container) : void + public function setContainer(?ContainerInterface $container): void { $this->container = $container; } @@ -66,27 +73,46 @@ public function setContainer(?ContainerInterface $container) : void /** * {@inheritdoc} */ - public function toRequestHandler($reference) : RequestHandlerInterface + public function getResponseResolver(): ?ResponseResolverInterface + { + return $this->responseResolver; + } + + /** + * {@inheritdoc} + */ + public function setResponseResolver(?ResponseResolverInterface $responseResolver): void + { + $this->responseResolver = $responseResolver; + } + + /** + * {@inheritdoc} + */ + public function toRequestHandler($reference): RequestHandlerInterface { if ($reference instanceof RequestHandlerInterface) { return $reference; } if ($reference instanceof Closure) { - return new CallableRequestHandler($reference); + return new CallableRequestHandler($reference, $this->responseResolver); } list($class, $method) = $this->normalizeReference($reference); if (isset($class) && isset($method) && method_exists($class, $method)) { - return new CallableRequestHandler([$this->resolveClass($class), $method]); + /** @var callable */ + $callback = [$this->resolveClass($class), $method]; + + return new CallableRequestHandler($callback, $this->responseResolver); } if (!isset($method) && isset($class) && is_subclass_of($class, RequestHandlerInterface::class)) { return $this->resolveClass($class); } - throw new UnresolvableReferenceException(sprintf( + throw new InvalidReferenceException(sprintf( 'Unable to resolve the "%s" reference to a request handler.', $this->stringifyReference($reference) )); @@ -95,7 +121,7 @@ public function toRequestHandler($reference) : RequestHandlerInterface /** * {@inheritdoc} */ - public function toMiddleware($reference) : MiddlewareInterface + public function toMiddleware($reference): MiddlewareInterface { if ($reference instanceof MiddlewareInterface) { return $reference; @@ -115,30 +141,42 @@ public function toMiddleware($reference) : MiddlewareInterface return $this->resolveClass($class); } - throw new UnresolvableReferenceException(sprintf( + throw new InvalidReferenceException(sprintf( 'Unable to resolve the "%s" reference to a middleware.', $this->stringifyReference($reference) )); } + /** + * {@inheritdoc} + */ + public function toMiddlewares(array $references): array + { + $middlewares = []; + /** @psalm-suppress MixedAssignment */ + foreach ($references as $reference) { + $middlewares[] = $this->toMiddleware($reference); + } + + return $middlewares; + } + /** * Normalizes the given reference * * @param mixed $reference * - * @return array{0: ?class-string, 1: ?string} + * @return array{0: ?class-string, 1: ?non-empty-string} */ - private function normalizeReference($reference) : array + private function normalizeReference($reference): array { if (is_array($reference) && is_callable($reference, true)) { - /** @var array{0: class-string, 1: string} $reference */ - + /** @var array{0: class-string, 1: non-empty-string} $reference */ return $reference; } if (is_string($reference)) { /** @var class-string $reference */ - return [$reference, null]; } @@ -152,14 +190,16 @@ private function normalizeReference($reference) : array * * @return string */ - private function stringifyReference($reference) : string + private function stringifyReference($reference): string { - if (is_array($reference) && is_callable($reference, true)) { + $reference = $this->normalizeReference($reference); + + if (isset($reference[0], $reference[1])) { return $reference[0] . '@' . $reference[1]; } - if (is_string($reference)) { - return $reference; + if (isset($reference[0])) { + return $reference[0]; } return ''; @@ -168,18 +208,20 @@ private function stringifyReference($reference) : string /** * Resolves the given class * - * @param class-string $class + * @param class-string $className * * @return T * * @template T */ - private function resolveClass(string $class) + private function resolveClass(string $className) { - if ($this->container && $this->container->has($class)) { - return $this->container->get($class); + if (isset($this->container) && $this->container->has($className)) { + /** @var T */ + return $this->container->get($className); } - return new $class; + /** @psalm-suppress MixedMethodCall */ + return new $className; } } From 6c50e91ce5b40eaa6f4450fb9a9c396863b3b942 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 20:02:13 +0100 Subject: [PATCH 019/180] New methods was added --- src/ReferenceResolverInterface.php | 52 ++++++++++++++++++++++++------ 1 file changed, 43 insertions(+), 9 deletions(-) diff --git a/src/ReferenceResolverInterface.php b/src/ReferenceResolverInterface.php index 219b9360..a939fa1c 100644 --- a/src/ReferenceResolverInterface.php +++ b/src/ReferenceResolverInterface.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -17,7 +17,7 @@ use Psr\Container\ContainerInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\UnresolvableReferenceException; +use Sunrise\Http\Router\Exception\InvalidReferenceException; /** * ReferenceResolverInterface @@ -32,7 +32,7 @@ interface ReferenceResolverInterface * * @return ContainerInterface|null */ - public function getContainer() : ?ContainerInterface; + public function getContainer(): ?ContainerInterface; /** * Sets the given container to the reference resolver @@ -41,7 +41,27 @@ public function getContainer() : ?ContainerInterface; * * @return void */ - public function setContainer(?ContainerInterface $container) : void; + public function setContainer(?ContainerInterface $container): void; + + /** + * Gets the reference resolver's response resolver + * + * @return ResponseResolverInterface|null + * + * @since 3.0.0 + */ + public function getResponseResolver(): ?ResponseResolverInterface; + + /** + * Sets the given response resolver to the reference resolver + * + * @param ResponseResolverInterface|null $responseResolver + * + * @return void + * + * @since 3.0.0 + */ + public function setResponseResolver(?ResponseResolverInterface $responseResolver): void; /** * Resolves the given reference to a request handler @@ -50,10 +70,10 @@ public function setContainer(?ContainerInterface $container) : void; * * @return RequestHandlerInterface * - * @throws UnresolvableReferenceException + * @throws InvalidReferenceException * If the given reference cannot be resolved to a request handler. */ - public function toRequestHandler($reference) : RequestHandlerInterface; + public function toRequestHandler($reference): RequestHandlerInterface; /** * Resolves the given reference to a middleware @@ -62,8 +82,22 @@ public function toRequestHandler($reference) : RequestHandlerInterface; * * @return MiddlewareInterface * - * @throws UnresolvableReferenceException + * @throws InvalidReferenceException * If the given reference cannot be resolved to a middleware. */ - public function toMiddleware($reference) : MiddlewareInterface; + public function toMiddleware($reference): MiddlewareInterface; + + /** + * Resolves the given references to middlewares + * + * @param array $references + * + * @return list + * + * @throws InvalidReferenceException + * If one of the given references cannot be resolved to a middleware. + * + * @since 3.0.0 + */ + public function toMiddlewares(array $references): array; } From 64486b90f8bd3c30e820ee324f0452ff49086cf3 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 20:04:06 +0100 Subject: [PATCH 020/180] Update CallableRequestHandler.php 1. Ability to pass the response resolver to the constructor; 2. New methods getReflection, getParameters, getAttributedParameter, getReturnType, getArguments, withArguments; 3. Ability to pass arguments to the callback; 4. Code style. --- src/RequestHandler/CallableRequestHandler.php | 151 +++++++++++++++++- 1 file changed, 143 insertions(+), 8 deletions(-) diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index d84e313b..ee03fa83 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -17,6 +17,18 @@ use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\ResponseResolverInterface; +use ReflectionFunctionAbstract; +use ReflectionFunction; +use ReflectionMethod; +use ReflectionParameter; +use ReflectionType; + +/** + * Import functions + */ +use function ksort; +use function Sunrise\Http\Router\reflect_callable; /** * CallableRequestHandler @@ -25,39 +37,162 @@ class CallableRequestHandler implements RequestHandlerInterface { /** - * The request handler callback + * The handler callback * * @var callable */ private $callback; + /** + * The callback arguments + * + * @var list + * + * @since 3.0.0 + * + * @psalm-immutable + */ + private array $arguments = []; + + /** + * The response resolver + * + * @var ResponseResolverInterface|null + * + * @since 3.0.0 + */ + private ?ResponseResolverInterface $responseResolver; + /** * Constructor of the class * * @param callable $callback + * @param ResponseResolverInterface|null $responseResolver */ - public function __construct(callable $callback) + public function __construct(callable $callback, ?ResponseResolverInterface $responseResolver = null) { $this->callback = $callback; + $this->responseResolver = $responseResolver; } /** - * Gets the request handler callback + * Gets the handler callback * * @return callable * * @since 2.10.0 */ - public function getCallback() : callable + public function getCallback(): callable { return $this->callback; } + /** + * Gets the callback reflection + * + * @return ReflectionFunction|ReflectionMethod + * + * @since 3.0.0 + */ + public function getReflection(): ReflectionFunctionAbstract + { + return reflect_callable($this->callback); + } + + /** + * Gets the callback parameters + * + * @return list + * + * @since 3.0.0 + */ + public function getParameters(): array + { + return $this->getReflection()->getParameters(); + } + + /** + * Gets the callback's attributed parameter + * + * @param class-string $attribute + * + * @return ReflectionParameter|null + * + * @since 3.0.0 + */ + public function getAttributedParameter(string $attribute): ?ReflectionParameter + { + foreach ($this->getParameters() as $parameter) { + if ($parameter->getAttributes($attribute)) { + return $parameter; + } + } + + return null; + } + + /** + * Gets the callback's return type + * + * @return ReflectionType|null + * + * @since 3.0.0 + */ + public function getReturnType(): ?ReflectionType + { + return $this->getReflection()->getReturnType(); + } + + /** + * Gets the callback arguments + * + * @return list + * + * @since 3.0.0 + */ + public function getArguments(): array + { + return $this->arguments; + } + + /** + * Creates a new instance of the request handler with the given arguments and returns it + * + * Please note that the first argument will be the server request instance. + * + * @param array $arguments + * + * @return static + * + * @since 3.0.0 + */ + public function withArguments(array $arguments): self + { + ksort($arguments, SORT_NUMERIC); + + $clone = clone $this; + $clone->arguments = []; + + /** @psalm-suppress MixedAssignment */ + foreach ($arguments as $argument) { + $clone->arguments[] = $argument; + } + + return $clone; + } + /** * {@inheritdoc} */ - public function handle(ServerRequestInterface $request) : ResponseInterface + public function handle(ServerRequestInterface $request): ResponseInterface { - return ($this->callback)($request); + /** @var ResponseInterface $response */ + $response = ($this->callback)($request, ...$this->arguments); + + if (isset($this->responseResolver)) { + return $this->responseResolver->resolveResponse($response); + } + + return $response; } } From 84a4ea476747e608cef84a405b48e43c39133bee Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 20:05:38 +0100 Subject: [PATCH 021/180] Update QueueableRequestHandler.php 1. Type declarations for properties; 2. Code style. --- .../QueueableRequestHandler.php | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index ce9c45f0..ce55f941 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -29,16 +29,16 @@ class QueueableRequestHandler implements RequestHandlerInterface /** * The request handler queue * - * @var SplQueue + * @var SplQueue */ - private $queue; + private SplQueue $queue; /** * The request handler endpoint * * @var RequestHandlerInterface */ - private $endpoint; + private RequestHandlerInterface $endpoint; /** * Constructor of the class @@ -47,7 +47,10 @@ class QueueableRequestHandler implements RequestHandlerInterface */ public function __construct(RequestHandlerInterface $endpoint) { - $this->queue = new SplQueue(); + /** @var SplQueue */ + $queue = new SplQueue(); + + $this->queue = $queue; $this->endpoint = $endpoint; } @@ -58,7 +61,7 @@ public function __construct(RequestHandlerInterface $endpoint) * * @return void */ - public function add(MiddlewareInterface ...$middlewares) : void + public function add(MiddlewareInterface ...$middlewares): void { foreach ($middlewares as $middleware) { $this->queue->enqueue($middleware); @@ -68,7 +71,7 @@ public function add(MiddlewareInterface ...$middlewares) : void /** * {@inheritdoc} */ - public function handle(ServerRequestInterface $request) : ResponseInterface + public function handle(ServerRequestInterface $request): ResponseInterface { if (!$this->queue->isEmpty()) { return $this->queue->dequeue()->process($request, $this); From b243cc7d967613262ea39462884a0fdccef460a2 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 20:05:49 +0100 Subject: [PATCH 022/180] Create ResponseResolverInterface.php --- src/ResponseResolverInterface.php | 39 +++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 src/ResponseResolverInterface.php diff --git a/src/ResponseResolverInterface.php b/src/ResponseResolverInterface.php new file mode 100644 index 00000000..56ae81f6 --- /dev/null +++ b/src/ResponseResolverInterface.php @@ -0,0 +1,39 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router; + +/** + * Import classes + */ +use Psr\Http\Message\ResponseInterface; +use Sunrise\Http\Router\Exception\LogicException; + +/** + * ResponseResolverInterface + * + * @since 3.0.0 + */ +interface ResponseResolverInterface +{ + + /** + * Resolves the given data to the response instance + * + * @param mixed $data + * + * @return ResponseInterface + * + * @throws LogicException + * If the data cannot be resolved to the response. + */ + public function resolveResponse($data): ResponseInterface; +} From e5513e4fad1cc78d83a7114700cd661962f53bbc Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 20:07:06 +0100 Subject: [PATCH 023/180] Update Route.php 1. Type declarations for properties; 2. Deleted deprecated constants and sections of code; 3. Code style. --- src/Route.php | 151 +++++++++++++++++++++----------------------------- 1 file changed, 62 insertions(+), 89 deletions(-) diff --git a/src/Route.php b/src/Route.php index e442795c..03049070 100644 --- a/src/Route.php +++ b/src/Route.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -20,10 +20,7 @@ use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; -use Closure; use ReflectionClass; -use ReflectionMethod; -use ReflectionFunction; use Reflector; /** @@ -40,103 +37,85 @@ class Route implements RouteInterface { - /** - * Server Request attribute name for the route - * - * @var string - * - * @deprecated 2.11.0 Use the RouteInterface::ATTR_ROUTE constant. - */ - public const ATTR_NAME_FOR_ROUTE = self::ATTR_ROUTE; - - /** - * Server Request attribute name for the route name - * - * @var string - * - * @deprecated 2.9.0 - */ - public const ATTR_NAME_FOR_ROUTE_NAME = '@route-name'; - /** * The route name * * @var string */ - private $name; + private string $name; /** * The route host * * @var string|null */ - private $host = null; + private ?string $host = null; /** * The route path * * @var string */ - private $path; + private string $path; /** * The route methods * - * @var string[] + * @var list */ - private $methods; + private array $methods = []; /** * The route request handler * * @var RequestHandlerInterface */ - private $requestHandler; + private RequestHandlerInterface $requestHandler; /** * The route middlewares * - * @var MiddlewareInterface[] + * @var list */ - private $middlewares = []; + private array $middlewares = []; /** * The route attributes * - * @var array + * @var array */ - private $attributes = []; + private array $attributes = []; /** * The route summary * * @var string */ - private $summary = ''; + private string $summary = ''; /** * The route description * * @var string */ - private $description = ''; + private string $description = ''; /** * The route tags * - * @var string[] + * @var list */ - private $tags = []; + private array $tags = []; /** * Constructor of the class * * @param string $name * @param string $path - * @param string[] $methods + * @param list $methods * @param RequestHandlerInterface $requestHandler - * @param MiddlewareInterface[] $middlewares - * @param array $attributes + * @param list $middlewares + * @param array $attributes */ public function __construct( string $name, @@ -146,18 +125,18 @@ public function __construct( array $middlewares = [], array $attributes = [] ) { - $this->setName($name); - $this->setPath($path); + $this->name = $name; + $this->path = $path; $this->setMethods(...$methods); - $this->setRequestHandler($requestHandler); + $this->requestHandler = $requestHandler; $this->setMiddlewares(...$middlewares); - $this->setAttributes($attributes); + $this->attributes = $attributes; } /** * {@inheritdoc} */ - public function getName() : string + public function getName(): string { return $this->name; } @@ -165,7 +144,7 @@ public function getName() : string /** * {@inheritdoc} */ - public function getHost() : ?string + public function getHost(): ?string { return $this->host; } @@ -173,7 +152,7 @@ public function getHost() : ?string /** * {@inheritdoc} */ - public function getPath() : string + public function getPath(): string { return $this->path; } @@ -181,7 +160,7 @@ public function getPath() : string /** * {@inheritdoc} */ - public function getMethods() : array + public function getMethods(): array { return $this->methods; } @@ -189,7 +168,7 @@ public function getMethods() : array /** * {@inheritdoc} */ - public function getRequestHandler() : RequestHandlerInterface + public function getRequestHandler(): RequestHandlerInterface { return $this->requestHandler; } @@ -197,7 +176,7 @@ public function getRequestHandler() : RequestHandlerInterface /** * {@inheritdoc} */ - public function getMiddlewares() : array + public function getMiddlewares(): array { return $this->middlewares; } @@ -205,7 +184,7 @@ public function getMiddlewares() : array /** * {@inheritdoc} */ - public function getAttributes() : array + public function getAttributes(): array { return $this->attributes; } @@ -213,7 +192,7 @@ public function getAttributes() : array /** * {@inheritdoc} */ - public function getSummary() : string + public function getSummary(): string { return $this->summary; } @@ -221,7 +200,7 @@ public function getSummary() : string /** * {@inheritdoc} */ - public function getDescription() : string + public function getDescription(): string { return $this->description; } @@ -229,7 +208,7 @@ public function getDescription() : string /** * {@inheritdoc} */ - public function getTags() : array + public function getTags(): array { return $this->tags; } @@ -237,27 +216,19 @@ public function getTags() : array /** * {@inheritdoc} */ - public function getHolder() : Reflector + public function getHolder(): Reflector { - $handler = $this->requestHandler; - if ($handler instanceof CallableRequestHandler) { - $callback = $handler->getCallback(); - if ($callback instanceof Closure) { - return new ReflectionFunction($callback); - } - - /** @var array{0: class-string|object, 1: string} $callback */ - - return new ReflectionMethod(...$callback); + if ($this->requestHandler instanceof CallableRequestHandler) { + return $this->requestHandler->getReflection(); } - return new ReflectionClass($handler); + return new ReflectionClass($this->requestHandler); } /** * {@inheritdoc} */ - public function setName(string $name) : RouteInterface + public function setName(string $name): RouteInterface { $this->name = $name; @@ -267,7 +238,7 @@ public function setName(string $name) : RouteInterface /** * {@inheritdoc} */ - public function setHost(?string $host) : RouteInterface + public function setHost(?string $host): RouteInterface { $this->host = $host; @@ -277,7 +248,7 @@ public function setHost(?string $host) : RouteInterface /** * {@inheritdoc} */ - public function setPath(string $path) : RouteInterface + public function setPath(string $path): RouteInterface { $this->path = $path; @@ -287,21 +258,20 @@ public function setPath(string $path) : RouteInterface /** * {@inheritdoc} */ - public function setMethods(string ...$methods) : RouteInterface + public function setMethods(string ...$methods): RouteInterface { - foreach ($methods as &$method) { - $method = strtoupper($method); + $this->methods = []; + foreach ($methods as $method) { + $this->methods[] = strtoupper($method); } - $this->methods = $methods; - return $this; } /** * {@inheritdoc} */ - public function setRequestHandler(RequestHandlerInterface $requestHandler) : RouteInterface + public function setRequestHandler(RequestHandlerInterface $requestHandler): RouteInterface { $this->requestHandler = $requestHandler; @@ -311,8 +281,10 @@ public function setRequestHandler(RequestHandlerInterface $requestHandler) : Rou /** * {@inheritdoc} */ - public function setMiddlewares(MiddlewareInterface ...$middlewares) : RouteInterface + public function setMiddlewares(MiddlewareInterface ...$middlewares): RouteInterface { + /** @var list $middlewares */ + $this->middlewares = $middlewares; return $this; @@ -321,7 +293,7 @@ public function setMiddlewares(MiddlewareInterface ...$middlewares) : RouteInter /** * {@inheritdoc} */ - public function setAttributes(array $attributes) : RouteInterface + public function setAttributes(array $attributes): RouteInterface { $this->attributes = $attributes; @@ -331,7 +303,7 @@ public function setAttributes(array $attributes) : RouteInterface /** * {@inheritdoc} */ - public function setSummary(string $summary) : RouteInterface + public function setSummary(string $summary): RouteInterface { $this->summary = $summary; @@ -341,7 +313,7 @@ public function setSummary(string $summary) : RouteInterface /** * {@inheritdoc} */ - public function setDescription(string $description) : RouteInterface + public function setDescription(string $description): RouteInterface { $this->description = $description; @@ -351,8 +323,10 @@ public function setDescription(string $description) : RouteInterface /** * {@inheritdoc} */ - public function setTags(string ...$tags) : RouteInterface + public function setTags(string ...$tags): RouteInterface { + /** @var list $tags */ + $this->tags = $tags; return $this; @@ -361,7 +335,7 @@ public function setTags(string ...$tags) : RouteInterface /** * {@inheritdoc} */ - public function addPrefix(string $prefix) : RouteInterface + public function addPrefix(string $prefix): RouteInterface { // https://github.com/sunrise-php/http-router/issues/26 $prefix = rtrim($prefix, '/'); @@ -374,7 +348,7 @@ public function addPrefix(string $prefix) : RouteInterface /** * {@inheritdoc} */ - public function addSuffix(string $suffix) : RouteInterface + public function addSuffix(string $suffix): RouteInterface { $this->path .= $suffix; @@ -384,7 +358,7 @@ public function addSuffix(string $suffix) : RouteInterface /** * {@inheritdoc} */ - public function addMethod(string ...$methods) : RouteInterface + public function addMethod(string ...$methods): RouteInterface { foreach ($methods as $method) { $this->methods[] = strtoupper($method); @@ -396,7 +370,7 @@ public function addMethod(string ...$methods) : RouteInterface /** * {@inheritdoc} */ - public function addMiddleware(MiddlewareInterface ...$middlewares) : RouteInterface + public function addMiddleware(MiddlewareInterface ...$middlewares): RouteInterface { foreach ($middlewares as $middleware) { $this->middlewares[] = $middleware; @@ -408,10 +382,11 @@ public function addMiddleware(MiddlewareInterface ...$middlewares) : RouteInterf /** * {@inheritdoc} */ - public function withAddedAttributes(array $attributes) : RouteInterface + public function withAddedAttributes(array $attributes): RouteInterface { $clone = clone $this; + /** @psalm-suppress MixedAssignment */ foreach ($attributes as $key => $value) { $clone->attributes[$key] = $value; } @@ -422,13 +397,11 @@ public function withAddedAttributes(array $attributes) : RouteInterface /** * {@inheritdoc} */ - public function handle(ServerRequestInterface $request) : ResponseInterface + public function handle(ServerRequestInterface $request): ResponseInterface { $request = $request->withAttribute(self::ATTR_ROUTE, $this); - /** @todo Must be removed from the 3.0.0 version */ - $request = $request->withAttribute(self::ATTR_NAME_FOR_ROUTE_NAME, $this->name); - + /** @psalm-suppress MixedAssignment */ foreach ($this->attributes as $key => $value) { $request = $request->withAttribute($key, $value); } From dc8d3aab01d4ed988109e574c49d782a8fb8fba9 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 21:08:54 +0100 Subject: [PATCH 024/180] Update RouteListCommand.php --- src/Command/RouteListCommand.php | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/Command/RouteListCommand.php b/src/Command/RouteListCommand.php index b6f6a678..259aa205 100644 --- a/src/Command/RouteListCommand.php +++ b/src/Command/RouteListCommand.php @@ -59,15 +59,6 @@ public function __construct(?Router $router = null) $this->router = $router; } - /** - * {@inheritdoc} - */ - protected function configure(): void - { - $this->setName('router:route-list'); - $this->setDescription('Lists all routes in your application'); - } - /** * Gets the router instance populated with routes * @@ -93,6 +84,15 @@ protected function getRouter(): Router return $this->router; } + /** + * {@inheritdoc} + */ + protected function configure(): void + { + $this->setName('router:route-list'); + $this->setDescription('Lists all routes in your application'); + } + /** * {@inheritdoc} */ From 30d3ad69aad63a7e3387f9a3f7eaa1b5086cb98d Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 21:09:29 +0100 Subject: [PATCH 025/180] Removed the getCallback method --- src/Middleware/CallableMiddleware.php | 12 ------------ src/RequestHandler/CallableRequestHandler.php | 12 ------------ 2 files changed, 24 deletions(-) diff --git a/src/Middleware/CallableMiddleware.php b/src/Middleware/CallableMiddleware.php index a7eeccbb..e565ad4d 100644 --- a/src/Middleware/CallableMiddleware.php +++ b/src/Middleware/CallableMiddleware.php @@ -44,18 +44,6 @@ public function __construct(callable $callback) $this->callback = $callback; } - /** - * Gets the middleware callback - * - * @return callable - * - * @since 2.10.0 - */ - public function getCallback(): callable - { - return $this->callback; - } - /** * {@inheritdoc} */ diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index ee03fa83..5ea01241 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -75,18 +75,6 @@ public function __construct(callable $callback, ?ResponseResolverInterface $resp $this->responseResolver = $responseResolver; } - /** - * Gets the handler callback - * - * @return callable - * - * @since 2.10.0 - */ - public function getCallback(): callable - { - return $this->callback; - } - /** * Gets the callback reflection * From 9657812e74daa45f5e2283ac87da1bf46d2f3fc3 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 8 Jan 2023 21:11:35 +0100 Subject: [PATCH 026/180] Update CallableRequestHandler.php --- src/RequestHandler/CallableRequestHandler.php | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index 5ea01241..dadbd247 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -48,8 +48,6 @@ class CallableRequestHandler implements RequestHandlerInterface * * @var list * - * @since 3.0.0 - * * @psalm-immutable */ private array $arguments = []; @@ -58,8 +56,6 @@ class CallableRequestHandler implements RequestHandlerInterface * The response resolver * * @var ResponseResolverInterface|null - * - * @since 3.0.0 */ private ?ResponseResolverInterface $responseResolver; From a8e67b311f945ef7bd0709273d74af4f8dd251ab Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 14 Jan 2023 04:47:08 +0100 Subject: [PATCH 027/180] v3 --- CHANGELOG.md | 7 +- composer.json | 22 +- functions/emit.php | 22 +- functions/path_build.php | 16 +- functions/path_match.php | 4 +- functions/path_parse.php | 37 +-- functions/path_plain.php | 4 +- functions/path_regex.php | 4 +- functions/reflect_callable.php | 68 +++++ src/Exception/BadRequestException.php | 43 --- src/Exception/Exception.php | 51 +--- src/Exception/ExceptionInterface.php | 23 +- src/Exception/Http/HttpException.php | 2 +- .../Http/HttpMethodNotAllowedException.php | 8 +- .../HttpUnsupportedMediaTypeException.php | 8 +- src/Exception/InvalidArgumentException.php | 11 +- .../InvalidAttributeValueException.php | 19 -- .../InvalidLoaderResourceException.php | 6 +- src/Exception/InvalidPayloadException.php | 26 ++ .../InvalidReferenceException.php} | 12 +- src/Exception/LogicException.php | 26 ++ src/Exception/MethodNotAllowedException.php | 42 +-- src/Exception/PageNotFoundException.php | 6 +- src/Exception/RouteNotFoundException.php | 11 +- ...eption.php => RoutePathBuildException.php} | 10 +- ...eption.php => RoutePathParseException.php} | 10 +- ...n.php => RoutePathProcessingException.php} | 10 +- .../UnsupportedMediaTypeException.php | 54 ---- src/Loader/ConfigLoader.php | 27 ++ src/Loader/DescriptorLoader.php | 31 +- src/Middleware/CallableMiddleware.php | 65 +++- .../JsonPayloadDecodingMiddleware.php | 36 +-- .../ParsedBodyMappingMiddleware.php | 154 ---------- src/ParameterResolver.php | 287 ++++++++++++++++++ ...ion.php => ParameterResolverInterface.php} | 12 +- src/ReferenceResolver.php | 7 + src/RequestHandler/CallableRequestHandler.php | 134 ++------ .../QueueableRequestHandler.php | 2 +- src/ResponseResolver.php | 39 +++ src/ResponseResolverInterface.php | 8 +- src/RouteCollection.php | 46 +-- src/RouteCollectionFactory.php | 6 +- src/RouteCollectionFactoryInterface.php | 6 +- src/RouteCollectionInterface.php | 26 +- src/RouteCollector.php | 84 +++-- src/RouteFactory.php | 4 +- src/RouteFactoryInterface.php | 6 +- src/RouteInterface.php | 10 +- src/Router.php | 58 ++-- src/RouterBuilder.php | 25 +- 50 files changed, 893 insertions(+), 742 deletions(-) create mode 100644 functions/reflect_callable.php delete mode 100644 src/Exception/BadRequestException.php delete mode 100644 src/Exception/InvalidAttributeValueException.php create mode 100644 src/Exception/InvalidPayloadException.php rename src/{Annotation/Body.php => Exception/InvalidReferenceException.php} (71%) create mode 100644 src/Exception/LogicException.php rename src/Exception/{UndecodablePayloadException.php => RoutePathBuildException.php} (58%) rename src/Exception/{InvalidPathException.php => RoutePathParseException.php} (58%) rename src/Exception/{UnresolvableReferenceException.php => RoutePathProcessingException.php} (59%) delete mode 100644 src/Exception/UnsupportedMediaTypeException.php delete mode 100644 src/Middleware/ParsedBodyMappingMiddleware.php create mode 100644 src/ParameterResolver.php rename src/{Exception/MissingAttributeValueException.php => ParameterResolverInterface.php} (52%) create mode 100644 src/ResponseResolver.php diff --git a/CHANGELOG.md b/CHANGELOG.md index a4cc563b..c35e1984 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,9 @@ -# v2.16.0 +# v3.0.0 + +* Minimal PHP version **7.4**; +* ... + +## v2.16.0 * New method: `Router::hasRoute(string):bool`. diff --git a/composer.json b/composer.json index 304c6856..36e331d7 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,7 @@ { "name": "sunrise/http-router", "homepage": "https://github.com/sunrise-php/http-router", - "description": "HTTP router for PHP 7.1+ based on PSR-7 and PSR-15 with support for annotations/attributes and OpenAPI (Swagger) Specification", + "description": "HTTP router for PHP 7.4+ based on PSR-7 and PSR-15 with support for annotations/attributes and OpenAPI (Swagger) Specification", "license": "MIT", "keywords": [ "fenric", @@ -21,26 +21,27 @@ ], "authors": [ { - "name": "Anatoly Fenric", + "name": "Anatoly Nekhay", "email": "afenric@gmail.com", "homepage": "https://github.com/fenric" } ], "require": { - "php": "^7.1|^8.0", + "php": ">=7.4", "fig/http-message-util": "^1.1", - "psr/container": "^1.0", + "psr/container": "^1.0 || ^2.0", "psr/http-message": "^1.0", "psr/http-server-handler": "^1.0", "psr/http-server-middleware": "^1.0", - "psr/simple-cache": "^1.0" + "psr/simple-cache": "^1.0", + "sunrise/hydrator": "^2.7" }, "require-dev": { - "phpunit/phpunit": "7.5.20|9.5.0", - "sunrise/coding-standard": "1.0.0", - "sunrise/http-factory": "2.0.0", + "phpunit/phpunit": "~9.5.0", + "sunrise/coding-standard": "~1.0.0", + "sunrise/http-message": "^3.0", "doctrine/annotations": "^1.6", - "symfony/console": "^4.4", + "symfony/console": "^5.4", "symfony/event-dispatcher": "^4.4" }, "autoload": { @@ -50,7 +51,8 @@ "functions/path_match.php", "functions/path_parse.php", "functions/path_plain.php", - "functions/path_regex.php" + "functions/path_regex.php", + "functions/reflect_callable.php" ], "psr-4": { "Sunrise\\Http\\Router\\": "src/" diff --git a/functions/emit.php b/functions/emit.php index 39466230..38251649 100644 --- a/functions/emit.php +++ b/functions/emit.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -25,14 +25,19 @@ /** * Sends the given response * - * Don't use the function in your production environment, it's only for tests! - * * @param ResponseInterface $response * * @return void */ -function emit(ResponseInterface $response) : void +function emit(ResponseInterface $response): void { + header(sprintf( + 'HTTP/%s %d %s', + $response->getProtocolVersion(), + $response->getStatusCode(), + $response->getReasonPhrase() + ), true); + foreach ($response->getHeaders() as $name => $values) { foreach ($values as $value) { header(sprintf( @@ -43,12 +48,5 @@ function emit(ResponseInterface $response) : void } } - header(sprintf( - 'HTTP/%s %d %s', - $response->getProtocolVersion(), - $response->getStatusCode(), - $response->getReasonPhrase() - ), true); - echo $response->getBody(); } diff --git a/functions/path_build.php b/functions/path_build.php index d7557b9a..4ebff507 100644 --- a/functions/path_build.php +++ b/functions/path_build.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -14,8 +14,7 @@ /** * Import classes */ -use Sunrise\Http\Router\Exception\InvalidAttributeValueException; -use Sunrise\Http\Router\Exception\MissingAttributeValueException; +use Sunrise\Http\Router\Exception\RoutePathBuildException; /** * Import functions @@ -27,7 +26,7 @@ /** * Builds the given path using the given attributes * - * If strict mode is enabled, each attribute value will be validated. + * If strict mode is enabled then each attribute value will be validated. * * @param string $path * @param array $attributes @@ -35,8 +34,7 @@ * * @return string * - * @throws InvalidAttributeValueException - * @throws MissingAttributeValueException + * @throws RoutePathBuildException */ function path_build(string $path, array $attributes = [], bool $strict = false) : string { @@ -49,7 +47,7 @@ function path_build(string $path, array $attributes = [], bool $strict = false) if (!$match['isOptional']) { $errmsg = '[%s] build error: no value given for the attribute "%s".'; - throw new MissingAttributeValueException(sprintf($errmsg, $path, $match['name']), [ + throw new RoutePathBuildException(sprintf($errmsg, $path, $match['name']), [ 'path' => $path, 'match' => $match, ]); @@ -67,7 +65,7 @@ function path_build(string $path, array $attributes = [], bool $strict = false) if (!preg_match('#^' . $match['pattern'] . '$#u', $replacement)) { $errmsg = '[%s] build error: the given value for the attribute "%s" does not match its pattern.'; - throw new InvalidAttributeValueException(sprintf($errmsg, $path, $match['name']), [ + throw new RoutePathBuildException(sprintf($errmsg, $path, $match['name']), [ 'path' => $path, 'value' => $replacement, 'match' => $match, diff --git a/functions/path_match.php b/functions/path_match.php index 2142c96c..715413c0 100644 --- a/functions/path_match.php +++ b/functions/path_match.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ diff --git a/functions/path_parse.php b/functions/path_parse.php index b95be62b..4e00b732 100644 --- a/functions/path_parse.php +++ b/functions/path_parse.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -14,7 +14,7 @@ /** * Import classes */ -use Sunrise\Http\Router\Exception\InvalidPathException; +use Sunrise\Http\Router\Exception\RoutePathParseException; /** * Import functions @@ -59,7 +59,8 @@ * * @return array * - * @throws InvalidPathException If the given path syntax isn't valid. + * @throws RoutePathParseException + * If the given path syntax isn't valid. */ function path_parse(string $path) : array { @@ -104,7 +105,7 @@ function path_parse(string $path) : array if ('(' === $char && !$cursorInAttribute) { if ($cursorInParentheses) { - throw new InvalidPathException( + throw new RoutePathParseException( sprintf('[%s:%d] parentheses inside parentheses are not allowed.', $path, $cursorPosition) ); } @@ -116,13 +117,13 @@ function path_parse(string $path) : array if ('{' === $char && !$cursorInPattern) { if ($cursorInAttribute) { - throw new InvalidPathException( + throw new RoutePathParseException( sprintf('[%s:%d] braces inside attributes are not allowed.', $path, $cursorPosition) ); } if ($parenthesesBusy) { - throw new InvalidPathException( + throw new RoutePathParseException( sprintf('[%s:%d] multiple attributes inside parentheses are not allowed.', $path, $cursorPosition) ); } @@ -145,7 +146,7 @@ function path_parse(string $path) : array if ('<' === $char && $cursorInAttribute) { if ($cursorInPattern) { - throw new InvalidPathException( + throw new RoutePathParseException( sprintf('[%s:%d] the char "<" inside patterns is not allowed.', $path, $cursorPosition) ); } @@ -160,13 +161,13 @@ function path_parse(string $path) : array if ('>' === $char && $cursorInAttribute) { if (!$cursorInPattern) { - throw new InvalidPathException( + throw new RoutePathParseException( sprintf('[%s:%d] at position %2$d an extra char ">" was found.', $path, $cursorPosition) ); } if (null === $attributes[$attributeIndex]['pattern']) { - throw new InvalidPathException( + throw new RoutePathParseException( sprintf('[%s:%d] an attribute pattern is empty.', $path, $cursorPosition) ); } @@ -184,13 +185,13 @@ function path_parse(string $path) : array if ('}' === $char && !$cursorInPattern) { if (!$cursorInAttribute) { - throw new InvalidPathException( + throw new RoutePathParseException( sprintf('[%s:%d] at position %2$d an extra closing brace was found.', $path, $cursorPosition) ); } if (null === $attributes[$attributeIndex]['name']) { - throw new InvalidPathException( + throw new RoutePathParseException( sprintf('[%s:%d] an attribute name is empty.', $path, $cursorPosition) ); } @@ -206,7 +207,7 @@ function path_parse(string $path) : array if (')' === $char && !$cursorInAttribute) { if (!$cursorInParentheses) { - throw new InvalidPathException( + throw new RoutePathParseException( sprintf('[%s:%d] at position %2$d an extra closing parenthesis was found.', $path, $cursorPosition) ); } @@ -240,7 +241,7 @@ function path_parse(string $path) : array if ($cursorInAttributeName) { if (null === $attributes[$attributeIndex]['name']) { if (!isset(CHARACTER_TABLE_FOR_FIRST_CHARACTER_OF_SUBPATTERN_NAME[$char])) { - throw new InvalidPathException( + throw new RoutePathParseException( sprintf('[%s:%d] an attribute name must begin with "A-Za-z_".', $path, $cursorPosition) ); } @@ -248,7 +249,7 @@ function path_parse(string $path) : array if (null !== $attributes[$attributeIndex]['name']) { if (!isset(CHARACTER_TABLE_FOR_SUBPATTERN_NAME[$char])) { - throw new InvalidPathException( + throw new RoutePathParseException( sprintf('[%s:%d] an attribute name must contain only "0-9A-Za-z_".', $path, $cursorPosition) ); } @@ -259,7 +260,7 @@ function path_parse(string $path) : array if ($cursorInPattern) { if ('#' === $char) { - throw new InvalidPathException( + throw new RoutePathParseException( sprintf('[%s:%d] unallowed character "#" in an attribute pattern.', $path, $cursorPosition) ); } @@ -269,13 +270,13 @@ function path_parse(string $path) : array } if ($cursorInParentheses) { - throw new InvalidPathException( + throw new RoutePathParseException( sprintf('[%s] the route path contains non-closed parentheses.', $path) ); } if ($cursorInAttribute) { - throw new InvalidPathException( + throw new RoutePathParseException( sprintf('[%s] the route path contains non-closed attribute.', $path) ); } diff --git a/functions/path_plain.php b/functions/path_plain.php index d8638eec..a07e856b 100644 --- a/functions/path_plain.php +++ b/functions/path_plain.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ diff --git a/functions/path_regex.php b/functions/path_regex.php index 40162180..5f28274a 100644 --- a/functions/path_regex.php +++ b/functions/path_regex.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ diff --git a/functions/reflect_callable.php b/functions/reflect_callable.php new file mode 100644 index 00000000..d756bdd9 --- /dev/null +++ b/functions/reflect_callable.php @@ -0,0 +1,68 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router; + +/** + * Import classes + */ +use Closure; +use InvalidArgumentException; +use ReflectionFunctionAbstract; +use ReflectionFunction; +use ReflectionMethod; + +/** + * Import functions + */ +use function function_exists; +use function is_array; +use function is_object; +use function is_string; +use function method_exists; +use function strpos; + +/** + * Tries to reflect the given callback + * + * @param callable $callback + * + * @return ReflectionFunction|ReflectionMethod + * + * @throws InvalidArgumentException + * If the given callback cannot be reflected. + * + * @since 3.0.0 + */ +function reflect_callable(callable $callback): ReflectionFunctionAbstract +{ + if ($callback instanceof Closure) { + return new ReflectionFunction($callback); + } + + if (is_array($callback)) { + return new ReflectionMethod(...$callback); + } + + if (is_object($callback) && method_exists($callback, '__invoke')) { + return new ReflectionMethod($callback, '__invoke'); + } + + if (is_string($callback) && strpos($callback, '::')) { + return new ReflectionMethod($callback); + } + + if (is_string($callback) && function_exists($callback)) { + return new ReflectionFunction($callback); + } + + throw new InvalidArgumentException('Unsupported callback notation'); +} diff --git a/src/Exception/BadRequestException.php b/src/Exception/BadRequestException.php deleted file mode 100644 index 3cad99ee..00000000 --- a/src/Exception/BadRequestException.php +++ /dev/null @@ -1,43 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Fenric - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Exception; - -/** - * BadRequestException - */ -class BadRequestException extends Exception -{ - - /** - * Gets errors - * - * @return mixed - * - * @since 2.9.0 - */ - public function getErrors() - { - return $this->fromContext('errors', []); - } - - /** - * Gets violations - * - * @return mixed - * - * @deprecated 2.9.0 Use the getErrors method. - */ - public function getViolations() - { - return $this->fromContext('violations', []); - } -} diff --git a/src/Exception/Exception.php b/src/Exception/Exception.php index d773c958..d414fe46 100644 --- a/src/Exception/Exception.php +++ b/src/Exception/Exception.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -14,52 +14,11 @@ /** * Import classes */ -use RuntimeException; -use Throwable; +use Exception as BaseException; /** - * Exception + * The package base exception */ -class Exception extends RuntimeException implements ExceptionInterface +class Exception extends BaseException implements ExceptionInterface { - - /** - * Context of the exception - * - * @var array - */ - private $context = []; - - /** - * Constructor of the exception - * - * @param string $message - * @param array $context - * @param int $code - * @param Throwable|null $previous - * - * @link https://www.php.net/manual/en/exception.construct.php - */ - public function __construct(string $message = '', array $context = [], int $code = 0, ?Throwable $previous = null) - { - $this->context = $context; - - parent::__construct($message, $code, $previous); - } - - /** - * {@inheritdoc} - */ - final public function getContext() : array - { - return $this->context; - } - - /** - * {@inheritdoc} - */ - final public function fromContext($key, $default = null) - { - return $this->context[$key] ?? $default; - } } diff --git a/src/Exception/ExceptionInterface.php b/src/Exception/ExceptionInterface.php index b0f0940c..ec36257a 100644 --- a/src/Exception/ExceptionInterface.php +++ b/src/Exception/ExceptionInterface.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -17,25 +17,8 @@ use Throwable; /** - * ExceptionInterface + * The package base exception interface */ interface ExceptionInterface extends Throwable { - - /** - * Gets the exception context - * - * @return array - */ - public function getContext() : array; - - /** - * Gets a value from the exception context by the given key - * - * @param mixed $key - * @param mixed $default - * - * @return mixed - */ - public function fromContext($key, $default); } diff --git a/src/Exception/Http/HttpException.php b/src/Exception/Http/HttpException.php index 4987e8dd..401fea9b 100644 --- a/src/Exception/Http/HttpException.php +++ b/src/Exception/Http/HttpException.php @@ -30,7 +30,7 @@ class HttpException extends Exception implements HttpExceptionInterface * * @var int */ - private int $statusCode; + private $statusCode; /** * Constructor of the class diff --git a/src/Exception/Http/HttpMethodNotAllowedException.php b/src/Exception/Http/HttpMethodNotAllowedException.php index b70663cc..5c61c488 100644 --- a/src/Exception/Http/HttpMethodNotAllowedException.php +++ b/src/Exception/Http/HttpMethodNotAllowedException.php @@ -46,13 +46,13 @@ class HttpMethodNotAllowedException extends HttpException * * @var list */ - private array $allowedMethods; + private array $allowedMethods = []; /** * Constructor of the class * * @param string $unallowedMethod - * @param list $allowedMethods + * @param string[] $allowedMethods * @param ?string $message * @param int $code * @param ?Throwable $previous @@ -69,7 +69,9 @@ public function __construct( parent::__construct(self::STATUS_METHOD_NOT_ALLOWED, $message, $code, $previous); $this->unallowedMethod = $unallowedMethod; - $this->allowedMethods = $allowedMethods; + foreach ($allowedMethods as $allowedMethod) { + $this->allowedMethods[] = $allowedMethod; + } } /** diff --git a/src/Exception/Http/HttpUnsupportedMediaTypeException.php b/src/Exception/Http/HttpUnsupportedMediaTypeException.php index 6c31d2ff..090887b7 100644 --- a/src/Exception/Http/HttpUnsupportedMediaTypeException.php +++ b/src/Exception/Http/HttpUnsupportedMediaTypeException.php @@ -45,13 +45,13 @@ class HttpUnsupportedMediaTypeException extends HttpException * * @var list */ - private array $supportedMediaTypes; + private array $supportedMediaTypes = []; /** * Constructor of the class * * @param string $unsupportedMediaType - * @param list $supportedMediaTypes + * @param string[] $supportedMediaTypes * @param ?string $message * @param int $code * @param ?Throwable $previous @@ -68,7 +68,9 @@ public function __construct( parent::__construct(self::STATUS_UNSUPPORTED_MEDIA_TYPE, $message, $code, $previous); $this->unsupportedMediaType = $unsupportedMediaType; - $this->supportedMediaTypes = $supportedMediaTypes; + foreach ($supportedMediaTypes as $supportedMediaType) { + $this->supportedMediaTypes[] = $supportedMediaType; + } } /** diff --git a/src/Exception/InvalidArgumentException.php b/src/Exception/InvalidArgumentException.php index 7319ec42..1ef49b94 100644 --- a/src/Exception/InvalidArgumentException.php +++ b/src/Exception/InvalidArgumentException.php @@ -3,19 +3,24 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ namespace Sunrise\Http\Router\Exception; +/** + * Import classes + */ +use InvalidArgumentException as BaseInvalidArgumentException; + /** * InvalidArgumentException * * @since 2.9.0 */ -class InvalidArgumentException extends Exception +class InvalidArgumentException extends BaseInvalidArgumentException implements ExceptionInterface { } diff --git a/src/Exception/InvalidAttributeValueException.php b/src/Exception/InvalidAttributeValueException.php deleted file mode 100644 index aa16e284..00000000 --- a/src/Exception/InvalidAttributeValueException.php +++ /dev/null @@ -1,19 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Fenric - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Exception; - -/** - * InvalidAttributeValueException - */ -class InvalidAttributeValueException extends Exception -{ -} diff --git a/src/Exception/InvalidLoaderResourceException.php b/src/Exception/InvalidLoaderResourceException.php index 883a8112..42301f93 100644 --- a/src/Exception/InvalidLoaderResourceException.php +++ b/src/Exception/InvalidLoaderResourceException.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -14,6 +14,6 @@ /** * InvalidLoaderResourceException */ -class InvalidLoaderResourceException extends Exception +class InvalidLoaderResourceException extends InvalidArgumentException { } diff --git a/src/Exception/InvalidPayloadException.php b/src/Exception/InvalidPayloadException.php new file mode 100644 index 00000000..b10d32de --- /dev/null +++ b/src/Exception/InvalidPayloadException.php @@ -0,0 +1,26 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; + +/** + * InvalidPayloadException + * + * @since 3.0.0 + */ +class InvalidPayloadException extends HttpBadRequestException +{ +} diff --git a/src/Annotation/Body.php b/src/Exception/InvalidReferenceException.php similarity index 71% rename from src/Annotation/Body.php rename to src/Exception/InvalidReferenceException.php index ad90075c..a099da3d 100644 --- a/src/Annotation/Body.php +++ b/src/Exception/InvalidReferenceException.php @@ -9,17 +9,13 @@ * @link https://github.com/sunrise-php/http-router */ -namespace Sunrise\Http\Router\Annotation; - -/** - * Import classes - */ -use Attribute; +namespace Sunrise\Http\Router\Exception; /** + * InvalidReferenceException + * * @since 3.0.0 */ -#[Attribute(Attribute::TARGET_PARAMETER)] -final class Body +class InvalidReferenceException extends LogicException { } diff --git a/src/Exception/LogicException.php b/src/Exception/LogicException.php new file mode 100644 index 00000000..17c8238b --- /dev/null +++ b/src/Exception/LogicException.php @@ -0,0 +1,26 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * Import classes + */ +use LogicException as BaseLogicException; + +/** + * LogicException + * + * @since 3.0.0 + */ +class LogicException extends BaseLogicException implements ExceptionInterface +{ +} diff --git a/src/Exception/MethodNotAllowedException.php b/src/Exception/MethodNotAllowedException.php index 60101ad8..b2edb2f4 100644 --- a/src/Exception/MethodNotAllowedException.php +++ b/src/Exception/MethodNotAllowedException.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -12,45 +12,13 @@ namespace Sunrise\Http\Router\Exception; /** - * Import functions + * Import classes */ -use function implode; +use Sunrise\Http\Router\Exception\Http\HttpMethodNotAllowedException; /** * MethodNotAllowedException */ -class MethodNotAllowedException extends Exception +class MethodNotAllowedException extends HttpMethodNotAllowedException { - - /** - * Gets a method - * - * @return string - * - * @since 2.9.0 - */ - public function getMethod() : string - { - return $this->fromContext('method', ''); - } - - /** - * Gets allowed methods - * - * @return string[] - */ - public function getAllowedMethods() : array - { - return $this->fromContext('allowed', []); - } - - /** - * Gets joined allowed methods - * - * @return string - */ - public function getJoinedAllowedMethods() : string - { - return implode(',', $this->getAllowedMethods()); - } } diff --git a/src/Exception/PageNotFoundException.php b/src/Exception/PageNotFoundException.php index 1a26d248..461cc136 100644 --- a/src/Exception/PageNotFoundException.php +++ b/src/Exception/PageNotFoundException.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -13,8 +13,6 @@ /** * PageNotFoundException - * - * @since 2.4.2 */ class PageNotFoundException extends RouteNotFoundException { diff --git a/src/Exception/RouteNotFoundException.php b/src/Exception/RouteNotFoundException.php index 8877a240..4e78d5d8 100644 --- a/src/Exception/RouteNotFoundException.php +++ b/src/Exception/RouteNotFoundException.php @@ -3,17 +3,22 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ namespace Sunrise\Http\Router\Exception; +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; + /** * RouteNotFoundException */ -class RouteNotFoundException extends Exception +class RouteNotFoundException extends HttpNotFoundException { } diff --git a/src/Exception/UndecodablePayloadException.php b/src/Exception/RoutePathBuildException.php similarity index 58% rename from src/Exception/UndecodablePayloadException.php rename to src/Exception/RoutePathBuildException.php index 2a440230..45e4da74 100644 --- a/src/Exception/UndecodablePayloadException.php +++ b/src/Exception/RoutePathBuildException.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -12,10 +12,10 @@ namespace Sunrise\Http\Router\Exception; /** - * UndecodablePayloadException + * RoutePathBuildException * - * @since 2.15.0 + * @since 3.0.0 */ -class UndecodablePayloadException extends BadRequestException +class RoutePathBuildException extends RoutePathProcessingException { } diff --git a/src/Exception/InvalidPathException.php b/src/Exception/RoutePathParseException.php similarity index 58% rename from src/Exception/InvalidPathException.php rename to src/Exception/RoutePathParseException.php index ad788e8f..158f92f9 100644 --- a/src/Exception/InvalidPathException.php +++ b/src/Exception/RoutePathParseException.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -12,8 +12,10 @@ namespace Sunrise\Http\Router\Exception; /** - * InvalidPathException + * RoutePathParseException + * + * @since 3.0.0 */ -class InvalidPathException extends Exception +class RoutePathParseException extends RoutePathProcessingException { } diff --git a/src/Exception/UnresolvableReferenceException.php b/src/Exception/RoutePathProcessingException.php similarity index 59% rename from src/Exception/UnresolvableReferenceException.php rename to src/Exception/RoutePathProcessingException.php index a3b78143..8e4022e0 100644 --- a/src/Exception/UnresolvableReferenceException.php +++ b/src/Exception/RoutePathProcessingException.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -12,10 +12,10 @@ namespace Sunrise\Http\Router\Exception; /** - * UnresolvableReferenceException + * RoutePathProcessingException * - * @since 2.10.0 + * @since 3.0.0 */ -class UnresolvableReferenceException extends Exception +class RoutePathProcessingException extends Exception { } diff --git a/src/Exception/UnsupportedMediaTypeException.php b/src/Exception/UnsupportedMediaTypeException.php deleted file mode 100644 index 2f4c795b..00000000 --- a/src/Exception/UnsupportedMediaTypeException.php +++ /dev/null @@ -1,54 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Fenric - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Exception; - -/** - * Import functions - */ -use function implode; - -/** - * UnsupportedMediaTypeException - */ -class UnsupportedMediaTypeException extends Exception -{ - - /** - * Gets a type - * - * @return string - */ - public function getType() : string - { - return $this->fromContext('type', ''); - } - - /** - * Gets supported types - * - * @return string[] - */ - public function getSupportedTypes() : array - { - return $this->fromContext('supported', []); - } - - /** - * Gets joined supported types - * - * @return string - */ - public function getJoinedSupportedTypes() : string - { - return implode(',', $this->getSupportedTypes()); - } -} diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index 96cdc357..9d0bca76 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -16,6 +16,7 @@ */ use Psr\Container\ContainerInterface; use Sunrise\Http\Router\Exception\InvalidLoaderResourceException; +use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; use Sunrise\Http\Router\ResponseResolverInterface; @@ -103,6 +104,32 @@ public function setContainer(?ContainerInterface $container): void $this->referenceResolver->setContainer($container); } + /** + * Gets the loader parameter resolver + * + * @return ParameterResolverInterface|null + * + * @since 3.0.0 + */ + public function getParameterResolver(): ?ParameterResolverInterface + { + return $this->referenceResolver->getParameterResolver(); + } + + /** + * Sets the given parameter resolver to the loader + * + * @param ParameterResolverInterface|null $parameterResolver + * + * @return void + * + * @since 3.0.0 + */ + public function setParameterResolver(?ParameterResolverInterface $parameterResolver): void + { + $this->referenceResolver->setParameterResolver($parameterResolver); + } + /** * Gets the loader response resolver * diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index a8237386..f8517755 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -27,6 +27,7 @@ use Sunrise\Http\Router\Annotation\Route; use Sunrise\Http\Router\Exception\InvalidLoaderResourceException; use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; use Sunrise\Http\Router\ResponseResolverInterface; @@ -117,7 +118,7 @@ public function __construct( $this->routeFactory = $routeFactory ?? new RouteFactory(); $this->referenceResolver = $referenceResolver ?? new ReferenceResolver(); - if (8 > PHP_MAJOR_VERSION) { + if (PHP_MAJOR_VERSION < 8) { $this->useDefaultAnnotationReader(); } } @@ -144,6 +145,32 @@ public function setContainer(?ContainerInterface $container): void $this->referenceResolver->setContainer($container); } + /** + * Gets the loader parameter resolver + * + * @return ParameterResolverInterface|null + * + * @since 3.0.0 + */ + public function getParameterResolver(): ?ParameterResolverInterface + { + return $this->referenceResolver->getParameterResolver(); + } + + /** + * Sets the given parameter resolver to the loader + * + * @param ParameterResolverInterface|null $parameterResolver + * + * @return void + * + * @since 3.0.0 + */ + public function setParameterResolver(?ParameterResolverInterface $parameterResolver): void + { + $this->referenceResolver->setParameterResolver($parameterResolver); + } + /** * Gets the loader response resolver * @@ -495,7 +522,7 @@ private function getAnnotations(Reflector $reflector, string $annotationName): a { $result = []; - if (8 === PHP_MAJOR_VERSION) { + if (PHP_MAJOR_VERSION === 8) { /** @var ReflectionAttribute[] */ $attributes = $reflector->getAttributes($annotationName); foreach ($attributes as $attribute) { diff --git a/src/Middleware/CallableMiddleware.php b/src/Middleware/CallableMiddleware.php index e565ad4d..49cd99ff 100644 --- a/src/Middleware/CallableMiddleware.php +++ b/src/Middleware/CallableMiddleware.php @@ -18,13 +18,23 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\ParameterResolverInterface; +use Sunrise\Http\Router\ResponseResolverInterface; +use ReflectionFunctionAbstract; +use ReflectionFunction; +use ReflectionMethod; + +/** + * Import functions + */ +use function Sunrise\Http\Router\reflect_callable; /** * CallableMiddleware * * @since 2.8.0 */ -class CallableMiddleware implements MiddlewareInterface +final class CallableMiddleware implements MiddlewareInterface { /** @@ -34,14 +44,54 @@ class CallableMiddleware implements MiddlewareInterface */ private $callback; + /** + * The callback's parameter resolver + * + * @var ParameterResolverInterface + */ + private ParameterResolverInterface $parameterResolver; + + /** + * The callback's response resolver + * + * @var ResponseResolverInterface + */ + private ResponseResolverInterface $responseResolver; + + /** + * The callback's reflection + * + * @var ReflectionFunction|ReflectionMethod + */ + private ?ReflectionFunctionAbstract $reflection = null; + /** * Constructor of the class * * @param callable $callback + * @param ParameterResolverInterface $parameterResolver + * @param ResponseResolverInterface $responseResolver */ - public function __construct(callable $callback) - { + public function __construct( + callable $callback, + ParameterResolverInterface $parameterResolver, + ResponseResolverInterface $responseResolver + ) { $this->callback = $callback; + $this->parameterResolver = $parameterResolver; + $this->responseResolver = $responseResolver; + } + + /** + * Gets the callback's reflection + * + * @return ReflectionFunction|ReflectionMethod + * + * @since 3.0.0 + */ + public function getReflection(): ReflectionFunctionAbstract + { + return $this->reflection ??= reflect_callable($this->callback); } /** @@ -49,9 +99,12 @@ public function __construct(callable $callback) */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - /** @var ResponseInterface */ - $response = ($this->callback)($request, $handler); + $arguments = $this->parameterResolver + ->withNames($request->getAttributes()) + ->withType(ServerRequestInterface::class, $request) + ->withType(RequestHandlerInterface::class, $handler) + ->resolveParameters(...$this->getReflection()->getParameters()); - return $response; + return $this->responseResolver->resolveResponse(($this->callback)(...$arguments)); } } diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index ddf5d6ce..2c1431f2 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -55,26 +55,19 @@ class JsonPayloadDecodingMiddleware implements MiddlewareInterface */ private const JSON_MEDIA_TYPE = 'application/json'; - /** - * JSON maximal depth - * - * @var int - */ - protected const JSON_MAXIMAL_DEPTH = 512; - /** * JSON decoding options * * @var int * - * @link https://www.php.net/manual/ru/json.constants.php + * @link https://www.php.net/json.constants */ protected const JSON_DECODING_OPTIONS = JSON_BIGINT_AS_STRING | JSON_OBJECT_AS_ARRAY; /** * {@inheritdoc} */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + final public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { if ($this->isSupportedRequest($request)) { $data = $this->decodeRequestJsonPayload($request); @@ -93,11 +86,13 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface */ private function isSupportedRequest(ServerRequestInterface $request): bool { - return self::JSON_MEDIA_TYPE === $this->getRequestMediaType($request); + return $this->getRequestMediaType($request) === self::JSON_MEDIA_TYPE; } /** - * Gets media type from the given request + * Gets a media type from the given request + * + * Returns null if a media type cannot be retrieved. * * @param ServerRequestInterface $request * @@ -114,12 +109,12 @@ private function getRequestMediaType(ServerRequestInterface $request): ?string // type "/" subtype *( OWS ";" OWS parameter ) $mediaType = $request->getHeaderLine('Content-Type'); - $semicolonPosition = strpos($mediaType, ';'); - if (false === $semicolonPosition) { + $semicolon = strpos($mediaType, ';'); + if (false === $semicolon) { return $mediaType; } - return rtrim(substr($mediaType, 0, $semicolonPosition)); + return rtrim(substr($mediaType, 0, $semicolon)); } /** @@ -130,27 +125,20 @@ private function getRequestMediaType(ServerRequestInterface $request): ?string * @return array|object|null * * @throws InvalidPayloadException - * If the request's payload cannot be decoded. + * If the request's JSON payload cannot be decoded. */ private function decodeRequestJsonPayload(ServerRequestInterface $request) { - /** @var int */ - $depth = static::JSON_MAXIMAL_DEPTH; - /** @var int */ $flags = static::JSON_DECODING_OPTIONS; try { /** @var mixed */ - $result = json_decode($request->getBody()->__toString(), null, $depth, $flags | JSON_THROW_ON_ERROR); + $result = json_decode($request->getBody()->__toString(), null, 512, $flags | JSON_THROW_ON_ERROR); } catch (JsonException $e) { throw new InvalidPayloadException(sprintf('Invalid Payload: %s', $e->getMessage()), 0, $e); } - if (is_array($result) || is_object($result)) { - return $result; - } - - return null; + return (is_array($result) || is_object($result)) ? $result : null; } } diff --git a/src/Middleware/ParsedBodyMappingMiddleware.php b/src/Middleware/ParsedBodyMappingMiddleware.php deleted file mode 100644 index f7f25804..00000000 --- a/src/Middleware/ParsedBodyMappingMiddleware.php +++ /dev/null @@ -1,154 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Middleware; - -/** - * Import classes - */ -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Annotation\Body; -use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; -use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; -use Sunrise\Http\Router\RouteInterface; -use Sunrise\Hydrator\Exception\InvalidValueException; -use Sunrise\Hydrator\Exception\InvalidObjectException; -use Sunrise\Hydrator\HydratorInterface; -use Sunrise\Hydrator\Hydrator; -use ReflectionNamedType; - -/** - * Import functions - */ -use function class_exists; -use function sprintf; - -/** - * Import constants - */ -use const PHP_MAJOR_VERSION; - -/** - * ParsedBodyMappingMiddleware - * - * @link https://github.com/sunrise-php/hydrator - * - * @since 3.0.0 - */ -class ParsedBodyMappingMiddleware implements MiddlewareInterface -{ - - /** - * Objects hydrator - * - * @var HydratorInterface - */ - private HydratorInterface $objectHydrator; - - /** - * Constructor of the class - * - * @param HydratorInterface|null $objectHydrator - * - * @throws LogicException - * If the PHP version less than 8. - */ - public function __construct(?HydratorInterface $objectHydrator = null) - { - if (PHP_MAJOR_VERSION < 8) { - throw new LogicException('Parsed body mapping requires PHP version 8'); - } - - $this->objectHydrator = $objectHydrator ?? new Hydrator(); - } - - /** - * {@inheritdoc} - * - * @throws LogicException - * If something went wrong... - * - * @throws HttpUnprocessableEntityException - * If the request body isn't valid. - */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface - { - $route = $request->getAttribute(RouteInterface::ATTR_ROUTE); - if (!($route instanceof RouteInterface)) { - throw new LogicException(sprintf( - 'The "%s" middleware must be related with a route', - __CLASS__ - )); - } - - $routeRequestHandler = $route->getRequestHandler(); - if (!($routeRequestHandler instanceof CallableRequestHandler)) { - throw new LogicException(sprintf( - 'The "%s" route cannot be related with the "%s" middleware', - $route->getName(), - __CLASS__ - )); - } - - $routeRequestHandlerProcessableParameter = $routeRequestHandler->getAttributedParameter(Body::class); - if (!isset($routeRequestHandlerProcessableParameter)) { - return $handler->handle($request); - } - - $routeRequestHandlerProcessableParameterType = $routeRequestHandlerProcessableParameter->getType(); - if (!($routeRequestHandlerProcessableParameterType instanceof ReflectionNamedType)) { - throw new LogicException(sprintf( - 'The "%s" parameter of the "%s" route request handler cannot be hydrated ' . - 'because its type is not supported, do not use union or intersection types', - $routeRequestHandlerProcessableParameter->getName(), - $route->getName() - )); - } - - $routeRequestHandlerProcessableParameterClassName = $routeRequestHandlerProcessableParameterType->getName(); - if (!class_exists($routeRequestHandlerProcessableParameterClassName)) { - throw new LogicException(sprintf( - 'The "%s" parameter of the "%s" route request handler cannot be hydrated ' . - 'because its refers to the "%s" class that cannot be found', - $routeRequestHandlerProcessableParameter->getName(), - $route->getName(), - $routeRequestHandlerProcessableParameterType->getName() - )); - } - - try { - $hydratedObject = $this->objectHydrator->hydrate( - $routeRequestHandlerProcessableParameterClassName, - (array) $request->getParsedBody() - ); - } catch (InvalidObjectException $e) { - throw new LogicException(sprintf( - 'The "%s" parameter of the "%s" route request handler cannot be hydrated ' . - 'because its refers to an invalid DTO: %s', - $routeRequestHandlerProcessableParameter->getName(), - $route->getName(), - $e->getMessage() - ), 0, $e); - } catch (InvalidValueException $e) { - throw new HttpUnprocessableEntityException($e->getMessage(), 0, $e); - } - - $routeRequestHandlerArguments = $routeRequestHandler->getArguments(); - $routeRequestHandlerArguments[$routeRequestHandlerProcessableParameter->getPosition()] = $hydratedObject; - $route->setRequestHandler($routeRequestHandler->withArguments($routeRequestHandlerArguments)); - - return $handler->handle($request); - } -} diff --git a/src/ParameterResolver.php b/src/ParameterResolver.php new file mode 100644 index 00000000..6f5c1771 --- /dev/null +++ b/src/ParameterResolver.php @@ -0,0 +1,287 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router; + +/** + * Import classes + */ +use Psr\Container\ContainerInterface; +use ReflectionNamedType; +use ReflectionParameter; + +/** + * ParameterResolver + * + * @since 3.0.0 + */ +final class ParameterResolver implements ParameterResolverInterface +{ + + /** + * Known parameter names + * + * @var array + */ + private array $names = []; + + /** + * Known types + * + * @var array + */ + private array $types = []; + + /** + * The resolver's container + * + * @var ContainerInterface|null + */ + private ?ContainerInterface $container = null; + + /** + * {@inheritdoc} + */ + public function getNames(): array + { + return $this->names; + } + + /** + * {@inheritdoc} + */ + public function getTypes(): array + { + return $this->types; + } + + /** + * {@inheritdoc} + */ + public function getContainer(): ?ContainerInterface + { + return $this->container; + } + + /** + * {@inheritdoc} + */ + public function setContainer(?ContainerInterface $container): void + { + $this->container = $container; + } + + /** + * {@inheritdoc} + */ + public function withName(string $name, $value): ParameterResolverInterface + { + $clone = clone $this; + $clone->setName($name, $value); + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function withNames(array $names): ParameterResolverInterface + { + $clone = clone $this; + foreach ($names as $name => $value) { + $clone->setName($name, $value); + } + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function withType(string $type, $value): ParameterResolverInterface + { + $clone = clone $this; + $clone->setType($type, $value); + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function withTypes(array $types): ParameterResolverInterface + { + $clone = clone $this; + foreach ($types as $type => $value) { + $clone->setType($type, $value); + } + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function resolveParameters(ReflectionParameter ...$parameters): array + { + $arguments = []; + foreach ($parameters as $parameter) { + $arguments[] = $this->resolveParameter($parameter); + } + + return $arguments; + } + + /** + * Sets a new known name + * + * @param string $name + * @param mixed $value + * + * @return void + */ + private function setName(string $name, $value): void + { + $this->names[$name] = $value; + } + + /** + * Sets a new known type + * + * @param string $type + * @param mixed $value + * + * @return void + * + * @throws LogicException + * If the value isn't an instance of the type. + */ + private function setType(string $type, $value): void + { + if (!($value instanceof $type)) { + throw new LogicException(); + } + + $this->types[$type] = $value; + } + + /** + * Resolves the given parameter + * + * @param ReflectionParameter $parameter + * + * @return mixed + * + * @throws LogicException + * If the parameter cannot be resolved. + */ + private function resolveParameter(ReflectionParameter $parameter) + { + if (!$parameter->hasType()) { + return $this->resolveUntypedParameter($parameter); + } + + $type = $parameter->getType(); + if (!($type instanceof ReflectionNamedType)) { + throw new LogicException(); + } + + return !$type->isBuiltin() ? + $this->resolveTypedParameterWithNonBuiltinType($type, $parameter) : + $this->resolveTypedParameterWithBuiltinType($type, $parameter); + } + + /** + * Resolves the given untyped parameter + * + * @param ReflectionParameter $parameter + * + * @return mixed + * + * @throws LogicException + * If the parameter cannot be resolved. + */ + private function resolveUntypedParameter(ReflectionParameter $parameter) + { + if (array_key_exists($parameter->getName(), $this->names)) { + return $this->names[$parameter->getName()]; + } + + if ($parameter->isDefaultValueAvailable()) { + return $parameter->getDefaultValue(); + } + + throw new LogicException(); + } + + /** + * Resolves the given typed parameter with non-built-in type + * + * @param ReflectionNamedType $type + * @param ReflectionParameter $parameter + * + * @return mixed + * + * @throws LogicException + * If the parameter cannot be resolved. + */ + private function resolveTypedParameterWithNonBuiltinType(ReflectionNamedType $type, ReflectionParameter $parameter) + { + if (isset($this->types[$parameter->getName()])) { + return $this->types[$parameter->getName()]; + } + + if (isset($this->container) && $this->container->has($type->getName())) { + return $this->container->get($type->getName()); + } + + if ($parameter->isDefaultValueAvailable()) { + return $parameter->getDefaultValue(); + } + + throw new LogicException(); + } + + /** + * Resolves the given typed parameter with built-in type + * + * @param ReflectionNamedType $type + * @param ReflectionParameter $parameter + * + * @return mixed + * + * @throws LogicException + * If the parameter cannot be resolved. + */ + private function resolveTypedParameterWithBuiltinType(ReflectionNamedType $type, ReflectionParameter $parameter) + { + if (!array_key_exists($parameter->getName(), $this->names)) { + if ($parameter->isDefaultValueAvailable()) { + return $parameter->getDefaultValue(); + } + + throw new LogicException(); + } + + switch ($type->getName()) { + case 'bool': + break; + case 'int': + break; + case 'float': + break; + case 'string': + break; + } + + throw new LogicException(); + } +} diff --git a/src/Exception/MissingAttributeValueException.php b/src/ParameterResolverInterface.php similarity index 52% rename from src/Exception/MissingAttributeValueException.php rename to src/ParameterResolverInterface.php index 142d2d07..281faed7 100644 --- a/src/Exception/MissingAttributeValueException.php +++ b/src/ParameterResolverInterface.php @@ -3,17 +3,19 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ -namespace Sunrise\Http\Router\Exception; +namespace Sunrise\Http\Router; /** - * MissingAttributeValueException + * ParameterResolverInterface + * + * @since 3.0.0 */ -class MissingAttributeValueException extends Exception +interface ParameterResolverInterface { } diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index 30a3c658..9e25e165 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -47,6 +47,13 @@ class ReferenceResolver implements ReferenceResolverInterface */ private ?ContainerInterface $container = null; + /** + * The reference resolver's parameter resolver + * + * @var ParameterResolverInterface|null + */ + private ?ParameterResolverInterface $parameterResolver = null; + /** * The reference resolver's response resolver * diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index dadbd247..c2bd086a 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -17,23 +17,21 @@ use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ResponseResolverInterface; use ReflectionFunctionAbstract; use ReflectionFunction; use ReflectionMethod; -use ReflectionParameter; -use ReflectionType; /** * Import functions */ -use function ksort; use function Sunrise\Http\Router\reflect_callable; /** * CallableRequestHandler */ -class CallableRequestHandler implements RequestHandlerInterface +final class CallableRequestHandler implements RequestHandlerInterface { /** @@ -44,35 +42,45 @@ class CallableRequestHandler implements RequestHandlerInterface private $callback; /** - * The callback arguments + * The callback's parameter resolver * - * @var list + * @var ParameterResolverInterface + */ + private ParameterResolverInterface $parameterResolver; + + /** + * The callback's response resolver * - * @psalm-immutable + * @var ResponseResolverInterface */ - private array $arguments = []; + private ResponseResolverInterface $responseResolver; /** - * The response resolver + * The callback's reflection * - * @var ResponseResolverInterface|null + * @var ReflectionFunction|ReflectionMethod */ - private ?ResponseResolverInterface $responseResolver; + private ?ReflectionFunctionAbstract $reflection = null; /** * Constructor of the class * * @param callable $callback - * @param ResponseResolverInterface|null $responseResolver + * @param ParameterResolverInterface $parameterResolver + * @param ResponseResolverInterface $responseResolver */ - public function __construct(callable $callback, ?ResponseResolverInterface $responseResolver = null) - { + public function __construct( + callable $callback, + ParameterResolverInterface $parameterResolver, + ResponseResolverInterface $responseResolver + ) { $this->callback = $callback; + $this->parameterResolver = $parameterResolver; $this->responseResolver = $responseResolver; } /** - * Gets the callback reflection + * Gets the callback's reflection * * @return ReflectionFunction|ReflectionMethod * @@ -80,89 +88,7 @@ public function __construct(callable $callback, ?ResponseResolverInterface $resp */ public function getReflection(): ReflectionFunctionAbstract { - return reflect_callable($this->callback); - } - - /** - * Gets the callback parameters - * - * @return list - * - * @since 3.0.0 - */ - public function getParameters(): array - { - return $this->getReflection()->getParameters(); - } - - /** - * Gets the callback's attributed parameter - * - * @param class-string $attribute - * - * @return ReflectionParameter|null - * - * @since 3.0.0 - */ - public function getAttributedParameter(string $attribute): ?ReflectionParameter - { - foreach ($this->getParameters() as $parameter) { - if ($parameter->getAttributes($attribute)) { - return $parameter; - } - } - - return null; - } - - /** - * Gets the callback's return type - * - * @return ReflectionType|null - * - * @since 3.0.0 - */ - public function getReturnType(): ?ReflectionType - { - return $this->getReflection()->getReturnType(); - } - - /** - * Gets the callback arguments - * - * @return list - * - * @since 3.0.0 - */ - public function getArguments(): array - { - return $this->arguments; - } - - /** - * Creates a new instance of the request handler with the given arguments and returns it - * - * Please note that the first argument will be the server request instance. - * - * @param array $arguments - * - * @return static - * - * @since 3.0.0 - */ - public function withArguments(array $arguments): self - { - ksort($arguments, SORT_NUMERIC); - - $clone = clone $this; - $clone->arguments = []; - - /** @psalm-suppress MixedAssignment */ - foreach ($arguments as $argument) { - $clone->arguments[] = $argument; - } - - return $clone; + return $this->reflection ??= reflect_callable($this->callback); } /** @@ -170,13 +96,11 @@ public function withArguments(array $arguments): self */ public function handle(ServerRequestInterface $request): ResponseInterface { - /** @var ResponseInterface $response */ - $response = ($this->callback)($request, ...$this->arguments); - - if (isset($this->responseResolver)) { - return $this->responseResolver->resolveResponse($response); - } + $arguments = $this->parameterResolver + ->withNames($request->getAttributes()) + ->withType(ServerRequestInterface::class, $request) + ->resolveParameters(...$this->getReflection()->getParameters()); - return $response; + return $this->responseResolver->resolveResponse(($this->callback)(...$arguments)); } } diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index ce55f941..00282bff 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -23,7 +23,7 @@ /** * QueueableRequestHandler */ -class QueueableRequestHandler implements RequestHandlerInterface +final class QueueableRequestHandler implements RequestHandlerInterface { /** diff --git a/src/ResponseResolver.php b/src/ResponseResolver.php new file mode 100644 index 00000000..dcbc6703 --- /dev/null +++ b/src/ResponseResolver.php @@ -0,0 +1,39 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router; + +/** + * Import classes + */ +use Psr\Http\Message\ResponseInterface; +use Sunrise\Http\Router\Exception\LogicException; + +/** + * ResponseResolver + * + * @since 3.0.0 + */ +final class ResponseResolver implements ResponseResolverInterface +{ + + /** + * {@inheritdoc} + */ + public function resolveResponse($response): ResponseInterface + { + if ($response instanceof ResponseInterface) { + return $response; + } + + throw new LogicException(); + } +} diff --git a/src/ResponseResolverInterface.php b/src/ResponseResolverInterface.php index 56ae81f6..af0c7f04 100644 --- a/src/ResponseResolverInterface.php +++ b/src/ResponseResolverInterface.php @@ -26,14 +26,14 @@ interface ResponseResolverInterface { /** - * Resolves the given data to the response instance + * Resolves the given raw response to the response object * - * @param mixed $data + * @param mixed $response * * @return ResponseInterface * * @throws LogicException - * If the data cannot be resolved to the response. + * If the raw response cannot be resolved to the response object. */ - public function resolveResponse($data): ResponseInterface; + public function resolveResponse($response): ResponseInterface; } diff --git a/src/RouteCollection.php b/src/RouteCollection.php index 8dcbf0ce..d6da65c3 100644 --- a/src/RouteCollection.php +++ b/src/RouteCollection.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -32,9 +32,9 @@ class RouteCollection implements RouteCollectionInterface /** * The collection routes * - * @var RouteInterface[] + * @var list */ - private $routes; + private $routes = []; /** * Constructor of the class @@ -43,13 +43,15 @@ class RouteCollection implements RouteCollectionInterface */ public function __construct(RouteInterface ...$routes) { + /** @var list $routes */ + $this->routes = $routes; } /** * {@inheritdoc} */ - public function all() : array + public function all(): array { return $this->routes; } @@ -57,7 +59,7 @@ public function all() : array /** * {@inheritdoc} */ - public function get(string $name) : ?RouteInterface + public function get(string $name): ?RouteInterface { foreach ($this->routes as $route) { if ($name === $route->getName()) { @@ -71,7 +73,7 @@ public function get(string $name) : ?RouteInterface /** * {@inheritdoc} */ - public function has(string $name) : bool + public function has(string $name): bool { return $this->get($name) instanceof RouteInterface; } @@ -79,7 +81,7 @@ public function has(string $name) : bool /** * {@inheritdoc} */ - public function add(RouteInterface ...$routes) : RouteCollectionInterface + public function add(RouteInterface ...$routes): RouteCollectionInterface { foreach ($routes as $route) { $this->routes[] = $route; @@ -91,7 +93,7 @@ public function add(RouteInterface ...$routes) : RouteCollectionInterface /** * {@inheritdoc} */ - public function setHost(string $host) : RouteCollectionInterface + public function setHost(string $host): RouteCollectionInterface { foreach ($this->routes as $route) { $route->setHost($host); @@ -103,7 +105,7 @@ public function setHost(string $host) : RouteCollectionInterface /** * {@inheritdoc} */ - public function addPrefix(string $prefix) : RouteCollectionInterface + public function addPrefix(string $prefix): RouteCollectionInterface { foreach ($this->routes as $route) { $route->addPrefix($prefix); @@ -115,7 +117,7 @@ public function addPrefix(string $prefix) : RouteCollectionInterface /** * {@inheritdoc} */ - public function addSuffix(string $suffix) : RouteCollectionInterface + public function addSuffix(string $suffix): RouteCollectionInterface { foreach ($this->routes as $route) { $route->addSuffix($suffix); @@ -127,7 +129,7 @@ public function addSuffix(string $suffix) : RouteCollectionInterface /** * {@inheritdoc} */ - public function addMethod(string ...$methods) : RouteCollectionInterface + public function addMethod(string ...$methods): RouteCollectionInterface { foreach ($this->routes as $route) { $route->addMethod(...$methods); @@ -139,7 +141,7 @@ public function addMethod(string ...$methods) : RouteCollectionInterface /** * {@inheritdoc} */ - public function addMiddleware(MiddlewareInterface ...$middlewares) : RouteCollectionInterface + public function addMiddleware(MiddlewareInterface ...$middlewares): RouteCollectionInterface { foreach ($this->routes as $route) { $route->addMiddleware(...$middlewares); @@ -151,7 +153,7 @@ public function addMiddleware(MiddlewareInterface ...$middlewares) : RouteCollec /** * {@inheritdoc} */ - public function prependMiddleware(MiddlewareInterface ...$middlewares) : RouteCollectionInterface + public function prependMiddleware(MiddlewareInterface ...$middlewares): RouteCollectionInterface { foreach ($this->routes as $route) { $route->setMiddlewares(...array_merge($middlewares, $route->getMiddlewares())); @@ -159,20 +161,4 @@ public function prependMiddleware(MiddlewareInterface ...$middlewares) : RouteCo return $this; } - - /** - * @deprecated 2.12.0 Use the addMiddleware method. - */ - public function appendMiddleware(MiddlewareInterface ...$middlewares) : RouteCollectionInterface - { - return $this->addMiddleware(...$middlewares); - } - - /** - * @deprecated 2.10.0 Use the prependMiddleware method. - */ - public function unshiftMiddleware(MiddlewareInterface ...$middlewares) : RouteCollectionInterface - { - return $this->prependMiddleware(...$middlewares); - } } diff --git a/src/RouteCollectionFactory.php b/src/RouteCollectionFactory.php index eec33899..40274f2f 100644 --- a/src/RouteCollectionFactory.php +++ b/src/RouteCollectionFactory.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -20,7 +20,7 @@ class RouteCollectionFactory implements RouteCollectionFactoryInterface /** * {@inheritdoc} */ - public function createCollection(RouteInterface ...$routes) : RouteCollectionInterface + public function createCollection(RouteInterface ...$routes): RouteCollectionInterface { return new RouteCollection(...$routes); } diff --git a/src/RouteCollectionFactoryInterface.php b/src/RouteCollectionFactoryInterface.php index e69350c2..768a0dc1 100644 --- a/src/RouteCollectionFactoryInterface.php +++ b/src/RouteCollectionFactoryInterface.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -24,5 +24,5 @@ interface RouteCollectionFactoryInterface * * @return RouteCollectionInterface */ - public function createCollection(RouteInterface ...$routes) : RouteCollectionInterface; + public function createCollection(RouteInterface ...$routes): RouteCollectionInterface; } diff --git a/src/RouteCollectionInterface.php b/src/RouteCollectionInterface.php index 6adc3211..ff392e70 100644 --- a/src/RouteCollectionInterface.php +++ b/src/RouteCollectionInterface.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -25,9 +25,9 @@ interface RouteCollectionInterface /** * Gets all routes from the collection * - * @return RouteInterface[] + * @return list */ - public function all() : array; + public function all(): array; /** * Gets a route by the given name @@ -38,7 +38,7 @@ public function all() : array; * * @since 2.10.0 */ - public function get(string $name) : ?RouteInterface; + public function get(string $name): ?RouteInterface; /** * Checks by the given name if a route exists in the collection @@ -49,7 +49,7 @@ public function get(string $name) : ?RouteInterface; * * @since 2.10.0 */ - public function has(string $name) : bool; + public function has(string $name): bool; /** * Adds the given route(s) to the collection @@ -58,7 +58,7 @@ public function has(string $name) : bool; * * @return RouteCollectionInterface */ - public function add(RouteInterface ...$routes) : RouteCollectionInterface; + public function add(RouteInterface ...$routes): RouteCollectionInterface; /** * Sets the given host to all routes in the collection @@ -69,7 +69,7 @@ public function add(RouteInterface ...$routes) : RouteCollectionInterface; * * @since 2.9.0 */ - public function setHost(string $host) : RouteCollectionInterface; + public function setHost(string $host): RouteCollectionInterface; /** * Adds the given path prefix to all routes in the collection @@ -80,7 +80,7 @@ public function setHost(string $host) : RouteCollectionInterface; * * @since 2.9.0 */ - public function addPrefix(string $prefix) : RouteCollectionInterface; + public function addPrefix(string $prefix): RouteCollectionInterface; /** * Adds the given path suffix to all routes in the collection @@ -91,7 +91,7 @@ public function addPrefix(string $prefix) : RouteCollectionInterface; * * @since 2.9.0 */ - public function addSuffix(string $suffix) : RouteCollectionInterface; + public function addSuffix(string $suffix): RouteCollectionInterface; /** * Adds the given method(s) to all routes in the collection @@ -102,7 +102,7 @@ public function addSuffix(string $suffix) : RouteCollectionInterface; * * @since 2.9.0 */ - public function addMethod(string ...$methods) : RouteCollectionInterface; + public function addMethod(string ...$methods): RouteCollectionInterface; /** * Adds the given middleware(s) to all routes in the collection @@ -113,7 +113,7 @@ public function addMethod(string ...$methods) : RouteCollectionInterface; * * @since 2.9.0 */ - public function addMiddleware(MiddlewareInterface ...$middlewares) : RouteCollectionInterface; + public function addMiddleware(MiddlewareInterface ...$middlewares): RouteCollectionInterface; /** * Adds the given middleware(s) to the beginning of all routes in the collection @@ -124,5 +124,5 @@ public function addMiddleware(MiddlewareInterface ...$middlewares) : RouteCollec * * @since 2.9.0 */ - public function prependMiddleware(MiddlewareInterface ...$middlewares) : RouteCollectionInterface; + public function prependMiddleware(MiddlewareInterface ...$middlewares): RouteCollectionInterface; } diff --git a/src/RouteCollector.php b/src/RouteCollector.php index 7e8653fc..3e76ad6a 100644 --- a/src/RouteCollector.php +++ b/src/RouteCollector.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -15,7 +15,7 @@ * Import classes */ use Psr\Container\ContainerInterface; -use Sunrise\Http\Router\Exception\UnresolvableReferenceException; +use Sunrise\Http\Router\Exception\InvalidReferenceException; /** * RouteCollector @@ -106,6 +106,32 @@ public function setContainer(?ContainerInterface $container) : void $this->referenceResolver->setContainer($container); } + /** + * Gets the collector response resolver + * + * @return ResponseResolverInterface|null + * + * @since 3.0.0 + */ + public function getResponseResolver(): ?ResponseResolverInterface + { + return $this->referenceResolver->getResponseResolver(); + } + + /** + * Sets the given response resolver to the collector + * + * @param ResponseResolverInterface|null $responseResolver + * + * @return void + * + * @since 3.0.0 + */ + public function setResponseResolver(?ResponseResolverInterface $responseResolver): void + { + $this->referenceResolver->setResponseResolver($responseResolver); + } + /** * Makes a new route from the given parameters * @@ -114,11 +140,11 @@ public function setContainer(?ContainerInterface $container) : void * @param string[] $methods * @param mixed $requestHandler * @param array $middlewares - * @param array $attributes + * @param array $attributes * * @return RouteInterface * - * @throws UnresolvableReferenceException + * @throws InvalidReferenceException * If the given request handler or one of the given middlewares cannot be resolved. */ public function route( @@ -129,16 +155,12 @@ public function route( array $middlewares = [], array $attributes = [] ) : RouteInterface { - foreach ($middlewares as &$middleware) { - $middleware = $this->referenceResolver->toMiddleware($middleware); - } - $route = $this->routeFactory->createRoute( $name, $path, $methods, $this->referenceResolver->toRequestHandler($requestHandler), - $middlewares, + $this->referenceResolver->toMiddlewares($middlewares), $attributes ); @@ -154,11 +176,11 @@ public function route( * @param string $path * @param mixed $requestHandler * @param array $middlewares - * @param array $attributes + * @param array $attributes * * @return RouteInterface * - * @throws UnresolvableReferenceException + * @throws InvalidReferenceException * If the given request handler or one of the given middlewares cannot be resolved. */ public function head( @@ -185,11 +207,11 @@ public function head( * @param string $path * @param mixed $requestHandler * @param array $middlewares - * @param array $attributes + * @param array $attributes * * @return RouteInterface * - * @throws UnresolvableReferenceException + * @throws InvalidReferenceException * If the given request handler or one of the given middlewares cannot be resolved. */ public function get( @@ -216,11 +238,11 @@ public function get( * @param string $path * @param mixed $requestHandler * @param array $middlewares - * @param array $attributes + * @param array $attributes * * @return RouteInterface * - * @throws UnresolvableReferenceException + * @throws InvalidReferenceException * If the given request handler or one of the given middlewares cannot be resolved. */ public function post( @@ -247,11 +269,11 @@ public function post( * @param string $path * @param mixed $requestHandler * @param array $middlewares - * @param array $attributes + * @param array $attributes * * @return RouteInterface * - * @throws UnresolvableReferenceException + * @throws InvalidReferenceException * If the given request handler or one of the given middlewares cannot be resolved. */ public function put( @@ -278,11 +300,11 @@ public function put( * @param string $path * @param mixed $requestHandler * @param array $middlewares - * @param array $attributes + * @param array $attributes * * @return RouteInterface * - * @throws UnresolvableReferenceException + * @throws InvalidReferenceException * If the given request handler or one of the given middlewares cannot be resolved. */ public function patch( @@ -309,11 +331,11 @@ public function patch( * @param string $path * @param mixed $requestHandler * @param array $middlewares - * @param array $attributes + * @param array $attributes * * @return RouteInterface * - * @throws UnresolvableReferenceException + * @throws InvalidReferenceException * If the given request handler or one of the given middlewares cannot be resolved. */ public function delete( @@ -340,11 +362,11 @@ public function delete( * @param string $path * @param mixed $requestHandler * @param array $middlewares - * @param array $attributes + * @param array $attributes * * @return RouteInterface * - * @throws UnresolvableReferenceException + * @throws InvalidReferenceException * If the given request handler or one of the given middlewares cannot be resolved. */ public function purge( @@ -372,15 +394,11 @@ public function purge( * * @return RouteCollectionInterface * - * @throws UnresolvableReferenceException + * @throws InvalidReferenceException * If one of the given middlewares cannot be resolved. */ public function group(callable $callback, array $middlewares = []) : RouteCollectionInterface { - foreach ($middlewares as &$middleware) { - $middleware = $this->referenceResolver->toMiddleware($middleware); - } - $collector = new self( $this->collectionFactory, $this->routeFactory, @@ -389,9 +407,13 @@ public function group(callable $callback, array $middlewares = []) : RouteCollec $callback($collector); - $collector->collection->prependMiddleware(...$middlewares); + $collector->collection->prependMiddleware( + ...$this->referenceResolver->toMiddlewares($middlewares) + ); - $this->collection->add(...$collector->collection->all()); + $this->collection->add( + ...$collector->collection->all() + ); return $collector->collection; } diff --git a/src/RouteFactory.php b/src/RouteFactory.php index 343548a4..5c5602c8 100644 --- a/src/RouteFactory.php +++ b/src/RouteFactory.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ diff --git a/src/RouteFactoryInterface.php b/src/RouteFactoryInterface.php index 2fe69bf7..86541d9b 100644 --- a/src/RouteFactoryInterface.php +++ b/src/RouteFactoryInterface.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -31,7 +31,7 @@ interface RouteFactoryInterface * @param string[] $methods * @param RequestHandlerInterface $requestHandler * @param MiddlewareInterface[] $middlewares - * @param array $attributes + * @param array $attributes * * @return RouteInterface */ diff --git a/src/RouteInterface.php b/src/RouteInterface.php index 31d739a3..935bc6f0 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -83,7 +83,7 @@ public function getMiddlewares() : array; /** * Gets the route attributes * - * @return array + * @return array */ public function getAttributes() : array; @@ -182,7 +182,7 @@ public function setMiddlewares(MiddlewareInterface ...$middlewares) : RouteInter /** * Sets the given attributes to the route * - * @param array $attributes + * @param array $attributes * * @return RouteInterface */ @@ -262,7 +262,7 @@ public function addMiddleware(MiddlewareInterface ...$middlewares) : RouteInterf * * This method MUST NOT change the state of the object. * - * @param array $attributes + * @param array $attributes * * @return RouteInterface */ diff --git a/src/Router.php b/src/Router.php index 6b973897..1b21d50a 100644 --- a/src/Router.php +++ b/src/Router.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -21,9 +21,9 @@ use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Event\RouteEvent; use Sunrise\Http\Router\Exception\InvalidArgumentException; -use Sunrise\Http\Router\Exception\MethodNotAllowedException; use Sunrise\Http\Router\Exception\PageNotFoundException; use Sunrise\Http\Router\Exception\RouteNotFoundException; +use Sunrise\Http\Router\Exception\MethodNotAllowedException; use Sunrise\Http\Router\Loader\LoaderInterface; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; @@ -400,7 +400,7 @@ public function getRoute(string $name) : RouteInterface * Generates a URI for the given named route * * @param string $name - * @param array $attributes + * @param array $attributes * @param bool $strict * * @return string @@ -408,11 +408,9 @@ public function getRoute(string $name) : RouteInterface * @throws RouteNotFoundException * If the given named route wasn't found. * - * @throws Exception\InvalidAttributeValueException - * It can be thrown in strict mode, if an attribute value is not valid. - * - * @throws Exception\MissingAttributeValueException - * If a required attribute value is not given. + * @throws Exception\RoutePathBuildException + * If a required attribute value is not given, + * or if an attribute value is not valid in strict mode. */ public function generateUri(string $name, array $attributes = [], bool $strict = false) : string { @@ -430,19 +428,19 @@ public function generateUri(string $name, array $attributes = [], bool $strict = * * @return RouteInterface * - * @throws MethodNotAllowedException * @throws PageNotFoundException + * @throws MethodNotAllowedException */ public function match(ServerRequestInterface $request) : RouteInterface { - $currentHost = $request->getUri()->getHost(); - $currentPath = $request->getUri()->getPath(); + $currentUri = $request->getUri(); + $currentHost = $currentUri->getHost(); + $currentPath = $currentUri->getPath(); $currentMethod = $request->getMethod(); $allowedMethods = []; + $currentHostRoutes = $this->getRoutesByHostname($currentHost); - $routes = $this->getRoutesByHostname($currentHost); - - foreach ($routes as $route) { + foreach ($currentHostRoutes as $route) { // https://github.com/sunrise-php/http-router/issues/50 // https://tools.ietf.org/html/rfc7231#section-6.5.5 if (!path_match($route->getPath(), $currentPath, $attributes)) { @@ -452,24 +450,26 @@ public function match(ServerRequestInterface $request) : RouteInterface $routeMethods = []; foreach ($route->getMethods() as $routeMethod) { $routeMethods[$routeMethod] = true; - $allowedMethods[$routeMethod] = true; + $allowedMethods[$routeMethod] = $routeMethod; } if (!isset($routeMethods[$currentMethod])) { continue; } + /** @var array $attributes */ + return $route->withAddedAttributes($attributes); } - if (!empty($allowedMethods)) { - throw new MethodNotAllowedException('Method Not Allowed', [ - 'method' => $currentMethod, - 'allowed' => array_keys($allowedMethods), - ]); + if (empty($allowedMethods)) { + throw new PageNotFoundException(); } - throw new PageNotFoundException('Page Not Found'); + throw new MethodNotAllowedException( + $currentMethod, + $allowedMethods + ); } /** @@ -491,9 +491,7 @@ public function run(ServerRequestInterface $request) : ResponseInterface if (isset($this->eventDispatcher)) { $event = new RouteEvent($route, $request); - /** - * @psalm-suppress TooManyArguments - */ + /** @psalm-suppress TooManyArguments */ $this->eventDispatcher->dispatch($event, RouteEvent::NAME); $request = $event->getRequest(); @@ -524,9 +522,7 @@ public function handle(ServerRequestInterface $request) : ResponseInterface if (isset($this->eventDispatcher)) { $event = new RouteEvent($route, $request); - /** - * @psalm-suppress TooManyArguments - */ + /** @psalm-suppress TooManyArguments */ $this->eventDispatcher->dispatch($event, RouteEvent::NAME); $request = $event->getRequest(); @@ -550,10 +546,8 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface { try { return $this->handle($request); - } catch (MethodNotAllowedException|PageNotFoundException $e) { - $request = $request->withAttribute(self::ATTR_NAME_FOR_ROUTING_ERROR, $e); - - return $handler->handle($request); + } catch (PageNotFoundException|MethodNotAllowedException $e) { + return $handler->handle($request->withAttribute(self::ATTR_NAME_FOR_ROUTING_ERROR, $e)); } } diff --git a/src/RouterBuilder.php b/src/RouterBuilder.php index d8f017b0..fcc38a62 100644 --- a/src/RouterBuilder.php +++ b/src/RouterBuilder.php @@ -3,8 +3,8 @@ /** * It's free open-source software released under the MIT License. * - * @author Anatoly Fenric - * @copyright Copyright (c) 2018, Anatoly Fenric + * @author Anatoly Nekhay + * @copyright Copyright (c) 2018, Anatoly Nekhay * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE * @link https://github.com/sunrise-php/http-router */ @@ -39,6 +39,11 @@ final class RouterBuilder */ private $container = null; + /** + * @var ResponseResolverInterface|null + */ + private $responseResolver = null; + /** * @var CacheInterface|null */ @@ -104,6 +109,20 @@ public function setContainer(?ContainerInterface $container) : self return $this; } + /** + * Sets the given response resolver to the builder + * + * @param ResponseResolverInterface|null $responseResolver + * + * @return self + */ + public function setResponseResolver(?ResponseResolverInterface $responseResolver) : self + { + $this->responseResolver = $responseResolver; + + return $this; + } + /** * Sets the given cache to the builder * @@ -239,11 +258,13 @@ public function build() : Router if (isset($this->configLoader)) { $this->configLoader->setContainer($this->container); + $this->configLoader->setResponseResolver($this->responseResolver); $router->load($this->configLoader); } if (isset($this->descriptorLoader)) { $this->descriptorLoader->setContainer($this->container); + $this->descriptorLoader->setResponseResolver($this->responseResolver); $this->descriptorLoader->setCache($this->cache); $this->descriptorLoader->setCacheKey($this->cacheKey); $router->load($this->descriptorLoader); From 2d426e7d5ea40e376422e9fdb71e471f2c259ad4 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 14 Jan 2023 05:01:00 +0100 Subject: [PATCH 028/180] v3 --- src/Event/RouteEvent.php | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/src/Event/RouteEvent.php b/src/Event/RouteEvent.php index cd5f6f36..9e94bdbc 100644 --- a/src/Event/RouteEvent.php +++ b/src/Event/RouteEvent.php @@ -68,14 +68,4 @@ public function getRequest(): ServerRequestInterface { return $this->request; } - - /** - * @param ServerRequestInterface $request - * - * @return void - */ - public function setRequest(ServerRequestInterface $request): void - { - $this->request = $request; - } } From 98337d5fcadad37ffa99f350f200cd2b52db210b Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 15 Jan 2023 09:43:36 +0100 Subject: [PATCH 029/180] v3 --- src/Annotation/RequestBody.php | 25 ++ src/Event/RouteEvent.php | 5 - src/Exception/ParameterResolvingException.php | 57 ++++ src/Loader/ConfigLoader.php | 54 ---- src/Loader/DescriptorLoader.php | 54 ---- src/Middleware/CallableMiddleware.php | 54 ++-- .../JsonPayloadDecodingMiddleware.php | 35 +-- src/ParameterResolutioner.php | 150 +++++++++ src/ParameterResolutionerInterface.php | 84 +++++ src/ParameterResolver.php | 287 ------------------ .../RequestBodyParameterResolver.php | 120 ++++++++ src/ParameterResolverInterface.php | 30 ++ src/ReferenceResolver.php | 41 +-- src/ReferenceResolverInterface.php | 20 -- src/RequestBodyInterface.php | 21 ++ src/RequestHandler/CallableRequestHandler.php | 54 ++-- .../QueueableRequestHandler.php | 2 +- ...eResolver.php => ResponseResolutioner.php} | 22 +- ....php => ResponseResolutionerInterface.php} | 15 +- src/RouteCollector.php | 26 -- src/Router.php | 14 +- src/RouterBuilder.php | 21 -- 22 files changed, 598 insertions(+), 593 deletions(-) create mode 100644 src/Annotation/RequestBody.php create mode 100644 src/Exception/ParameterResolvingException.php create mode 100644 src/ParameterResolutioner.php create mode 100644 src/ParameterResolutionerInterface.php delete mode 100644 src/ParameterResolver.php create mode 100644 src/ParameterResolver/RequestBodyParameterResolver.php create mode 100644 src/RequestBodyInterface.php rename src/{ResponseResolver.php => ResponseResolutioner.php} (64%) rename src/{ResponseResolverInterface.php => ResponseResolutionerInterface.php} (68%) diff --git a/src/Annotation/RequestBody.php b/src/Annotation/RequestBody.php new file mode 100644 index 00000000..56ae949a --- /dev/null +++ b/src/Annotation/RequestBody.php @@ -0,0 +1,25 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Annotation; + +/** + * Import classes + */ +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_PARAMETER)] +final class RequestBody +{ +} diff --git a/src/Event/RouteEvent.php b/src/Event/RouteEvent.php index 9e94bdbc..af880bfb 100644 --- a/src/Event/RouteEvent.php +++ b/src/Event/RouteEvent.php @@ -26,11 +26,6 @@ final class RouteEvent extends Event { - /** - * @var string - */ - public const NAME = 'router.route'; - /** * @var RouteInterface */ diff --git a/src/Exception/ParameterResolvingException.php b/src/Exception/ParameterResolvingException.php new file mode 100644 index 00000000..81773b51 --- /dev/null +++ b/src/Exception/ParameterResolvingException.php @@ -0,0 +1,57 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * Import classes + */ +use ReflectionParameter; + +/** + * Import functions + */ +use function sprintf; + +/** + * ParameterResolvingException + * + * @since 3.0.0 + */ +class ParameterResolvingException extends Exception +{ + + /** + * @return self + */ + final public static function unsupportedParameterTypeDeclaration(ReflectionParameter $parameter): self + { + return new self(sprintf( + '%s($%s[%d]): Unsupported parameter type declaration', + $parameter->getDeclaringFunction()->getName(), + $parameter->getName(), + $parameter->getPosition() + )); + } + + /** + * @return self + */ + final public static function unknownParameter(ReflectionParameter $parameter): self + { + return new self(sprintf( + '%s($%s[%d]): Unknown parameter', + $parameter->getDeclaringFunction()->getName(), + $parameter->getName(), + $parameter->getPosition() + )); + } +} diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index 9d0bca76..0a70af38 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -16,10 +16,8 @@ */ use Psr\Container\ContainerInterface; use Sunrise\Http\Router\Exception\InvalidLoaderResourceException; -use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; -use Sunrise\Http\Router\ResponseResolverInterface; use Sunrise\Http\Router\RouteCollectionFactory; use Sunrise\Http\Router\RouteCollectionFactoryInterface; use Sunrise\Http\Router\RouteCollectionInterface; @@ -104,58 +102,6 @@ public function setContainer(?ContainerInterface $container): void $this->referenceResolver->setContainer($container); } - /** - * Gets the loader parameter resolver - * - * @return ParameterResolverInterface|null - * - * @since 3.0.0 - */ - public function getParameterResolver(): ?ParameterResolverInterface - { - return $this->referenceResolver->getParameterResolver(); - } - - /** - * Sets the given parameter resolver to the loader - * - * @param ParameterResolverInterface|null $parameterResolver - * - * @return void - * - * @since 3.0.0 - */ - public function setParameterResolver(?ParameterResolverInterface $parameterResolver): void - { - $this->referenceResolver->setParameterResolver($parameterResolver); - } - - /** - * Gets the loader response resolver - * - * @return ResponseResolverInterface|null - * - * @since 3.0.0 - */ - public function getResponseResolver(): ?ResponseResolverInterface - { - return $this->referenceResolver->getResponseResolver(); - } - - /** - * Sets the given response resolver to the loader - * - * @param ResponseResolverInterface|null $responseResolver - * - * @return void - * - * @since 3.0.0 - */ - public function setResponseResolver(?ResponseResolverInterface $responseResolver): void - { - $this->referenceResolver->setResponseResolver($responseResolver); - } - /** * {@inheritdoc} */ diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index f8517755..557079d2 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -27,10 +27,8 @@ use Sunrise\Http\Router\Annotation\Route; use Sunrise\Http\Router\Exception\InvalidLoaderResourceException; use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; -use Sunrise\Http\Router\ResponseResolverInterface; use Sunrise\Http\Router\RouteCollectionFactory; use Sunrise\Http\Router\RouteCollectionFactoryInterface; use Sunrise\Http\Router\RouteCollectionInterface; @@ -145,58 +143,6 @@ public function setContainer(?ContainerInterface $container): void $this->referenceResolver->setContainer($container); } - /** - * Gets the loader parameter resolver - * - * @return ParameterResolverInterface|null - * - * @since 3.0.0 - */ - public function getParameterResolver(): ?ParameterResolverInterface - { - return $this->referenceResolver->getParameterResolver(); - } - - /** - * Sets the given parameter resolver to the loader - * - * @param ParameterResolverInterface|null $parameterResolver - * - * @return void - * - * @since 3.0.0 - */ - public function setParameterResolver(?ParameterResolverInterface $parameterResolver): void - { - $this->referenceResolver->setParameterResolver($parameterResolver); - } - - /** - * Gets the loader response resolver - * - * @return ResponseResolverInterface|null - * - * @since 3.0.0 - */ - public function getResponseResolver(): ?ResponseResolverInterface - { - return $this->referenceResolver->getResponseResolver(); - } - - /** - * Sets the given response resolver to the loader - * - * @param ResponseResolverInterface|null $responseResolver - * - * @return void - * - * @since 3.0.0 - */ - public function setResponseResolver(?ResponseResolverInterface $responseResolver): void - { - $this->referenceResolver->setResponseResolver($responseResolver); - } - /** * Gets the loader annotation reader * diff --git a/src/Middleware/CallableMiddleware.php b/src/Middleware/CallableMiddleware.php index 49cd99ff..e100ffa9 100644 --- a/src/Middleware/CallableMiddleware.php +++ b/src/Middleware/CallableMiddleware.php @@ -14,15 +14,15 @@ /** * Import classes */ +use ReflectionFunctionAbstract; +use ReflectionFunction; +use ReflectionMethod; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\ParameterResolverInterface; -use Sunrise\Http\Router\ResponseResolverInterface; -use ReflectionFunctionAbstract; -use ReflectionFunction; -use ReflectionMethod; +use Sunrise\Http\Router\ParameterResolutionerInterface; +use Sunrise\Http\Router\ResponseResolutionerInterface; /** * Import functions @@ -45,41 +45,34 @@ final class CallableMiddleware implements MiddlewareInterface private $callback; /** - * The callback's parameter resolver + * The callback's parameter resolutioner * - * @var ParameterResolverInterface + * @var ParameterResolutionerInterface */ - private ParameterResolverInterface $parameterResolver; + private ParameterResolutionerInterface $parameterResolutioner; /** - * The callback's response resolver + * The callback's response resolutioner * - * @var ResponseResolverInterface + * @var ResponseResolutionerInterface */ - private ResponseResolverInterface $responseResolver; - - /** - * The callback's reflection - * - * @var ReflectionFunction|ReflectionMethod - */ - private ?ReflectionFunctionAbstract $reflection = null; + private ResponseResolutionerInterface $responseResolutioner; /** * Constructor of the class * * @param callable $callback - * @param ParameterResolverInterface $parameterResolver - * @param ResponseResolverInterface $responseResolver + * @param ParameterResolutionerInterface $parameterResolutioner + * @param ResponseResolutionerInterface $responseResolutioner */ public function __construct( callable $callback, - ParameterResolverInterface $parameterResolver, - ResponseResolverInterface $responseResolver + ParameterResolutionerInterface $parameterResolutioner, + ResponseResolutionerInterface $responseResolutioner ) { $this->callback = $callback; - $this->parameterResolver = $parameterResolver; - $this->responseResolver = $responseResolver; + $this->parameterResolutioner = $parameterResolutioner; + $this->responseResolutioner = $responseResolutioner; } /** @@ -91,7 +84,7 @@ public function __construct( */ public function getReflection(): ReflectionFunctionAbstract { - return $this->reflection ??= reflect_callable($this->callback); + return reflect_callable($this->callback); } /** @@ -99,12 +92,17 @@ public function getReflection(): ReflectionFunctionAbstract */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - $arguments = $this->parameterResolver - ->withNames($request->getAttributes()) + $arguments = $this->parameterResolutioner + ->withContext($request) ->withType(ServerRequestInterface::class, $request) ->withType(RequestHandlerInterface::class, $handler) ->resolveParameters(...$this->getReflection()->getParameters()); - return $this->responseResolver->resolveResponse(($this->callback)(...$arguments)); + /** @var mixed */ + $response = ($this->callback)(...$arguments); + + return $this->responseResolutioner + ->withContext($request) + ->resolveResponse($response); } } diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 2c1431f2..46ea269a 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -28,6 +28,7 @@ use function is_object; use function json_decode; use function rtrim; +use function sprintf; use function strpos; use function substr; @@ -43,31 +44,22 @@ * * @since 2.15.0 */ -class JsonPayloadDecodingMiddleware implements MiddlewareInterface +final class JsonPayloadDecodingMiddleware implements MiddlewareInterface { /** * JSON media type * - * @var string - * * @link https://datatracker.ietf.org/doc/html/rfc4627 - */ - private const JSON_MEDIA_TYPE = 'application/json'; - - /** - * JSON decoding options * - * @var int - * - * @link https://www.php.net/json.constants + * @var string */ - protected const JSON_DECODING_OPTIONS = JSON_BIGINT_AS_STRING | JSON_OBJECT_AS_ARRAY; + private const JSON_MEDIA_TYPE = 'application/json'; /** * {@inheritdoc} */ - final public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { if ($this->isSupportedRequest($request)) { $data = $this->decodeRequestJsonPayload($request); @@ -86,7 +78,7 @@ final public function process(ServerRequestInterface $request, RequestHandlerInt */ private function isSupportedRequest(ServerRequestInterface $request): bool { - return $this->getRequestMediaType($request) === self::JSON_MEDIA_TYPE; + return self::JSON_MEDIA_TYPE === $this->getRequestMediaType($request); } /** @@ -94,11 +86,11 @@ private function isSupportedRequest(ServerRequestInterface $request): bool * * Returns null if a media type cannot be retrieved. * + * @link https://tools.ietf.org/html/rfc7231#section-3.1.1.1 + * * @param ServerRequestInterface $request * * @return string|null - * - * @link https://tools.ietf.org/html/rfc7231#section-3.1.1.1 */ private function getRequestMediaType(ServerRequestInterface $request): ?string { @@ -129,8 +121,8 @@ private function getRequestMediaType(ServerRequestInterface $request): ?string */ private function decodeRequestJsonPayload(ServerRequestInterface $request) { - /** @var int */ - $flags = static::JSON_DECODING_OPTIONS; + // https://www.php.net/json.constants + $flags = JSON_BIGINT_AS_STRING | JSON_OBJECT_AS_ARRAY; try { /** @var mixed */ @@ -139,6 +131,11 @@ private function decodeRequestJsonPayload(ServerRequestInterface $request) throw new InvalidPayloadException(sprintf('Invalid Payload: %s', $e->getMessage()), 0, $e); } - return (is_array($result) || is_object($result)) ? $result : null; + if (is_array($result) || + is_object($result)) { + return $result; + } + + return null; } } diff --git a/src/ParameterResolutioner.php b/src/ParameterResolutioner.php new file mode 100644 index 00000000..2cee788d --- /dev/null +++ b/src/ParameterResolutioner.php @@ -0,0 +1,150 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router; + +/** + * Import classes + */ +use ReflectionNamedType; +use ReflectionParameter; +use Psr\Container\ContainerInterface; +use Sunrise\Http\Router\Exception\ParameterResolvingException; + +/** + * ParameterResolutioner + * + * @since 3.0.0 + */ +final class ParameterResolutioner implements ParameterResolutionerInterface +{ + + /** + * The current context + * + * @var mixed + */ + private $context = null; + + /** + * Known types + * + * @var array + */ + private array $types = []; + + /** + * The resolutioner's resolvers + * + * @var list + */ + private array $resolvers = []; + + /** + * The resolutioner's container + * + * @var ContainerInterface|null + */ + private ?ContainerInterface $container = null; + + /** + * {@inheritdoc} + */ + public function withContext($context): ParameterResolutionerInterface + { + $clone = clone $this; + $clone->context = $context; + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function withType(string $type, object $value): ParameterResolutionerInterface + { + $clone = clone $this; + $clone->types[$type] = $value; + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function addResolver(ParameterResolverInterface ...$resolvers): void + { + foreach ($resolvers as $resolver) { + $this->resolvers[] = $resolver; + } + } + + /** + * {@inheritdoc} + */ + public function setContainer(?ContainerInterface $container): void + { + $this->container = $container; + } + + /** + * {@inheritdoc} + */ + public function resolveParameters(ReflectionParameter ...$parameters): array + { + $arguments = []; + foreach ($parameters as $parameter) { + /** @var mixed */ + $arguments[] = $this->resolveParameter($parameter); + } + + return $arguments; + } + + /** + * Tries to resolve the given parameter to an argument + * + * @param ReflectionParameter $parameter + * + * @return mixed + * The ready-to-pass argument. + * + * @throws ParameterResolvingException + * If the parameter cannot be resolved to an argument. + */ + private function resolveParameter(ReflectionParameter $parameter) + { + $type = $parameter->getType(); + if (!($type instanceof ReflectionNamedType)) { + throw ParameterResolvingException::unsupportedParameterTypeDeclaration($parameter); + } + + if (isset($this->types[$type->getName()])) { + return $this->types[$type->getName()]; + } + + foreach ($this->resolvers as $resolver) { + if ($resolver->supportsParameter($parameter, $this->context)) { + return $resolver->resolveParameter($parameter, $this->context); + } + } + + if (isset($this->container) && $this->container->has($type->getName())) { + return $this->container->get($type->getName()); + } + + if ($parameter->isDefaultValueAvailable()) { + return $parameter->getDefaultValue(); + } + + throw ParameterResolvingException::unknownParameter($parameter); + } +} diff --git a/src/ParameterResolutionerInterface.php b/src/ParameterResolutionerInterface.php new file mode 100644 index 00000000..c4f1d3e2 --- /dev/null +++ b/src/ParameterResolutionerInterface.php @@ -0,0 +1,84 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router; + +/** + * Import classes + */ +use ReflectionParameter; +use Psr\Container\ContainerInterface; +use Sunrise\Http\Router\Exception\ParameterResolvingException; + +/** + * ParameterResolutionerInterface + * + * @since 3.0.0 + */ +interface ParameterResolutionerInterface +{ + + /** + * Creates a new instance of the resolutioner with the given current context + * + * Please note that this method MUST NOT change the object state. + * + * @param mixed $context + * + * @return static + */ + public function withContext($context): ParameterResolutionerInterface; + + /** + * Creates a new instance of the resolutioner with the given data for resolve a non-built-in typed parameter + * + * Please note that this method MUST NOT change the object state. + * + * @param class-string $type + * @param T $value + * + * @return static + * + * @template T + */ + public function withType(string $type, object $value): ParameterResolutionerInterface; + + /** + * Adds the given parameter resolver(s) to the resolutioner + * + * @param ParameterResolverInterface ...$resolvers + * + * @return void + */ + public function addResolver(ParameterResolverInterface ...$resolvers): void; + + /** + * Sets the given container to the resolutioner for resolve non-built-in typed parameters + * + * @param ContainerInterface|null $container + * + * @return void + */ + public function setContainer(?ContainerInterface $container): void; + + /** + * Resolves the given parameter(s) to arguments + * + * @param ReflectionParameter ...$parameters + * + * @return list + * List of ready-to-pass arguments. + * + * @throws ParameterResolvingException + * If one of the parameters cannot be resolved to an argument. + */ + public function resolveParameters(ReflectionParameter ...$parameters): array; +} diff --git a/src/ParameterResolver.php b/src/ParameterResolver.php deleted file mode 100644 index 6f5c1771..00000000 --- a/src/ParameterResolver.php +++ /dev/null @@ -1,287 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router; - -/** - * Import classes - */ -use Psr\Container\ContainerInterface; -use ReflectionNamedType; -use ReflectionParameter; - -/** - * ParameterResolver - * - * @since 3.0.0 - */ -final class ParameterResolver implements ParameterResolverInterface -{ - - /** - * Known parameter names - * - * @var array - */ - private array $names = []; - - /** - * Known types - * - * @var array - */ - private array $types = []; - - /** - * The resolver's container - * - * @var ContainerInterface|null - */ - private ?ContainerInterface $container = null; - - /** - * {@inheritdoc} - */ - public function getNames(): array - { - return $this->names; - } - - /** - * {@inheritdoc} - */ - public function getTypes(): array - { - return $this->types; - } - - /** - * {@inheritdoc} - */ - public function getContainer(): ?ContainerInterface - { - return $this->container; - } - - /** - * {@inheritdoc} - */ - public function setContainer(?ContainerInterface $container): void - { - $this->container = $container; - } - - /** - * {@inheritdoc} - */ - public function withName(string $name, $value): ParameterResolverInterface - { - $clone = clone $this; - $clone->setName($name, $value); - - return $clone; - } - - /** - * {@inheritdoc} - */ - public function withNames(array $names): ParameterResolverInterface - { - $clone = clone $this; - foreach ($names as $name => $value) { - $clone->setName($name, $value); - } - - return $clone; - } - - /** - * {@inheritdoc} - */ - public function withType(string $type, $value): ParameterResolverInterface - { - $clone = clone $this; - $clone->setType($type, $value); - - return $clone; - } - - /** - * {@inheritdoc} - */ - public function withTypes(array $types): ParameterResolverInterface - { - $clone = clone $this; - foreach ($types as $type => $value) { - $clone->setType($type, $value); - } - - return $clone; - } - - /** - * {@inheritdoc} - */ - public function resolveParameters(ReflectionParameter ...$parameters): array - { - $arguments = []; - foreach ($parameters as $parameter) { - $arguments[] = $this->resolveParameter($parameter); - } - - return $arguments; - } - - /** - * Sets a new known name - * - * @param string $name - * @param mixed $value - * - * @return void - */ - private function setName(string $name, $value): void - { - $this->names[$name] = $value; - } - - /** - * Sets a new known type - * - * @param string $type - * @param mixed $value - * - * @return void - * - * @throws LogicException - * If the value isn't an instance of the type. - */ - private function setType(string $type, $value): void - { - if (!($value instanceof $type)) { - throw new LogicException(); - } - - $this->types[$type] = $value; - } - - /** - * Resolves the given parameter - * - * @param ReflectionParameter $parameter - * - * @return mixed - * - * @throws LogicException - * If the parameter cannot be resolved. - */ - private function resolveParameter(ReflectionParameter $parameter) - { - if (!$parameter->hasType()) { - return $this->resolveUntypedParameter($parameter); - } - - $type = $parameter->getType(); - if (!($type instanceof ReflectionNamedType)) { - throw new LogicException(); - } - - return !$type->isBuiltin() ? - $this->resolveTypedParameterWithNonBuiltinType($type, $parameter) : - $this->resolveTypedParameterWithBuiltinType($type, $parameter); - } - - /** - * Resolves the given untyped parameter - * - * @param ReflectionParameter $parameter - * - * @return mixed - * - * @throws LogicException - * If the parameter cannot be resolved. - */ - private function resolveUntypedParameter(ReflectionParameter $parameter) - { - if (array_key_exists($parameter->getName(), $this->names)) { - return $this->names[$parameter->getName()]; - } - - if ($parameter->isDefaultValueAvailable()) { - return $parameter->getDefaultValue(); - } - - throw new LogicException(); - } - - /** - * Resolves the given typed parameter with non-built-in type - * - * @param ReflectionNamedType $type - * @param ReflectionParameter $parameter - * - * @return mixed - * - * @throws LogicException - * If the parameter cannot be resolved. - */ - private function resolveTypedParameterWithNonBuiltinType(ReflectionNamedType $type, ReflectionParameter $parameter) - { - if (isset($this->types[$parameter->getName()])) { - return $this->types[$parameter->getName()]; - } - - if (isset($this->container) && $this->container->has($type->getName())) { - return $this->container->get($type->getName()); - } - - if ($parameter->isDefaultValueAvailable()) { - return $parameter->getDefaultValue(); - } - - throw new LogicException(); - } - - /** - * Resolves the given typed parameter with built-in type - * - * @param ReflectionNamedType $type - * @param ReflectionParameter $parameter - * - * @return mixed - * - * @throws LogicException - * If the parameter cannot be resolved. - */ - private function resolveTypedParameterWithBuiltinType(ReflectionNamedType $type, ReflectionParameter $parameter) - { - if (!array_key_exists($parameter->getName(), $this->names)) { - if ($parameter->isDefaultValueAvailable()) { - return $parameter->getDefaultValue(); - } - - throw new LogicException(); - } - - switch ($type->getName()) { - case 'bool': - break; - case 'int': - break; - case 'float': - break; - case 'string': - break; - } - - throw new LogicException(); - } -} diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php new file mode 100644 index 00000000..14745c93 --- /dev/null +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -0,0 +1,120 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\ParameterResolver; + +/** + * Import classes + */ +use Psr\Http\Message\ServerRequestInterface; +use Sunrise\Http\Router\Annotation\RequestBody; +use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; +use Sunrise\Http\Router\Exception\ParameterResolvingException; +use Sunrise\Http\Router\ParameterResolverInterface; +use Sunrise\Http\Router\RequestBodyInterface; +use Sunrise\Hydrator\Exception\InvalidObjectException; +use Sunrise\Hydrator\Exception\InvalidValueException; +use Sunrise\Hydrator\HydratorInterface; +use Sunrise\Hydrator\Hydrator; +use ReflectionNamedType; +use ReflectionParameter; + +/** + * Import constants + */ +use const PHP_MAJOR_VERSION; + +/** + * RequestBodyParameterResolver + * + * @link https://github.com/sunrise-php/hydrator + * + * @since 3.0.0 + */ +final class RequestBodyParameterResolver implements ParameterResolverInterface +{ + + /** + * @var HydratorInterface|null + */ + private ?HydratorInterface $hydrator = null; + + /** + * @param HydratorInterface|null $hydrator + */ + public function __construct(?HydratorInterface $hydrator = null) + { + $this->hydrator = $hydrator; + } + + /** + * @return HydratorInterface + */ + private function getHydrator(): HydratorInterface + { + if (isset($this->hydrator)) { + return $this->hydrator; + } + + $this->hydrator = new Hydrator(); + + // auto-enable annotation support for php 7 + if (7 === PHP_MAJOR_VERSION) { + $this->hydrator->useAnnotations(); + } + + return $this->hydrator; + } + + /** + * {@inheritdoc} + */ + public function supportsParameter(ReflectionParameter $parameter, $context): bool + { + if (!($context instanceof ServerRequestInterface)) { + return false; + } + + if (!($parameter->getType() instanceof ReflectionNamedType)) { + return false; + } + + if ($parameter->getType()->getName() instanceof RequestBodyInterface) { + return true; + } + + if (8 === PHP_MAJOR_VERSION && $parameter->getAttributes(RequestBody::class)) { + return true; + } + + return false; + } + + /** + * {@inheritdoc} + */ + public function resolveParameter(ReflectionParameter $parameter, $context) + { + /** @var ServerRequestInterface */ + $context = $context; + + /** @var ReflectionNamedType */ + $parameterType = $parameter->getType(); + + try { + return $this->getHydrator()->hydrate($parameterType->getName(), (array) $context->getParsedBody()); + } catch (InvalidObjectException $e) { + throw new ParameterResolvingException($e->getMessage(), 0, $e); + } catch (InvalidValueException $e) { + throw new HttpUnprocessableEntityException($e->getMessage(), 0, $e); + } + } +} diff --git a/src/ParameterResolverInterface.php b/src/ParameterResolverInterface.php index 281faed7..0a6de0e8 100644 --- a/src/ParameterResolverInterface.php +++ b/src/ParameterResolverInterface.php @@ -11,6 +11,12 @@ namespace Sunrise\Http\Router; +/** + * Import classes + */ +use ReflectionParameter; +use Sunrise\Http\Router\Exception\ParameterResolvingException; + /** * ParameterResolverInterface * @@ -18,4 +24,28 @@ */ interface ParameterResolverInterface { + + /** + * Checks if the given parameter is supported + * + * @param ReflectionParameter $parameter + * @param mixed $context + * + * @return bool + */ + public function supportsParameter(ReflectionParameter $parameter, $context): bool; + + /** + * Resolves the given parameter to an argument + * + * @param ReflectionParameter $parameter + * @param mixed $context + * + * @return mixed + * The ready-to-pass argument. + * + * @throws ParameterResolvingException + * If the parameter cannot be resolved to an argument. + */ + public function resolveParameter(ReflectionParameter $parameter, $context); } diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index 9e25e165..4a06deb8 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -47,20 +47,6 @@ class ReferenceResolver implements ReferenceResolverInterface */ private ?ContainerInterface $container = null; - /** - * The reference resolver's parameter resolver - * - * @var ParameterResolverInterface|null - */ - private ?ParameterResolverInterface $parameterResolver = null; - - /** - * The reference resolver's response resolver - * - * @var ResponseResolverInterface|null - */ - private ?ResponseResolverInterface $responseResolver = null; - /** * {@inheritdoc} */ @@ -77,22 +63,6 @@ public function setContainer(?ContainerInterface $container): void $this->container = $container; } - /** - * {@inheritdoc} - */ - public function getResponseResolver(): ?ResponseResolverInterface - { - return $this->responseResolver; - } - - /** - * {@inheritdoc} - */ - public function setResponseResolver(?ResponseResolverInterface $responseResolver): void - { - $this->responseResolver = $responseResolver; - } - /** * {@inheritdoc} */ @@ -103,7 +73,7 @@ public function toRequestHandler($reference): RequestHandlerInterface } if ($reference instanceof Closure) { - return new CallableRequestHandler($reference, $this->responseResolver); + // return new CallableRequestHandler($reference, $this->parameterResolver, $this->responseResolver); } list($class, $method) = $this->normalizeReference($reference); @@ -112,7 +82,7 @@ public function toRequestHandler($reference): RequestHandlerInterface /** @var callable */ $callback = [$this->resolveClass($class), $method]; - return new CallableRequestHandler($callback, $this->responseResolver); + // return new CallableRequestHandler($callback, $this->parameterResolver, $this->responseResolver); } if (!isset($method) && isset($class) && is_subclass_of($class, RequestHandlerInterface::class)) { @@ -135,13 +105,16 @@ public function toMiddleware($reference): MiddlewareInterface } if ($reference instanceof Closure) { - return new CallableMiddleware($reference); + // return new CallableMiddleware($reference, $this->parameterResolver, $this->responseResolver); } list($class, $method) = $this->normalizeReference($reference); if (isset($class) && isset($method) && method_exists($class, $method)) { - return new CallableMiddleware([$this->resolveClass($class), $method]); + /** @var callable */ + $callback = [$this->resolveClass($class), $method]; + + // return new CallableMiddleware($callback, $this->parameterResolver, $this->responseResolver); } if (!isset($method) && isset($class) && is_subclass_of($class, MiddlewareInterface::class)) { diff --git a/src/ReferenceResolverInterface.php b/src/ReferenceResolverInterface.php index a939fa1c..67b6208d 100644 --- a/src/ReferenceResolverInterface.php +++ b/src/ReferenceResolverInterface.php @@ -43,26 +43,6 @@ public function getContainer(): ?ContainerInterface; */ public function setContainer(?ContainerInterface $container): void; - /** - * Gets the reference resolver's response resolver - * - * @return ResponseResolverInterface|null - * - * @since 3.0.0 - */ - public function getResponseResolver(): ?ResponseResolverInterface; - - /** - * Sets the given response resolver to the reference resolver - * - * @param ResponseResolverInterface|null $responseResolver - * - * @return void - * - * @since 3.0.0 - */ - public function setResponseResolver(?ResponseResolverInterface $responseResolver): void; - /** * Resolves the given reference to a request handler * diff --git a/src/RequestBodyInterface.php b/src/RequestBodyInterface.php new file mode 100644 index 00000000..b6610e37 --- /dev/null +++ b/src/RequestBodyInterface.php @@ -0,0 +1,21 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router; + +/** + * RequestBodyInterface + * + * @since 3.0.0 + */ +interface RequestBodyInterface +{ +} diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index c2bd086a..aaf00728 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -14,14 +14,14 @@ /** * Import classes */ -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\ParameterResolverInterface; -use Sunrise\Http\Router\ResponseResolverInterface; use ReflectionFunctionAbstract; use ReflectionFunction; use ReflectionMethod; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\ParameterResolutionerInterface; +use Sunrise\Http\Router\ResponseResolutionerInterface; /** * Import functions @@ -42,41 +42,34 @@ final class CallableRequestHandler implements RequestHandlerInterface private $callback; /** - * The callback's parameter resolver + * The callback's parameter resolutioner * - * @var ParameterResolverInterface + * @var ParameterResolutionerInterface */ - private ParameterResolverInterface $parameterResolver; + private ParameterResolutionerInterface $parameterResolutioner; /** - * The callback's response resolver + * The callback's response resolutioner * - * @var ResponseResolverInterface + * @var ResponseResolutionerInterface */ - private ResponseResolverInterface $responseResolver; - - /** - * The callback's reflection - * - * @var ReflectionFunction|ReflectionMethod - */ - private ?ReflectionFunctionAbstract $reflection = null; + private ResponseResolutionerInterface $responseResolutioner; /** * Constructor of the class * * @param callable $callback - * @param ParameterResolverInterface $parameterResolver - * @param ResponseResolverInterface $responseResolver + * @param ParameterResolutionerInterface $parameterResolutioner + * @param ResponseResolutionerInterface $responseResolutioner */ public function __construct( callable $callback, - ParameterResolverInterface $parameterResolver, - ResponseResolverInterface $responseResolver + ParameterResolutionerInterface $parameterResolutioner, + ResponseResolutionerInterface $responseResolutioner ) { $this->callback = $callback; - $this->parameterResolver = $parameterResolver; - $this->responseResolver = $responseResolver; + $this->parameterResolutioner = $parameterResolutioner; + $this->responseResolutioner = $responseResolutioner; } /** @@ -88,7 +81,7 @@ public function __construct( */ public function getReflection(): ReflectionFunctionAbstract { - return $this->reflection ??= reflect_callable($this->callback); + return reflect_callable($this->callback); } /** @@ -96,11 +89,16 @@ public function getReflection(): ReflectionFunctionAbstract */ public function handle(ServerRequestInterface $request): ResponseInterface { - $arguments = $this->parameterResolver - ->withNames($request->getAttributes()) + $arguments = $this->parameterResolutioner + ->withContext($request) ->withType(ServerRequestInterface::class, $request) ->resolveParameters(...$this->getReflection()->getParameters()); - return $this->responseResolver->resolveResponse(($this->callback)(...$arguments)); + /** @var mixed */ + $response = ($this->callback)(...$arguments); + + return $this->responseResolutioner + ->withContext($request) + ->resolveResponse($response); } } diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index 00282bff..62f62a4b 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -14,11 +14,11 @@ /** * Import classes */ +use SplQueue; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use SplQueue; /** * QueueableRequestHandler diff --git a/src/ResponseResolver.php b/src/ResponseResolutioner.php similarity index 64% rename from src/ResponseResolver.php rename to src/ResponseResolutioner.php index dcbc6703..0b16fe5d 100644 --- a/src/ResponseResolver.php +++ b/src/ResponseResolutioner.php @@ -18,13 +18,31 @@ use Sunrise\Http\Router\Exception\LogicException; /** - * ResponseResolver + * ResponseResolutioner * * @since 3.0.0 */ -final class ResponseResolver implements ResponseResolverInterface +final class ResponseResolutioner implements ResponseResolutionerInterface { + /** + * The current context + * + * @var mixed + */ + private $context = null; + + /** + * {@inheritdoc} + */ + public function withContext($context): ResponseResolutionerInterface + { + $clone = clone $this; + $clone->context = $context; + + return $clone; + } + /** * {@inheritdoc} */ diff --git a/src/ResponseResolverInterface.php b/src/ResponseResolutionerInterface.php similarity index 68% rename from src/ResponseResolverInterface.php rename to src/ResponseResolutionerInterface.php index af0c7f04..cbbb3bb5 100644 --- a/src/ResponseResolverInterface.php +++ b/src/ResponseResolutionerInterface.php @@ -18,13 +18,24 @@ use Sunrise\Http\Router\Exception\LogicException; /** - * ResponseResolverInterface + * ResponseResolutionerInterface * * @since 3.0.0 */ -interface ResponseResolverInterface +interface ResponseResolutionerInterface { + /** + * Creates a new instance of the resolutioner with the given current context + * + * Please note that this method MUST NOT change the object state. + * + * @param mixed $context + * + * @return static + */ + public function withContext($context): ResponseResolutionerInterface; + /** * Resolves the given raw response to the response object * diff --git a/src/RouteCollector.php b/src/RouteCollector.php index 3e76ad6a..b0f92900 100644 --- a/src/RouteCollector.php +++ b/src/RouteCollector.php @@ -106,32 +106,6 @@ public function setContainer(?ContainerInterface $container) : void $this->referenceResolver->setContainer($container); } - /** - * Gets the collector response resolver - * - * @return ResponseResolverInterface|null - * - * @since 3.0.0 - */ - public function getResponseResolver(): ?ResponseResolverInterface - { - return $this->referenceResolver->getResponseResolver(); - } - - /** - * Sets the given response resolver to the collector - * - * @param ResponseResolverInterface|null $responseResolver - * - * @return void - * - * @since 3.0.0 - */ - public function setResponseResolver(?ResponseResolverInterface $responseResolver): void - { - $this->referenceResolver->setResponseResolver($responseResolver); - } - /** * Makes a new route from the given parameters * diff --git a/src/Router.php b/src/Router.php index 1b21d50a..d3365bcc 100644 --- a/src/Router.php +++ b/src/Router.php @@ -489,12 +489,7 @@ public function run(ServerRequestInterface $request) : ResponseInterface $this->matchedRoute = $route; if (isset($this->eventDispatcher)) { - $event = new RouteEvent($route, $request); - - /** @psalm-suppress TooManyArguments */ - $this->eventDispatcher->dispatch($event, RouteEvent::NAME); - - $request = $event->getRequest(); + $this->eventDispatcher->dispatch(new RouteEvent($route, $request)); } return $route->handle($request); @@ -520,12 +515,7 @@ public function handle(ServerRequestInterface $request) : ResponseInterface $this->matchedRoute = $route; if (isset($this->eventDispatcher)) { - $event = new RouteEvent($route, $request); - - /** @psalm-suppress TooManyArguments */ - $this->eventDispatcher->dispatch($event, RouteEvent::NAME); - - $request = $event->getRequest(); + $this->eventDispatcher->dispatch(new RouteEvent($route, $request)); } $middlewares = $this->getMiddlewares(); diff --git a/src/RouterBuilder.php b/src/RouterBuilder.php index fcc38a62..a0dbbeb9 100644 --- a/src/RouterBuilder.php +++ b/src/RouterBuilder.php @@ -39,11 +39,6 @@ final class RouterBuilder */ private $container = null; - /** - * @var ResponseResolverInterface|null - */ - private $responseResolver = null; - /** * @var CacheInterface|null */ @@ -109,20 +104,6 @@ public function setContainer(?ContainerInterface $container) : self return $this; } - /** - * Sets the given response resolver to the builder - * - * @param ResponseResolverInterface|null $responseResolver - * - * @return self - */ - public function setResponseResolver(?ResponseResolverInterface $responseResolver) : self - { - $this->responseResolver = $responseResolver; - - return $this; - } - /** * Sets the given cache to the builder * @@ -258,13 +239,11 @@ public function build() : Router if (isset($this->configLoader)) { $this->configLoader->setContainer($this->container); - $this->configLoader->setResponseResolver($this->responseResolver); $router->load($this->configLoader); } if (isset($this->descriptorLoader)) { $this->descriptorLoader->setContainer($this->container); - $this->descriptorLoader->setResponseResolver($this->responseResolver); $this->descriptorLoader->setCache($this->cache); $this->descriptorLoader->setCacheKey($this->cacheKey); $router->load($this->descriptorLoader); From 81a7a683b2f0c6f1ecdf90d13fc2f13a1bc57865 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 15 Jan 2023 21:14:26 +0100 Subject: [PATCH 030/180] v3 --- composer.json | 7 +- functions/get_debug_type.php | 47 ++++++++++ src/Annotation/Middleware.php | 5 +- src/Annotation/Route.php | 25 +++--- src/Exception/ParameterResolvingException.php | 38 +-------- src/Exception/ReferenceResolvingException.php | 21 +++++ src/Exception/ResolvingException.php | 21 +++++ src/Exception/ResponseResolvingException.php | 21 +++++ src/Loader/ConfigLoader.php | 12 --- src/Loader/DescriptorLoader.php | 14 +-- src/ParameterResolutioner.php | 27 ++++-- .../RequestBodyParameterResolver.php | 34 ++------ src/ReferenceResolver.php | 85 ++++++++++++++----- src/ReferenceResolverInterface.php | 29 +++---- src/ResponseResolutioner.php | 36 +++++++- src/ResponseResolutionerInterface.php | 17 +++- .../StatusCodeResponseResolver.php | 64 ++++++++++++++ src/ResponseResolverInterface.php | 50 +++++++++++ src/RouteCollector.php | 36 +++----- src/Router.php | 20 +++-- 20 files changed, 419 insertions(+), 190 deletions(-) create mode 100644 functions/get_debug_type.php create mode 100644 src/Exception/ReferenceResolvingException.php create mode 100644 src/Exception/ResolvingException.php create mode 100644 src/Exception/ResponseResolvingException.php create mode 100644 src/ResponseResolver/StatusCodeResponseResolver.php create mode 100644 src/ResponseResolverInterface.php diff --git a/composer.json b/composer.json index 36e331d7..9c9cb8b8 100644 --- a/composer.json +++ b/composer.json @@ -33,20 +33,21 @@ "psr/http-message": "^1.0", "psr/http-server-handler": "^1.0", "psr/http-server-middleware": "^1.0", - "psr/simple-cache": "^1.0", - "sunrise/hydrator": "^2.7" + "psr/simple-cache": "^1.0" }, "require-dev": { + "doctrine/annotations": "^2.0", "phpunit/phpunit": "~9.5.0", "sunrise/coding-standard": "~1.0.0", "sunrise/http-message": "^3.0", - "doctrine/annotations": "^1.6", + "sunrise/hydrator": "^2.7", "symfony/console": "^5.4", "symfony/event-dispatcher": "^4.4" }, "autoload": { "files": [ "functions/emit.php", + "functions/get_debug_type.php", "functions/path_build.php", "functions/path_match.php", "functions/path_parse.php", diff --git a/functions/get_debug_type.php b/functions/get_debug_type.php new file mode 100644 index 00000000..282b5875 --- /dev/null +++ b/functions/get_debug_type.php @@ -0,0 +1,47 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +if (PHP_MAJOR_VERSION < 8) { + + /** + * Polyfill for the get_debug_type function + * + * @param mixed $value + * + * @return string + * + * @since 3.0.0 + */ + function get_debug_type($value): string + { + if (null === $value) { + return 'null'; + } + + if (is_bool($value)) { + return 'bool'; + } + + if (is_int($value)) { + return 'int'; + } + + if (is_float($value)) { + return 'float'; + } + + if (is_object($value)) { + return get_class($value); + } + + return gettype($value); + } +} diff --git a/src/Annotation/Middleware.php b/src/Annotation/Middleware.php index 1d339476..275b0e17 100644 --- a/src/Annotation/Middleware.php +++ b/src/Annotation/Middleware.php @@ -15,7 +15,6 @@ * Import classes */ use Attribute; -use Psr\Http\Server\MiddlewareInterface; /** * @Annotation @@ -37,14 +36,14 @@ final class Middleware /** * The attribute value * - * @var class-string + * @var class-string */ public string $value; /** * Constructor of the class * - * @param class-string $value + * @param class-string $value */ public function __construct(string $value) { diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index f2fce7b2..a25293bf 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -16,7 +16,6 @@ */ use Attribute; use Fig\Http\Message\RequestMethodInterface; -use Psr\Http\Server\MiddlewareInterface; /** * @Annotation @@ -83,7 +82,7 @@ final class Route implements RequestMethodInterface /** * The route middlewares * - * @var list> + * @var list */ public array $middlewares; @@ -125,17 +124,17 @@ final class Route implements RequestMethodInterface /** * Constructor of the class * - * @param string $name The route name - * @param string|null $host The route host - * @param string $path The route path - * @param string|null $method The route method - * @param list $methods The route methods - * @param list> $middlewares The route middlewares - * @param array $attributes The route attributes - * @param string $summary The route summary - * @param string $description The route description - * @param list $tags The route tags - * @param int $priority The route priority (default 0) + * @param string $name The route name + * @param string|null $host The route host + * @param string $path The route path + * @param string|null $method The route method + * @param list $methods The route methods + * @param list $middlewares The route middlewares + * @param array $attributes The route attributes + * @param string $summary The route summary + * @param string $description The route description + * @param list $tags The route tags + * @param int $priority The route priority (default 0) */ public function __construct( string $name, diff --git a/src/Exception/ParameterResolvingException.php b/src/Exception/ParameterResolvingException.php index 81773b51..ad85b9cf 100644 --- a/src/Exception/ParameterResolvingException.php +++ b/src/Exception/ParameterResolvingException.php @@ -11,47 +11,11 @@ namespace Sunrise\Http\Router\Exception; -/** - * Import classes - */ -use ReflectionParameter; - -/** - * Import functions - */ -use function sprintf; - /** * ParameterResolvingException * * @since 3.0.0 */ -class ParameterResolvingException extends Exception +class ParameterResolvingException extends ResolvingException { - - /** - * @return self - */ - final public static function unsupportedParameterTypeDeclaration(ReflectionParameter $parameter): self - { - return new self(sprintf( - '%s($%s[%d]): Unsupported parameter type declaration', - $parameter->getDeclaringFunction()->getName(), - $parameter->getName(), - $parameter->getPosition() - )); - } - - /** - * @return self - */ - final public static function unknownParameter(ReflectionParameter $parameter): self - { - return new self(sprintf( - '%s($%s[%d]): Unknown parameter', - $parameter->getDeclaringFunction()->getName(), - $parameter->getName(), - $parameter->getPosition() - )); - } } diff --git a/src/Exception/ReferenceResolvingException.php b/src/Exception/ReferenceResolvingException.php new file mode 100644 index 00000000..9a8387b7 --- /dev/null +++ b/src/Exception/ReferenceResolvingException.php @@ -0,0 +1,21 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * ReferenceResolvingException + * + * @since 3.0.0 + */ +class ReferenceResolvingException extends ResolvingException +{ +} diff --git a/src/Exception/ResolvingException.php b/src/Exception/ResolvingException.php new file mode 100644 index 00000000..4fafb2a5 --- /dev/null +++ b/src/Exception/ResolvingException.php @@ -0,0 +1,21 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * ResolvingException + * + * @since 3.0.0 + */ +class ResolvingException extends Exception +{ +} diff --git a/src/Exception/ResponseResolvingException.php b/src/Exception/ResponseResolvingException.php new file mode 100644 index 00000000..6b4db132 --- /dev/null +++ b/src/Exception/ResponseResolvingException.php @@ -0,0 +1,21 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * ResponseResolvingException + * + * @since 3.0.0 + */ +class ResponseResolvingException extends ResolvingException +{ +} diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index 0a70af38..4b64bab4 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -76,18 +76,6 @@ public function __construct( $this->referenceResolver = $referenceResolver ?? new ReferenceResolver(); } - /** - * Gets the loader container - * - * @return ContainerInterface|null - * - * @since 2.9.0 - */ - public function getContainer(): ?ContainerInterface - { - return $this->referenceResolver->getContainer(); - } - /** * Sets the given container to the loader * diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 557079d2..c5b0bde2 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -121,16 +121,6 @@ public function __construct( } } - /** - * Gets the loader container - * - * @return ContainerInterface|null - */ - public function getContainer(): ?ContainerInterface - { - return $this->referenceResolver->getContainer(); - } - /** * Sets the given container to the loader * @@ -295,8 +285,8 @@ public function load(): RouteCollectionInterface $descriptor->name, $descriptor->path, $descriptor->methods, - $this->referenceResolver->toRequestHandler($descriptor->holder), - $this->referenceResolver->toMiddlewares($descriptor->middlewares), + $this->referenceResolver->resolveRequestHandler($descriptor->holder), + $this->referenceResolver->resolveMiddlewares($descriptor->middlewares), $descriptor->attributes ) ->setHost($descriptor->host) diff --git a/src/ParameterResolutioner.php b/src/ParameterResolutioner.php index 2cee788d..780bd6db 100644 --- a/src/ParameterResolutioner.php +++ b/src/ParameterResolutioner.php @@ -19,6 +19,11 @@ use Psr\Container\ContainerInterface; use Sunrise\Http\Router\Exception\ParameterResolvingException; +/** + * Import functions + */ +use function sprintf; + /** * ParameterResolutioner * @@ -123,12 +128,11 @@ public function resolveParameters(ReflectionParameter ...$parameters): array private function resolveParameter(ReflectionParameter $parameter) { $type = $parameter->getType(); - if (!($type instanceof ReflectionNamedType)) { - throw ParameterResolvingException::unsupportedParameterTypeDeclaration($parameter); - } - if (isset($this->types[$type->getName()])) { - return $this->types[$type->getName()]; + if (($type instanceof ReflectionNamedType) && !$type->isBuiltin()) { + if (isset($this->types[$type->getName()])) { + return $this->types[$type->getName()]; + } } foreach ($this->resolvers as $resolver) { @@ -137,14 +141,21 @@ private function resolveParameter(ReflectionParameter $parameter) } } - if (isset($this->container) && $this->container->has($type->getName())) { - return $this->container->get($type->getName()); + if (($type instanceof ReflectionNamedType) && !$type->isBuiltin()) { + if (isset($this->container) && $this->container->has($type->getName())) { + return $this->container->get($type->getName()); + } } if ($parameter->isDefaultValueAvailable()) { return $parameter->getDefaultValue(); } - throw ParameterResolvingException::unknownParameter($parameter); + throw new ParameterResolvingException(sprintf( + 'Unexpected parameter {%s($%s[%d])}', + $parameter->getDeclaringFunction()->getName(), + $parameter->getName(), + $parameter->getPosition() + )); } } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 14745c93..001d9c32 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -23,7 +23,6 @@ use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; -use Sunrise\Hydrator\Hydrator; use ReflectionNamedType; use ReflectionParameter; @@ -43,37 +42,18 @@ final class RequestBodyParameterResolver implements ParameterResolverInterface { /** - * @var HydratorInterface|null + * @var HydratorInterface */ - private ?HydratorInterface $hydrator = null; + private HydratorInterface $hydrator; /** - * @param HydratorInterface|null $hydrator + * @param HydratorInterface $hydrator */ - public function __construct(?HydratorInterface $hydrator = null) + public function __construct(HydratorInterface $hydrator) { $this->hydrator = $hydrator; } - /** - * @return HydratorInterface - */ - private function getHydrator(): HydratorInterface - { - if (isset($this->hydrator)) { - return $this->hydrator; - } - - $this->hydrator = new Hydrator(); - - // auto-enable annotation support for php 7 - if (7 === PHP_MAJOR_VERSION) { - $this->hydrator->useAnnotations(); - } - - return $this->hydrator; - } - /** * {@inheritdoc} */ @@ -87,6 +67,10 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo return false; } + if ($parameter->getType()->isBuiltin()) { + return false; + } + if ($parameter->getType()->getName() instanceof RequestBodyInterface) { return true; } @@ -110,7 +94,7 @@ public function resolveParameter(ReflectionParameter $parameter, $context) $parameterType = $parameter->getType(); try { - return $this->getHydrator()->hydrate($parameterType->getName(), (array) $context->getParsedBody()); + return $this->hydrator->hydrate($parameterType->getName(), (array) $context->getParsedBody()); } catch (InvalidObjectException $e) { throw new ParameterResolvingException($e->getMessage(), 0, $e); } catch (InvalidValueException $e) { diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index 4a06deb8..ce0025e3 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -21,6 +21,7 @@ use Sunrise\Http\Router\Middleware\CallableMiddleware; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use Closure; +use ReflectionClass; /** * Import functions @@ -41,18 +42,37 @@ class ReferenceResolver implements ReferenceResolverInterface { /** - * The reference resolver container + * The resolver's parameter resolutioner + * + * @var ParameterResolutionerInterface + */ + private ParameterResolutionerInterface $parameterResolutioner; + /** + * The resolver's response resolutioner + * + * @var ResponseResolutionerInterface + */ + private ResponseResolutionerInterface $responseResolutioner; + + /** + * The resolver's container * * @var ContainerInterface|null */ private ?ContainerInterface $container = null; /** - * {@inheritdoc} + * Constructor of the class + * + * @param ParameterResolutionerInterface|null $parameterResolutioner + * @param ResponseResolutionerInterface|null $responseResolutioner */ - public function getContainer(): ?ContainerInterface - { - return $this->container; + public function __construct( + ?ParameterResolutionerInterface $parameterResolutioner = null, + ?ResponseResolutionerInterface $responseResolutioner = null + ) { + $this->parameterResolutioner = $parameterResolutioner ?? new ParameterResolutioner(); + $this->responseResolutioner = $responseResolutioner ?? new ResponseResolutioner(); } /** @@ -61,28 +81,34 @@ public function getContainer(): ?ContainerInterface public function setContainer(?ContainerInterface $container): void { $this->container = $container; + $this->parameterResolutioner->setContainer($container); } /** * {@inheritdoc} */ - public function toRequestHandler($reference): RequestHandlerInterface + public function resolveRequestHandler($reference): RequestHandlerInterface { if ($reference instanceof RequestHandlerInterface) { return $reference; } if ($reference instanceof Closure) { - // return new CallableRequestHandler($reference, $this->parameterResolver, $this->responseResolver); + return new CallableRequestHandler( + $reference, + $this->parameterResolutioner, + $this->responseResolutioner + ); } list($class, $method) = $this->normalizeReference($reference); if (isset($class) && isset($method) && method_exists($class, $method)) { - /** @var callable */ - $callback = [$this->resolveClass($class), $method]; - - // return new CallableRequestHandler($callback, $this->parameterResolver, $this->responseResolver); + return new CallableRequestHandler( + [$this->resolveClass($class), $method], + $this->parameterResolutioner, + $this->responseResolutioner + ); } if (!isset($method) && isset($class) && is_subclass_of($class, RequestHandlerInterface::class)) { @@ -98,23 +124,28 @@ public function toRequestHandler($reference): RequestHandlerInterface /** * {@inheritdoc} */ - public function toMiddleware($reference): MiddlewareInterface + public function resolveMiddleware($reference): MiddlewareInterface { if ($reference instanceof MiddlewareInterface) { return $reference; } if ($reference instanceof Closure) { - // return new CallableMiddleware($reference, $this->parameterResolver, $this->responseResolver); + return new CallableMiddleware( + $reference, + $this->parameterResolutioner, + $this->responseResolutioner + ); } list($class, $method) = $this->normalizeReference($reference); if (isset($class) && isset($method) && method_exists($class, $method)) { - /** @var callable */ - $callback = [$this->resolveClass($class), $method]; - - // return new CallableMiddleware($callback, $this->parameterResolver, $this->responseResolver); + return new CallableMiddleware( + [$this->resolveClass($class), $method], + $this->parameterResolutioner, + $this->responseResolutioner + ); } if (!isset($method) && isset($class) && is_subclass_of($class, MiddlewareInterface::class)) { @@ -130,12 +161,12 @@ public function toMiddleware($reference): MiddlewareInterface /** * {@inheritdoc} */ - public function toMiddlewares(array $references): array + public function resolveMiddlewares(array $references): array { $middlewares = []; /** @psalm-suppress MixedAssignment */ foreach ($references as $reference) { - $middlewares[] = $this->toMiddleware($reference); + $middlewares[] = $this->resolveMiddleware($reference); } return $middlewares; @@ -201,7 +232,19 @@ private function resolveClass(string $className) return $this->container->get($className); } - /** @psalm-suppress MixedMethodCall */ - return new $className; + $reflection = new ReflectionClass($className); + if (!$reflection->isInstantiable()) { + throw new ReferenceResolvingException(); + } + + $arguments = []; + $constructor = $reflection->getConstructor(); + if (isset($constructor)) { + $arguments = $this->parameterResolutioner->resolveParameters( + ...$constructor->getParameters() + ); + } + + return new $className(...$arguments); } } diff --git a/src/ReferenceResolverInterface.php b/src/ReferenceResolverInterface.php index 67b6208d..25916e85 100644 --- a/src/ReferenceResolverInterface.php +++ b/src/ReferenceResolverInterface.php @@ -17,7 +17,7 @@ use Psr\Container\ContainerInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\InvalidReferenceException; +use Sunrise\Http\Router\Exception\ReferenceResolvingException; /** * ReferenceResolverInterface @@ -28,14 +28,7 @@ interface ReferenceResolverInterface { /** - * Gets the reference resolver container - * - * @return ContainerInterface|null - */ - public function getContainer(): ?ContainerInterface; - - /** - * Sets the given container to the reference resolver + * Sets the given container to the resolver * * @param ContainerInterface|null $container * @@ -50,10 +43,10 @@ public function setContainer(?ContainerInterface $container): void; * * @return RequestHandlerInterface * - * @throws InvalidReferenceException - * If the given reference cannot be resolved to a request handler. + * @throws ReferenceResolvingException + * If the reference cannot be resolved to a request handler. */ - public function toRequestHandler($reference): RequestHandlerInterface; + public function resolveRequestHandler($reference): RequestHandlerInterface; /** * Resolves the given reference to a middleware @@ -62,10 +55,10 @@ public function toRequestHandler($reference): RequestHandlerInterface; * * @return MiddlewareInterface * - * @throws InvalidReferenceException - * If the given reference cannot be resolved to a middleware. + * @throws ReferenceResolvingException + * If the reference cannot be resolved to a middleware. */ - public function toMiddleware($reference): MiddlewareInterface; + public function resolveMiddleware($reference): MiddlewareInterface; /** * Resolves the given references to middlewares @@ -74,10 +67,10 @@ public function toMiddleware($reference): MiddlewareInterface; * * @return list * - * @throws InvalidReferenceException - * If one of the given references cannot be resolved to a middleware. + * @throws ReferenceResolvingException + * If one of the references cannot be resolved to a middleware. * * @since 3.0.0 */ - public function toMiddlewares(array $references): array; + public function resolveMiddlewares(array $references): array; } diff --git a/src/ResponseResolutioner.php b/src/ResponseResolutioner.php index 0b16fe5d..f5147350 100644 --- a/src/ResponseResolutioner.php +++ b/src/ResponseResolutioner.php @@ -15,7 +15,13 @@ * Import classes */ use Psr\Http\Message\ResponseInterface; -use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\Exception\ResponseResolvingException; + +/** + * Import functions + */ +use function get_debug_type; +use function sprintf; /** * ResponseResolutioner @@ -32,6 +38,13 @@ final class ResponseResolutioner implements ResponseResolutionerInterface */ private $context = null; + /** + * The resolutioner's resolvers + * + * @var list + */ + private array $resolvers = []; + /** * {@inheritdoc} */ @@ -43,6 +56,16 @@ public function withContext($context): ResponseResolutionerInterface return $clone; } + /** + * {@inheritdoc} + */ + public function addResolver(ResponseResolverInterface ...$resolvers): void + { + foreach ($resolvers as $resolver) { + $this->resolvers[] = $resolver; + } + } + /** * {@inheritdoc} */ @@ -52,6 +75,15 @@ public function resolveResponse($response): ResponseInterface return $response; } - throw new LogicException(); + foreach ($this->resolvers as $resolver) { + if ($resolver->supportsResponse($response, $this->context)) { + return $resolver->resolveResponse($response, $this->context); + } + } + + throw new ResponseResolvingException(sprintf( + 'Unexpected response {%s}', + get_debug_type($response) + )); } } diff --git a/src/ResponseResolutionerInterface.php b/src/ResponseResolutionerInterface.php index cbbb3bb5..f737802c 100644 --- a/src/ResponseResolutionerInterface.php +++ b/src/ResponseResolutionerInterface.php @@ -15,7 +15,7 @@ * Import classes */ use Psr\Http\Message\ResponseInterface; -use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\Exception\ResponseResolvingException; /** * ResponseResolutionerInterface @@ -37,14 +37,23 @@ interface ResponseResolutionerInterface public function withContext($context): ResponseResolutionerInterface; /** - * Resolves the given raw response to the response object + * Adds the given response resolver(s) to the resolutioner + * + * @param ResponseResolverInterface ...$resolvers + * + * @return void + */ + public function addResolver(ResponseResolverInterface ...$resolvers): void; + + /** + * Resolves the given raw response to the object * * @param mixed $response * * @return ResponseInterface * - * @throws LogicException - * If the raw response cannot be resolved to the response object. + * @throws ResponseResolvingException + * If the raw response cannot be resolved to the object. */ public function resolveResponse($response): ResponseInterface; } diff --git a/src/ResponseResolver/StatusCodeResponseResolver.php b/src/ResponseResolver/StatusCodeResponseResolver.php new file mode 100644 index 00000000..c7b97262 --- /dev/null +++ b/src/ResponseResolver/StatusCodeResponseResolver.php @@ -0,0 +1,64 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\ResponseResolver; + +/** + * Import classes + */ +use Psr\Http\Message\ResponseFactoryInterface; +use Psr\Http\Message\ResponseInterface; +use Sunrise\Http\Router\ResponseResolverInterface; + +/** + * Import functions + */ +use function is_int; + +/** + * StatusCodeResponseResolver + * + * @since 3.0.0 + */ +final class StatusCodeResponseResolver implements ResponseResolverInterface +{ + + /** + * @var ResponseFactoryInterface + */ + private ResponseFactoryInterface $responseFactory; + + /** + * @param ResponseFactoryInterface $responseFactory + */ + public function __construct(ResponseFactoryInterface $responseFactory) + { + $this->responseFactory = $responseFactory; + } + + /** + * {@inheritdoc} + */ + public function supportsResponse($response, $context): bool + { + return is_int($response) && $response >= 100 && $response <= 599; + } + + /** + * {@inheritdoc} + */ + public function resolveResponse($response, $context): ResponseInterface + { + /** @var int $response */ + + return $this->responseFactory->createResponse($response); + } +} diff --git a/src/ResponseResolverInterface.php b/src/ResponseResolverInterface.php new file mode 100644 index 00000000..fa6fd515 --- /dev/null +++ b/src/ResponseResolverInterface.php @@ -0,0 +1,50 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router; + +/** + * Import classes + */ +use Psr\Http\Message\ResponseInterface; +use Sunrise\Http\Router\Exception\ResponseResolvingException; + +/** + * ResponseResolverInterface + * + * @since 3.0.0 + */ +interface ResponseResolverInterface +{ + + /** + * Checks if the given raw response is supported + * + * @param mixed $response + * @param mixed $context + * + * @return bool + */ + public function supportsResponse($response, $context): bool; + + /** + * Resolves the given raw response to the object + * + * @param mixed $response + * @param mixed $context + * + * @return ResponseInterface + * + * @throws ResponseResolvingException + * If the raw response cannot be resolved to the object. + */ + public function resolveResponse($response, $context): ResponseInterface; +} diff --git a/src/RouteCollector.php b/src/RouteCollector.php index b0f92900..512e23e2 100644 --- a/src/RouteCollector.php +++ b/src/RouteCollector.php @@ -71,39 +71,27 @@ public function __construct( } /** - * Gets the collector collection + * Sets the given container to the collector * - * @return RouteCollectionInterface - */ - public function getCollection() : RouteCollectionInterface - { - return $this->collection; - } - - /** - * Gets the collector container + * @param ContainerInterface|null $container * - * @return ContainerInterface|null + * @return void * * @since 2.9.0 */ - public function getContainer() : ?ContainerInterface + public function setContainer(?ContainerInterface $container) : void { - return $this->referenceResolver->getContainer(); + $this->referenceResolver->setContainer($container); } /** - * Sets the given container to the collector - * - * @param ContainerInterface|null $container - * - * @return void + * Gets the collector collection * - * @since 2.9.0 + * @return RouteCollectionInterface */ - public function setContainer(?ContainerInterface $container) : void + public function getCollection() : RouteCollectionInterface { - $this->referenceResolver->setContainer($container); + return $this->collection; } /** @@ -133,8 +121,8 @@ public function route( $name, $path, $methods, - $this->referenceResolver->toRequestHandler($requestHandler), - $this->referenceResolver->toMiddlewares($middlewares), + $this->referenceResolver->resolveRequestHandler($requestHandler), + $this->referenceResolver->resolveMiddlewares($middlewares), $attributes ); @@ -382,7 +370,7 @@ public function group(callable $callback, array $middlewares = []) : RouteCollec $callback($collector); $collector->collection->prependMiddleware( - ...$this->referenceResolver->toMiddlewares($middlewares) + ...$this->referenceResolver->resolveMiddlewares($middlewares) ); $this->collection->add( diff --git a/src/Router.php b/src/Router.php index d3365bcc..b59a6764 100644 --- a/src/Router.php +++ b/src/Router.php @@ -484,16 +484,20 @@ public function match(ServerRequestInterface $request) : RouteInterface public function run(ServerRequestInterface $request) : ResponseInterface { // lazy resolving of the given request... - $routing = new CallableRequestHandler(function (ServerRequestInterface $request) : ResponseInterface { - $route = $this->match($request); - $this->matchedRoute = $route; + $routing = new class implements RequestHandlerInterface + { + public function handle(ServerRequestInterface $request): ResponseInterface + { + $route = $this->match($request); + $this->matchedRoute = $route; + + if (isset($this->eventDispatcher)) { + $this->eventDispatcher->dispatch(new RouteEvent($route, $request)); + } - if (isset($this->eventDispatcher)) { - $this->eventDispatcher->dispatch(new RouteEvent($route, $request)); + return $route->handle($request); } - - return $route->handle($request); - }); + }; $middlewares = $this->getMiddlewares(); if (empty($middlewares)) { From ed185552636af92e5ee7802d54287ea9c92f05b4 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 22 Jan 2023 01:16:55 +0100 Subject: [PATCH 031/180] v3 --- composer.json | 1 + functions/find_classes.php | 62 +++++++ src/Annotation/Middleware.php | 5 +- src/Annotation/Route.php | 25 +-- src/Command/RouteListCommand.php | 2 +- src/Loader/ConfigLoader.php | 47 ++++-- src/Loader/DescriptorLoader.php | 112 ++++++------- .../JsonPayloadDecodingMiddleware.php | 30 ++-- src/ParameterResolutioner.php | 2 +- .../RequestBodyParameterResolver.php | 15 +- src/ReferenceResolver.php | 154 ++++++++---------- src/ReferenceResolverInterface.php | 22 +++ src/ResponseResolutioner.php | 2 +- src/RouteCollector.php | 6 +- src/RouteFactoryInterface.php | 4 +- src/RouteInterface.php | 52 +++--- src/Router.php | 46 +++--- src/RouterBuilder.php | 22 +-- 18 files changed, 340 insertions(+), 269 deletions(-) create mode 100644 functions/find_classes.php diff --git a/composer.json b/composer.json index 9c9cb8b8..b19d2476 100644 --- a/composer.json +++ b/composer.json @@ -47,6 +47,7 @@ "autoload": { "files": [ "functions/emit.php", + "functions/find_classes.php", "functions/get_debug_type.php", "functions/path_build.php", "functions/path_match.php", diff --git a/functions/find_classes.php b/functions/find_classes.php new file mode 100644 index 00000000..755aa46b --- /dev/null +++ b/functions/find_classes.php @@ -0,0 +1,62 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router; + +/** + * Import classes + */ +use Iterator; +use RecursiveDirectoryIterator; +use RecursiveIteratorIterator; +use SplFileInfo; + +/** + * Import functions + */ +use function array_diff; +use function get_declared_classes; + +/** + * Scans the given directory and returns the found classes + * + * @param string $directory + * + * @return class-string[] + * + * @since 3.0.0 + */ +function find_classes(string $directory): array +{ + static $cache = []; + + if (isset($cache[$directory])) { + return $cache[$directory]; + } + + /** @var Iterator */ + $files = new RecursiveIteratorIterator( + new RecursiveDirectoryIterator($directory) + ); + + $knownClasses = get_declared_classes(); + + foreach ($files as $file) { + if ('php' === $file->getExtension()) { + /** @psalm-suppress UnresolvableInclude */ + require_once $file->getPathname(); + } + } + + $cache[$directory] = array_diff(get_declared_classes(), $knownClasses); + + return $cache[$directory]; +} diff --git a/src/Annotation/Middleware.php b/src/Annotation/Middleware.php index 275b0e17..1d339476 100644 --- a/src/Annotation/Middleware.php +++ b/src/Annotation/Middleware.php @@ -15,6 +15,7 @@ * Import classes */ use Attribute; +use Psr\Http\Server\MiddlewareInterface; /** * @Annotation @@ -36,14 +37,14 @@ final class Middleware /** * The attribute value * - * @var class-string + * @var class-string */ public string $value; /** * Constructor of the class * - * @param class-string $value + * @param class-string $value */ public function __construct(string $value) { diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index a25293bf..f2fce7b2 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -16,6 +16,7 @@ */ use Attribute; use Fig\Http\Message\RequestMethodInterface; +use Psr\Http\Server\MiddlewareInterface; /** * @Annotation @@ -82,7 +83,7 @@ final class Route implements RequestMethodInterface /** * The route middlewares * - * @var list + * @var list> */ public array $middlewares; @@ -124,17 +125,17 @@ final class Route implements RequestMethodInterface /** * Constructor of the class * - * @param string $name The route name - * @param string|null $host The route host - * @param string $path The route path - * @param string|null $method The route method - * @param list $methods The route methods - * @param list $middlewares The route middlewares - * @param array $attributes The route attributes - * @param string $summary The route summary - * @param string $description The route description - * @param list $tags The route tags - * @param int $priority The route priority (default 0) + * @param string $name The route name + * @param string|null $host The route host + * @param string $path The route path + * @param string|null $method The route method + * @param list $methods The route methods + * @param list> $middlewares The route middlewares + * @param array $attributes The route attributes + * @param string $summary The route summary + * @param string $description The route description + * @param list $tags The route tags + * @param int $priority The route priority (default 0) */ public function __construct( string $name, diff --git a/src/Command/RouteListCommand.php b/src/Command/RouteListCommand.php index 259aa205..65052713 100644 --- a/src/Command/RouteListCommand.php +++ b/src/Command/RouteListCommand.php @@ -32,7 +32,7 @@ * This command will list all routes in your application * * If you can't pass the router to the constructor, - * or your architecture has problems with autowiring, + * or your architecture has problems with the autowiring, * just inherit this class and override the getRouter method. * * @since 2.9.0 diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index 4b64bab4..1694048a 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -16,8 +16,10 @@ */ use Psr\Container\ContainerInterface; use Sunrise\Http\Router\Exception\InvalidLoaderResourceException; +use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; +use Sunrise\Http\Router\ResponseResolverInterface; use Sunrise\Http\Router\RouteCollectionFactory; use Sunrise\Http\Router\RouteCollectionFactoryInterface; use Sunrise\Http\Router\RouteCollectionInterface; @@ -28,6 +30,7 @@ /** * Import functions */ +use function get_debug_type; use function glob; use function is_dir; use function is_file; @@ -36,7 +39,7 @@ /** * ConfigLoader */ -class ConfigLoader implements LoaderInterface +final class ConfigLoader implements LoaderInterface { /** @@ -77,7 +80,7 @@ public function __construct( } /** - * Sets the given container to the loader + * Sets the given container to the reference resolver * * @param ContainerInterface|null $container * @@ -90,23 +93,45 @@ public function setContainer(?ContainerInterface $container): void $this->referenceResolver->setContainer($container); } + /** + * Adds the given parameter resolver(s) to the reference resolver + * + * @param ParameterResolverInterface ...$resolvers + * + * @return void + * + * @since 3.0.0 + */ + public function addParameterResolver(ParameterResolverInterface ...$resolvers): void + { + $this->referenceResolver->addParameterResolver(...$resolvers); + } + + /** + * Adds the given response resolver(s) to the reference resolver + * + * @param ResponseResolverInterface ...$resolvers + * + * @return void + * + * @since 3.0.0 + */ + public function addResponseResolver(ResponseResolverInterface ...$resolvers): void + { + $this->referenceResolver->addResponseResolver(...$resolvers); + } + /** * {@inheritdoc} */ public function attach($resource): void { - if (!is_string($resource)) { - throw new InvalidLoaderResourceException( - 'Config route loader only expects string resources' - ); - } - - if (is_file($resource)) { + if (is_string($resource) && is_file($resource)) { $this->resources[] = $resource; return; } - if (is_dir($resource)) { + if (is_string($resource) && is_dir($resource)) { $filenames = glob($resource . '/*.php'); foreach ($filenames as $filename) { $this->resources[] = $filename; @@ -118,7 +143,7 @@ public function attach($resource): void throw new InvalidLoaderResourceException(sprintf( 'Config route loader only handles file or directory paths, ' . 'however the given resource "%s" is not as expected', - $resource + is_string($resource) ? $resource : get_debug_type($resource) )); } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index c5b0bde2..d48120ef 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -27,32 +27,30 @@ use Sunrise\Http\Router\Annotation\Route; use Sunrise\Http\Router\Exception\InvalidLoaderResourceException; use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; +use Sunrise\Http\Router\ResponseResolverInterface; use Sunrise\Http\Router\RouteCollectionFactory; use Sunrise\Http\Router\RouteCollectionFactoryInterface; use Sunrise\Http\Router\RouteCollectionInterface; use Sunrise\Http\Router\RouteFactory; use Sunrise\Http\Router\RouteFactoryInterface; -use Iterator; -use RecursiveDirectoryIterator; -use RecursiveIteratorIterator; use ReflectionAttribute; use ReflectionClass; use ReflectionMethod; use Reflector; -use SplFileInfo; /** * Import functions */ -use function array_diff; use function class_exists; -use function get_declared_classes; +use function get_debug_type; use function hash; use function is_dir; use function is_string; use function usort; +use Sunrise\Http\Router\find_classes; /** * Import constants @@ -122,7 +120,7 @@ public function __construct( } /** - * Sets the given container to the loader + * Sets the given container to the reference resolver * * @param ContainerInterface|null $container * @@ -134,15 +132,31 @@ public function setContainer(?ContainerInterface $container): void } /** - * Gets the loader annotation reader + * Adds the given parameter resolver(s) to the reference resolver * - * @return AnnotationReaderInterface|null + * @param ParameterResolverInterface ...$resolvers + * + * @return void + * + * @since 3.0.0 + */ + public function addParameterResolver(ParameterResolverInterface ...$resolvers): void + { + $this->referenceResolver->addParameterResolver(...$resolvers); + } + + /** + * Adds the given response resolver(s) to the reference resolver + * + * @param ResponseResolverInterface ...$resolvers + * + * @return void * * @since 3.0.0 */ - public function getAnnotationReader(): ?AnnotationReaderInterface + public function addResponseResolver(ResponseResolverInterface ...$resolvers): void { - return $this->annotationReader; + $this->referenceResolver->addResponseResolver(...$resolvers); } /** @@ -234,21 +248,15 @@ public function useDefaultAnnotationReader(): void */ public function attach($resource): void { - if (!is_string($resource)) { - throw new InvalidLoaderResourceException( - 'Descriptor route loader only expects string resources' - ); - } - - if (class_exists($resource)) { + if (is_string($resource) && class_exists($resource)) { $this->resources[] = $resource; return; } - if (is_dir($resource)) { - $classNames = $this->scandir($resource); - foreach ($classNames as $className) { - $this->resources[] = $className; + if (is_string($resource) && is_dir($resource)) { + $classnames = find_classes($resource); + foreach ($classnames as $classname) { + $this->resources[] = $classname; } return; @@ -257,7 +265,7 @@ public function attach($resource): void throw new InvalidLoaderResourceException(sprintf( 'Descriptor route loader only handles class names or directory paths, ' . 'however the given resource "%s" is not as expected', - $resource + is_string($resource) ? $resource : get_debug_type($resource) )); } @@ -333,7 +341,7 @@ private function collectDescriptors(): array $result = []; foreach ($this->resources as $resource) { $class = new ReflectionClass($resource); - $descriptors = $this->getClassDescriptors($class); + $descriptors = $this->getDescriptorsFromClass($class); foreach ($descriptors as $descriptor) { $result[] = $descriptor; } @@ -353,7 +361,7 @@ private function collectDescriptors(): array * * @return list */ - private function getClassDescriptors(ReflectionClass $class): array + private function getDescriptorsFromClass(ReflectionClass $class): array { // e.g., interfaces, traits, enums, abstract classes, // classes with private constructor... @@ -364,26 +372,26 @@ private function getClassDescriptors(ReflectionClass $class): array $descriptors = []; if ($class->isSubclassOf(RequestHandlerInterface::class)) { - $annotations = $this->getAnnotations($class, Route::class); + $annotations = $this->getAnnotationsFromClassOrMethod($class, Route::class); if (isset($annotations[0])) { $descriptor = $annotations[0]; - $this->supplementDescriptor($descriptor, $class); + $this->supplementDescriptorFromClassOrMethod($descriptor, $class); $descriptor->holder = $class->getName(); $descriptors[] = $descriptor; } } foreach ($class->getMethods() as $method) { - // ignore non-available methods... - if (!$method->isPublic() || $method->isStatic()) { + // ignore non-public methods... + if (!$method->isPublic()) { continue; } - $annotations = $this->getAnnotations($method, Route::class); + $annotations = $this->getAnnotationsFromClassOrMethod($method, Route::class); if (isset($annotations[0])) { $descriptor = $annotations[0]; - $this->supplementDescriptor($descriptor, $class); - $this->supplementDescriptor($descriptor, $method); + $this->supplementDescriptorFromClassOrMethod($descriptor, $class); + $this->supplementDescriptorFromClassOrMethod($descriptor, $method); $descriptor->holder = [$class->getName(), $method->getName()]; $descriptors[] = $descriptor; } @@ -421,24 +429,24 @@ private function getClassDescriptors(ReflectionClass $class): array * * @return void */ - private function supplementDescriptor(Route $descriptor, Reflector $reflector): void + private function supplementDescriptorFromClassOrMethod(Route $descriptor, Reflector $reflector): void { - $annotations = $this->getAnnotations($reflector, Host::class); + $annotations = $this->getAnnotationsFromClassOrMethod($reflector, Host::class); if (isset($annotations[0])) { $descriptor->host = $annotations[0]->value; } - $annotations = $this->getAnnotations($reflector, Prefix::class); + $annotations = $this->getAnnotationsFromClassOrMethod($reflector, Prefix::class); if (isset($annotations[0])) { $descriptor->path = $annotations[0]->value . $descriptor->path; } - $annotations = $this->getAnnotations($reflector, Postfix::class); + $annotations = $this->getAnnotationsFromClassOrMethod($reflector, Postfix::class); if (isset($annotations[0])) { $descriptor->path = $descriptor->path . $annotations[0]->value; } - $annotations = $this->getAnnotations($reflector, Middleware::class); + $annotations = $this->getAnnotationsFromClassOrMethod($reflector, Middleware::class); foreach ($annotations as $annotation) { $descriptor->middlewares[] = $annotation->value; } @@ -454,7 +462,7 @@ private function supplementDescriptor(Route $descriptor, Reflector $reflector): * * @template T */ - private function getAnnotations(Reflector $reflector, string $annotationName): array + private function getAnnotationsFromClassOrMethod(Reflector $reflector, string $annotationName): array { $result = []; @@ -467,7 +475,7 @@ private function getAnnotations(Reflector $reflector, string $annotationName): a } } - if (isset($this->annotationReader) && empty($result)) { + if (isset($this->annotationReader)) { $annotations = ($reflector instanceof ReflectionClass) ? $this->annotationReader->getClassAnnotations($reflector) : $this->annotationReader->getMethodAnnotations($reflector); @@ -481,30 +489,4 @@ private function getAnnotations(Reflector $reflector, string $annotationName): a return $result; } - - /** - * Scans the given directory and returns the found classes - * - * @param string $directory - * - * @return class-string[] - */ - private function scandir(string $directory): array - { - /** @var Iterator */ - $files = new RecursiveIteratorIterator( - new RecursiveDirectoryIterator($directory) - ); - - $declared = get_declared_classes(); - - foreach ($files as $file) { - if ('php' === $file->getExtension()) { - /** @psalm-suppress UnresolvableInclude */ - require_once $file->getPathname(); - } - } - - return array_diff(get_declared_classes(), $declared); - } } diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 46ea269a..70740f04 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -47,21 +47,12 @@ final class JsonPayloadDecodingMiddleware implements MiddlewareInterface { - /** - * JSON media type - * - * @link https://datatracker.ietf.org/doc/html/rfc4627 - * - * @var string - */ - private const JSON_MEDIA_TYPE = 'application/json'; - /** * {@inheritdoc} */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if ($this->isSupportedRequest($request)) { + if ($this->supportsRequest($request)) { $data = $this->decodeRequestJsonPayload($request); $request = $request->withParsedBody($data); } @@ -72,13 +63,15 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface /** * Checks if the given request is supported * + * @link https://datatracker.ietf.org/doc/html/rfc4627 + * * @param ServerRequestInterface $request * * @return bool */ - private function isSupportedRequest(ServerRequestInterface $request): bool + private function supportsRequest(ServerRequestInterface $request): bool { - return self::JSON_MEDIA_TYPE === $this->getRequestMediaType($request); + return 'application/json' === $this->getRequestMediaType($request); } /** @@ -99,14 +92,13 @@ private function getRequestMediaType(ServerRequestInterface $request): ?string } // type "/" subtype *( OWS ";" OWS parameter ) - $mediaType = $request->getHeaderLine('Content-Type'); + $mediatype = $request->getHeaderLine('Content-Type'); - $semicolon = strpos($mediaType, ';'); - if (false === $semicolon) { - return $mediaType; + if ($semicolon = strpos($mediatype, ';')) { + $mediatype = substr($mediatype, 0, $semicolon); } - return rtrim(substr($mediaType, 0, $semicolon)); + return rtrim($mediatype); } /** @@ -117,12 +109,12 @@ private function getRequestMediaType(ServerRequestInterface $request): ?string * @return array|object|null * * @throws InvalidPayloadException - * If the request's JSON payload cannot be decoded. + * If the request's "JSON" payload cannot be decoded. */ private function decodeRequestJsonPayload(ServerRequestInterface $request) { // https://www.php.net/json.constants - $flags = JSON_BIGINT_AS_STRING | JSON_OBJECT_AS_ARRAY; + $flags = JSON_OBJECT_AS_ARRAY | JSON_BIGINT_AS_STRING; try { /** @var mixed */ diff --git a/src/ParameterResolutioner.php b/src/ParameterResolutioner.php index 780bd6db..d85fcd14 100644 --- a/src/ParameterResolutioner.php +++ b/src/ParameterResolutioner.php @@ -152,7 +152,7 @@ private function resolveParameter(ReflectionParameter $parameter) } throw new ParameterResolvingException(sprintf( - 'Unexpected parameter {%s($%s[%d])}', + 'Unable to resolve the parameter {%s($%s[%d])}', $parameter->getDeclaringFunction()->getName(), $parameter->getName(), $parameter->getPosition() diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 001d9c32..f70a4593 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -26,6 +26,11 @@ use ReflectionNamedType; use ReflectionParameter; +/** + * Import functions + */ +use function is_subclass_of; + /** * Import constants */ @@ -63,19 +68,15 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo return false; } - if (!($parameter->getType() instanceof ReflectionNamedType)) { - return false; - } - - if ($parameter->getType()->isBuiltin()) { + if (!($parameter->getType() instanceof ReflectionNamedType) || $parameter->getType()->isBuiltin()) { return false; } - if ($parameter->getType()->getName() instanceof RequestBodyInterface) { + if (8 === PHP_MAJOR_VERSION && $parameter->getAttributes(RequestBody::class)) { return true; } - if (8 === PHP_MAJOR_VERSION && $parameter->getAttributes(RequestBody::class)) { + if (is_subclass_of($parameter->getType()->getName(), RequestBodyInterface::class)) { return true; } diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index ce0025e3..80361180 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -17,7 +17,7 @@ use Psr\Container\ContainerInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\InvalidReferenceException; +use Sunrise\Http\Router\Exception\ReferenceResolvingException; use Sunrise\Http\Router\Middleware\CallableMiddleware; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use Closure; @@ -26,6 +26,7 @@ /** * Import functions */ +use function get_debug_type; use function is_array; use function is_callable; use function is_string; @@ -38,7 +39,7 @@ * * @since 2.10.0 */ -class ReferenceResolver implements ReferenceResolverInterface +final class ReferenceResolver implements ReferenceResolverInterface { /** @@ -81,9 +82,26 @@ public function __construct( public function setContainer(?ContainerInterface $container): void { $this->container = $container; + $this->parameterResolutioner->setContainer($container); } + /** + * {@inheritdoc} + */ + public function addParameterResolver(ParameterResolverInterface ...$resolvers): void + { + $this->parameterResolutioner->addResolver(...$resolvers); + } + + /** + * {@inheritdoc} + */ + public function addResponseResolver(ResponseResolverInterface ...$resolvers): void + { + $this->responseResolutioner->addResolver(...$resolvers); + } + /** * {@inheritdoc} */ @@ -94,29 +112,26 @@ public function resolveRequestHandler($reference): RequestHandlerInterface } if ($reference instanceof Closure) { - return new CallableRequestHandler( - $reference, - $this->parameterResolutioner, - $this->responseResolutioner - ); + return new CallableRequestHandler($reference, $this->parameterResolutioner, $this->responseResolutioner); } - list($class, $method) = $this->normalizeReference($reference); + // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 + /** @psalm-suppress MixedArgument */ + if (is_array($reference) && is_callable($reference, true) && method_exists($reference[0], $reference[1])) { + /** @var array{0: object|class-string, 1: non-empty-string} $reference */ - if (isset($class) && isset($method) && method_exists($class, $method)) { - return new CallableRequestHandler( - [$this->resolveClass($class), $method], - $this->parameterResolutioner, - $this->responseResolutioner - ); + $callback = [is_string($reference[0]) ? $this->resolveClass($reference[0]) : $reference[0], $reference[1]]; + + return new CallableRequestHandler($callback, $this->parameterResolutioner, $this->responseResolutioner); } - if (!isset($method) && isset($class) && is_subclass_of($class, RequestHandlerInterface::class)) { - return $this->resolveClass($class); + if (is_string($reference) && is_subclass_of($reference, RequestHandlerInterface::class)) { + /** @var RequestHandlerInterface */ + return $this->resolveClass($reference); } - throw new InvalidReferenceException(sprintf( - 'Unable to resolve the "%s" reference to a request handler.', + throw new ReferenceResolvingException(sprintf( + 'Unable to resolve the reference {%s} to a request handler.', $this->stringifyReference($reference) )); } @@ -131,29 +146,26 @@ public function resolveMiddleware($reference): MiddlewareInterface } if ($reference instanceof Closure) { - return new CallableMiddleware( - $reference, - $this->parameterResolutioner, - $this->responseResolutioner - ); + return new CallableMiddleware($reference, $this->parameterResolutioner, $this->responseResolutioner); } - list($class, $method) = $this->normalizeReference($reference); - - if (isset($class) && isset($method) && method_exists($class, $method)) { - return new CallableMiddleware( - [$this->resolveClass($class), $method], - $this->parameterResolutioner, - $this->responseResolutioner - ); + if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { + /** @var MiddlewareInterface */ + return $this->resolveClass($reference); } - if (!isset($method) && isset($class) && is_subclass_of($class, MiddlewareInterface::class)) { - return $this->resolveClass($class); + // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 + /** @psalm-suppress MixedArgument */ + if (is_array($reference) && is_callable($reference, true) && method_exists($reference[0], $reference[1])) { + /** @var array{0: object|class-string, 1: non-empty-string} $reference */ + + $callback = [is_string($reference[0]) ? $this->resolveClass($reference[0]) : $reference[0], $reference[1]]; + + return new CallableMiddleware($callback, $this->parameterResolutioner, $this->responseResolutioner); } - throw new InvalidReferenceException(sprintf( - 'Unable to resolve the "%s" reference to a middleware.', + throw new ReferenceResolvingException(sprintf( + 'Unable to resolve the reference {%s} to a middleware.', $this->stringifyReference($reference) )); } @@ -173,25 +185,31 @@ public function resolveMiddlewares(array $references): array } /** - * Normalizes the given reference + * Resolves the given class * - * @param mixed $reference + * @param class-string $class * - * @return array{0: ?class-string, 1: ?non-empty-string} + * @return T + * + * @template T */ - private function normalizeReference($reference): array + private function resolveClass(string $class): object { - if (is_array($reference) && is_callable($reference, true)) { - /** @var array{0: class-string, 1: non-empty-string} $reference */ - return $reference; + if (isset($this->container) && $this->container->has($class)) { + /** @var T */ + return $this->container->get($class); } - if (is_string($reference)) { - /** @var class-string $reference */ - return [$reference, null]; + $arguments = []; + $reflection = new ReflectionClass($class); + $constructor = $reflection->getConstructor(); + if (isset($constructor)) { + $arguments = $this->parameterResolutioner->resolveParameters( + ...$constructor->getParameters() + ); } - return [null, null]; + return $reflection->newInstance(...$arguments); } /** @@ -203,48 +221,14 @@ private function normalizeReference($reference): array */ private function stringifyReference($reference): string { - $reference = $this->normalizeReference($reference); - - if (isset($reference[0], $reference[1])) { - return $reference[0] . '@' . $reference[1]; - } - - if (isset($reference[0])) { - return $reference[0]; + if (is_array($reference) && is_callable($reference, true, $refString)) { + return $refString; } - return ''; - } - - /** - * Resolves the given class - * - * @param class-string $className - * - * @return T - * - * @template T - */ - private function resolveClass(string $className) - { - if (isset($this->container) && $this->container->has($className)) { - /** @var T */ - return $this->container->get($className); - } - - $reflection = new ReflectionClass($className); - if (!$reflection->isInstantiable()) { - throw new ReferenceResolvingException(); - } - - $arguments = []; - $constructor = $reflection->getConstructor(); - if (isset($constructor)) { - $arguments = $this->parameterResolutioner->resolveParameters( - ...$constructor->getParameters() - ); + if (is_string($reference)) { + return $reference; } - return new $className(...$arguments); + return get_debug_type($reference); } } diff --git a/src/ReferenceResolverInterface.php b/src/ReferenceResolverInterface.php index 25916e85..c818b4e2 100644 --- a/src/ReferenceResolverInterface.php +++ b/src/ReferenceResolverInterface.php @@ -36,6 +36,28 @@ interface ReferenceResolverInterface */ public function setContainer(?ContainerInterface $container): void; + /** + * Adds the given parameter resolver(s) to the parameter resolutioner + * + * @param ParameterResolverInterface ...$resolvers + * + * @return void + * + * @since 3.0.0 + */ + public function addParameterResolver(ParameterResolverInterface ...$resolvers): void; + + /** + * Adds the given response resolver(s) to the response resolutioner + * + * @param ResponseResolverInterface ...$resolvers + * + * @return void + * + * @since 3.0.0 + */ + public function addResponseResolver(ResponseResolverInterface ...$resolvers): void; + /** * Resolves the given reference to a request handler * diff --git a/src/ResponseResolutioner.php b/src/ResponseResolutioner.php index f5147350..b85ce085 100644 --- a/src/ResponseResolutioner.php +++ b/src/ResponseResolutioner.php @@ -82,7 +82,7 @@ public function resolveResponse($response): ResponseInterface } throw new ResponseResolvingException(sprintf( - 'Unexpected response {%s}', + 'Unable to resolve the response {%s}', get_debug_type($response) )); } diff --git a/src/RouteCollector.php b/src/RouteCollector.php index 512e23e2..05dd4214 100644 --- a/src/RouteCollector.php +++ b/src/RouteCollector.php @@ -79,7 +79,7 @@ public function __construct( * * @since 2.9.0 */ - public function setContainer(?ContainerInterface $container) : void + public function setContainer(?ContainerInterface $container): void { $this->referenceResolver->setContainer($container); } @@ -89,7 +89,7 @@ public function setContainer(?ContainerInterface $container) : void * * @return RouteCollectionInterface */ - public function getCollection() : RouteCollectionInterface + public function getCollection(): RouteCollectionInterface { return $this->collection; } @@ -359,7 +359,7 @@ public function purge( * @throws InvalidReferenceException * If one of the given middlewares cannot be resolved. */ - public function group(callable $callback, array $middlewares = []) : RouteCollectionInterface + public function group(callable $callback, array $middlewares = []): RouteCollectionInterface { $collector = new self( $this->collectionFactory, diff --git a/src/RouteFactoryInterface.php b/src/RouteFactoryInterface.php index 86541d9b..8bd56fdf 100644 --- a/src/RouteFactoryInterface.php +++ b/src/RouteFactoryInterface.php @@ -28,9 +28,9 @@ interface RouteFactoryInterface * * @param string $name * @param string $path - * @param string[] $methods + * @param list $methods * @param RequestHandlerInterface $requestHandler - * @param MiddlewareInterface[] $middlewares + * @param list $middlewares * @param array $attributes * * @return RouteInterface diff --git a/src/RouteInterface.php b/src/RouteInterface.php index 935bc6f0..dbc66928 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -41,7 +41,7 @@ interface RouteInterface extends RequestHandlerInterface * * @return string */ - public function getName() : string; + public function getName(): string; /** * Gets the route host @@ -50,42 +50,42 @@ public function getName() : string; * * @since 2.6.0 */ - public function getHost() : ?string; + public function getHost(): ?string; /** * Gets the route path * * @return string */ - public function getPath() : string; + public function getPath(): string; /** * Gets the route methods * * @return string[] */ - public function getMethods() : array; + public function getMethods(): array; /** * Gets the route request handler * * @return RequestHandlerInterface */ - public function getRequestHandler() : RequestHandlerInterface; + public function getRequestHandler(): RequestHandlerInterface; /** * Gets the route middlewares * * @return MiddlewareInterface[] */ - public function getMiddlewares() : array; + public function getMiddlewares(): array; /** * Gets the route attributes * * @return array */ - public function getAttributes() : array; + public function getAttributes(): array; /** * Gets the route summary @@ -94,7 +94,7 @@ public function getAttributes() : array; * * @since 2.4.0 */ - public function getSummary() : string; + public function getSummary(): string; /** * Gets the route description @@ -103,7 +103,7 @@ public function getSummary() : string; * * @since 2.4.0 */ - public function getDescription() : string; + public function getDescription(): string; /** * Gets the route tags @@ -112,7 +112,7 @@ public function getDescription() : string; * * @since 2.4.0 */ - public function getTags() : array; + public function getTags(): array; /** * Gets the route holder @@ -121,7 +121,7 @@ public function getTags() : array; * * @since 2.14.0 */ - public function getHolder() : Reflector; + public function getHolder(): Reflector; /** * Sets the given name to the route @@ -130,7 +130,7 @@ public function getHolder() : Reflector; * * @return RouteInterface */ - public function setName(string $name) : RouteInterface; + public function setName(string $name): RouteInterface; /** * Sets the given host to the route @@ -141,7 +141,7 @@ public function setName(string $name) : RouteInterface; * * @since 2.6.0 */ - public function setHost(?string $host) : RouteInterface; + public function setHost(?string $host): RouteInterface; /** * Sets the given path to the route @@ -150,7 +150,7 @@ public function setHost(?string $host) : RouteInterface; * * @return RouteInterface */ - public function setPath(string $path) : RouteInterface; + public function setPath(string $path): RouteInterface; /** * Sets the given method(s) to the route @@ -159,7 +159,7 @@ public function setPath(string $path) : RouteInterface; * * @return RouteInterface */ - public function setMethods(string ...$methods) : RouteInterface; + public function setMethods(string ...$methods): RouteInterface; /** * Sets the given request handler to the route @@ -168,7 +168,7 @@ public function setMethods(string ...$methods) : RouteInterface; * * @return RouteInterface */ - public function setRequestHandler(RequestHandlerInterface $requestHandler) : RouteInterface; + public function setRequestHandler(RequestHandlerInterface $requestHandler): RouteInterface; /** * Sets the given middleware(s) to the route @@ -177,7 +177,7 @@ public function setRequestHandler(RequestHandlerInterface $requestHandler) : Rou * * @return RouteInterface */ - public function setMiddlewares(MiddlewareInterface ...$middlewares) : RouteInterface; + public function setMiddlewares(MiddlewareInterface ...$middlewares): RouteInterface; /** * Sets the given attributes to the route @@ -186,7 +186,7 @@ public function setMiddlewares(MiddlewareInterface ...$middlewares) : RouteInter * * @return RouteInterface */ - public function setAttributes(array $attributes) : RouteInterface; + public function setAttributes(array $attributes): RouteInterface; /** * Sets the given summary to the route @@ -197,7 +197,7 @@ public function setAttributes(array $attributes) : RouteInterface; * * @since 2.4.0 */ - public function setSummary(string $summary) : RouteInterface; + public function setSummary(string $summary): RouteInterface; /** * Sets the given description to the route @@ -208,7 +208,7 @@ public function setSummary(string $summary) : RouteInterface; * * @since 2.4.0 */ - public function setDescription(string $description) : RouteInterface; + public function setDescription(string $description): RouteInterface; /** * Sets the given tag(s) to the route @@ -219,7 +219,7 @@ public function setDescription(string $description) : RouteInterface; * * @since 2.4.0 */ - public function setTags(string ...$tags) : RouteInterface; + public function setTags(string ...$tags): RouteInterface; /** * Adds the given prefix to the route path @@ -228,7 +228,7 @@ public function setTags(string ...$tags) : RouteInterface; * * @return RouteInterface */ - public function addPrefix(string $prefix) : RouteInterface; + public function addPrefix(string $prefix): RouteInterface; /** * Adds the given suffix to the route path @@ -237,7 +237,7 @@ public function addPrefix(string $prefix) : RouteInterface; * * @return RouteInterface */ - public function addSuffix(string $suffix) : RouteInterface; + public function addSuffix(string $suffix): RouteInterface; /** * Adds the given method(s) to the route @@ -246,7 +246,7 @@ public function addSuffix(string $suffix) : RouteInterface; * * @return RouteInterface */ - public function addMethod(string ...$methods) : RouteInterface; + public function addMethod(string ...$methods): RouteInterface; /** * Adds the given middleware(s) to the route @@ -255,7 +255,7 @@ public function addMethod(string ...$methods) : RouteInterface; * * @return RouteInterface */ - public function addMiddleware(MiddlewareInterface ...$middlewares) : RouteInterface; + public function addMiddleware(MiddlewareInterface ...$middlewares): RouteInterface; /** * Returns the route clone with the given attributes @@ -266,5 +266,5 @@ public function addMiddleware(MiddlewareInterface ...$middlewares) : RouteInterf * * @return RouteInterface */ - public function withAddedAttributes(array $attributes) : RouteInterface; + public function withAddedAttributes(array $attributes): RouteInterface; } diff --git a/src/Router.php b/src/Router.php index b59a6764..2dda44c8 100644 --- a/src/Router.php +++ b/src/Router.php @@ -102,7 +102,7 @@ class Router implements MiddlewareInterface, RequestHandlerInterface, RequestMet * * @since 2.13.0 */ - private $eventDispatcher = null; + private ?EventDispatcherInterface $eventDispatcher = null; /** * Gets the router's host table @@ -111,7 +111,7 @@ class Router implements MiddlewareInterface, RequestHandlerInterface, RequestMet * * @since 2.6.0 */ - public function getHosts() : array + public function getHosts(): array { return $this->hosts; } @@ -125,7 +125,7 @@ public function getHosts() : array * * @since 2.14.0 */ - public function resolveHostname(string $hostname) : ?string + public function resolveHostname(string $hostname): ?string { foreach ($this->hosts as $alias => $hostnames) { foreach ($hostnames as $value) { @@ -143,7 +143,7 @@ public function resolveHostname(string $hostname) : ?string * * @return RouteInterface[] */ - public function getRoutes() : array + public function getRoutes(): array { $routes = []; foreach ($this->routes as $route) { @@ -162,7 +162,7 @@ public function getRoutes() : array * * @since 2.14.0 */ - public function getRoutesByHostname(string $hostname) : array + public function getRoutesByHostname(string $hostname): array { // the hostname's alias. $alias = $this->resolveHostname($hostname); @@ -183,7 +183,7 @@ public function getRoutesByHostname(string $hostname) : array * * @return MiddlewareInterface[] */ - public function getMiddlewares() : array + public function getMiddlewares(): array { $middlewares = []; foreach ($this->middlewares as $middleware) { @@ -198,7 +198,7 @@ public function getMiddlewares() : array * * @return RouteInterface|null */ - public function getMatchedRoute() : ?RouteInterface + public function getMatchedRoute(): ?RouteInterface { return $this->matchedRoute; } @@ -210,7 +210,7 @@ public function getMatchedRoute() : ?RouteInterface * * @since 2.13.0 */ - public function getEventDispatcher() : ?EventDispatcherInterface + public function getEventDispatcher(): ?EventDispatcherInterface { return $this->eventDispatcher; } @@ -235,7 +235,7 @@ public function getEventDispatcher() : ?EventDispatcherInterface * * @since 2.11.0 */ - public function addPatterns(array $patterns) : void + public function addPatterns(array $patterns): void { foreach ($patterns as $alias => $pattern) { self::$patterns[$alias] = $pattern; @@ -262,7 +262,7 @@ public function addPatterns(array $patterns) : void * * @since 2.11.0 */ - public function addHosts(array $hosts) : void + public function addHosts(array $hosts): void { foreach ($hosts as $alias => $hostnames) { $this->addHost($alias, ...$hostnames); @@ -279,7 +279,7 @@ public function addHosts(array $hosts) : void * * @since 2.6.0 */ - public function addHost(string $alias, string ...$hostnames) : void + public function addHost(string $alias, string ...$hostnames): void { $this->hosts[$alias] = $hostnames; } @@ -294,7 +294,7 @@ public function addHost(string $alias, string ...$hostnames) : void * @throws InvalidArgumentException * if one of the given routes already exists. */ - public function addRoute(RouteInterface ...$routes) : void + public function addRoute(RouteInterface ...$routes): void { foreach ($routes as $route) { $name = $route->getName(); @@ -319,7 +319,7 @@ public function addRoute(RouteInterface ...$routes) : void * @throws InvalidArgumentException * if one of the given middlewares already exists. */ - public function addMiddleware(MiddlewareInterface ...$middlewares) : void + public function addMiddleware(MiddlewareInterface ...$middlewares): void { foreach ($middlewares as $middleware) { $hash = spl_object_hash($middleware); @@ -343,7 +343,7 @@ public function addMiddleware(MiddlewareInterface ...$middlewares) : void * * @since 2.13.0 */ - public function setEventDispatcher(?EventDispatcherInterface $eventDispatcher) : void + public function setEventDispatcher(?EventDispatcherInterface $eventDispatcher): void { $this->eventDispatcher = $eventDispatcher; } @@ -353,7 +353,7 @@ public function setEventDispatcher(?EventDispatcherInterface $eventDispatcher) : * * @return string[] */ - public function getAllowedMethods() : array + public function getAllowedMethods(): array { $methods = []; foreach ($this->routes as $route) { @@ -370,7 +370,7 @@ public function getAllowedMethods() : array * * @return bool */ - public function hasRoute(string $name) : bool + public function hasRoute(string $name): bool { return isset($this->routes[$name]); } @@ -384,7 +384,7 @@ public function hasRoute(string $name) : bool * * @throws RouteNotFoundException */ - public function getRoute(string $name) : RouteInterface + public function getRoute(string $name): RouteInterface { if (!isset($this->routes[$name])) { throw new RouteNotFoundException(sprintf( @@ -412,7 +412,7 @@ public function getRoute(string $name) : RouteInterface * If a required attribute value is not given, * or if an attribute value is not valid in strict mode. */ - public function generateUri(string $name, array $attributes = [], bool $strict = false) : string + public function generateUri(string $name, array $attributes = [], bool $strict = false): string { $route = $this->getRoute($name); @@ -431,7 +431,7 @@ public function generateUri(string $name, array $attributes = [], bool $strict = * @throws PageNotFoundException * @throws MethodNotAllowedException */ - public function match(ServerRequestInterface $request) : RouteInterface + public function match(ServerRequestInterface $request): RouteInterface { $currentUri = $request->getUri(); $currentHost = $currentUri->getHost(); @@ -481,7 +481,7 @@ public function match(ServerRequestInterface $request) : RouteInterface * * @since 2.8.0 */ - public function run(ServerRequestInterface $request) : ResponseInterface + public function run(ServerRequestInterface $request): ResponseInterface { // lazy resolving of the given request... $routing = new class implements RequestHandlerInterface @@ -513,7 +513,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface /** * {@inheritdoc} */ - public function handle(ServerRequestInterface $request) : ResponseInterface + public function handle(ServerRequestInterface $request): ResponseInterface { $route = $this->match($request); $this->matchedRoute = $route; @@ -536,7 +536,7 @@ public function handle(ServerRequestInterface $request) : ResponseInterface /** * {@inheritdoc} */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler) : ResponseInterface + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { try { return $this->handle($request); @@ -552,7 +552,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface * * @return void */ - public function load(LoaderInterface ...$loaders) : void + public function load(LoaderInterface ...$loaders): void { foreach ($loaders as $loader) { $this->addRoute(...$loader->load()->all()); diff --git a/src/RouterBuilder.php b/src/RouterBuilder.php index a0dbbeb9..598662f8 100644 --- a/src/RouterBuilder.php +++ b/src/RouterBuilder.php @@ -83,7 +83,7 @@ final class RouterBuilder * * @since 2.14.0 */ - public function setEventDispatcher(?EventDispatcherInterface $eventDispatcher) : self + public function setEventDispatcher(?EventDispatcherInterface $eventDispatcher): self { $this->eventDispatcher = $eventDispatcher; @@ -97,7 +97,7 @@ public function setEventDispatcher(?EventDispatcherInterface $eventDispatcher) : * * @return self */ - public function setContainer(?ContainerInterface $container) : self + public function setContainer(?ContainerInterface $container): self { $this->container = $container; @@ -111,7 +111,7 @@ public function setContainer(?ContainerInterface $container) : self * * @return self */ - public function setCache(?CacheInterface $cache) : self + public function setCache(?CacheInterface $cache): self { $this->cache = $cache; @@ -127,7 +127,7 @@ public function setCache(?CacheInterface $cache) : self * * @since 2.10.0 */ - public function setCacheKey(?string $cacheKey) : self + public function setCacheKey(?string $cacheKey): self { $this->cacheKey = $cacheKey; @@ -141,7 +141,7 @@ public function setCacheKey(?string $cacheKey) : self * * @return self */ - public function useConfigLoader(array $resources) : self + public function useConfigLoader(array $resources): self { $this->configLoader = new Loader\ConfigLoader(); $this->configLoader->attachArray($resources); @@ -156,7 +156,7 @@ public function useConfigLoader(array $resources) : self * * @return self */ - public function useDescriptorLoader(array $resources) : self + public function useDescriptorLoader(array $resources): self { $this->descriptorLoader = new Loader\DescriptorLoader(); $this->descriptorLoader->attachArray($resources); @@ -173,7 +173,7 @@ public function useDescriptorLoader(array $resources) : self * * @return self */ - public function useMetadataLoader(array $resources) : self + public function useMetadataLoader(array $resources): self { $this->useDescriptorLoader($resources); @@ -189,7 +189,7 @@ public function useMetadataLoader(array $resources) : self * * @since 2.11.0 */ - public function setPatterns(?array $patterns) : self + public function setPatterns(?array $patterns): self { $this->patterns = $patterns; @@ -203,7 +203,7 @@ public function setPatterns(?array $patterns) : self * * @return self */ - public function setHosts(?array $hosts) : self + public function setHosts(?array $hosts): self { $this->hosts = $hosts; @@ -217,7 +217,7 @@ public function setHosts(?array $hosts) : self * * @return self */ - public function setMiddlewares(?array $middlewares) : self + public function setMiddlewares(?array $middlewares): self { $this->middlewares = $middlewares; @@ -229,7 +229,7 @@ public function setMiddlewares(?array $middlewares) : self * * @return Router */ - public function build() : Router + public function build(): Router { $router = new Router(); From a5b25bb4c623e25f9e96e8aef6b5414964b95a08 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 22 Jan 2023 05:55:44 +0100 Subject: [PATCH 032/180] v3 --- src/Annotation/RequestQuery.php | 25 +++++ src/Loader/DescriptorLoader.php | 4 +- .../JsonPayloadDecodingMiddleware.php | 16 +-- .../WhitespaceStrippingMiddleware.php | 56 ++++++++++ .../RequestQueryParameterResolver.php | 105 ++++++++++++++++++ .../UnsafeCallableRequestHandler.php | 54 +++++++++ src/RequestQueryInterface.php | 21 ++++ src/RouteCollector.php | 2 +- src/Router.php | 34 +++--- 9 files changed, 285 insertions(+), 32 deletions(-) create mode 100644 src/Annotation/RequestQuery.php create mode 100644 src/Middleware/WhitespaceStrippingMiddleware.php create mode 100644 src/ParameterResolver/RequestQueryParameterResolver.php create mode 100644 src/RequestHandler/UnsafeCallableRequestHandler.php create mode 100644 src/RequestQueryInterface.php diff --git a/src/Annotation/RequestQuery.php b/src/Annotation/RequestQuery.php new file mode 100644 index 00000000..e2aa1e52 --- /dev/null +++ b/src/Annotation/RequestQuery.php @@ -0,0 +1,25 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Annotation; + +/** + * Import classes + */ +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_PARAMETER)] +final class RequestQuery +{ +} diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index d48120ef..eaa7fb92 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -50,7 +50,7 @@ use function is_dir; use function is_string; use function usort; -use Sunrise\Http\Router\find_classes; +use function Sunrise\Http\Router\find_classes; /** * Import constants @@ -347,7 +347,7 @@ private function collectDescriptors(): array } } - usort($result, function (Route $a, Route $b): int { + usort($result, static function (Route $a, Route $b): int { return $b->priority <=> $a->priority; }); diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 70740f04..3cee875d 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -25,7 +25,6 @@ * Import functions */ use function is_array; -use function is_object; use function json_decode; use function rtrim; use function sprintf; @@ -106,28 +105,23 @@ private function getRequestMediaType(ServerRequestInterface $request): ?string * * @param ServerRequestInterface $request * - * @return array|object|null + * @return array|null * * @throws InvalidPayloadException * If the request's "JSON" payload cannot be decoded. */ - private function decodeRequestJsonPayload(ServerRequestInterface $request) + private function decodeRequestJsonPayload(ServerRequestInterface $request): ?array { // https://www.php.net/json.constants - $flags = JSON_OBJECT_AS_ARRAY | JSON_BIGINT_AS_STRING; + $flags = JSON_OBJECT_AS_ARRAY | JSON_BIGINT_AS_STRING | JSON_THROW_ON_ERROR; try { /** @var mixed */ - $result = json_decode($request->getBody()->__toString(), null, 512, $flags | JSON_THROW_ON_ERROR); + $result = json_decode($request->getBody()->__toString(), null, 512, $flags); } catch (JsonException $e) { throw new InvalidPayloadException(sprintf('Invalid Payload: %s', $e->getMessage()), 0, $e); } - if (is_array($result) || - is_object($result)) { - return $result; - } - - return null; + return is_array($result) ? $result : null; } } diff --git a/src/Middleware/WhitespaceStrippingMiddleware.php b/src/Middleware/WhitespaceStrippingMiddleware.php new file mode 100644 index 00000000..83b6af11 --- /dev/null +++ b/src/Middleware/WhitespaceStrippingMiddleware.php @@ -0,0 +1,56 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Middleware; + +/** + * Import classes + */ +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; + +/** + * Import functions + */ +use function array_walk_recursive; +use function is_array; +use function is_string; +use function trim; + +/** + * WhitespaceStrippingMiddleware + * + * @since 3.0.0 + */ +final class WhitespaceStrippingMiddleware implements MiddlewareInterface +{ + + /** + * {@inheritdoc} + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + $parsedBody = $request->getParsedBody(); + + if (!empty($parsedBody) && is_array($parsedBody)) { + /** @psalm-suppress MissingClosureParamType, MixedAssignment */ + array_walk_recursive($parsedBody, static function (&$value): void { + $value = is_string($value) ? trim($value) : $value; + }); + + $request = $request->withParsedBody($parsedBody); + } + + return $handler->handle($request); + } +} diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php new file mode 100644 index 00000000..017bb5a7 --- /dev/null +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -0,0 +1,105 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\ParameterResolver; + +/** + * Import classes + */ +use Psr\Http\Message\ServerRequestInterface; +use Sunrise\Http\Router\Annotation\RequestQuery; +use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; +use Sunrise\Http\Router\Exception\ParameterResolvingException; +use Sunrise\Http\Router\ParameterResolverInterface; +use Sunrise\Http\Router\RequestQueryInterface; +use Sunrise\Hydrator\Exception\InvalidObjectException; +use Sunrise\Hydrator\Exception\InvalidValueException; +use Sunrise\Hydrator\HydratorInterface; +use ReflectionNamedType; +use ReflectionParameter; + +/** + * Import functions + */ +use function is_subclass_of; + +/** + * Import constants + */ +use const PHP_MAJOR_VERSION; + +/** + * RequestQueryParameterResolver + * + * @link https://github.com/sunrise-php/hydrator + * + * @since 3.0.0 + */ +final class RequestQueryParameterResolver implements ParameterResolverInterface +{ + + /** + * @var HydratorInterface + */ + private HydratorInterface $hydrator; + + /** + * @param HydratorInterface $hydrator + */ + public function __construct(HydratorInterface $hydrator) + { + $this->hydrator = $hydrator; + } + + /** + * {@inheritdoc} + */ + public function supportsParameter(ReflectionParameter $parameter, $context): bool + { + if (!($context instanceof ServerRequestInterface)) { + return false; + } + + if (!($parameter->getType() instanceof ReflectionNamedType) || $parameter->getType()->isBuiltin()) { + return false; + } + + if (8 === PHP_MAJOR_VERSION && $parameter->getAttributes(RequestQuery::class)) { + return true; + } + + if (is_subclass_of($parameter->getType()->getName(), RequestQueryInterface::class)) { + return true; + } + + return false; + } + + /** + * {@inheritdoc} + */ + public function resolveParameter(ReflectionParameter $parameter, $context) + { + /** @var ServerRequestInterface */ + $context = $context; + + /** @var ReflectionNamedType */ + $parameterType = $parameter->getType(); + + try { + return $this->hydrator->hydrate($parameterType->getName(), $context->getQueryParams()); + } catch (InvalidObjectException $e) { + throw new ParameterResolvingException($e->getMessage(), 0, $e); + } catch (InvalidValueException $e) { + throw new HttpUnprocessableEntityException($e->getMessage(), 0, $e); + } + } +} diff --git a/src/RequestHandler/UnsafeCallableRequestHandler.php b/src/RequestHandler/UnsafeCallableRequestHandler.php new file mode 100644 index 00000000..36c46b15 --- /dev/null +++ b/src/RequestHandler/UnsafeCallableRequestHandler.php @@ -0,0 +1,54 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\RequestHandler; + +/** + * Import classes + */ +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\RequestHandlerInterface; + +/** + * UnsafeCallableRequestHandler + * + * @since 3.0.0 + */ +final class UnsafeCallableRequestHandler implements RequestHandlerInterface +{ + + /** + * The handler callback + * + * @var callable + */ + private $callback; + + /** + * Constructor of the class + * + * @param callable $callback + */ + public function __construct(callable $callback) + { + $this->callback = $callback; + } + + /** + * {@inheritdoc} + */ + public function handle(ServerRequestInterface $request): ResponseInterface + { + /** @var ResponseInterface */ + return ($this->callback)($request); + } +} diff --git a/src/RequestQueryInterface.php b/src/RequestQueryInterface.php new file mode 100644 index 00000000..8b59053c --- /dev/null +++ b/src/RequestQueryInterface.php @@ -0,0 +1,21 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router; + +/** + * RequestQueryInterface + * + * @since 3.0.0 + */ +interface RequestQueryInterface +{ +} diff --git a/src/RouteCollector.php b/src/RouteCollector.php index 05dd4214..6fd0c634 100644 --- a/src/RouteCollector.php +++ b/src/RouteCollector.php @@ -99,7 +99,7 @@ public function getCollection(): RouteCollectionInterface * * @param string $name * @param string $path - * @param string[] $methods + * @param list $methods * @param mixed $requestHandler * @param array $middlewares * @param array $attributes diff --git a/src/Router.php b/src/Router.php index 2dda44c8..267d8703 100644 --- a/src/Router.php +++ b/src/Router.php @@ -25,8 +25,8 @@ use Sunrise\Http\Router\Exception\RouteNotFoundException; use Sunrise\Http\Router\Exception\MethodNotAllowedException; use Sunrise\Http\Router\Loader\LoaderInterface; -use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; +use Sunrise\Http\Router\RequestHandler\UnsafeCallableRequestHandler; use Symfony\Contracts\EventDispatcher\EventDispatcherInterface; /** @@ -484,20 +484,17 @@ public function match(ServerRequestInterface $request): RouteInterface public function run(ServerRequestInterface $request): ResponseInterface { // lazy resolving of the given request... - $routing = new class implements RequestHandlerInterface - { - public function handle(ServerRequestInterface $request): ResponseInterface - { - $route = $this->match($request); - $this->matchedRoute = $route; - - if (isset($this->eventDispatcher)) { - $this->eventDispatcher->dispatch(new RouteEvent($route, $request)); - } + $routing = new UnsafeCallableRequestHandler(function (ServerRequestInterface $request): ResponseInterface { + $this->matchedRoute = $this->match($request); - return $route->handle($request); + if (isset($this->eventDispatcher)) { + $this->eventDispatcher->dispatch( + new RouteEvent($this->matchedRoute, $request) + ); } - }; + + return $this->matchedRoute->handle($request); + }); $middlewares = $this->getMiddlewares(); if (empty($middlewares)) { @@ -515,19 +512,20 @@ public function handle(ServerRequestInterface $request): ResponseInterface */ public function handle(ServerRequestInterface $request): ResponseInterface { - $route = $this->match($request); - $this->matchedRoute = $route; + $this->matchedRoute = $this->match($request); if (isset($this->eventDispatcher)) { - $this->eventDispatcher->dispatch(new RouteEvent($route, $request)); + $this->eventDispatcher->dispatch( + new RouteEvent($this->matchedRoute, $request) + ); } $middlewares = $this->getMiddlewares(); if (empty($middlewares)) { - return $route->handle($request); + return $this->matchedRoute->handle($request); } - $handler = new QueueableRequestHandler($route); + $handler = new QueueableRequestHandler($this->matchedRoute); $handler->add(...$middlewares); return $handler->handle($request); From 8e6f50dc9327368cbc1d7287482f9039c16d42e3 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 22 Jan 2023 07:19:00 +0100 Subject: [PATCH 033/180] v3 --- composer.json | 1 - functions/find_classes.php | 62 ------------- src/Loader/ConfigLoader.php | 4 +- src/Loader/DescriptorLoader.php | 87 +++++++++++-------- .../JsonPayloadDecodingMiddleware.php | 2 +- 5 files changed, 56 insertions(+), 100 deletions(-) delete mode 100644 functions/find_classes.php diff --git a/composer.json b/composer.json index b19d2476..9c9cb8b8 100644 --- a/composer.json +++ b/composer.json @@ -47,7 +47,6 @@ "autoload": { "files": [ "functions/emit.php", - "functions/find_classes.php", "functions/get_debug_type.php", "functions/path_build.php", "functions/path_match.php", diff --git a/functions/find_classes.php b/functions/find_classes.php deleted file mode 100644 index 755aa46b..00000000 --- a/functions/find_classes.php +++ /dev/null @@ -1,62 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router; - -/** - * Import classes - */ -use Iterator; -use RecursiveDirectoryIterator; -use RecursiveIteratorIterator; -use SplFileInfo; - -/** - * Import functions - */ -use function array_diff; -use function get_declared_classes; - -/** - * Scans the given directory and returns the found classes - * - * @param string $directory - * - * @return class-string[] - * - * @since 3.0.0 - */ -function find_classes(string $directory): array -{ - static $cache = []; - - if (isset($cache[$directory])) { - return $cache[$directory]; - } - - /** @var Iterator */ - $files = new RecursiveIteratorIterator( - new RecursiveDirectoryIterator($directory) - ); - - $knownClasses = get_declared_classes(); - - foreach ($files as $file) { - if ('php' === $file->getExtension()) { - /** @psalm-suppress UnresolvableInclude */ - require_once $file->getPathname(); - } - } - - $cache[$directory] = array_diff(get_declared_classes(), $knownClasses); - - return $cache[$directory]; -} diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index 1694048a..fb6df141 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -142,7 +142,7 @@ public function attach($resource): void throw new InvalidLoaderResourceException(sprintf( 'Config route loader only handles file or directory paths, ' . - 'however the given resource "%s" is not as expected', + 'however the given resource "%s" is not one of them', is_string($resource) ? $resource : get_debug_type($resource) )); } @@ -170,7 +170,7 @@ public function load(): RouteCollectionInterface ); foreach ($this->resources as $filename) { - (function (string $filename) { + (function (string $filename): void { /** @psalm-suppress UnresolvableInclude */ require $filename; })->call($collector, $filename); diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index eaa7fb92..b3bc5c7c 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -36,21 +36,26 @@ use Sunrise\Http\Router\RouteCollectionInterface; use Sunrise\Http\Router\RouteFactory; use Sunrise\Http\Router\RouteFactoryInterface; +use Iterator; +use RecursiveDirectoryIterator; +use RecursiveIteratorIterator; use ReflectionAttribute; use ReflectionClass; use ReflectionMethod; use Reflector; +use SplFileInfo; /** * Import functions */ +use function array_diff; use function class_exists; use function get_debug_type; +use function get_declared_classes; use function hash; use function is_dir; use function is_string; use function usort; -use function Sunrise\Http\Router\find_classes; /** * Import constants @@ -114,7 +119,7 @@ public function __construct( $this->routeFactory = $routeFactory ?? new RouteFactory(); $this->referenceResolver = $referenceResolver ?? new ReferenceResolver(); - if (PHP_MAJOR_VERSION < 8) { + if (PHP_MAJOR_VERSION === 7) { $this->useDefaultAnnotationReader(); } } @@ -227,7 +232,7 @@ public function setCacheKey(?string $cacheKey): void * @return void * * @throws LogicException - * If the doctrine/annotations package isn't installed. + * If the "doctrine/annotations" package isn't installed. * * @since 3.0.0 */ @@ -235,7 +240,7 @@ public function useDefaultAnnotationReader(): void { if (!class_exists(AnnotationReader::class)) { throw new LogicException( - 'Loading routes from descriptors requires the "doctrine/annotations" package that is not installed, ' . + 'Loading routes from descriptors requires an uninstalled "doctrine/annotations" package, ' . 'run the command "composer install doctrine/annotations" and try again' ); } @@ -254,9 +259,9 @@ public function attach($resource): void } if (is_string($resource) && is_dir($resource)) { - $classnames = find_classes($resource); - foreach ($classnames as $classname) { - $this->resources[] = $classname; + $classNames = $this->scandir($resource); + foreach ($classNames as $className) { + $this->resources[] = $className; } return; @@ -264,7 +269,7 @@ public function attach($resource): void throw new InvalidLoaderResourceException(sprintf( 'Descriptor route loader only handles class names or directory paths, ' . - 'however the given resource "%s" is not as expected', + 'however the given resource "%s" is not one of them', is_string($resource) ? $resource : get_debug_type($resource) )); } @@ -369,7 +374,7 @@ private function getDescriptorsFromClass(ReflectionClass $class): array return []; } - $descriptors = []; + $result = []; if ($class->isSubclassOf(RequestHandlerInterface::class)) { $annotations = $this->getAnnotationsFromClassOrMethod($class, Route::class); @@ -377,7 +382,7 @@ private function getDescriptorsFromClass(ReflectionClass $class): array $descriptor = $annotations[0]; $this->supplementDescriptorFromClassOrMethod($descriptor, $class); $descriptor->holder = $class->getName(); - $descriptors[] = $descriptor; + $result[] = $descriptor; } } @@ -393,36 +398,15 @@ private function getDescriptorsFromClass(ReflectionClass $class): array $this->supplementDescriptorFromClassOrMethod($descriptor, $class); $this->supplementDescriptorFromClassOrMethod($descriptor, $method); $descriptor->holder = [$class->getName(), $method->getName()]; - $descriptors[] = $descriptor; + $result[] = $descriptor; } } - return $descriptors; + return $result; } /** - * Supplements the given descriptor from the given class or method with data such as: - * - * - host - * - path prefix - * - path postfix - * - middlewares - * - * ```php - * #[Prefix('/api/v1')] - * class SomeController { - * - * #[Route('foo', path: '/foo')] - * public function foo() { - * // will be available at: /api/v1/foo - * } - * - * #[Route('bar', path: '/bar')] - * public function bar() { - * // will be available at: /api/v1/bar - * } - * } - * ``` + * Supplements the given descriptor from the given class or method * * @param Route $descriptor * @param ReflectionClass|ReflectionMethod $reflector @@ -489,4 +473,39 @@ private function getAnnotationsFromClassOrMethod(Reflector $reflector, string $a return $result; } + + /** + * Scans the given directory and returns the found classes + * + * @param string $directory + * + * @return class-string[] + */ + private function scandir(string $directory): array + { + /** @var array */ + static $cache = []; + + if (isset($cache[$directory])) { + return $cache[$directory]; + } + + $known = get_declared_classes(); + + /** @var Iterator */ + $files = new RecursiveIteratorIterator( + new RecursiveDirectoryIterator($directory) + ); + + foreach ($files as $file) { + if ('php' === $file->getExtension()) { + /** @psalm-suppress UnresolvableInclude */ + require_once $file->getPathname(); + } + } + + $cache[$directory] = array_diff(get_declared_classes(), $known); + + return $cache[$directory]; + } } diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 3cee875d..5371d7da 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -113,7 +113,7 @@ private function getRequestMediaType(ServerRequestInterface $request): ?string private function decodeRequestJsonPayload(ServerRequestInterface $request): ?array { // https://www.php.net/json.constants - $flags = JSON_OBJECT_AS_ARRAY | JSON_BIGINT_AS_STRING | JSON_THROW_ON_ERROR; + $flags = JSON_BIGINT_AS_STRING | JSON_OBJECT_AS_ARRAY | JSON_THROW_ON_ERROR; try { /** @var mixed */ From 554dcaf24360d6417c63880c9ed2bc7bb29960bd Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 22 Jan 2023 18:32:51 +0100 Subject: [PATCH 034/180] v3 --- src/Loader/ConfigLoader.php | 10 +- src/Loader/DescriptorLoader.php | 145 ++++++++---------- .../WhitespaceStrippingMiddleware.php | 1 + 3 files changed, 69 insertions(+), 87 deletions(-) diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index fb6df141..926f6309 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -126,11 +126,6 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo */ public function attach($resource): void { - if (is_string($resource) && is_file($resource)) { - $this->resources[] = $resource; - return; - } - if (is_string($resource) && is_dir($resource)) { $filenames = glob($resource . '/*.php'); foreach ($filenames as $filename) { @@ -140,6 +135,11 @@ public function attach($resource): void return; } + if (is_string($resource) && is_file($resource)) { + $this->resources[] = $resource; + return; + } + throw new InvalidLoaderResourceException(sprintf( 'Config route loader only handles file or directory paths, ' . 'however the given resource "%s" is not one of them', diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index b3bc5c7c..226c9efb 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -253,20 +253,20 @@ public function useDefaultAnnotationReader(): void */ public function attach($resource): void { - if (is_string($resource) && class_exists($resource)) { - $this->resources[] = $resource; - return; - } - if (is_string($resource) && is_dir($resource)) { - $classNames = $this->scandir($resource); - foreach ($classNames as $className) { - $this->resources[] = $className; + $classnames = $this->scandir($resource); + foreach ($classnames as $classname) { + $this->resources[] = $classname; } return; } + if (is_string($resource) && class_exists($resource)) { + $this->resources[] = $resource; + return; + } + throw new InvalidLoaderResourceException(sprintf( 'Descriptor route loader only handles class names or directory paths, ' . 'however the given resource "%s" is not one of them', @@ -290,9 +290,8 @@ public function attachArray(array $resources): void */ public function load(): RouteCollectionInterface { - $descriptors = $this->getDescriptors(); - $routes = []; + $descriptors = $this->getDescriptors(); foreach ($descriptors as $descriptor) { $routes[] = $this->routeFactory->createRoute( $descriptor->name, @@ -314,7 +313,7 @@ public function load(): RouteCollectionInterface /** * Gets descriptors from the cache if they are stored in it, * otherwise collects them from the loader resources, - * and then tries to cache and return them + * then tries to cache and return them * * @return list */ @@ -327,26 +326,13 @@ private function getDescriptors(): array return $this->cache->get($cacheKey); } - $descriptors = $this->collectDescriptors(); - - if (isset($this->cache)) { - $this->cache->set($cacheKey, $descriptors); - } - - return $descriptors; - } - - /** - * Collects and returns descriptors from the loader resources - * - * @return list - */ - private function collectDescriptors(): array - { $result = []; + foreach ($this->resources as $resource) { - $class = new ReflectionClass($resource); - $descriptors = $this->getDescriptorsFromClass($class); + $descriptors = $this->getClassDescriptors( + new ReflectionClass($resource) + ); + foreach ($descriptors as $descriptor) { $result[] = $descriptor; } @@ -356,6 +342,10 @@ private function collectDescriptors(): array return $b->priority <=> $a->priority; }); + if (isset($this->cache)) { + $this->cache->set($cacheKey, $result); + } + return $result; } @@ -366,7 +356,7 @@ private function collectDescriptors(): array * * @return list */ - private function getDescriptorsFromClass(ReflectionClass $class): array + private function getClassDescriptors(ReflectionClass $class): array { // e.g., interfaces, traits, enums, abstract classes, // classes with private constructor... @@ -377,11 +367,11 @@ private function getDescriptorsFromClass(ReflectionClass $class): array $result = []; if ($class->isSubclassOf(RequestHandlerInterface::class)) { - $annotations = $this->getAnnotationsFromClassOrMethod($class, Route::class); + $annotations = $this->getClassOrMethodAnnotations($class, Route::class); if (isset($annotations[0])) { $descriptor = $annotations[0]; - $this->supplementDescriptorFromClassOrMethod($descriptor, $class); $descriptor->holder = $class->getName(); + $this->supplementDescriptorFromClassOrMethod($descriptor, $class); $result[] = $descriptor; } } @@ -392,12 +382,12 @@ private function getDescriptorsFromClass(ReflectionClass $class): array continue; } - $annotations = $this->getAnnotationsFromClassOrMethod($method, Route::class); + $annotations = $this->getClassOrMethodAnnotations($method, Route::class); if (isset($annotations[0])) { $descriptor = $annotations[0]; + $descriptor->holder = [$class->getName(), $method->getName()]; $this->supplementDescriptorFromClassOrMethod($descriptor, $class); $this->supplementDescriptorFromClassOrMethod($descriptor, $method); - $descriptor->holder = [$class->getName(), $method->getName()]; $result[] = $descriptor; } } @@ -406,53 +396,22 @@ private function getDescriptorsFromClass(ReflectionClass $class): array } /** - * Supplements the given descriptor from the given class or method - * - * @param Route $descriptor - * @param ReflectionClass|ReflectionMethod $reflector - * - * @return void - */ - private function supplementDescriptorFromClassOrMethod(Route $descriptor, Reflector $reflector): void - { - $annotations = $this->getAnnotationsFromClassOrMethod($reflector, Host::class); - if (isset($annotations[0])) { - $descriptor->host = $annotations[0]->value; - } - - $annotations = $this->getAnnotationsFromClassOrMethod($reflector, Prefix::class); - if (isset($annotations[0])) { - $descriptor->path = $annotations[0]->value . $descriptor->path; - } - - $annotations = $this->getAnnotationsFromClassOrMethod($reflector, Postfix::class); - if (isset($annotations[0])) { - $descriptor->path = $descriptor->path . $annotations[0]->value; - } - - $annotations = $this->getAnnotationsFromClassOrMethod($reflector, Middleware::class); - foreach ($annotations as $annotation) { - $descriptor->middlewares[] = $annotation->value; - } - } - - /** - * Gets annotations from the given class or method + * Gets annotations from the given class or method by the given name * - * @param ReflectionClass|ReflectionMethod $reflector + * @param ReflectionClass|ReflectionMethod $reflection * @param class-string $annotationName * * @return list * * @template T */ - private function getAnnotationsFromClassOrMethod(Reflector $reflector, string $annotationName): array + private function getClassOrMethodAnnotations(Reflector $reflection, string $annotationName): array { $result = []; if (PHP_MAJOR_VERSION === 8) { /** @var ReflectionAttribute[] */ - $attributes = $reflector->getAttributes($annotationName); + $attributes = $reflection->getAttributes($annotationName); foreach ($attributes as $attribute) { /** @var T */ $result[] = $attribute->newInstance(); @@ -460,9 +419,9 @@ private function getAnnotationsFromClassOrMethod(Reflector $reflector, string $a } if (isset($this->annotationReader)) { - $annotations = ($reflector instanceof ReflectionClass) ? - $this->annotationReader->getClassAnnotations($reflector) : - $this->annotationReader->getMethodAnnotations($reflector); + $annotations = ($reflection instanceof ReflectionClass) ? + $this->annotationReader->getClassAnnotations($reflection) : + $this->annotationReader->getMethodAnnotations($reflection); foreach ($annotations as $annotation) { if ($annotation instanceof $annotationName) { @@ -474,6 +433,37 @@ private function getAnnotationsFromClassOrMethod(Reflector $reflector, string $a return $result; } + /** + * Supplements the given descriptor from the given class or method + * + * @param Route $descriptor + * @param ReflectionClass|ReflectionMethod $reflection + * + * @return void + */ + private function supplementDescriptorFromClassOrMethod(Route $descriptor, Reflector $reflection): void + { + $annotations = $this->getClassOrMethodAnnotations($reflection, Host::class); + if (isset($annotations[0])) { + $descriptor->host = $annotations[0]->value; + } + + $annotations = $this->getClassOrMethodAnnotations($reflection, Prefix::class); + if (isset($annotations[0])) { + $descriptor->path = $annotations[0]->value . $descriptor->path; + } + + $annotations = $this->getClassOrMethodAnnotations($reflection, Postfix::class); + if (isset($annotations[0])) { + $descriptor->path = $descriptor->path . $annotations[0]->value; + } + + $annotations = $this->getClassOrMethodAnnotations($reflection, Middleware::class); + foreach ($annotations as $annotation) { + $descriptor->middlewares[] = $annotation->value; + } + } + /** * Scans the given directory and returns the found classes * @@ -483,13 +473,6 @@ private function getAnnotationsFromClassOrMethod(Reflector $reflector, string $a */ private function scandir(string $directory): array { - /** @var array */ - static $cache = []; - - if (isset($cache[$directory])) { - return $cache[$directory]; - } - $known = get_declared_classes(); /** @var Iterator */ @@ -504,8 +487,6 @@ private function scandir(string $directory): array } } - $cache[$directory] = array_diff(get_declared_classes(), $known); - - return $cache[$directory]; + return array_diff(get_declared_classes(), $known); } } diff --git a/src/Middleware/WhitespaceStrippingMiddleware.php b/src/Middleware/WhitespaceStrippingMiddleware.php index 83b6af11..766e6de7 100644 --- a/src/Middleware/WhitespaceStrippingMiddleware.php +++ b/src/Middleware/WhitespaceStrippingMiddleware.php @@ -43,6 +43,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface $parsedBody = $request->getParsedBody(); if (!empty($parsedBody) && is_array($parsedBody)) { + /** @psalm-suppress MissingClosureParamType, MixedAssignment */ array_walk_recursive($parsedBody, static function (&$value): void { $value = is_string($value) ? trim($value) : $value; From 037aa7bb66e91862578636e7041b8aacca075d50 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 22 Jan 2023 19:39:06 +0100 Subject: [PATCH 035/180] v3 --- .../InvalidLoaderResourceException.php | 19 -------------- src/Exception/InvalidPayloadException.php | 26 ------------------- src/Loader/ConfigLoader.php | 17 +++++++----- src/Loader/DescriptorLoader.php | 25 +++++++++++------- src/Loader/LoaderInterface.php | 6 ++--- .../JsonPayloadDecodingMiddleware.php | 6 ++--- 6 files changed, 32 insertions(+), 67 deletions(-) delete mode 100644 src/Exception/InvalidLoaderResourceException.php delete mode 100644 src/Exception/InvalidPayloadException.php diff --git a/src/Exception/InvalidLoaderResourceException.php b/src/Exception/InvalidLoaderResourceException.php deleted file mode 100644 index 42301f93..00000000 --- a/src/Exception/InvalidLoaderResourceException.php +++ /dev/null @@ -1,19 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Exception; - -/** - * InvalidLoaderResourceException - */ -class InvalidLoaderResourceException extends InvalidArgumentException -{ -} diff --git a/src/Exception/InvalidPayloadException.php b/src/Exception/InvalidPayloadException.php deleted file mode 100644 index b10d32de..00000000 --- a/src/Exception/InvalidPayloadException.php +++ /dev/null @@ -1,26 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Exception; - -/** - * Import classes - */ -use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; - -/** - * InvalidPayloadException - * - * @since 3.0.0 - */ -class InvalidPayloadException extends HttpBadRequestException -{ -} diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index 926f6309..bb9c030a 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -15,7 +15,7 @@ * Import classes */ use Psr\Container\ContainerInterface; -use Sunrise\Http\Router\Exception\InvalidLoaderResourceException; +use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; @@ -30,7 +30,6 @@ /** * Import functions */ -use function get_debug_type; use function glob; use function is_dir; use function is_file; @@ -126,7 +125,13 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo */ public function attach($resource): void { - if (is_string($resource) && is_dir($resource)) { + if (!is_string($resource)) { + throw new InvalidArgumentException( + 'Config route loader only handles string resources' + ); + } + + if (is_dir($resource)) { $filenames = glob($resource . '/*.php'); foreach ($filenames as $filename) { $this->resources[] = $filename; @@ -135,15 +140,15 @@ public function attach($resource): void return; } - if (is_string($resource) && is_file($resource)) { + if (is_file($resource)) { $this->resources[] = $resource; return; } - throw new InvalidLoaderResourceException(sprintf( + throw new InvalidArgumentException(sprintf( 'Config route loader only handles file or directory paths, ' . 'however the given resource "%s" is not one of them', - is_string($resource) ? $resource : get_debug_type($resource) + $resource )); } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 226c9efb..e2e7fe59 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -25,7 +25,7 @@ use Sunrise\Http\Router\Annotation\Postfix; use Sunrise\Http\Router\Annotation\Prefix; use Sunrise\Http\Router\Annotation\Route; -use Sunrise\Http\Router\Exception\InvalidLoaderResourceException; +use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ReferenceResolver; @@ -50,7 +50,6 @@ */ use function array_diff; use function class_exists; -use function get_debug_type; use function get_declared_classes; use function hash; use function is_dir; @@ -253,7 +252,13 @@ public function useDefaultAnnotationReader(): void */ public function attach($resource): void { - if (is_string($resource) && is_dir($resource)) { + if (!is_string($resource)) { + throw new InvalidArgumentException( + 'Descriptor route loader only handles string resources' + ); + } + + if (is_dir($resource)) { $classnames = $this->scandir($resource); foreach ($classnames as $classname) { $this->resources[] = $classname; @@ -262,15 +267,15 @@ public function attach($resource): void return; } - if (is_string($resource) && class_exists($resource)) { + if (class_exists($resource)) { $this->resources[] = $resource; return; } - throw new InvalidLoaderResourceException(sprintf( + throw new InvalidArgumentException(sprintf( 'Descriptor route loader only handles class names or directory paths, ' . 'however the given resource "%s" is not one of them', - is_string($resource) ? $resource : get_debug_type($resource) + $resource )); } @@ -319,11 +324,11 @@ public function load(): RouteCollectionInterface */ private function getDescriptors(): array { - $cacheKey = $this->getCacheKey(); + $key = $this->getCacheKey(); - if (isset($this->cache) && $this->cache->has($cacheKey)) { + if (isset($this->cache) && $this->cache->has($key)) { /** @var list */ - return $this->cache->get($cacheKey); + return $this->cache->get($key); } $result = []; @@ -343,7 +348,7 @@ private function getDescriptors(): array }); if (isset($this->cache)) { - $this->cache->set($cacheKey, $result); + $this->cache->set($key, $result); } return $result; diff --git a/src/Loader/LoaderInterface.php b/src/Loader/LoaderInterface.php index b268edc4..be6408b4 100644 --- a/src/Loader/LoaderInterface.php +++ b/src/Loader/LoaderInterface.php @@ -14,7 +14,7 @@ /** * Import classes */ -use Sunrise\Http\Router\Exception\InvalidLoaderResourceException; +use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\RouteCollectionInterface; /** @@ -30,7 +30,7 @@ interface LoaderInterface * * @return void * - * @throws InvalidLoaderResourceException + * @throws InvalidArgumentException * If the given resource isn't valid. */ public function attach($resource): void; @@ -42,7 +42,7 @@ public function attach($resource): void; * * @return void * - * @throws InvalidLoaderResourceException + * @throws InvalidArgumentException * If one of the given resources isn't valid. */ public function attachArray(array $resources): void; diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 5371d7da..71e7516d 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -19,7 +19,7 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\InvalidPayloadException; +use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; /** * Import functions @@ -107,7 +107,7 @@ private function getRequestMediaType(ServerRequestInterface $request): ?string * * @return array|null * - * @throws InvalidPayloadException + * @throws HttpBadRequestException * If the request's "JSON" payload cannot be decoded. */ private function decodeRequestJsonPayload(ServerRequestInterface $request): ?array @@ -119,7 +119,7 @@ private function decodeRequestJsonPayload(ServerRequestInterface $request): ?arr /** @var mixed */ $result = json_decode($request->getBody()->__toString(), null, 512, $flags); } catch (JsonException $e) { - throw new InvalidPayloadException(sprintf('Invalid Payload: %s', $e->getMessage()), 0, $e); + throw new HttpBadRequestException(sprintf('Invalid Payload: %s', $e->getMessage()), 0, $e); } return is_array($result) ? $result : null; From 5024f93511df8793c388f37dda8764688dcaf1b6 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 22 Jan 2023 22:05:56 +0100 Subject: [PATCH 036/180] v3 --- src/Exception/InvalidRequestBodyException.php | 26 +++++++++++++++++++ .../InvalidRequestPayloadException.php | 26 +++++++++++++++++++ .../InvalidRequestQueryException.php | 26 +++++++++++++++++++ .../JsonPayloadDecodingMiddleware.php | 6 ++--- .../RequestBodyParameterResolver.php | 13 ++++++---- .../RequestQueryParameterResolver.php | 13 ++++++---- 6 files changed, 97 insertions(+), 13 deletions(-) create mode 100644 src/Exception/InvalidRequestBodyException.php create mode 100644 src/Exception/InvalidRequestPayloadException.php create mode 100644 src/Exception/InvalidRequestQueryException.php diff --git a/src/Exception/InvalidRequestBodyException.php b/src/Exception/InvalidRequestBodyException.php new file mode 100644 index 00000000..3e1135a4 --- /dev/null +++ b/src/Exception/InvalidRequestBodyException.php @@ -0,0 +1,26 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; + +/** + * InvalidRequestBodyException + * + * @since 3.0.0 + */ +class InvalidRequestBodyException extends HttpBadRequestException +{ +} diff --git a/src/Exception/InvalidRequestPayloadException.php b/src/Exception/InvalidRequestPayloadException.php new file mode 100644 index 00000000..24c8c478 --- /dev/null +++ b/src/Exception/InvalidRequestPayloadException.php @@ -0,0 +1,26 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; + +/** + * InvalidRequestPayloadException + * + * @since 3.0.0 + */ +class InvalidRequestPayloadException extends HttpBadRequestException +{ +} diff --git a/src/Exception/InvalidRequestQueryException.php b/src/Exception/InvalidRequestQueryException.php new file mode 100644 index 00000000..6f7a6499 --- /dev/null +++ b/src/Exception/InvalidRequestQueryException.php @@ -0,0 +1,26 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; + +/** + * InvalidRequestQueryException + * + * @since 3.0.0 + */ +class InvalidRequestQueryException extends HttpBadRequestException +{ +} diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 71e7516d..e566b60c 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -19,7 +19,7 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; +use Sunrise\Http\Router\Exception\InvalidRequestPayloadException; /** * Import functions @@ -107,7 +107,7 @@ private function getRequestMediaType(ServerRequestInterface $request): ?string * * @return array|null * - * @throws HttpBadRequestException + * @throws InvalidRequestPayloadException * If the request's "JSON" payload cannot be decoded. */ private function decodeRequestJsonPayload(ServerRequestInterface $request): ?array @@ -119,7 +119,7 @@ private function decodeRequestJsonPayload(ServerRequestInterface $request): ?arr /** @var mixed */ $result = json_decode($request->getBody()->__toString(), null, 512, $flags); } catch (JsonException $e) { - throw new HttpBadRequestException(sprintf('Invalid Payload: %s', $e->getMessage()), 0, $e); + throw new InvalidRequestPayloadException(sprintf('Invalid Payload: %s', $e->getMessage()), 0, $e); } return is_array($result) ? $result : null; diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index f70a4593..9b699d4f 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -16,8 +16,7 @@ */ use Psr\Http\Message\ServerRequestInterface; use Sunrise\Http\Router\Annotation\RequestBody; -use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; -use Sunrise\Http\Router\Exception\ParameterResolvingException; +use Sunrise\Http\Router\Exception\InvalidRequestBodyException; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\RequestBodyInterface; use Sunrise\Hydrator\Exception\InvalidObjectException; @@ -85,6 +84,12 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo /** * {@inheritdoc} + * + * @throws InvalidObjectException + * If the DTO isn't valid. + * + * @throws InvalidRequestBodyException + * If the DTO cannot be hydrated with the request body. */ public function resolveParameter(ReflectionParameter $parameter, $context) { @@ -96,10 +101,8 @@ public function resolveParameter(ReflectionParameter $parameter, $context) try { return $this->hydrator->hydrate($parameterType->getName(), (array) $context->getParsedBody()); - } catch (InvalidObjectException $e) { - throw new ParameterResolvingException($e->getMessage(), 0, $e); } catch (InvalidValueException $e) { - throw new HttpUnprocessableEntityException($e->getMessage(), 0, $e); + throw new InvalidRequestBodyException($e->getMessage(), 0, $e); } } } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 017bb5a7..93980eb8 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -16,8 +16,7 @@ */ use Psr\Http\Message\ServerRequestInterface; use Sunrise\Http\Router\Annotation\RequestQuery; -use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; -use Sunrise\Http\Router\Exception\ParameterResolvingException; +use Sunrise\Http\Router\Exception\InvalidRequestQueryException; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\RequestQueryInterface; use Sunrise\Hydrator\Exception\InvalidObjectException; @@ -85,6 +84,12 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo /** * {@inheritdoc} + * + * @throws InvalidObjectException + * If the DTO isn't valid. + * + * @throws InvalidRequestQueryException + * If the DTO cannot be hydrated with the request query. */ public function resolveParameter(ReflectionParameter $parameter, $context) { @@ -96,10 +101,8 @@ public function resolveParameter(ReflectionParameter $parameter, $context) try { return $this->hydrator->hydrate($parameterType->getName(), $context->getQueryParams()); - } catch (InvalidObjectException $e) { - throw new ParameterResolvingException($e->getMessage(), 0, $e); } catch (InvalidValueException $e) { - throw new HttpUnprocessableEntityException($e->getMessage(), 0, $e); + throw new InvalidRequestQueryException($e->getMessage(), 0, $e); } } } From 8ee8bb3de1ace473a3e686670ab6f94688bb63f2 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Mon, 23 Jan 2023 20:06:16 +0100 Subject: [PATCH 037/180] v3 --- src/AnnotationReader.php | 117 +++++++++++++++++ src/Exception/ParameterResolvingException.php | 21 ---- src/Exception/ResolvingException.php | 2 +- src/Exception/ResponseResolvingException.php | 21 ---- src/Loader/ConfigLoader.php | 4 +- src/Loader/DescriptorLoader.php | 119 ++++++------------ src/Middleware/CallableMiddleware.php | 15 ++- .../JsonPayloadDecodingMiddleware.php | 2 +- src/ParameterResolutioner.php | 111 +++++++++------- src/ParameterResolutionerInterface.php | 23 +--- .../DependencyInjectionParameterResolver.php | 73 +++++++++++ .../KnownTypeParameterResolver.php | 93 ++++++++++++++ .../RequestBodyParameterResolver.php | 17 ++- .../RequestQueryParameterResolver.php | 17 ++- src/ParameterResolverInterface.php | 4 +- src/ReferenceResolver.php | 2 - src/RequestHandler/CallableRequestHandler.php | 13 +- .../QueueableRequestHandler.php | 2 +- src/ResponseResolutioner.php | 4 +- src/ResponseResolutionerInterface.php | 4 +- src/ResponseResolverInterface.php | 4 +- 21 files changed, 444 insertions(+), 224 deletions(-) create mode 100644 src/AnnotationReader.php delete mode 100644 src/Exception/ParameterResolvingException.php delete mode 100644 src/Exception/ResponseResolvingException.php create mode 100644 src/ParameterResolver/DependencyInjectionParameterResolver.php create mode 100644 src/ParameterResolver/KnownTypeParameterResolver.php diff --git a/src/AnnotationReader.php b/src/AnnotationReader.php new file mode 100644 index 00000000..6ecd595d --- /dev/null +++ b/src/AnnotationReader.php @@ -0,0 +1,117 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router; + +/** + * Import classes + */ +use Doctrine\Common\Annotations\AnnotationReader as DoctrineAnnotationReader; +use Doctrine\Common\Annotations\Reader as DoctrineAnnotationReaderInterface; +use Sunrise\Http\Router\Exception\LogicException; +use ReflectionAttribute; +use ReflectionClass; +use ReflectionMethod; +use Reflector; + +/** + * Import functions + */ +use function class_exists; + +/** + * Import constants + */ +use const PHP_MAJOR_VERSION; + +/** + * AnnotationReader + * + * @since 3.0.0 + */ +final class AnnotationReader +{ + + /** + * @var DoctrineAnnotationReaderInterface|null + */ + private ?DoctrineAnnotationReaderInterface $annotationReader = null; + + /** + * Sets the given annotation reader to the reader + * + * @param DoctrineAnnotationReaderInterface|null $annotationReader + * + * @return void + */ + public function setAnnotationReader(?DoctrineAnnotationReaderInterface $annotationReader): void + { + $this->annotationReader = $annotationReader; + } + + /** + * Sets the default annotation reader to the reader + * + * @return void + * + * @throws LogicException + * If the "doctrine/annotations" package isn't installed. + */ + public function useDefaultAnnotationReader(): void + { + if (!class_exists(DoctrineAnnotationReader::class)) { + throw new LogicException( + 'The annotations reading logic requires an uninstalled "doctrine/annotations" package, ' . + 'run the command "composer install doctrine/annotations" and try again' + ); + } + + $this->setAnnotationReader(new DoctrineAnnotationReader()); + } + + /** + * Gets annotations by the given name from the given class or method + * + * @param ReflectionClass|ReflectionMethod $classOrMethod + * @param class-string $annotationName + * + * @return list + * + * @template T + */ + public function getAnnotations(Reflector $classOrMethod, string $annotationName): array + { + $result = []; + + if (PHP_MAJOR_VERSION === 8) { + /** @var ReflectionAttribute[] */ + $attributes = $classOrMethod->getAttributes($annotationName); + foreach ($attributes as $attribute) { + /** @var T */ + $result[] = $attribute->newInstance(); + } + } + + if (isset($this->annotationReader)) { + $annotations = ($classOrMethod instanceof ReflectionClass) ? + $this->annotationReader->getClassAnnotations($classOrMethod) : + $this->annotationReader->getMethodAnnotations($classOrMethod); + + foreach ($annotations as $annotation) { + if ($annotation instanceof $annotationName) { + $result[] = $annotation; + } + } + } + + return $result; + } +} diff --git a/src/Exception/ParameterResolvingException.php b/src/Exception/ParameterResolvingException.php deleted file mode 100644 index ad85b9cf..00000000 --- a/src/Exception/ParameterResolvingException.php +++ /dev/null @@ -1,21 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Exception; - -/** - * ParameterResolvingException - * - * @since 3.0.0 - */ -class ParameterResolvingException extends ResolvingException -{ -} diff --git a/src/Exception/ResolvingException.php b/src/Exception/ResolvingException.php index 4fafb2a5..85953a58 100644 --- a/src/Exception/ResolvingException.php +++ b/src/Exception/ResolvingException.php @@ -16,6 +16,6 @@ * * @since 3.0.0 */ -class ResolvingException extends Exception +class ResolvingException extends LogicException { } diff --git a/src/Exception/ResponseResolvingException.php b/src/Exception/ResponseResolvingException.php deleted file mode 100644 index 6b4db132..00000000 --- a/src/Exception/ResponseResolvingException.php +++ /dev/null @@ -1,21 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Exception; - -/** - * ResponseResolvingException - * - * @since 3.0.0 - */ -class ResponseResolvingException extends ResolvingException -{ -} diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index bb9c030a..3a44852e 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -127,7 +127,7 @@ public function attach($resource): void { if (!is_string($resource)) { throw new InvalidArgumentException( - 'Config route loader only handles string resources' + 'The config route loader only handles string resources' ); } @@ -146,7 +146,7 @@ public function attach($resource): void } throw new InvalidArgumentException(sprintf( - 'Config route loader only handles file or directory paths, ' . + 'The config route loader only handles file or directory paths, ' . 'however the given resource "%s" is not one of them', $resource )); diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index e2e7fe59..e9002683 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -14,10 +14,8 @@ /** * Import classes */ -use Doctrine\Common\Annotations\AnnotationReader; use Doctrine\Common\Annotations\Reader as AnnotationReaderInterface; use Psr\Container\ContainerInterface; -use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use Psr\SimpleCache\CacheInterface; use Sunrise\Http\Router\Annotation\Host; @@ -26,7 +24,7 @@ use Sunrise\Http\Router\Annotation\Prefix; use Sunrise\Http\Router\Annotation\Route; use Sunrise\Http\Router\Exception\InvalidArgumentException; -use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\AnnotationReader; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; @@ -39,7 +37,6 @@ use Iterator; use RecursiveDirectoryIterator; use RecursiveIteratorIterator; -use ReflectionAttribute; use ReflectionClass; use ReflectionMethod; use Reflector; @@ -64,7 +61,7 @@ /** * DescriptorLoader */ -class DescriptorLoader implements LoaderInterface +final class DescriptorLoader implements LoaderInterface { /** @@ -88,9 +85,9 @@ class DescriptorLoader implements LoaderInterface private ReferenceResolverInterface $referenceResolver; /** - * @var AnnotationReaderInterface|null + * @var AnnotationReader */ - private ?AnnotationReaderInterface $annotationReader = null; + private AnnotationReader $annotationReader; /** * @var CacheInterface|null @@ -118,8 +115,10 @@ public function __construct( $this->routeFactory = $routeFactory ?? new RouteFactory(); $this->referenceResolver = $referenceResolver ?? new ReferenceResolver(); - if (PHP_MAJOR_VERSION === 7) { - $this->useDefaultAnnotationReader(); + $this->annotationReader = new AnnotationReader(); + + if (8 > PHP_MAJOR_VERSION) { + $this->annotationReader->useDefaultAnnotationReader(); } } @@ -164,7 +163,7 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo } /** - * Sets the given annotation reader to the loader + * Sets the given annotation reader to the descriptor loader * * @param AnnotationReaderInterface|null $annotationReader * @@ -174,7 +173,19 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo */ public function setAnnotationReader(?AnnotationReaderInterface $annotationReader): void { - $this->annotationReader = $annotationReader; + $this->annotationReader->setAnnotationReader($annotationReader); + } + + /** + * Uses the default annotation reader + * + * @return void + * + * @since 3.0.0 + */ + public function useDefaultAnnotationReader(): void + { + $this->annotationReader->useDefaultAnnotationReader(); } /** @@ -225,28 +236,6 @@ public function setCacheKey(?string $cacheKey): void $this->cacheKey = $cacheKey; } - /** - * Uses the default annotation reader - * - * @return void - * - * @throws LogicException - * If the "doctrine/annotations" package isn't installed. - * - * @since 3.0.0 - */ - public function useDefaultAnnotationReader(): void - { - if (!class_exists(AnnotationReader::class)) { - throw new LogicException( - 'Loading routes from descriptors requires an uninstalled "doctrine/annotations" package, ' . - 'run the command "composer install doctrine/annotations" and try again' - ); - } - - $this->setAnnotationReader(new AnnotationReader()); - } - /** * {@inheritdoc} */ @@ -254,7 +243,7 @@ public function attach($resource): void { if (!is_string($resource)) { throw new InvalidArgumentException( - 'Descriptor route loader only handles string resources' + 'The descriptor route loader only handles string resources' ); } @@ -273,7 +262,7 @@ public function attach($resource): void } throw new InvalidArgumentException(sprintf( - 'Descriptor route loader only handles class names or directory paths, ' . + 'The descriptor route loader only handles class names or directory paths, ' . 'however the given resource "%s" is not one of them', $resource )); @@ -372,11 +361,11 @@ private function getClassDescriptors(ReflectionClass $class): array $result = []; if ($class->isSubclassOf(RequestHandlerInterface::class)) { - $annotations = $this->getClassOrMethodAnnotations($class, Route::class); + $annotations = $this->annotationReader->getAnnotations($class, Route::class); if (isset($annotations[0])) { $descriptor = $annotations[0]; $descriptor->holder = $class->getName(); - $this->supplementDescriptorFromClassOrMethod($descriptor, $class); + $this->supplementDescriptor($descriptor, $class); $result[] = $descriptor; } } @@ -387,12 +376,12 @@ private function getClassDescriptors(ReflectionClass $class): array continue; } - $annotations = $this->getClassOrMethodAnnotations($method, Route::class); + $annotations = $this->annotationReader->getAnnotations($method, Route::class); if (isset($annotations[0])) { $descriptor = $annotations[0]; $descriptor->holder = [$class->getName(), $method->getName()]; - $this->supplementDescriptorFromClassOrMethod($descriptor, $class); - $this->supplementDescriptorFromClassOrMethod($descriptor, $method); + $this->supplementDescriptor($descriptor, $class); + $this->supplementDescriptor($descriptor, $method); $result[] = $descriptor; } } @@ -400,70 +389,32 @@ private function getClassDescriptors(ReflectionClass $class): array return $result; } - /** - * Gets annotations from the given class or method by the given name - * - * @param ReflectionClass|ReflectionMethod $reflection - * @param class-string $annotationName - * - * @return list - * - * @template T - */ - private function getClassOrMethodAnnotations(Reflector $reflection, string $annotationName): array - { - $result = []; - - if (PHP_MAJOR_VERSION === 8) { - /** @var ReflectionAttribute[] */ - $attributes = $reflection->getAttributes($annotationName); - foreach ($attributes as $attribute) { - /** @var T */ - $result[] = $attribute->newInstance(); - } - } - - if (isset($this->annotationReader)) { - $annotations = ($reflection instanceof ReflectionClass) ? - $this->annotationReader->getClassAnnotations($reflection) : - $this->annotationReader->getMethodAnnotations($reflection); - - foreach ($annotations as $annotation) { - if ($annotation instanceof $annotationName) { - $result[] = $annotation; - } - } - } - - return $result; - } - /** * Supplements the given descriptor from the given class or method * * @param Route $descriptor - * @param ReflectionClass|ReflectionMethod $reflection + * @param ReflectionClass|ReflectionMethod $source * * @return void */ - private function supplementDescriptorFromClassOrMethod(Route $descriptor, Reflector $reflection): void + private function supplementDescriptor(Route $descriptor, Reflector $source): void { - $annotations = $this->getClassOrMethodAnnotations($reflection, Host::class); + $annotations = $this->annotationReader->getAnnotations($source, Host::class); if (isset($annotations[0])) { $descriptor->host = $annotations[0]->value; } - $annotations = $this->getClassOrMethodAnnotations($reflection, Prefix::class); + $annotations = $this->annotationReader->getAnnotations($source, Prefix::class); if (isset($annotations[0])) { $descriptor->path = $annotations[0]->value . $descriptor->path; } - $annotations = $this->getClassOrMethodAnnotations($reflection, Postfix::class); + $annotations = $this->annotationReader->getAnnotations($source, Postfix::class); if (isset($annotations[0])) { $descriptor->path = $descriptor->path . $annotations[0]->value; } - $annotations = $this->getClassOrMethodAnnotations($reflection, Middleware::class); + $annotations = $this->annotationReader->getAnnotations($source, Middleware::class); foreach ($annotations as $annotation) { $descriptor->middlewares[] = $annotation->value; } diff --git a/src/Middleware/CallableMiddleware.php b/src/Middleware/CallableMiddleware.php index e100ffa9..5d8d3a57 100644 --- a/src/Middleware/CallableMiddleware.php +++ b/src/Middleware/CallableMiddleware.php @@ -14,15 +14,16 @@ /** * Import classes */ -use ReflectionFunctionAbstract; -use ReflectionFunction; -use ReflectionMethod; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\ParameterResolver\KnownTypeParameterResolver; use Sunrise\Http\Router\ParameterResolutionerInterface; use Sunrise\Http\Router\ResponseResolutionerInterface; +use ReflectionFunctionAbstract; +use ReflectionFunction; +use ReflectionMethod; /** * Import functions @@ -92,10 +93,14 @@ public function getReflection(): ReflectionFunctionAbstract */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { + $resolvers = [ + new KnownTypeParameterResolver(ServerRequestInterface::class, $request), + new KnownTypeParameterResolver(RequestHandlerInterface::class, $handler), + ]; + $arguments = $this->parameterResolutioner ->withContext($request) - ->withType(ServerRequestInterface::class, $request) - ->withType(RequestHandlerInterface::class, $handler) + ->withPriorityResolver(...$resolvers) ->resolveParameters(...$this->getReflection()->getParameters()); /** @var mixed */ diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index e566b60c..b853d822 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -14,12 +14,12 @@ /** * Import classes */ -use JsonException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Exception\InvalidRequestPayloadException; +use JsonException; /** * Import functions diff --git a/src/ParameterResolutioner.php b/src/ParameterResolutioner.php index d85fcd14..090cf505 100644 --- a/src/ParameterResolutioner.php +++ b/src/ParameterResolutioner.php @@ -14,10 +14,10 @@ /** * Import classes */ -use ReflectionNamedType; +use Sunrise\Http\Router\Exception\LogicException; +use ReflectionFunctionAbstract; +use ReflectionMethod; use ReflectionParameter; -use Psr\Container\ContainerInterface; -use Sunrise\Http\Router\Exception\ParameterResolvingException; /** * Import functions @@ -39,13 +39,6 @@ final class ParameterResolutioner implements ParameterResolutionerInterface */ private $context = null; - /** - * Known types - * - * @var array - */ - private array $types = []; - /** * The resolutioner's resolvers * @@ -53,13 +46,6 @@ final class ParameterResolutioner implements ParameterResolutionerInterface */ private array $resolvers = []; - /** - * The resolutioner's container - * - * @var ContainerInterface|null - */ - private ?ContainerInterface $container = null; - /** * {@inheritdoc} */ @@ -74,10 +60,16 @@ public function withContext($context): ParameterResolutionerInterface /** * {@inheritdoc} */ - public function withType(string $type, object $value): ParameterResolutionerInterface + public function withPriorityResolver(ParameterResolverInterface ...$resolvers): ParameterResolutionerInterface { + /** @var list $resolvers */ + + foreach ($this->resolvers as $resolver) { + $resolvers[] = $resolver; + } + $clone = clone $this; - $clone->types[$type] = $value; + $clone->resolvers = $resolvers; return $clone; } @@ -92,14 +84,6 @@ public function addResolver(ParameterResolverInterface ...$resolvers): void } } - /** - * {@inheritdoc} - */ - public function setContainer(?ContainerInterface $container): void - { - $this->container = $container; - } - /** * {@inheritdoc} */ @@ -122,40 +106,75 @@ public function resolveParameters(ReflectionParameter ...$parameters): array * @return mixed * The ready-to-pass argument. * - * @throws ParameterResolvingException + * @throws LogicException * If the parameter cannot be resolved to an argument. */ private function resolveParameter(ReflectionParameter $parameter) { - $type = $parameter->getType(); - - if (($type instanceof ReflectionNamedType) && !$type->isBuiltin()) { - if (isset($this->types[$type->getName()])) { - return $this->types[$type->getName()]; - } - } - foreach ($this->resolvers as $resolver) { if ($resolver->supportsParameter($parameter, $this->context)) { return $resolver->resolveParameter($parameter, $this->context); } } - if (($type instanceof ReflectionNamedType) && !$type->isBuiltin()) { - if (isset($this->container) && $this->container->has($type->getName())) { - return $this->container->get($type->getName()); - } - } - if ($parameter->isDefaultValueAvailable()) { return $parameter->getDefaultValue(); } - throw new ParameterResolvingException(sprintf( - 'Unable to resolve the parameter {%s($%s[%d])}', - $parameter->getDeclaringFunction()->getName(), + throw new LogicException(sprintf( + 'Unable to resolve the parameter {%s}', + $this->stringifyParameter($parameter) + )); + } + + /** + * Stringifies the given parameter + * + * @param ReflectionParameter $parameter + * + * @return string + */ + private function stringifyParameter(ReflectionParameter $parameter): string + { + return ($parameter->getDeclaringFunction() instanceof ReflectionMethod) ? + $this->stringifyMethodParameter($parameter->getDeclaringFunction(), $parameter) : + $this->stringifyFunctionParameter($parameter->getDeclaringFunction(), $parameter); + } + + /** + * Stringifies the given method parameter + * + * @param ReflectionMethod $method + * @param ReflectionParameter $parameter + * + * @return string + */ + private function stringifyMethodParameter(ReflectionMethod $method, ReflectionParameter $parameter): string + { + return sprintf( + '%s::%s($%s[%d])', + $method->getDeclaringClass()->getName(), + $method->getName(), $parameter->getName(), $parameter->getPosition() - )); + ); + } + + /** + * Stringifies the given function parameter + * + * @param ReflectionFunctionAbstract $function + * @param ReflectionParameter $parameter + * + * @return string + */ + private function stringifyFunctionParameter(ReflectionFunctionAbstract $function, ReflectionParameter $parameter): string + { + return sprintf( + '%s($%s[%d])', + $function->getName(), + $parameter->getName(), + $parameter->getPosition() + ); } } diff --git a/src/ParameterResolutionerInterface.php b/src/ParameterResolutionerInterface.php index c4f1d3e2..d81c9313 100644 --- a/src/ParameterResolutionerInterface.php +++ b/src/ParameterResolutionerInterface.php @@ -14,9 +14,8 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\LogicException; use ReflectionParameter; -use Psr\Container\ContainerInterface; -use Sunrise\Http\Router\Exception\ParameterResolvingException; /** * ParameterResolutionerInterface @@ -38,18 +37,15 @@ interface ParameterResolutionerInterface public function withContext($context): ParameterResolutionerInterface; /** - * Creates a new instance of the resolutioner with the given data for resolve a non-built-in typed parameter + * Creates a new instance of the resolutioner with the given priority parameter resolver(s) * * Please note that this method MUST NOT change the object state. * - * @param class-string $type - * @param T $value + * @param ParameterResolverInterface ...$resolvers * * @return static - * - * @template T */ - public function withType(string $type, object $value): ParameterResolutionerInterface; + public function withPriorityResolver(ParameterResolverInterface ...$resolvers): ParameterResolutionerInterface; /** * Adds the given parameter resolver(s) to the resolutioner @@ -60,15 +56,6 @@ public function withType(string $type, object $value): ParameterResolutionerInte */ public function addResolver(ParameterResolverInterface ...$resolvers): void; - /** - * Sets the given container to the resolutioner for resolve non-built-in typed parameters - * - * @param ContainerInterface|null $container - * - * @return void - */ - public function setContainer(?ContainerInterface $container): void; - /** * Resolves the given parameter(s) to arguments * @@ -77,7 +64,7 @@ public function setContainer(?ContainerInterface $container): void; * @return list * List of ready-to-pass arguments. * - * @throws ParameterResolvingException + * @throws LogicException * If one of the parameters cannot be resolved to an argument. */ public function resolveParameters(ReflectionParameter ...$parameters): array; diff --git a/src/ParameterResolver/DependencyInjectionParameterResolver.php b/src/ParameterResolver/DependencyInjectionParameterResolver.php new file mode 100644 index 00000000..38eb7df1 --- /dev/null +++ b/src/ParameterResolver/DependencyInjectionParameterResolver.php @@ -0,0 +1,73 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\ParameterResolver; + +/** + * Import classes + */ +use Psr\Container\ContainerInterface; +use Sunrise\Http\Router\ParameterResolverInterface; +use ReflectionNamedType; +use ReflectionParameter; + +/** + * DependencyInjectionParameterResolver + * + * @since 3.0.0 + */ +final class DependencyInjectionParameterResolver implements ParameterResolverInterface +{ + + /** + * @var ContainerInterface + */ + private ContainerInterface $container; + + /** + * @param ContainerInterface $container + */ + public function __construct(ContainerInterface $container) + { + $this->container = $container; + } + + /** + * {@inheritdoc} + */ + public function supportsParameter(ReflectionParameter $parameter, $context): bool + { + if (!($parameter->getType() instanceof ReflectionNamedType)) { + return false; + } + + if ($parameter->getType()->isBuiltin()) { + return false; + } + + if (!$this->container->has($parameter->getType()->getName())) { + return false; + } + + return true; + } + + /** + * {@inheritdoc} + */ + public function resolveParameter(ReflectionParameter $parameter, $context) + { + /** @var ReflectionNamedType */ + $parameterType = $parameter->getType(); + + return $this->container->get($parameterType->getName()); + } +} diff --git a/src/ParameterResolver/KnownTypeParameterResolver.php b/src/ParameterResolver/KnownTypeParameterResolver.php new file mode 100644 index 00000000..f531c328 --- /dev/null +++ b/src/ParameterResolver/KnownTypeParameterResolver.php @@ -0,0 +1,93 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\ParameterResolver; + +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\InvalidArgumentException; +use Sunrise\Http\Router\ParameterResolverInterface; +use ReflectionNamedType; +use ReflectionParameter; + +/** + * Import classes + */ +use function get_class; +use function sprintf; + +/** + * KnownTypeParameterResolver + * + * @template T as object + * + * @since 3.0.0 + */ +final class KnownTypeParameterResolver implements ParameterResolverInterface +{ + + /** + * @var class-string + */ + private string $type; + + /** + * @var T + */ + private object $value; + + /** + * @param class-string $type + * @param T $value + * + * @throws InvalidArgumentException + * If the given value is not an instance of the given type. + */ + public function __construct(string $type, object $value) + { + if (!($value instanceof $type)) { + throw new InvalidArgumentException(sprintf( + 'The known type parameter resolver cannot accept the value "%s" ' . + 'because it is not an instance of the "%s"', + get_class($value), + $type + )); + } + + $this->type = $type; + $this->value = $value; + } + + /** + * {@inheritdoc} + */ + public function supportsParameter(ReflectionParameter $parameter, $context): bool + { + if (!($parameter->getType() instanceof ReflectionNamedType)) { + return false; + } + + if ($parameter->getType()->isBuiltin()) { + return false; + } + + return $this->type === $parameter->getType()->getName(); + } + + /** + * {@inheritdoc} + */ + public function resolveParameter(ReflectionParameter $parameter, $context) + { + return $this->value; + } +} diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 9b699d4f..6abe86ab 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -17,6 +17,7 @@ use Psr\Http\Message\ServerRequestInterface; use Sunrise\Http\Router\Annotation\RequestBody; use Sunrise\Http\Router\Exception\InvalidRequestBodyException; +use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\RequestBodyInterface; use Sunrise\Hydrator\Exception\InvalidObjectException; @@ -67,7 +68,11 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo return false; } - if (!($parameter->getType() instanceof ReflectionNamedType) || $parameter->getType()->isBuiltin()) { + if (!($parameter->getType() instanceof ReflectionNamedType)) { + return false; + } + + if ($parameter->getType()->isBuiltin()) { return false; } @@ -85,11 +90,11 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo /** * {@inheritdoc} * - * @throws InvalidObjectException - * If the DTO isn't valid. - * * @throws InvalidRequestBodyException - * If the DTO cannot be hydrated with the request body. + * If the request body isn't valid. + * + * @throws LogicException + * If the DTO isn't valid. */ public function resolveParameter(ReflectionParameter $parameter, $context) { @@ -103,6 +108,8 @@ public function resolveParameter(ReflectionParameter $parameter, $context) return $this->hydrator->hydrate($parameterType->getName(), (array) $context->getParsedBody()); } catch (InvalidValueException $e) { throw new InvalidRequestBodyException($e->getMessage(), 0, $e); + } catch (InvalidObjectException $e) { + throw new LogicException($e->getMessage(), 0, $e); } } } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 93980eb8..91f5039a 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -17,6 +17,7 @@ use Psr\Http\Message\ServerRequestInterface; use Sunrise\Http\Router\Annotation\RequestQuery; use Sunrise\Http\Router\Exception\InvalidRequestQueryException; +use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\RequestQueryInterface; use Sunrise\Hydrator\Exception\InvalidObjectException; @@ -67,7 +68,11 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo return false; } - if (!($parameter->getType() instanceof ReflectionNamedType) || $parameter->getType()->isBuiltin()) { + if (!($parameter->getType() instanceof ReflectionNamedType)) { + return false; + } + + if ($parameter->getType()->isBuiltin()) { return false; } @@ -85,11 +90,11 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo /** * {@inheritdoc} * - * @throws InvalidObjectException - * If the DTO isn't valid. - * * @throws InvalidRequestQueryException - * If the DTO cannot be hydrated with the request query. + * If the request query isn't valid. + * + * @throws LogicException + * If the DTO isn't valid. */ public function resolveParameter(ReflectionParameter $parameter, $context) { @@ -103,6 +108,8 @@ public function resolveParameter(ReflectionParameter $parameter, $context) return $this->hydrator->hydrate($parameterType->getName(), $context->getQueryParams()); } catch (InvalidValueException $e) { throw new InvalidRequestQueryException($e->getMessage(), 0, $e); + } catch (InvalidObjectException $e) { + throw new LogicException($e->getMessage(), 0, $e); } } } diff --git a/src/ParameterResolverInterface.php b/src/ParameterResolverInterface.php index 0a6de0e8..41cf3ef5 100644 --- a/src/ParameterResolverInterface.php +++ b/src/ParameterResolverInterface.php @@ -14,8 +14,8 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\LogicException; use ReflectionParameter; -use Sunrise\Http\Router\Exception\ParameterResolvingException; /** * ParameterResolverInterface @@ -44,7 +44,7 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo * @return mixed * The ready-to-pass argument. * - * @throws ParameterResolvingException + * @throws LogicException * If the parameter cannot be resolved to an argument. */ public function resolveParameter(ReflectionParameter $parameter, $context); diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index 80361180..6761a53e 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -82,8 +82,6 @@ public function __construct( public function setContainer(?ContainerInterface $container): void { $this->container = $container; - - $this->parameterResolutioner->setContainer($container); } /** diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index aaf00728..4c17c11c 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -14,14 +14,15 @@ /** * Import classes */ -use ReflectionFunctionAbstract; -use ReflectionFunction; -use ReflectionMethod; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\ParameterResolver\KnownTypeParameterResolver; use Sunrise\Http\Router\ParameterResolutionerInterface; use Sunrise\Http\Router\ResponseResolutionerInterface; +use ReflectionFunctionAbstract; +use ReflectionFunction; +use ReflectionMethod; /** * Import functions @@ -89,9 +90,13 @@ public function getReflection(): ReflectionFunctionAbstract */ public function handle(ServerRequestInterface $request): ResponseInterface { + $resolvers = [ + new KnownTypeParameterResolver(ServerRequestInterface::class, $request), + ]; + $arguments = $this->parameterResolutioner ->withContext($request) - ->withType(ServerRequestInterface::class, $request) + ->withPriorityResolver(...$resolvers) ->resolveParameters(...$this->getReflection()->getParameters()); /** @var mixed */ diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index 62f62a4b..00282bff 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -14,11 +14,11 @@ /** * Import classes */ -use SplQueue; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; +use SplQueue; /** * QueueableRequestHandler diff --git a/src/ResponseResolutioner.php b/src/ResponseResolutioner.php index b85ce085..f845f7d8 100644 --- a/src/ResponseResolutioner.php +++ b/src/ResponseResolutioner.php @@ -15,7 +15,7 @@ * Import classes */ use Psr\Http\Message\ResponseInterface; -use Sunrise\Http\Router\Exception\ResponseResolvingException; +use Sunrise\Http\Router\Exception\LogicException; /** * Import functions @@ -81,7 +81,7 @@ public function resolveResponse($response): ResponseInterface } } - throw new ResponseResolvingException(sprintf( + throw new LogicException(sprintf( 'Unable to resolve the response {%s}', get_debug_type($response) )); diff --git a/src/ResponseResolutionerInterface.php b/src/ResponseResolutionerInterface.php index f737802c..6c36b0e9 100644 --- a/src/ResponseResolutionerInterface.php +++ b/src/ResponseResolutionerInterface.php @@ -15,7 +15,7 @@ * Import classes */ use Psr\Http\Message\ResponseInterface; -use Sunrise\Http\Router\Exception\ResponseResolvingException; +use Sunrise\Http\Router\Exception\LogicException; /** * ResponseResolutionerInterface @@ -52,7 +52,7 @@ public function addResolver(ResponseResolverInterface ...$resolvers): void; * * @return ResponseInterface * - * @throws ResponseResolvingException + * @throws LogicException * If the raw response cannot be resolved to the object. */ public function resolveResponse($response): ResponseInterface; diff --git a/src/ResponseResolverInterface.php b/src/ResponseResolverInterface.php index fa6fd515..77d2a6fa 100644 --- a/src/ResponseResolverInterface.php +++ b/src/ResponseResolverInterface.php @@ -15,7 +15,7 @@ * Import classes */ use Psr\Http\Message\ResponseInterface; -use Sunrise\Http\Router\Exception\ResponseResolvingException; +use Sunrise\Http\Router\Exception\LogicException; /** * ResponseResolverInterface @@ -43,7 +43,7 @@ public function supportsResponse($response, $context): bool; * * @return ResponseInterface * - * @throws ResponseResolvingException + * @throws LogicException * If the raw response cannot be resolved to the object. */ public function resolveResponse($response, $context): ResponseInterface; From ecc0719488be21d5913ac05049f7ae1ae0aafc87 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Tue, 24 Jan 2023 03:13:06 +0100 Subject: [PATCH 038/180] v3 --- ...on.php => ResolvingParameterException.php} | 4 +- src/Exception/ResolvingReferenceException.php | 21 ++++++++++ ...ion.php => ResolvingResponseException.php} | 4 +- src/Loader/DescriptorLoader.php | 12 +++--- .../JsonPayloadDecodingMiddleware.php | 12 +++--- src/ParameterResolutioner.php | 6 +-- src/ParameterResolutionerInterface.php | 4 +- .../RequestBodyParameterResolver.php | 12 +++--- .../RequestQueryParameterResolver.php | 12 +++--- src/ParameterResolverInterface.php | 4 +- src/ReferenceResolver.php | 42 ++++++++++++------- src/ReferenceResolverInterface.php | 12 +++--- src/ResponseResolutioner.php | 4 +- src/ResponseResolutionerInterface.php | 4 +- src/ResponseResolverInterface.php | 4 +- src/RouteCollector.php | 28 ------------- 16 files changed, 94 insertions(+), 91 deletions(-) rename src/Exception/{ReferenceResolvingException.php => ResolvingParameterException.php} (81%) create mode 100644 src/Exception/ResolvingReferenceException.php rename src/Exception/{InvalidReferenceException.php => ResolvingResponseException.php} (81%) diff --git a/src/Exception/ReferenceResolvingException.php b/src/Exception/ResolvingParameterException.php similarity index 81% rename from src/Exception/ReferenceResolvingException.php rename to src/Exception/ResolvingParameterException.php index 9a8387b7..3e46f9e4 100644 --- a/src/Exception/ReferenceResolvingException.php +++ b/src/Exception/ResolvingParameterException.php @@ -12,10 +12,10 @@ namespace Sunrise\Http\Router\Exception; /** - * ReferenceResolvingException + * ResolvingParameterException * * @since 3.0.0 */ -class ReferenceResolvingException extends ResolvingException +class ResolvingParameterException extends ResolvingException { } diff --git a/src/Exception/ResolvingReferenceException.php b/src/Exception/ResolvingReferenceException.php new file mode 100644 index 00000000..63ddb6f9 --- /dev/null +++ b/src/Exception/ResolvingReferenceException.php @@ -0,0 +1,21 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * ResolvingReferenceException + * + * @since 3.0.0 + */ +class ResolvingReferenceException extends ResolvingException +{ +} diff --git a/src/Exception/InvalidReferenceException.php b/src/Exception/ResolvingResponseException.php similarity index 81% rename from src/Exception/InvalidReferenceException.php rename to src/Exception/ResolvingResponseException.php index a099da3d..266aaca9 100644 --- a/src/Exception/InvalidReferenceException.php +++ b/src/Exception/ResolvingResponseException.php @@ -12,10 +12,10 @@ namespace Sunrise\Http\Router\Exception; /** - * InvalidReferenceException + * ResolvingResponseException * * @since 3.0.0 */ -class InvalidReferenceException extends LogicException +class ResolvingResponseException extends ResolvingException { } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index e9002683..1197d6a7 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -393,28 +393,28 @@ private function getClassDescriptors(ReflectionClass $class): array * Supplements the given descriptor from the given class or method * * @param Route $descriptor - * @param ReflectionClass|ReflectionMethod $source + * @param ReflectionClass|ReflectionMethod $classOrMethod * * @return void */ - private function supplementDescriptor(Route $descriptor, Reflector $source): void + private function supplementDescriptor(Route $descriptor, Reflector $classOrMethod): void { - $annotations = $this->annotationReader->getAnnotations($source, Host::class); + $annotations = $this->annotationReader->getAnnotations($classOrMethod, Host::class); if (isset($annotations[0])) { $descriptor->host = $annotations[0]->value; } - $annotations = $this->annotationReader->getAnnotations($source, Prefix::class); + $annotations = $this->annotationReader->getAnnotations($classOrMethod, Prefix::class); if (isset($annotations[0])) { $descriptor->path = $annotations[0]->value . $descriptor->path; } - $annotations = $this->annotationReader->getAnnotations($source, Postfix::class); + $annotations = $this->annotationReader->getAnnotations($classOrMethod, Postfix::class); if (isset($annotations[0])) { $descriptor->path = $descriptor->path . $annotations[0]->value; } - $annotations = $this->annotationReader->getAnnotations($source, Middleware::class); + $annotations = $this->annotationReader->getAnnotations($classOrMethod, Middleware::class); foreach ($annotations as $annotation) { $descriptor->middlewares[] = $annotation->value; } diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index b853d822..e77ded54 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -26,10 +26,10 @@ */ use function is_array; use function json_decode; -use function rtrim; use function sprintf; use function strpos; -use function substr; +use function strstr; +use function trim; /** * Import constants @@ -91,13 +91,13 @@ private function getRequestMediaType(ServerRequestInterface $request): ?string } // type "/" subtype *( OWS ";" OWS parameter ) - $mediatype = $request->getHeaderLine('Content-Type'); + $mediaType = $request->getHeaderLine('Content-Type'); - if ($semicolon = strpos($mediatype, ';')) { - $mediatype = substr($mediatype, 0, $semicolon); + if (false !== strpos($mediaType, ';')) { + $mediaType = strstr($mediaType, ';', true); } - return rtrim($mediatype); + return trim($mediaType); } /** diff --git a/src/ParameterResolutioner.php b/src/ParameterResolutioner.php index 090cf505..15fad058 100644 --- a/src/ParameterResolutioner.php +++ b/src/ParameterResolutioner.php @@ -14,7 +14,7 @@ /** * Import classes */ -use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\Exception\ResolvingParameterException; use ReflectionFunctionAbstract; use ReflectionMethod; use ReflectionParameter; @@ -106,7 +106,7 @@ public function resolveParameters(ReflectionParameter ...$parameters): array * @return mixed * The ready-to-pass argument. * - * @throws LogicException + * @throws ResolvingParameterException * If the parameter cannot be resolved to an argument. */ private function resolveParameter(ReflectionParameter $parameter) @@ -121,7 +121,7 @@ private function resolveParameter(ReflectionParameter $parameter) return $parameter->getDefaultValue(); } - throw new LogicException(sprintf( + throw new ResolvingParameterException(sprintf( 'Unable to resolve the parameter {%s}', $this->stringifyParameter($parameter) )); diff --git a/src/ParameterResolutionerInterface.php b/src/ParameterResolutionerInterface.php index d81c9313..1d04ea3e 100644 --- a/src/ParameterResolutionerInterface.php +++ b/src/ParameterResolutionerInterface.php @@ -14,7 +14,7 @@ /** * Import classes */ -use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\Exception\ResolvingParameterException; use ReflectionParameter; /** @@ -64,7 +64,7 @@ public function addResolver(ParameterResolverInterface ...$resolvers): void; * @return list * List of ready-to-pass arguments. * - * @throws LogicException + * @throws ResolvingParameterException * If one of the parameters cannot be resolved to an argument. */ public function resolveParameters(ReflectionParameter ...$parameters): array; diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 6abe86ab..bf5936f9 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -17,7 +17,7 @@ use Psr\Http\Message\ServerRequestInterface; use Sunrise\Http\Router\Annotation\RequestBody; use Sunrise\Http\Router\Exception\InvalidRequestBodyException; -use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\Exception\ResolvingParameterException; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\RequestBodyInterface; use Sunrise\Hydrator\Exception\InvalidObjectException; @@ -90,11 +90,11 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo /** * {@inheritdoc} * + * @throws ResolvingParameterException + * If the object cannot be hydrated. + * * @throws InvalidRequestBodyException * If the request body isn't valid. - * - * @throws LogicException - * If the DTO isn't valid. */ public function resolveParameter(ReflectionParameter $parameter, $context) { @@ -106,10 +106,10 @@ public function resolveParameter(ReflectionParameter $parameter, $context) try { return $this->hydrator->hydrate($parameterType->getName(), (array) $context->getParsedBody()); + } catch (InvalidObjectException $e) { + throw new ResolvingParameterException($e->getMessage(), 0, $e); } catch (InvalidValueException $e) { throw new InvalidRequestBodyException($e->getMessage(), 0, $e); - } catch (InvalidObjectException $e) { - throw new LogicException($e->getMessage(), 0, $e); } } } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 91f5039a..43ec85f7 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -17,7 +17,7 @@ use Psr\Http\Message\ServerRequestInterface; use Sunrise\Http\Router\Annotation\RequestQuery; use Sunrise\Http\Router\Exception\InvalidRequestQueryException; -use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\Exception\ResolvingParameterException; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\RequestQueryInterface; use Sunrise\Hydrator\Exception\InvalidObjectException; @@ -90,11 +90,11 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo /** * {@inheritdoc} * + * @throws ResolvingParameterException + * If the object cannot be hydrated. + * * @throws InvalidRequestQueryException * If the request query isn't valid. - * - * @throws LogicException - * If the DTO isn't valid. */ public function resolveParameter(ReflectionParameter $parameter, $context) { @@ -106,10 +106,10 @@ public function resolveParameter(ReflectionParameter $parameter, $context) try { return $this->hydrator->hydrate($parameterType->getName(), $context->getQueryParams()); + } catch (InvalidObjectException $e) { + throw new ResolvingParameterException($e->getMessage(), 0, $e); } catch (InvalidValueException $e) { throw new InvalidRequestQueryException($e->getMessage(), 0, $e); - } catch (InvalidObjectException $e) { - throw new LogicException($e->getMessage(), 0, $e); } } } diff --git a/src/ParameterResolverInterface.php b/src/ParameterResolverInterface.php index 41cf3ef5..e3f6b46b 100644 --- a/src/ParameterResolverInterface.php +++ b/src/ParameterResolverInterface.php @@ -14,7 +14,7 @@ /** * Import classes */ -use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\Exception\ResolvingParameterException; use ReflectionParameter; /** @@ -44,7 +44,7 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo * @return mixed * The ready-to-pass argument. * - * @throws LogicException + * @throws ResolvingParameterException * If the parameter cannot be resolved to an argument. */ public function resolveParameter(ReflectionParameter $parameter, $context); diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index 6761a53e..d340c491 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -17,7 +17,8 @@ use Psr\Container\ContainerInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\ReferenceResolvingException; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\Exception\ResolvingReferenceException; use Sunrise\Http\Router\Middleware\CallableMiddleware; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use Closure; @@ -116,7 +117,7 @@ public function resolveRequestHandler($reference): RequestHandlerInterface // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 /** @psalm-suppress MixedArgument */ if (is_array($reference) && is_callable($reference, true) && method_exists($reference[0], $reference[1])) { - /** @var array{0: object|class-string, 1: non-empty-string} $reference */ + /** @var array{0: class-string|object, 1: non-empty-string} $reference */ $callback = [is_string($reference[0]) ? $this->resolveClass($reference[0]) : $reference[0], $reference[1]]; @@ -128,8 +129,8 @@ public function resolveRequestHandler($reference): RequestHandlerInterface return $this->resolveClass($reference); } - throw new ReferenceResolvingException(sprintf( - 'Unable to resolve the reference {%s} to a request handler.', + throw new ResolvingReferenceException(sprintf( + 'Unable to resolve the reference {%s}', $this->stringifyReference($reference) )); } @@ -147,23 +148,23 @@ public function resolveMiddleware($reference): MiddlewareInterface return new CallableMiddleware($reference, $this->parameterResolutioner, $this->responseResolutioner); } - if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { - /** @var MiddlewareInterface */ - return $this->resolveClass($reference); - } - // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 /** @psalm-suppress MixedArgument */ if (is_array($reference) && is_callable($reference, true) && method_exists($reference[0], $reference[1])) { - /** @var array{0: object|class-string, 1: non-empty-string} $reference */ + /** @var array{0: class-string|object, 1: non-empty-string} $reference */ $callback = [is_string($reference[0]) ? $this->resolveClass($reference[0]) : $reference[0], $reference[1]]; return new CallableMiddleware($callback, $this->parameterResolutioner, $this->responseResolutioner); } - throw new ReferenceResolvingException(sprintf( - 'Unable to resolve the reference {%s} to a middleware.', + if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { + /** @var MiddlewareInterface */ + return $this->resolveClass($reference); + } + + throw new ResolvingReferenceException(sprintf( + 'Unable to resolve the reference {%s}', $this->stringifyReference($reference) )); } @@ -189,6 +190,9 @@ public function resolveMiddlewares(array $references): array * * @return T * + * @throws LogicException + * If the class cannot be directly initialized. + * * @template T */ private function resolveClass(string $class): object @@ -198,13 +202,19 @@ private function resolveClass(string $class): object return $this->container->get($class); } - $arguments = []; $reflection = new ReflectionClass($class); + if (!$reflection->isInstantiable()) { + throw new LogicException(sprintf( + 'The class %s cannot be initialized', + $class + )); + } + + $arguments = []; $constructor = $reflection->getConstructor(); if (isset($constructor)) { - $arguments = $this->parameterResolutioner->resolveParameters( - ...$constructor->getParameters() - ); + $arguments = $this->parameterResolutioner + ->resolveParameters(...$constructor->getParameters()); } return $reflection->newInstance(...$arguments); diff --git a/src/ReferenceResolverInterface.php b/src/ReferenceResolverInterface.php index c818b4e2..f7862239 100644 --- a/src/ReferenceResolverInterface.php +++ b/src/ReferenceResolverInterface.php @@ -17,7 +17,7 @@ use Psr\Container\ContainerInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\ReferenceResolvingException; +use Sunrise\Http\Router\Exception\ResolvingReferenceException; /** * ReferenceResolverInterface @@ -37,7 +37,7 @@ interface ReferenceResolverInterface public function setContainer(?ContainerInterface $container): void; /** - * Adds the given parameter resolver(s) to the parameter resolutioner + * Adds the given parameter resolver(s) to the resolver * * @param ParameterResolverInterface ...$resolvers * @@ -48,7 +48,7 @@ public function setContainer(?ContainerInterface $container): void; public function addParameterResolver(ParameterResolverInterface ...$resolvers): void; /** - * Adds the given response resolver(s) to the response resolutioner + * Adds the given response resolver(s) to the resolver * * @param ResponseResolverInterface ...$resolvers * @@ -65,7 +65,7 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo * * @return RequestHandlerInterface * - * @throws ReferenceResolvingException + * @throws ResolvingReferenceException * If the reference cannot be resolved to a request handler. */ public function resolveRequestHandler($reference): RequestHandlerInterface; @@ -77,7 +77,7 @@ public function resolveRequestHandler($reference): RequestHandlerInterface; * * @return MiddlewareInterface * - * @throws ReferenceResolvingException + * @throws ResolvingReferenceException * If the reference cannot be resolved to a middleware. */ public function resolveMiddleware($reference): MiddlewareInterface; @@ -89,7 +89,7 @@ public function resolveMiddleware($reference): MiddlewareInterface; * * @return list * - * @throws ReferenceResolvingException + * @throws ResolvingReferenceException * If one of the references cannot be resolved to a middleware. * * @since 3.0.0 diff --git a/src/ResponseResolutioner.php b/src/ResponseResolutioner.php index f845f7d8..1bd59e29 100644 --- a/src/ResponseResolutioner.php +++ b/src/ResponseResolutioner.php @@ -15,7 +15,7 @@ * Import classes */ use Psr\Http\Message\ResponseInterface; -use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\Exception\ResolvingResponseException; /** * Import functions @@ -81,7 +81,7 @@ public function resolveResponse($response): ResponseInterface } } - throw new LogicException(sprintf( + throw new ResolvingResponseException(sprintf( 'Unable to resolve the response {%s}', get_debug_type($response) )); diff --git a/src/ResponseResolutionerInterface.php b/src/ResponseResolutionerInterface.php index 6c36b0e9..e56ced98 100644 --- a/src/ResponseResolutionerInterface.php +++ b/src/ResponseResolutionerInterface.php @@ -15,7 +15,7 @@ * Import classes */ use Psr\Http\Message\ResponseInterface; -use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\Exception\ResolvingResponseException; /** * ResponseResolutionerInterface @@ -52,7 +52,7 @@ public function addResolver(ResponseResolverInterface ...$resolvers): void; * * @return ResponseInterface * - * @throws LogicException + * @throws ResolvingResponseException * If the raw response cannot be resolved to the object. */ public function resolveResponse($response): ResponseInterface; diff --git a/src/ResponseResolverInterface.php b/src/ResponseResolverInterface.php index 77d2a6fa..fa18d042 100644 --- a/src/ResponseResolverInterface.php +++ b/src/ResponseResolverInterface.php @@ -15,7 +15,7 @@ * Import classes */ use Psr\Http\Message\ResponseInterface; -use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\Exception\ResolvingResponseException; /** * ResponseResolverInterface @@ -43,7 +43,7 @@ public function supportsResponse($response, $context): bool; * * @return ResponseInterface * - * @throws LogicException + * @throws ResolvingResponseException * If the raw response cannot be resolved to the object. */ public function resolveResponse($response, $context): ResponseInterface; diff --git a/src/RouteCollector.php b/src/RouteCollector.php index 6fd0c634..f5903794 100644 --- a/src/RouteCollector.php +++ b/src/RouteCollector.php @@ -15,7 +15,6 @@ * Import classes */ use Psr\Container\ContainerInterface; -use Sunrise\Http\Router\Exception\InvalidReferenceException; /** * RouteCollector @@ -105,9 +104,6 @@ public function getCollection(): RouteCollectionInterface * @param array $attributes * * @return RouteInterface - * - * @throws InvalidReferenceException - * If the given request handler or one of the given middlewares cannot be resolved. */ public function route( string $name, @@ -141,9 +137,6 @@ public function route( * @param array $attributes * * @return RouteInterface - * - * @throws InvalidReferenceException - * If the given request handler or one of the given middlewares cannot be resolved. */ public function head( string $name, @@ -172,9 +165,6 @@ public function head( * @param array $attributes * * @return RouteInterface - * - * @throws InvalidReferenceException - * If the given request handler or one of the given middlewares cannot be resolved. */ public function get( string $name, @@ -203,9 +193,6 @@ public function get( * @param array $attributes * * @return RouteInterface - * - * @throws InvalidReferenceException - * If the given request handler or one of the given middlewares cannot be resolved. */ public function post( string $name, @@ -234,9 +221,6 @@ public function post( * @param array $attributes * * @return RouteInterface - * - * @throws InvalidReferenceException - * If the given request handler or one of the given middlewares cannot be resolved. */ public function put( string $name, @@ -265,9 +249,6 @@ public function put( * @param array $attributes * * @return RouteInterface - * - * @throws InvalidReferenceException - * If the given request handler or one of the given middlewares cannot be resolved. */ public function patch( string $name, @@ -296,9 +277,6 @@ public function patch( * @param array $attributes * * @return RouteInterface - * - * @throws InvalidReferenceException - * If the given request handler or one of the given middlewares cannot be resolved. */ public function delete( string $name, @@ -327,9 +305,6 @@ public function delete( * @param array $attributes * * @return RouteInterface - * - * @throws InvalidReferenceException - * If the given request handler or one of the given middlewares cannot be resolved. */ public function purge( string $name, @@ -355,9 +330,6 @@ public function purge( * @param array $middlewares * * @return RouteCollectionInterface - * - * @throws InvalidReferenceException - * If one of the given middlewares cannot be resolved. */ public function group(callable $callback, array $middlewares = []): RouteCollectionInterface { From 62113e5a6b81510f4d2bc2327cefa8338c41f85c Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Tue, 24 Jan 2023 04:10:27 +0100 Subject: [PATCH 039/180] v3 --- composer.json | 1 + functions/get_directory_classes.php | 54 +++++++++++++++++ src/AnnotationReader.php | 92 ++++++++++++++++++++++++----- src/Loader/DescriptorLoader.php | 52 ++++------------ src/ParameterResolutioner.php | 12 ++-- 5 files changed, 150 insertions(+), 61 deletions(-) create mode 100644 functions/get_directory_classes.php diff --git a/composer.json b/composer.json index 9c9cb8b8..81f47bcd 100644 --- a/composer.json +++ b/composer.json @@ -48,6 +48,7 @@ "files": [ "functions/emit.php", "functions/get_debug_type.php", + "functions/get_directory_classes.php", "functions/path_build.php", "functions/path_match.php", "functions/path_parse.php", diff --git a/functions/get_directory_classes.php b/functions/get_directory_classes.php new file mode 100644 index 00000000..f083c5cb --- /dev/null +++ b/functions/get_directory_classes.php @@ -0,0 +1,54 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router; + +/** + * Import classes + */ +use Iterator; +use RecursiveDirectoryIterator; +use RecursiveIteratorIterator; +use SplFileInfo; + +/** + * Import functions + */ +use function array_diff; +use function get_declared_classes; + +/** + * Scans the given directory and returns the found classes + * + * @param string $directory + * + * @return class-string[] + * + * @since 3.0.0 + */ +function get_directory_classes(string $directory): array +{ + $known = get_declared_classes(); + + /** @var Iterator */ + $files = new RecursiveIteratorIterator( + new RecursiveDirectoryIterator($directory) + ); + + foreach ($files as $file) { + if ('php' === $file->getExtension()) { + /** @psalm-suppress UnresolvableInclude */ + require_once $file->getPathname(); + } + } + + return array_diff(get_declared_classes(), $known); +} diff --git a/src/AnnotationReader.php b/src/AnnotationReader.php index 6ecd595d..037863a9 100644 --- a/src/AnnotationReader.php +++ b/src/AnnotationReader.php @@ -14,8 +14,6 @@ /** * Import classes */ -use Doctrine\Common\Annotations\AnnotationReader as DoctrineAnnotationReader; -use Doctrine\Common\Annotations\Reader as DoctrineAnnotationReaderInterface; use Sunrise\Http\Router\Exception\LogicException; use ReflectionAttribute; use ReflectionClass; @@ -26,6 +24,7 @@ * Import functions */ use function class_exists; +use function sprintf; /** * Import constants @@ -41,24 +40,24 @@ final class AnnotationReader { /** - * @var DoctrineAnnotationReaderInterface|null + * @var \Doctrine\Common\Annotations\Reader|null */ - private ?DoctrineAnnotationReaderInterface $annotationReader = null; + private ?\Doctrine\Common\Annotations\Reader $annotationReader = null; /** * Sets the given annotation reader to the reader * - * @param DoctrineAnnotationReaderInterface|null $annotationReader + * @param \Doctrine\Common\Annotations\Reader|null $annotationReader * * @return void */ - public function setAnnotationReader(?DoctrineAnnotationReaderInterface $annotationReader): void + public function setAnnotationReader(?\Doctrine\Common\Annotations\Reader $annotationReader): void { $this->annotationReader = $annotationReader; } /** - * Sets the default annotation reader to the reader + * Uses the default annotation reader * * @return void * @@ -67,33 +66,64 @@ public function setAnnotationReader(?DoctrineAnnotationReaderInterface $annotati */ public function useDefaultAnnotationReader(): void { - if (!class_exists(DoctrineAnnotationReader::class)) { + if (!class_exists(\Doctrine\Common\Annotations\AnnotationReader::class)) { throw new LogicException( 'The annotations reading logic requires an uninstalled "doctrine/annotations" package, ' . 'run the command "composer install doctrine/annotations" and try again' ); } - $this->setAnnotationReader(new DoctrineAnnotationReader()); + $this->setAnnotationReader(new \Doctrine\Common\Annotations\AnnotationReader()); } /** - * Gets annotations by the given name from the given class or method + * Gets annotations from the given class or method by the given annotation name * * @param ReflectionClass|ReflectionMethod $classOrMethod * @param class-string $annotationName * * @return list * + * @throws LogicException + * If the given reflection isn't supported. + * + * @psalm-suppress RedundantConditionGivenDocblockType + * + * @template T + */ + public function getClassOrMethodAnnotations(Reflector $classOrMethod, string $annotationName): array + { + if ($classOrMethod instanceof ReflectionClass) { + return $this->getClassAnnotations($classOrMethod, $annotationName); + } + + if ($classOrMethod instanceof ReflectionMethod) { + return $this->getMethodAnnotations($classOrMethod, $annotationName); + } + + throw new LogicException(sprintf( + 'The %s method only handles class or method reflection', + __METHOD__ + )); + } + + /** + * Gets annotations from the given class by the given annotation name + * + * @param ReflectionClass $class + * @param class-string $annotationName + * + * @return list + * * @template T */ - public function getAnnotations(Reflector $classOrMethod, string $annotationName): array + public function getClassAnnotations(ReflectionClass $class, string $annotationName): array { $result = []; if (PHP_MAJOR_VERSION === 8) { /** @var ReflectionAttribute[] */ - $attributes = $classOrMethod->getAttributes($annotationName); + $attributes = $class->getAttributes($annotationName); foreach ($attributes as $attribute) { /** @var T */ $result[] = $attribute->newInstance(); @@ -101,10 +131,42 @@ public function getAnnotations(Reflector $classOrMethod, string $annotationName) } if (isset($this->annotationReader)) { - $annotations = ($classOrMethod instanceof ReflectionClass) ? - $this->annotationReader->getClassAnnotations($classOrMethod) : - $this->annotationReader->getMethodAnnotations($classOrMethod); + $annotations = $this->annotationReader->getClassAnnotations($class); + foreach ($annotations as $annotation) { + if ($annotation instanceof $annotationName) { + $result[] = $annotation; + } + } + } + return $result; + } + + /** + * Gets annotations from the given method by the given annotation name + * + * @param ReflectionMethod $method + * @param class-string $annotationName + * + * @return list + * + * @template T + */ + public function getMethodAnnotations(ReflectionMethod $method, string $annotationName): array + { + $result = []; + + if (PHP_MAJOR_VERSION === 8) { + /** @var ReflectionAttribute[] */ + $attributes = $method->getAttributes($annotationName); + foreach ($attributes as $attribute) { + /** @var T */ + $result[] = $attribute->newInstance(); + } + } + + if (isset($this->annotationReader)) { + $annotations = $this->annotationReader->getMethodAnnotations($method); foreach ($annotations as $annotation) { if ($annotation instanceof $annotationName) { $result[] = $annotation; diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 1197d6a7..d1df4c87 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -14,7 +14,6 @@ /** * Import classes */ -use Doctrine\Common\Annotations\Reader as AnnotationReaderInterface; use Psr\Container\ContainerInterface; use Psr\Http\Server\RequestHandlerInterface; use Psr\SimpleCache\CacheInterface; @@ -34,24 +33,19 @@ use Sunrise\Http\Router\RouteCollectionInterface; use Sunrise\Http\Router\RouteFactory; use Sunrise\Http\Router\RouteFactoryInterface; -use Iterator; -use RecursiveDirectoryIterator; -use RecursiveIteratorIterator; use ReflectionClass; use ReflectionMethod; use Reflector; -use SplFileInfo; /** * Import functions */ -use function array_diff; use function class_exists; -use function get_declared_classes; use function hash; use function is_dir; use function is_string; use function usort; +use function Sunrise\Http\Router\get_directory_classes; /** * Import constants @@ -165,13 +159,13 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo /** * Sets the given annotation reader to the descriptor loader * - * @param AnnotationReaderInterface|null $annotationReader + * @param \Doctrine\Common\Annotations\Reader|null $annotationReader * * @return void * * @since 3.0.0 */ - public function setAnnotationReader(?AnnotationReaderInterface $annotationReader): void + public function setAnnotationReader(?\Doctrine\Common\Annotations\Reader $annotationReader): void { $this->annotationReader->setAnnotationReader($annotationReader); } @@ -248,7 +242,7 @@ public function attach($resource): void } if (is_dir($resource)) { - $classnames = $this->scandir($resource); + $classnames = get_directory_classes($resource); foreach ($classnames as $classname) { $this->resources[] = $classname; } @@ -361,7 +355,7 @@ private function getClassDescriptors(ReflectionClass $class): array $result = []; if ($class->isSubclassOf(RequestHandlerInterface::class)) { - $annotations = $this->annotationReader->getAnnotations($class, Route::class); + $annotations = $this->annotationReader->getClassAnnotations($class, Route::class); if (isset($annotations[0])) { $descriptor = $annotations[0]; $descriptor->holder = $class->getName(); @@ -376,7 +370,7 @@ private function getClassDescriptors(ReflectionClass $class): array continue; } - $annotations = $this->annotationReader->getAnnotations($method, Route::class); + $annotations = $this->annotationReader->getMethodAnnotations($method, Route::class); if (isset($annotations[0])) { $descriptor = $annotations[0]; $descriptor->holder = [$class->getName(), $method->getName()]; @@ -399,50 +393,24 @@ private function getClassDescriptors(ReflectionClass $class): array */ private function supplementDescriptor(Route $descriptor, Reflector $classOrMethod): void { - $annotations = $this->annotationReader->getAnnotations($classOrMethod, Host::class); + $annotations = $this->annotationReader->getClassOrMethodAnnotations($classOrMethod, Host::class); if (isset($annotations[0])) { $descriptor->host = $annotations[0]->value; } - $annotations = $this->annotationReader->getAnnotations($classOrMethod, Prefix::class); + $annotations = $this->annotationReader->getClassOrMethodAnnotations($classOrMethod, Prefix::class); if (isset($annotations[0])) { $descriptor->path = $annotations[0]->value . $descriptor->path; } - $annotations = $this->annotationReader->getAnnotations($classOrMethod, Postfix::class); + $annotations = $this->annotationReader->getClassOrMethodAnnotations($classOrMethod, Postfix::class); if (isset($annotations[0])) { $descriptor->path = $descriptor->path . $annotations[0]->value; } - $annotations = $this->annotationReader->getAnnotations($classOrMethod, Middleware::class); + $annotations = $this->annotationReader->getClassOrMethodAnnotations($classOrMethod, Middleware::class); foreach ($annotations as $annotation) { $descriptor->middlewares[] = $annotation->value; } } - - /** - * Scans the given directory and returns the found classes - * - * @param string $directory - * - * @return class-string[] - */ - private function scandir(string $directory): array - { - $known = get_declared_classes(); - - /** @var Iterator */ - $files = new RecursiveIteratorIterator( - new RecursiveDirectoryIterator($directory) - ); - - foreach ($files as $file) { - if ('php' === $file->getExtension()) { - /** @psalm-suppress UnresolvableInclude */ - require_once $file->getPathname(); - } - } - - return array_diff(get_declared_classes(), $known); - } } diff --git a/src/ParameterResolutioner.php b/src/ParameterResolutioner.php index 15fad058..ed23459a 100644 --- a/src/ParameterResolutioner.php +++ b/src/ParameterResolutioner.php @@ -149,8 +149,10 @@ private function stringifyParameter(ReflectionParameter $parameter): string * * @return string */ - private function stringifyMethodParameter(ReflectionMethod $method, ReflectionParameter $parameter): string - { + private function stringifyMethodParameter( + ReflectionMethod $method, + ReflectionParameter $parameter + ) : string { return sprintf( '%s::%s($%s[%d])', $method->getDeclaringClass()->getName(), @@ -168,8 +170,10 @@ private function stringifyMethodParameter(ReflectionMethod $method, ReflectionPa * * @return string */ - private function stringifyFunctionParameter(ReflectionFunctionAbstract $function, ReflectionParameter $parameter): string - { + private function stringifyFunctionParameter( + ReflectionFunctionAbstract $function, + ReflectionParameter $parameter + ) : string { return sprintf( '%s($%s[%d])', $function->getName(), From 848c1db7373c2b66c652eb51d67843457a6d396c Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Tue, 24 Jan 2023 04:53:52 +0100 Subject: [PATCH 040/180] v3 --- .../WhitespaceStrippingMiddleware.php | 10 +++- src/ResponseResolutioner.php | 16 ++++- .../RouteResponseResolver.php | 59 +++++++++++++++++++ 3 files changed, 81 insertions(+), 4 deletions(-) create mode 100644 src/ResponseResolver/RouteResponseResolver.php diff --git a/src/Middleware/WhitespaceStrippingMiddleware.php b/src/Middleware/WhitespaceStrippingMiddleware.php index 766e6de7..020eac59 100644 --- a/src/Middleware/WhitespaceStrippingMiddleware.php +++ b/src/Middleware/WhitespaceStrippingMiddleware.php @@ -45,9 +45,13 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface if (!empty($parsedBody) && is_array($parsedBody)) { /** @psalm-suppress MissingClosureParamType, MixedAssignment */ - array_walk_recursive($parsedBody, static function (&$value): void { - $value = is_string($value) ? trim($value) : $value; - }); + $walker = static function (&$value): void { + if (is_string($value)) { + $value = trim($value); + } + }; + + array_walk_recursive($parsedBody, $walker); $request = $request->withParsedBody($parsedBody); } diff --git a/src/ResponseResolutioner.php b/src/ResponseResolutioner.php index 1bd59e29..6422c26f 100644 --- a/src/ResponseResolutioner.php +++ b/src/ResponseResolutioner.php @@ -83,7 +83,21 @@ public function resolveResponse($response): ResponseInterface throw new ResolvingResponseException(sprintf( 'Unable to resolve the response {%s}', - get_debug_type($response) + $this->stringifyResponse($response) )); } + + /** + * Stringifies the given raw response + * + * @param mixed $response + * + * @return string + * + * @todo Think about how to display the responder... + */ + private function stringifyResponse($response): string + { + return get_debug_type($response); + } } diff --git a/src/ResponseResolver/RouteResponseResolver.php b/src/ResponseResolver/RouteResponseResolver.php new file mode 100644 index 00000000..d338cdce --- /dev/null +++ b/src/ResponseResolver/RouteResponseResolver.php @@ -0,0 +1,59 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\ResponseResolver; + +/** + * Import classes + */ +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Sunrise\Http\Router\ResponseResolverInterface; +use Sunrise\Http\Router\RouteInterface; + +/** + * RouteResponseResolver + * + * @since 3.0.0 + */ +final class RouteResponseResolver implements ResponseResolverInterface +{ + + /** + * {@inheritdoc} + */ + public function supportsResponse($response, $context): bool + { + if (!($response instanceof RouteInterface)) { + return false; + } + + if (!($context instanceof ServerRequestInterface)) { + return false; + } + + return true; + } + + /** + * {@inheritdoc} + */ + public function resolveResponse($response, $context): ResponseInterface + { + /** @var RouteInterface */ + $response = $response; + + /** @var ServerRequestInterface */ + $context = $context; + + return $response->handle($context); + } +} From 32a93fcca07fb36132b30463b02180a773895a39 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Tue, 24 Jan 2023 05:28:36 +0100 Subject: [PATCH 041/180] v3 --- composer.json | 3 +- ...ectory_classes.php => get_dir_classes.php} | 29 +++++++------- functions/get_file_classes.php | 38 +++++++++++++++++++ src/Loader/DescriptorLoader.php | 4 +- 4 files changed, 56 insertions(+), 18 deletions(-) rename functions/{get_directory_classes.php => get_dir_classes.php} (61%) create mode 100644 functions/get_file_classes.php diff --git a/composer.json b/composer.json index 81f47bcd..8dc8187d 100644 --- a/composer.json +++ b/composer.json @@ -48,7 +48,8 @@ "files": [ "functions/emit.php", "functions/get_debug_type.php", - "functions/get_directory_classes.php", + "functions/get_dir_classes.php", + "functions/get_file_classes.php", "functions/path_build.php", "functions/path_match.php", "functions/path_parse.php", diff --git a/functions/get_directory_classes.php b/functions/get_dir_classes.php similarity index 61% rename from functions/get_directory_classes.php rename to functions/get_dir_classes.php index f083c5cb..c32ff6e6 100644 --- a/functions/get_directory_classes.php +++ b/functions/get_dir_classes.php @@ -19,36 +19,35 @@ use RecursiveIteratorIterator; use SplFileInfo; -/** - * Import functions - */ -use function array_diff; -use function get_declared_classes; - /** * Scans the given directory and returns the found classes * - * @param string $directory + * @param string $dirname * * @return class-string[] * * @since 3.0.0 */ -function get_directory_classes(string $directory): array +function get_dir_classes(string $dirname): array { - $known = get_declared_classes(); - /** @var Iterator */ $files = new RecursiveIteratorIterator( - new RecursiveDirectoryIterator($directory) + new RecursiveDirectoryIterator($dirname) ); + $result = []; + foreach ($files as $file) { - if ('php' === $file->getExtension()) { - /** @psalm-suppress UnresolvableInclude */ - require_once $file->getPathname(); + // only php files... + if ($file->getExtension() !== 'php') { + continue; + } + + $classnames = get_file_classes($file->getPathname()); + foreach ($classnames as $classname) { + $result[] = $classname; } } - return array_diff(get_declared_classes(), $known); + return $result; } diff --git a/functions/get_file_classes.php b/functions/get_file_classes.php new file mode 100644 index 00000000..58b17e38 --- /dev/null +++ b/functions/get_file_classes.php @@ -0,0 +1,38 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router; + +/** + * Import functions + */ +use function array_diff; +use function get_declared_classes; + +/** + * Scans the given file and returns the found classes + * + * @param string $filename + * + * @return class-string[] + * + * @since 3.0.0 + * + * @todo https://www.php.net/manual/en/book.tokenizer.php + */ +function get_file_classes(string $filename): array +{ + $snapshot = get_declared_classes(); + + require_once $filename; + + return array_diff(get_declared_classes(), $snapshot); +} diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index d1df4c87..fb7af185 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -45,7 +45,7 @@ use function is_dir; use function is_string; use function usort; -use function Sunrise\Http\Router\get_directory_classes; +use function Sunrise\Http\Router\get_dir_classes; /** * Import constants @@ -242,7 +242,7 @@ public function attach($resource): void } if (is_dir($resource)) { - $classnames = get_directory_classes($resource); + $classnames = get_dir_classes($resource); foreach ($classnames as $classname) { $this->resources[] = $classname; } From a4e9470a80e6888876ea7b92be7e48b5ae42bca6 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Wed, 25 Jan 2023 01:22:36 +0100 Subject: [PATCH 042/180] v3 --- .../KnownTypeParameterResolver.php | 4 +- .../RequestRouteParameterResolver.php | 65 +++++++++++++++++++ .../RouteResponseResolver.php | 4 +- src/RouteCollector.php | 56 ++++++++++++---- 4 files changed, 111 insertions(+), 18 deletions(-) create mode 100644 src/ParameterResolver/RequestRouteParameterResolver.php diff --git a/src/ParameterResolver/KnownTypeParameterResolver.php b/src/ParameterResolver/KnownTypeParameterResolver.php index f531c328..ad4373b9 100644 --- a/src/ParameterResolver/KnownTypeParameterResolver.php +++ b/src/ParameterResolver/KnownTypeParameterResolver.php @@ -76,11 +76,11 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo return false; } - if ($parameter->getType()->isBuiltin()) { + if (!($parameter->getType()->getName() === $this->type)) { return false; } - return $this->type === $parameter->getType()->getName(); + return true; } /** diff --git a/src/ParameterResolver/RequestRouteParameterResolver.php b/src/ParameterResolver/RequestRouteParameterResolver.php new file mode 100644 index 00000000..3db1a9f9 --- /dev/null +++ b/src/ParameterResolver/RequestRouteParameterResolver.php @@ -0,0 +1,65 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\ParameterResolver; + +/** + * Import classes + */ +use Psr\Http\Message\ServerRequestInterface; +use Sunrise\Http\Router\ParameterResolverInterface; +use Sunrise\Http\Router\RouteInterface; +use ReflectionNamedType; +use ReflectionParameter; + +/** + * RequestRouteParameterResolver + * + * @since 3.0.0 + */ +final class RequestRouteParameterResolver implements ParameterResolverInterface +{ + + /** + * {@inheritdoc} + */ + public function supportsParameter(ReflectionParameter $parameter, $context): bool + { + if (!($context instanceof ServerRequestInterface)) { + return false; + } + + if (!($parameter->getType() instanceof ReflectionNamedType)) { + return false; + } + + if (!($parameter->getType()->getName() === RouteInterface::class)) { + return false; + } + + if (!($context->getAttribute(RouteInterface::ATTR_ROUTE) instanceof RouteInterface)) { + return false; + } + + return true; + } + + /** + * {@inheritdoc} + */ + public function resolveParameter(ReflectionParameter $parameter, $context) + { + /** @var ServerRequestInterface */ + $context = $context; + + return $context->getAttribute(RouteInterface::ATTR_ROUTE); + } +} diff --git a/src/ResponseResolver/RouteResponseResolver.php b/src/ResponseResolver/RouteResponseResolver.php index d338cdce..8e913ce6 100644 --- a/src/ResponseResolver/RouteResponseResolver.php +++ b/src/ResponseResolver/RouteResponseResolver.php @@ -32,11 +32,11 @@ final class RouteResponseResolver implements ResponseResolverInterface */ public function supportsResponse($response, $context): bool { - if (!($response instanceof RouteInterface)) { + if (!($context instanceof ServerRequestInterface)) { return false; } - if (!($context instanceof ServerRequestInterface)) { + if (!($response instanceof RouteInterface)) { return false; } diff --git a/src/RouteCollector.php b/src/RouteCollector.php index f5903794..5d18c147 100644 --- a/src/RouteCollector.php +++ b/src/RouteCollector.php @@ -27,28 +27,28 @@ class RouteCollector * * @var RouteCollectionFactoryInterface */ - private $collectionFactory; + private RouteCollectionFactoryInterface $collectionFactory; /** * Route factory of the collector * * @var RouteFactoryInterface */ - private $routeFactory; + private RouteFactoryInterface $routeFactory; /** * Reference resolver of the collector * * @var ReferenceResolverInterface */ - private $referenceResolver; + private ReferenceResolverInterface $referenceResolver; /** * Route collection of the collector * * @var RouteCollectionInterface */ - private $collection; + private RouteCollectionInterface $collection; /** * Constructor of the class @@ -84,7 +84,35 @@ public function setContainer(?ContainerInterface $container): void } /** - * Gets the collector collection + * Adds the given parameter resolver(s) to the collector + * + * @param ParameterResolverInterface ...$resolvers + * + * @return void + * + * @since 3.0.0 + */ + public function addParameterResolver(ParameterResolverInterface ...$resolvers): void + { + $this->referenceResolver->addParameterResolver(...$resolvers); + } + + /** + * Adds the given response resolver(s) to the collector + * + * @param ResponseResolverInterface ...$resolvers + * + * @return void + * + * @since 3.0.0 + */ + public function addResponseResolver(ResponseResolverInterface ...$resolvers): void + { + $this->referenceResolver->addResponseResolver(...$resolvers); + } + + /** + * Gets the collector's route collection * * @return RouteCollectionInterface */ @@ -100,7 +128,7 @@ public function getCollection(): RouteCollectionInterface * @param string $path * @param list $methods * @param mixed $requestHandler - * @param array $middlewares + * @param array $middlewares * @param array $attributes * * @return RouteInterface @@ -133,7 +161,7 @@ public function route( * @param string $name * @param string $path * @param mixed $requestHandler - * @param array $middlewares + * @param array $middlewares * @param array $attributes * * @return RouteInterface @@ -161,7 +189,7 @@ public function head( * @param string $name * @param string $path * @param mixed $requestHandler - * @param array $middlewares + * @param array $middlewares * @param array $attributes * * @return RouteInterface @@ -189,7 +217,7 @@ public function get( * @param string $name * @param string $path * @param mixed $requestHandler - * @param array $middlewares + * @param array $middlewares * @param array $attributes * * @return RouteInterface @@ -217,7 +245,7 @@ public function post( * @param string $name * @param string $path * @param mixed $requestHandler - * @param array $middlewares + * @param array $middlewares * @param array $attributes * * @return RouteInterface @@ -245,7 +273,7 @@ public function put( * @param string $name * @param string $path * @param mixed $requestHandler - * @param array $middlewares + * @param array $middlewares * @param array $attributes * * @return RouteInterface @@ -273,7 +301,7 @@ public function patch( * @param string $name * @param string $path * @param mixed $requestHandler - * @param array $middlewares + * @param array $middlewares * @param array $attributes * * @return RouteInterface @@ -301,7 +329,7 @@ public function delete( * @param string $name * @param string $path * @param mixed $requestHandler - * @param array $middlewares + * @param array $middlewares * @param array $attributes * * @return RouteInterface @@ -327,7 +355,7 @@ public function purge( * Route grouping logic * * @param callable $callback - * @param array $middlewares + * @param array $middlewares * * @return RouteCollectionInterface */ From 97b432cb8a441d7bfd3dfe8b5100afa43519d574 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 26 Jan 2023 04:18:07 +0100 Subject: [PATCH 043/180] v3 --- src/AnnotationReader.php | 5 +- src/ClassResolver.php | 93 +++++++++++++ src/ClassResolverInterface.php | 42 ++++++ src/Exception/Http/HttpException.php | 4 +- src/Loader/ConfigLoader.php | 79 +++++++++-- src/Loader/DescriptorLoader.php | 79 +++++++++-- .../JsonPayloadDecodingMiddleware.php | 15 ++- ...rsedBodyWhitespaceStrippingMiddleware.php} | 29 ++-- src/Middleware/UnsafeCallableMiddleware.php | 55 ++++++++ src/ReferenceResolver.php | 105 ++++----------- src/ReferenceResolverInterface.php | 32 ----- src/Route.php | 8 +- src/RouteCollector.php | 127 +++++++++++++----- src/RouteInterface.php | 3 +- src/Router.php | 21 +-- src/RouterBuilder.php | 22 --- 16 files changed, 480 insertions(+), 239 deletions(-) create mode 100644 src/ClassResolver.php create mode 100644 src/ClassResolverInterface.php rename src/Middleware/{WhitespaceStrippingMiddleware.php => ParsedBodyWhitespaceStrippingMiddleware.php} (61%) create mode 100644 src/Middleware/UnsafeCallableMiddleware.php diff --git a/src/AnnotationReader.php b/src/AnnotationReader.php index 037863a9..67f6321d 100644 --- a/src/AnnotationReader.php +++ b/src/AnnotationReader.php @@ -14,6 +14,7 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Exception\LogicException; use ReflectionAttribute; use ReflectionClass; @@ -84,7 +85,7 @@ public function useDefaultAnnotationReader(): void * * @return list * - * @throws LogicException + * @throws InvalidArgumentException * If the given reflection isn't supported. * * @psalm-suppress RedundantConditionGivenDocblockType @@ -101,7 +102,7 @@ public function getClassOrMethodAnnotations(Reflector $classOrMethod, string $an return $this->getMethodAnnotations($classOrMethod, $annotationName); } - throw new LogicException(sprintf( + throw new InvalidArgumentException(sprintf( 'The %s method only handles class or method reflection', __METHOD__ )); diff --git a/src/ClassResolver.php b/src/ClassResolver.php new file mode 100644 index 00000000..403e9ff5 --- /dev/null +++ b/src/ClassResolver.php @@ -0,0 +1,93 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router; + +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\InvalidArgumentException; +use Sunrise\Http\Router\Exception\LogicException; +use ReflectionClass; + +/** + * Import functions + */ +use function class_exists; +use function sprintf; + +/** + * ClassResolver + * + * @since 3.0.0 + */ +final class ClassResolver implements ClassResolverInterface +{ + + /** + * Map of classes that are already resolved + * + * @var array + */ + private array $resolvedClasses = []; + + /** + * The resolver's parameter resolutioner + * + * @var ParameterResolutionerInterface + */ + private ParameterResolutionerInterface $parameterResolutioner; + + /** + * Constructor of the class + * + * @param ParameterResolutionerInterface $parameterResolutioner + */ + public function __construct(ParameterResolutionerInterface $parameterResolutioner) + { + $this->parameterResolutioner = $parameterResolutioner; + } + + /** + * {@inheritdoc} + */ + public function resolveClass(string $classname): object + { + if (isset($this->resolvedClasses[$classname])) { + return $this->resolvedClasses[$classname]; + } + + if (!class_exists($classname)) { + throw new InvalidArgumentException(sprintf( + 'The class %s was not found', + $classname + )); + } + + $reflection = new ReflectionClass($classname); + if (!$reflection->isInstantiable()) { + throw new LogicException(sprintf( + 'The class %s cannot be initialized directly', + $classname + )); + } + + $arguments = []; + $constructor = $reflection->getConstructor(); + if (isset($constructor) && $constructor->getNumberOfParameters() > 0) { + $arguments = $this->parameterResolutioner->resolveParameters( + ...$constructor->getParameters() + ); + } + + return $this->resolvedClasses[$classname] = $reflection->newInstance(...$arguments); + } +} diff --git a/src/ClassResolverInterface.php b/src/ClassResolverInterface.php new file mode 100644 index 00000000..2757e97d --- /dev/null +++ b/src/ClassResolverInterface.php @@ -0,0 +1,42 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router; + +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\InvalidArgumentException; +use Sunrise\Http\Router\Exception\LogicException; + +/** + * ClassResolverInterface + * + * @since 3.0.0 + */ +interface ClassResolverInterface +{ + + /** + * Resolves the given class by its name + * + * @param class-string $classname + * + * @return object + * + * @throws InvalidArgumentException + * If the class doesn't exist. + * + * @throws LogicException + * If the class cannot be initialized directly. + */ + public function resolveClass(string $classname): object; +} diff --git a/src/Exception/Http/HttpException.php b/src/Exception/Http/HttpException.php index 401fea9b..b29cc1e5 100644 --- a/src/Exception/Http/HttpException.php +++ b/src/Exception/Http/HttpException.php @@ -14,7 +14,7 @@ /** * Import classes */ -use Exception; +use RuntimeException; use Throwable; /** @@ -22,7 +22,7 @@ * * @since 3.0.0 */ -class HttpException extends Exception implements HttpExceptionInterface +class HttpException extends RuntimeException implements HttpExceptionInterface { /** diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index 3a44852e..d3f36285 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -16,9 +16,15 @@ */ use Psr\Container\ContainerInterface; use Sunrise\Http\Router\Exception\InvalidArgumentException; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ParameterResolver\DependencyInjectionParameterResolver; +use Sunrise\Http\Router\ParameterResolutioner; +use Sunrise\Http\Router\ParameterResolutionerInterface; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; +use Sunrise\Http\Router\ResponseResolutioner; +use Sunrise\Http\Router\ResponseResolutionerInterface; use Sunrise\Http\Router\ResponseResolverInterface; use Sunrise\Http\Router\RouteCollectionFactory; use Sunrise\Http\Router\RouteCollectionFactoryInterface; @@ -61,63 +67,114 @@ final class ConfigLoader implements LoaderInterface */ private ReferenceResolverInterface $referenceResolver; + /** + * @var ParameterResolutionerInterface|null + */ + private ?ParameterResolutionerInterface $parameterResolutioner = null; + + /** + * @var ResponseResolutionerInterface|null + */ + private ?ResponseResolutionerInterface $responseResolutioner = null; + /** * Constructor of the class * * @param RouteCollectionFactoryInterface|null $collectionFactory * @param RouteFactoryInterface|null $routeFactory * @param ReferenceResolverInterface|null $referenceResolver + * @param ParameterResolutionerInterface|null $parameterResolutioner + * @param ResponseResolutionerInterface|null $responseResolutioner */ public function __construct( ?RouteCollectionFactoryInterface $collectionFactory = null, ?RouteFactoryInterface $routeFactory = null, - ?ReferenceResolverInterface $referenceResolver = null + ?ReferenceResolverInterface $referenceResolver = null, + ?ParameterResolutionerInterface $parameterResolutioner = null, + ?ResponseResolutionerInterface $responseResolutioner = null ) { $this->collectionFactory = $collectionFactory ?? new RouteCollectionFactory(); $this->routeFactory = $routeFactory ?? new RouteFactory(); - $this->referenceResolver = $referenceResolver ?? new ReferenceResolver(); + + $this->parameterResolutioner = $parameterResolutioner; + $this->responseResolutioner = $responseResolutioner; + + $this->referenceResolver = $referenceResolver ?? new ReferenceResolver( + $this->parameterResolutioner ??= new ParameterResolutioner(), + $this->responseResolutioner ??= new ResponseResolutioner() + ); } /** - * Sets the given container to the reference resolver + * Sets the given container to the parameter resolutioner * - * @param ContainerInterface|null $container + * @param ContainerInterface $container * * @return void * - * @since 2.9.0 + * @throws LogicException + * If a custom reference resolver was setted. */ - public function setContainer(?ContainerInterface $container): void + public function setContainer(ContainerInterface $container): void { - $this->referenceResolver->setContainer($container); + if (!isset($this->parameterResolutioner)) { + throw new LogicException( + 'The config route loader cannot accept the container ' . + 'because a custom reference resolver was setted' + ); + } + + $this->parameterResolutioner->addResolver( + new DependencyInjectionParameterResolver($container) + ); } /** - * Adds the given parameter resolver(s) to the reference resolver + * Adds the given parameter resolver(s) to the parameter resolutioner * * @param ParameterResolverInterface ...$resolvers * * @return void * + * @throws LogicException + * If a custom reference resolver was setted. + * * @since 3.0.0 */ public function addParameterResolver(ParameterResolverInterface ...$resolvers): void { - $this->referenceResolver->addParameterResolver(...$resolvers); + if (!isset($this->parameterResolutioner)) { + throw new LogicException( + 'The config route loader cannot accept the parameter resolver ' . + 'because a custom reference resolver was setted' + ); + } + + $this->parameterResolutioner->addResolver(...$resolvers); } /** - * Adds the given response resolver(s) to the reference resolver + * Adds the given response resolver(s) to the response resolutioner * * @param ResponseResolverInterface ...$resolvers * * @return void * + * @throws LogicException + * If a custom reference resolver was setted. + * * @since 3.0.0 */ public function addResponseResolver(ResponseResolverInterface ...$resolvers): void { - $this->referenceResolver->addResponseResolver(...$resolvers); + if (!isset($this->responseResolutioner)) { + throw new LogicException( + 'The config route loader cannot accept the response resolver ' . + 'because a custom reference resolver was setted' + ); + } + + $this->responseResolutioner->addResolver(...$resolvers); } /** diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index fb7af185..bd1e6abe 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -23,10 +23,16 @@ use Sunrise\Http\Router\Annotation\Prefix; use Sunrise\Http\Router\Annotation\Route; use Sunrise\Http\Router\Exception\InvalidArgumentException; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ParameterResolver\DependencyInjectionParameterResolver; use Sunrise\Http\Router\AnnotationReader; +use Sunrise\Http\Router\ParameterResolutioner; +use Sunrise\Http\Router\ParameterResolutionerInterface; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; +use Sunrise\Http\Router\ResponseResolutioner; +use Sunrise\Http\Router\ResponseResolutionerInterface; use Sunrise\Http\Router\ResponseResolverInterface; use Sunrise\Http\Router\RouteCollectionFactory; use Sunrise\Http\Router\RouteCollectionFactoryInterface; @@ -78,6 +84,16 @@ final class DescriptorLoader implements LoaderInterface */ private ReferenceResolverInterface $referenceResolver; + /** + * @var ParameterResolutionerInterface|null + */ + private ?ParameterResolutionerInterface $parameterResolutioner = null; + + /** + * @var ResponseResolutionerInterface|null + */ + private ?ResponseResolutionerInterface $responseResolutioner = null; + /** * @var AnnotationReader */ @@ -99,15 +115,26 @@ final class DescriptorLoader implements LoaderInterface * @param RouteCollectionFactoryInterface|null $collectionFactory * @param RouteFactoryInterface|null $routeFactory * @param ReferenceResolverInterface|null $referenceResolver + * @param ParameterResolutionerInterface|null $parameterResolutioner + * @param ResponseResolutionerInterface|null $responseResolutioner */ public function __construct( ?RouteCollectionFactoryInterface $collectionFactory = null, ?RouteFactoryInterface $routeFactory = null, - ?ReferenceResolverInterface $referenceResolver = null + ?ReferenceResolverInterface $referenceResolver = null, + ?ParameterResolutionerInterface $parameterResolutioner = null, + ?ResponseResolutionerInterface $responseResolutioner = null ) { $this->collectionFactory = $collectionFactory ?? new RouteCollectionFactory(); $this->routeFactory = $routeFactory ?? new RouteFactory(); - $this->referenceResolver = $referenceResolver ?? new ReferenceResolver(); + + $this->parameterResolutioner = $parameterResolutioner; + $this->responseResolutioner = $responseResolutioner; + + $this->referenceResolver = $referenceResolver ?? new ReferenceResolver( + $this->parameterResolutioner ??= new ParameterResolutioner(), + $this->responseResolutioner ??= new ResponseResolutioner() + ); $this->annotationReader = new AnnotationReader(); @@ -117,43 +144,75 @@ public function __construct( } /** - * Sets the given container to the reference resolver + * Sets the given container to the parameter resolutioner * - * @param ContainerInterface|null $container + * @param ContainerInterface $container * * @return void + * + * @throws LogicException + * If a custom reference resolver was setted. */ - public function setContainer(?ContainerInterface $container): void + public function setContainer(ContainerInterface $container): void { - $this->referenceResolver->setContainer($container); + if (!isset($this->parameterResolutioner)) { + throw new LogicException( + 'The descriptor route loader cannot accept the container ' . + 'because a custom reference resolver was setted' + ); + } + + $this->parameterResolutioner->addResolver( + new DependencyInjectionParameterResolver($container) + ); } /** - * Adds the given parameter resolver(s) to the reference resolver + * Adds the given parameter resolver(s) to the parameter resolutioner * * @param ParameterResolverInterface ...$resolvers * * @return void * + * @throws LogicException + * If a custom reference resolver was setted. + * * @since 3.0.0 */ public function addParameterResolver(ParameterResolverInterface ...$resolvers): void { - $this->referenceResolver->addParameterResolver(...$resolvers); + if (!isset($this->parameterResolutioner)) { + throw new LogicException( + 'The descriptor route loader cannot accept the parameter resolver ' . + 'because a custom reference resolver was setted' + ); + } + + $this->parameterResolutioner->addResolver(...$resolvers); } /** - * Adds the given response resolver(s) to the reference resolver + * Adds the given response resolver(s) to the response resolutioner * * @param ResponseResolverInterface ...$resolvers * * @return void * + * @throws LogicException + * If a custom reference resolver was setted. + * * @since 3.0.0 */ public function addResponseResolver(ResponseResolverInterface ...$resolvers): void { - $this->referenceResolver->addResponseResolver(...$resolvers); + if (!isset($this->responseResolutioner)) { + throw new LogicException( + 'The descriptor route loader cannot accept the response resolver ' . + 'because a custom reference resolver was setted' + ); + } + + $this->responseResolutioner->addResolver(...$resolvers); } /** diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index e77ded54..2bf508bb 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -52,8 +52,11 @@ final class JsonPayloadDecodingMiddleware implements MiddlewareInterface public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { if ($this->supportsRequest($request)) { - $data = $this->decodeRequestJsonPayload($request); - $request = $request->withParsedBody($data); + return $handler->handle( + $request->withParsedBody( + $this->decodeRequestPayload($request) + ) + ); } return $handler->handle($request); @@ -70,7 +73,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface */ private function supportsRequest(ServerRequestInterface $request): bool { - return 'application/json' === $this->getRequestMediaType($request); + return $this->getRequestMediaType($request) === 'application/json'; } /** @@ -101,16 +104,16 @@ private function getRequestMediaType(ServerRequestInterface $request): ?string } /** - * Tries to decode the given request's JSON payload + * Tries to decode the given request's payload * * @param ServerRequestInterface $request * * @return array|null * * @throws InvalidRequestPayloadException - * If the request's "JSON" payload cannot be decoded. + * If the request's payload cannot be decoded. */ - private function decodeRequestJsonPayload(ServerRequestInterface $request): ?array + private function decodeRequestPayload(ServerRequestInterface $request): ?array { // https://www.php.net/json.constants $flags = JSON_BIGINT_AS_STRING | JSON_OBJECT_AS_ARRAY | JSON_THROW_ON_ERROR; diff --git a/src/Middleware/WhitespaceStrippingMiddleware.php b/src/Middleware/ParsedBodyWhitespaceStrippingMiddleware.php similarity index 61% rename from src/Middleware/WhitespaceStrippingMiddleware.php rename to src/Middleware/ParsedBodyWhitespaceStrippingMiddleware.php index 020eac59..656cec85 100644 --- a/src/Middleware/WhitespaceStrippingMiddleware.php +++ b/src/Middleware/ParsedBodyWhitespaceStrippingMiddleware.php @@ -28,11 +28,11 @@ use function trim; /** - * WhitespaceStrippingMiddleware + * ParsedBodyWhitespaceStrippingMiddleware * * @since 3.0.0 */ -final class WhitespaceStrippingMiddleware implements MiddlewareInterface +final class ParsedBodyWhitespaceStrippingMiddleware implements MiddlewareInterface { /** @@ -42,20 +42,21 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface { $parsedBody = $request->getParsedBody(); - if (!empty($parsedBody) && is_array($parsedBody)) { - - /** @psalm-suppress MissingClosureParamType, MixedAssignment */ - $walker = static function (&$value): void { - if (is_string($value)) { - $value = trim($value); - } - }; + if (empty($parsedBody) || !is_array($parsedBody)) { + return $handler->handle($request); + } - array_walk_recursive($parsedBody, $walker); + /** @psalm-suppress MissingClosureParamType, MixedAssignment */ + $walker = static function (&$value): void { + if (is_string($value)) { + $value = trim($value); + } + }; - $request = $request->withParsedBody($parsedBody); - } + array_walk_recursive($parsedBody, $walker); - return $handler->handle($request); + return $handler->handle( + $request->withParsedBody($parsedBody) + ); } } diff --git a/src/Middleware/UnsafeCallableMiddleware.php b/src/Middleware/UnsafeCallableMiddleware.php new file mode 100644 index 00000000..b8b570a0 --- /dev/null +++ b/src/Middleware/UnsafeCallableMiddleware.php @@ -0,0 +1,55 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Middleware; + +/** + * Import classes + */ +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; + +/** + * UnsafeCallableMiddleware + * + * @since 3.0.0 + */ +final class UnsafeCallableMiddleware implements MiddlewareInterface +{ + + /** + * The middleware callback + * + * @var callable + */ + private $callback; + + /** + * Constructor of the class + * + * @param callable $callback + */ + public function __construct(callable $callback) + { + $this->callback = $callback; + } + + /** + * {@inheritdoc} + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + /** @var ResponseInterface */ + return ($this->callback)($request, $handler); + } +} diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index d340c491..77230a21 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -14,15 +14,12 @@ /** * Import classes */ -use Psr\Container\ContainerInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\Exception\ResolvingReferenceException; use Sunrise\Http\Router\Middleware\CallableMiddleware; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use Closure; -use ReflectionClass; /** * Import functions @@ -57,48 +54,29 @@ final class ReferenceResolver implements ReferenceResolverInterface private ResponseResolutionerInterface $responseResolutioner; /** - * The resolver's container + * The resolver's class resolver * - * @var ContainerInterface|null + * @var ClassResolverInterface */ - private ?ContainerInterface $container = null; + private ClassResolverInterface $classResolver; /** * Constructor of the class * - * @param ParameterResolutionerInterface|null $parameterResolutioner - * @param ResponseResolutionerInterface|null $responseResolutioner + * @param ParameterResolutionerInterface $parameterResolutioner + * @param ResponseResolutionerInterface $responseResolutioner + * @param ClassResolverInterface|null $classResolver */ public function __construct( - ?ParameterResolutionerInterface $parameterResolutioner = null, - ?ResponseResolutionerInterface $responseResolutioner = null + ParameterResolutionerInterface $parameterResolutioner, + ResponseResolutionerInterface $responseResolutioner, + ?ClassResolverInterface $classResolver = null ) { - $this->parameterResolutioner = $parameterResolutioner ?? new ParameterResolutioner(); - $this->responseResolutioner = $responseResolutioner ?? new ResponseResolutioner(); - } - - /** - * {@inheritdoc} - */ - public function setContainer(?ContainerInterface $container): void - { - $this->container = $container; - } - - /** - * {@inheritdoc} - */ - public function addParameterResolver(ParameterResolverInterface ...$resolvers): void - { - $this->parameterResolutioner->addResolver(...$resolvers); - } + $classResolver ??= new ClassResolver($parameterResolutioner); - /** - * {@inheritdoc} - */ - public function addResponseResolver(ResponseResolverInterface ...$resolvers): void - { - $this->responseResolutioner->addResolver(...$resolvers); + $this->parameterResolutioner = $parameterResolutioner; + $this->responseResolutioner = $responseResolutioner; + $this->classResolver = $classResolver; } /** @@ -119,14 +97,18 @@ public function resolveRequestHandler($reference): RequestHandlerInterface if (is_array($reference) && is_callable($reference, true) && method_exists($reference[0], $reference[1])) { /** @var array{0: class-string|object, 1: non-empty-string} $reference */ - $callback = [is_string($reference[0]) ? $this->resolveClass($reference[0]) : $reference[0], $reference[1]]; + $object = is_string($reference[0]) ? $this->classResolver->resolveClass($reference[0]) : $reference[0]; - return new CallableRequestHandler($callback, $this->parameterResolutioner, $this->responseResolutioner); + return new CallableRequestHandler( + [$object, $reference[1]], + $this->parameterResolutioner, + $this->responseResolutioner + ); } if (is_string($reference) && is_subclass_of($reference, RequestHandlerInterface::class)) { /** @var RequestHandlerInterface */ - return $this->resolveClass($reference); + return $this->classResolver->resolveClass($reference); } throw new ResolvingReferenceException(sprintf( @@ -153,14 +135,18 @@ public function resolveMiddleware($reference): MiddlewareInterface if (is_array($reference) && is_callable($reference, true) && method_exists($reference[0], $reference[1])) { /** @var array{0: class-string|object, 1: non-empty-string} $reference */ - $callback = [is_string($reference[0]) ? $this->resolveClass($reference[0]) : $reference[0], $reference[1]]; + $object = is_string($reference[0]) ? $this->classResolver->resolveClass($reference[0]) : $reference[0]; - return new CallableMiddleware($callback, $this->parameterResolutioner, $this->responseResolutioner); + return new CallableMiddleware( + [$object, $reference[1]], + $this->parameterResolutioner, + $this->responseResolutioner + ); } if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { /** @var MiddlewareInterface */ - return $this->resolveClass($reference); + return $this->classResolver->resolveClass($reference); } throw new ResolvingReferenceException(sprintf( @@ -183,43 +169,6 @@ public function resolveMiddlewares(array $references): array return $middlewares; } - /** - * Resolves the given class - * - * @param class-string $class - * - * @return T - * - * @throws LogicException - * If the class cannot be directly initialized. - * - * @template T - */ - private function resolveClass(string $class): object - { - if (isset($this->container) && $this->container->has($class)) { - /** @var T */ - return $this->container->get($class); - } - - $reflection = new ReflectionClass($class); - if (!$reflection->isInstantiable()) { - throw new LogicException(sprintf( - 'The class %s cannot be initialized', - $class - )); - } - - $arguments = []; - $constructor = $reflection->getConstructor(); - if (isset($constructor)) { - $arguments = $this->parameterResolutioner - ->resolveParameters(...$constructor->getParameters()); - } - - return $reflection->newInstance(...$arguments); - } - /** * Stringifies the given reference * diff --git a/src/ReferenceResolverInterface.php b/src/ReferenceResolverInterface.php index f7862239..9df2cd07 100644 --- a/src/ReferenceResolverInterface.php +++ b/src/ReferenceResolverInterface.php @@ -14,7 +14,6 @@ /** * Import classes */ -use Psr\Container\ContainerInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Exception\ResolvingReferenceException; @@ -27,37 +26,6 @@ interface ReferenceResolverInterface { - /** - * Sets the given container to the resolver - * - * @param ContainerInterface|null $container - * - * @return void - */ - public function setContainer(?ContainerInterface $container): void; - - /** - * Adds the given parameter resolver(s) to the resolver - * - * @param ParameterResolverInterface ...$resolvers - * - * @return void - * - * @since 3.0.0 - */ - public function addParameterResolver(ParameterResolverInterface ...$resolvers): void; - - /** - * Adds the given response resolver(s) to the resolver - * - * @param ResponseResolverInterface ...$resolvers - * - * @return void - * - * @since 3.0.0 - */ - public function addResponseResolver(ResponseResolverInterface ...$resolvers): void; - /** * Resolves the given reference to a request handler * diff --git a/src/Route.php b/src/Route.php index 03049070..e70a0c07 100644 --- a/src/Route.php +++ b/src/Route.php @@ -218,11 +218,9 @@ public function getTags(): array */ public function getHolder(): Reflector { - if ($this->requestHandler instanceof CallableRequestHandler) { - return $this->requestHandler->getReflection(); - } - - return new ReflectionClass($this->requestHandler); + return ($this->requestHandler instanceof CallableRequestHandler) ? + $this->requestHandler->getReflection() : + new ReflectionClass($this->requestHandler); } /** diff --git a/src/RouteCollector.php b/src/RouteCollector.php index 5d18c147..72208412 100644 --- a/src/RouteCollector.php +++ b/src/RouteCollector.php @@ -15,6 +15,8 @@ * Import classes */ use Psr\Container\ContainerInterface; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ParameterResolver\DependencyInjectionParameterResolver; /** * RouteCollector @@ -23,32 +25,42 @@ class RouteCollector { /** - * Route collection factory of the collector + * The collector's route collection + * + * @var RouteCollectionInterface + */ + private RouteCollectionInterface $collection; + + /** + * The collector's route collection factory * * @var RouteCollectionFactoryInterface */ private RouteCollectionFactoryInterface $collectionFactory; /** - * Route factory of the collector + * The collector's route factory * * @var RouteFactoryInterface */ private RouteFactoryInterface $routeFactory; /** - * Reference resolver of the collector + * The collector's reference resolver * * @var ReferenceResolverInterface */ private ReferenceResolverInterface $referenceResolver; /** - * Route collection of the collector - * - * @var RouteCollectionInterface + * @var ParameterResolutionerInterface|null */ - private RouteCollectionInterface $collection; + private ?ParameterResolutionerInterface $parameterResolutioner = null; + + /** + * @var ResponseResolutionerInterface|null + */ + private ?ResponseResolutionerInterface $responseResolutioner = null; /** * Constructor of the class @@ -56,69 +68,110 @@ class RouteCollector * @param RouteCollectionFactoryInterface|null $collectionFactory * @param RouteFactoryInterface|null $routeFactory * @param ReferenceResolverInterface|null $referenceResolver + * @param ParameterResolutionerInterface|null $parameterResolutioner + * @param ResponseResolutionerInterface|null $responseResolutioner */ public function __construct( ?RouteCollectionFactoryInterface $collectionFactory = null, ?RouteFactoryInterface $routeFactory = null, - ?ReferenceResolverInterface $referenceResolver = null + ?ReferenceResolverInterface $referenceResolver = null, + ?ParameterResolutionerInterface $parameterResolutioner = null, + ?ResponseResolutionerInterface $responseResolutioner = null ) { $this->collectionFactory = $collectionFactory ?? new RouteCollectionFactory(); $this->routeFactory = $routeFactory ?? new RouteFactory(); - $this->referenceResolver = $referenceResolver ?? new ReferenceResolver(); + + $this->parameterResolutioner = $parameterResolutioner; + $this->responseResolutioner = $responseResolutioner; + + $this->referenceResolver = $referenceResolver ?? new ReferenceResolver( + $this->parameterResolutioner ??= new ParameterResolutioner(), + $this->responseResolutioner ??= new ResponseResolutioner() + ); $this->collection = $this->collectionFactory->createCollection(); } /** - * Sets the given container to the collector + * Gets the collector's route collection * - * @param ContainerInterface|null $container + * @return RouteCollectionInterface + */ + public function getCollection(): RouteCollectionInterface + { + return $this->collection; + } + + /** + * Sets the given container to the parameter resolutioner + * + * @param ContainerInterface $container * * @return void * - * @since 2.9.0 + * @throws LogicException + * If a custom reference resolver was setted. */ - public function setContainer(?ContainerInterface $container): void + public function setContainer(ContainerInterface $container): void { - $this->referenceResolver->setContainer($container); + if (!isset($this->parameterResolutioner)) { + throw new LogicException( + 'The route collector cannot accept the container ' . + 'because a custom reference resolver was setted' + ); + } + + $this->parameterResolutioner->addResolver( + new DependencyInjectionParameterResolver($container) + ); } /** - * Adds the given parameter resolver(s) to the collector + * Adds the given parameter resolver(s) to the parameter resolutioner * * @param ParameterResolverInterface ...$resolvers * * @return void * + * @throws LogicException + * If a custom reference resolver was setted. + * * @since 3.0.0 */ public function addParameterResolver(ParameterResolverInterface ...$resolvers): void { - $this->referenceResolver->addParameterResolver(...$resolvers); + if (!isset($this->parameterResolutioner)) { + throw new LogicException( + 'The route collector cannot accept the parameter resolver ' . + 'because a custom reference resolver was setted' + ); + } + + $this->parameterResolutioner->addResolver(...$resolvers); } /** - * Adds the given response resolver(s) to the collector + * Adds the given response resolver(s) to the response resolutioner * * @param ResponseResolverInterface ...$resolvers * * @return void * + * @throws LogicException + * If a custom reference resolver was setted. + * * @since 3.0.0 */ public function addResponseResolver(ResponseResolverInterface ...$resolvers): void { - $this->referenceResolver->addResponseResolver(...$resolvers); - } + if (!isset($this->responseResolutioner)) { + throw new LogicException( + 'The route collector cannot accept the response resolver ' . + 'because a custom reference resolver was setted' + ); + } - /** - * Gets the collector's route collection - * - * @return RouteCollectionInterface - */ - public function getCollection(): RouteCollectionInterface - { - return $this->collection; + $this->responseResolutioner->addResolver(...$resolvers); } /** @@ -126,7 +179,7 @@ public function getCollection(): RouteCollectionInterface * * @param string $name * @param string $path - * @param list $methods + * @param array $methods * @param mixed $requestHandler * @param array $middlewares * @param array $attributes @@ -176,7 +229,7 @@ public function head( return $this->route( $name, $path, - [Router::METHOD_HEAD], + [RouteInterface::METHOD_HEAD], $requestHandler, $middlewares, $attributes @@ -204,7 +257,7 @@ public function get( return $this->route( $name, $path, - [Router::METHOD_GET], + [RouteInterface::METHOD_GET], $requestHandler, $middlewares, $attributes @@ -232,7 +285,7 @@ public function post( return $this->route( $name, $path, - [Router::METHOD_POST], + [RouteInterface::METHOD_POST], $requestHandler, $middlewares, $attributes @@ -260,7 +313,7 @@ public function put( return $this->route( $name, $path, - [Router::METHOD_PUT], + [RouteInterface::METHOD_PUT], $requestHandler, $middlewares, $attributes @@ -288,7 +341,7 @@ public function patch( return $this->route( $name, $path, - [Router::METHOD_PATCH], + [RouteInterface::METHOD_PATCH], $requestHandler, $middlewares, $attributes @@ -316,7 +369,7 @@ public function delete( return $this->route( $name, $path, - [Router::METHOD_DELETE], + [RouteInterface::METHOD_DELETE], $requestHandler, $middlewares, $attributes @@ -344,7 +397,7 @@ public function purge( return $this->route( $name, $path, - [Router::METHOD_PURGE], + [RouteInterface::METHOD_PURGE], $requestHandler, $middlewares, $attributes @@ -364,7 +417,9 @@ public function group(callable $callback, array $middlewares = []): RouteCollect $collector = new self( $this->collectionFactory, $this->routeFactory, - $this->referenceResolver + $this->referenceResolver, + $this->parameterResolutioner, + $this->responseResolutioner ); $callback($collector); diff --git a/src/RouteInterface.php b/src/RouteInterface.php index dbc66928..af817570 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -14,6 +14,7 @@ /** * Import classes */ +use Fig\Http\Message\RequestMethodInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use ReflectionClass; @@ -24,7 +25,7 @@ /** * RouteInterface */ -interface RouteInterface extends RequestHandlerInterface +interface RouteInterface extends RequestHandlerInterface, RequestMethodInterface { /** diff --git a/src/Router.php b/src/Router.php index 267d8703..17eae62f 100644 --- a/src/Router.php +++ b/src/Router.php @@ -42,16 +42,9 @@ /** * Router */ -class Router implements MiddlewareInterface, RequestHandlerInterface, RequestMethodInterface +class Router implements RequestHandlerInterface, RequestMethodInterface { - /** - * Server Request attribute name for routing error instance - * - * @var string - */ - public const ATTR_NAME_FOR_ROUTING_ERROR = '@routing-error'; - /** * Global patterns * @@ -531,18 +524,6 @@ public function handle(ServerRequestInterface $request): ResponseInterface return $handler->handle($request); } - /** - * {@inheritdoc} - */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface - { - try { - return $this->handle($request); - } catch (PageNotFoundException|MethodNotAllowedException $e) { - return $handler->handle($request->withAttribute(self::ATTR_NAME_FOR_ROUTING_ERROR, $e)); - } - } - /** * Loads routes through the given loaders * diff --git a/src/RouterBuilder.php b/src/RouterBuilder.php index 598662f8..fe1f96d7 100644 --- a/src/RouterBuilder.php +++ b/src/RouterBuilder.php @@ -14,7 +14,6 @@ /** * Import classes */ -use Psr\Container\ContainerInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\SimpleCache\CacheInterface; use Symfony\Contracts\EventDispatcher\EventDispatcherInterface; @@ -34,11 +33,6 @@ final class RouterBuilder */ private $eventDispatcher = null; - /** - * @var ContainerInterface|null - */ - private $container = null; - /** * @var CacheInterface|null */ @@ -90,20 +84,6 @@ public function setEventDispatcher(?EventDispatcherInterface $eventDispatcher): return $this; } - /** - * Sets the given container to the builder - * - * @param ContainerInterface|null $container - * - * @return self - */ - public function setContainer(?ContainerInterface $container): self - { - $this->container = $container; - - return $this; - } - /** * Sets the given cache to the builder * @@ -238,12 +218,10 @@ public function build(): Router } if (isset($this->configLoader)) { - $this->configLoader->setContainer($this->container); $router->load($this->configLoader); } if (isset($this->descriptorLoader)) { - $this->descriptorLoader->setContainer($this->container); $this->descriptorLoader->setCache($this->cache); $this->descriptorLoader->setCacheKey($this->cacheKey); $router->load($this->descriptorLoader); From 088c024a942439dd8c458a90b9611bbb2f6aacf7 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 26 Jan 2023 04:21:58 +0100 Subject: [PATCH 044/180] v3 --- src/ReferenceResolver.php | 1 + 1 file changed, 1 insertion(+) diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index 77230a21..c48a3670 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -46,6 +46,7 @@ final class ReferenceResolver implements ReferenceResolverInterface * @var ParameterResolutionerInterface */ private ParameterResolutionerInterface $parameterResolutioner; + /** * The resolver's response resolutioner * From e77ac9185ef9163c8f309dfcd477885a2554d09b Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 27 Jan 2023 20:46:48 +0100 Subject: [PATCH 045/180] v3 --- functions/get_debug_type.php | 2 +- src/Exception/Http/HttpException.php | 2 +- src/Exception/ResolvingException.php | 21 -------- src/Exception/ResolvingParameterException.php | 2 +- src/Exception/ResolvingReferenceException.php | 2 +- src/Exception/ResolvingResponseException.php | 2 +- src/Loader/ConfigLoader.php | 18 ++++--- src/Loader/DescriptorLoader.php | 26 +++++++--- src/Middleware/CallableMiddleware.php | 10 ++-- src/RequestHandler/CallableRequestHandler.php | 8 ++- src/RouteCollection.php | 50 +++++++++++++------ src/RouteCollectionInterface.php | 20 ++++++-- src/RouteCollector.php | 34 +++++++++---- src/RouteInterface.php | 4 +- src/Router.php | 20 ++++---- 15 files changed, 129 insertions(+), 92 deletions(-) delete mode 100644 src/Exception/ResolvingException.php diff --git a/functions/get_debug_type.php b/functions/get_debug_type.php index 282b5875..ed2302a8 100644 --- a/functions/get_debug_type.php +++ b/functions/get_debug_type.php @@ -9,7 +9,7 @@ * @link https://github.com/sunrise-php/http-router */ -if (PHP_MAJOR_VERSION < 8) { +if (!function_exists('get_debug_type')) { /** * Polyfill for the get_debug_type function diff --git a/src/Exception/Http/HttpException.php b/src/Exception/Http/HttpException.php index b29cc1e5..9c01bcf1 100644 --- a/src/Exception/Http/HttpException.php +++ b/src/Exception/Http/HttpException.php @@ -30,7 +30,7 @@ class HttpException extends RuntimeException implements HttpExceptionInterface * * @var int */ - private $statusCode; + private int $statusCode; /** * Constructor of the class diff --git a/src/Exception/ResolvingException.php b/src/Exception/ResolvingException.php deleted file mode 100644 index 85953a58..00000000 --- a/src/Exception/ResolvingException.php +++ /dev/null @@ -1,21 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Exception; - -/** - * ResolvingException - * - * @since 3.0.0 - */ -class ResolvingException extends LogicException -{ -} diff --git a/src/Exception/ResolvingParameterException.php b/src/Exception/ResolvingParameterException.php index 3e46f9e4..a84f69f8 100644 --- a/src/Exception/ResolvingParameterException.php +++ b/src/Exception/ResolvingParameterException.php @@ -16,6 +16,6 @@ * * @since 3.0.0 */ -class ResolvingParameterException extends ResolvingException +class ResolvingParameterException extends LogicException { } diff --git a/src/Exception/ResolvingReferenceException.php b/src/Exception/ResolvingReferenceException.php index 63ddb6f9..ce74aa7f 100644 --- a/src/Exception/ResolvingReferenceException.php +++ b/src/Exception/ResolvingReferenceException.php @@ -16,6 +16,6 @@ * * @since 3.0.0 */ -class ResolvingReferenceException extends ResolvingException +class ResolvingReferenceException extends LogicException { } diff --git a/src/Exception/ResolvingResponseException.php b/src/Exception/ResolvingResponseException.php index 266aaca9..c2160da7 100644 --- a/src/Exception/ResolvingResponseException.php +++ b/src/Exception/ResolvingResponseException.php @@ -16,6 +16,6 @@ * * @since 3.0.0 */ -class ResolvingResponseException extends ResolvingException +class ResolvingResponseException extends LogicException { } diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index d3f36285..3beff857 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -113,14 +113,16 @@ public function __construct( * @return void * * @throws LogicException - * If a custom reference resolver was setted. + * If a custom reference resolver was setted + * and a parameter resolutioner was not passed. */ public function setContainer(ContainerInterface $container): void { if (!isset($this->parameterResolutioner)) { throw new LogicException( 'The config route loader cannot accept the container ' . - 'because a custom reference resolver was setted' + 'because a custom reference resolver was setted ' . + 'and a parameter resolutioner was not passed' ); } @@ -137,7 +139,8 @@ public function setContainer(ContainerInterface $container): void * @return void * * @throws LogicException - * If a custom reference resolver was setted. + * If a custom reference resolver was setted + * and a parameter resolutioner was not passed. * * @since 3.0.0 */ @@ -146,7 +149,8 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): if (!isset($this->parameterResolutioner)) { throw new LogicException( 'The config route loader cannot accept the parameter resolver ' . - 'because a custom reference resolver was setted' + 'because a custom reference resolver was setted' . + 'and a parameter resolutioner was not passed' ); } @@ -161,7 +165,8 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): * @return void * * @throws LogicException - * If a custom reference resolver was setted. + * If a custom reference resolver was setted + * and a response resolutioner was not passed. * * @since 3.0.0 */ @@ -170,7 +175,8 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo if (!isset($this->responseResolutioner)) { throw new LogicException( 'The config route loader cannot accept the response resolver ' . - 'because a custom reference resolver was setted' + 'because a custom reference resolver was setted' . + 'and a response resolutioner was not passed' ); } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index bd1e6abe..a566d934 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -117,13 +117,15 @@ final class DescriptorLoader implements LoaderInterface * @param ReferenceResolverInterface|null $referenceResolver * @param ParameterResolutionerInterface|null $parameterResolutioner * @param ResponseResolutionerInterface|null $responseResolutioner + * @param \Doctrine\Common\Annotations\Reader|null $annotationReader */ public function __construct( ?RouteCollectionFactoryInterface $collectionFactory = null, ?RouteFactoryInterface $routeFactory = null, ?ReferenceResolverInterface $referenceResolver = null, ?ParameterResolutionerInterface $parameterResolutioner = null, - ?ResponseResolutionerInterface $responseResolutioner = null + ?ResponseResolutionerInterface $responseResolutioner = null, + ?\Doctrine\Common\Annotations\Reader $annotationReader = null ) { $this->collectionFactory = $collectionFactory ?? new RouteCollectionFactory(); $this->routeFactory = $routeFactory ?? new RouteFactory(); @@ -138,7 +140,9 @@ public function __construct( $this->annotationReader = new AnnotationReader(); - if (8 > PHP_MAJOR_VERSION) { + if (isset($annotationReader)) { + $this->annotationReader->setAnnotationReader($annotationReader); + } elseif (PHP_MAJOR_VERSION < 8) { $this->annotationReader->useDefaultAnnotationReader(); } } @@ -151,14 +155,16 @@ public function __construct( * @return void * * @throws LogicException - * If a custom reference resolver was setted. + * If a custom reference resolver was setted + * and a parameter resolutioner was not passed. */ public function setContainer(ContainerInterface $container): void { if (!isset($this->parameterResolutioner)) { throw new LogicException( 'The descriptor route loader cannot accept the container ' . - 'because a custom reference resolver was setted' + 'because a custom reference resolver was setted ' . + 'and a parameter resolutioner was not passed' ); } @@ -175,7 +181,8 @@ public function setContainer(ContainerInterface $container): void * @return void * * @throws LogicException - * If a custom reference resolver was setted. + * If a custom reference resolver was setted + * and a parameter resolutioner was not passed. * * @since 3.0.0 */ @@ -184,7 +191,8 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): if (!isset($this->parameterResolutioner)) { throw new LogicException( 'The descriptor route loader cannot accept the parameter resolver ' . - 'because a custom reference resolver was setted' + 'because a custom reference resolver was setted ' . + 'and a parameter resolutioner was not passed' ); } @@ -199,7 +207,8 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): * @return void * * @throws LogicException - * If a custom reference resolver was setted. + * If a custom reference resolver was setted + * and a response resolutioner was not passed. * * @since 3.0.0 */ @@ -208,7 +217,8 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo if (!isset($this->responseResolutioner)) { throw new LogicException( 'The descriptor route loader cannot accept the response resolver ' . - 'because a custom reference resolver was setted' + 'because a custom reference resolver was setted ' . + 'and a response resolutioner was not passed' ); } diff --git a/src/Middleware/CallableMiddleware.php b/src/Middleware/CallableMiddleware.php index 5d8d3a57..67751e47 100644 --- a/src/Middleware/CallableMiddleware.php +++ b/src/Middleware/CallableMiddleware.php @@ -93,14 +93,12 @@ public function getReflection(): ReflectionFunctionAbstract */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - $resolvers = [ - new KnownTypeParameterResolver(ServerRequestInterface::class, $request), - new KnownTypeParameterResolver(RequestHandlerInterface::class, $handler), - ]; - $arguments = $this->parameterResolutioner ->withContext($request) - ->withPriorityResolver(...$resolvers) + ->withPriorityResolver( + new KnownTypeParameterResolver(ServerRequestInterface::class, $request), + new KnownTypeParameterResolver(RequestHandlerInterface::class, $handler) + ) ->resolveParameters(...$this->getReflection()->getParameters()); /** @var mixed */ diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index 4c17c11c..2b4552d5 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -90,13 +90,11 @@ public function getReflection(): ReflectionFunctionAbstract */ public function handle(ServerRequestInterface $request): ResponseInterface { - $resolvers = [ - new KnownTypeParameterResolver(ServerRequestInterface::class, $request), - ]; - $arguments = $this->parameterResolutioner ->withContext($request) - ->withPriorityResolver(...$resolvers) + ->withPriorityResolver( + new KnownTypeParameterResolver(ServerRequestInterface::class, $request) + ) ->resolveParameters(...$this->getReflection()->getParameters()); /** @var mixed */ diff --git a/src/RouteCollection.php b/src/RouteCollection.php index d6da65c3..136131f9 100644 --- a/src/RouteCollection.php +++ b/src/RouteCollection.php @@ -20,6 +20,7 @@ * Import functions */ use function array_merge; +use function count; /** * RouteCollection @@ -32,9 +33,9 @@ class RouteCollection implements RouteCollectionInterface /** * The collection routes * - * @var list + * @var array */ - private $routes = []; + private array $routes = []; /** * Constructor of the class @@ -43,9 +44,7 @@ class RouteCollection implements RouteCollectionInterface */ public function __construct(RouteInterface ...$routes) { - /** @var list $routes */ - - $this->routes = $routes; + $this->add(...$routes); } /** @@ -53,7 +52,12 @@ public function __construct(RouteInterface ...$routes) */ public function all(): array { - return $this->routes; + $routes = []; + foreach ($this->routes as $route) { + $routes[] = $route; + } + + return $routes; } /** @@ -61,13 +65,7 @@ public function all(): array */ public function get(string $name): ?RouteInterface { - foreach ($this->routes as $route) { - if ($name === $route->getName()) { - return $route; - } - } - - return null; + return $this->routes[$name] ?? null; } /** @@ -75,7 +73,7 @@ public function get(string $name): ?RouteInterface */ public function has(string $name): bool { - return $this->get($name) instanceof RouteInterface; + return isset($this->routes[$name]); } /** @@ -84,7 +82,7 @@ public function has(string $name): bool public function add(RouteInterface ...$routes): RouteCollectionInterface { foreach ($routes as $route) { - $this->routes[] = $route; + $this->routes[$route->getName()] = $route; } return $this; @@ -153,7 +151,7 @@ public function addMiddleware(MiddlewareInterface ...$middlewares): RouteCollect /** * {@inheritdoc} */ - public function prependMiddleware(MiddlewareInterface ...$middlewares): RouteCollectionInterface + public function addPriorityMiddleware(MiddlewareInterface ...$middlewares): RouteCollectionInterface { foreach ($this->routes as $route) { $route->setMiddlewares(...array_merge($middlewares, $route->getMiddlewares())); @@ -161,4 +159,24 @@ public function prependMiddleware(MiddlewareInterface ...$middlewares): RouteCol return $this; } + + /** + * {@inheritdoc} + */ + public function addTag(string ...$tags): RouteCollectionInterface + { + foreach ($this->routes as $route) { + $route->addTag(...$tags); + } + + return $this; + } + + /** + * {@inheritdoc} + */ + public function count(): int + { + return count($this->routes); + } } diff --git a/src/RouteCollectionInterface.php b/src/RouteCollectionInterface.php index ff392e70..6d5f1b17 100644 --- a/src/RouteCollectionInterface.php +++ b/src/RouteCollectionInterface.php @@ -15,11 +15,12 @@ * Import classes */ use Psr\Http\Server\MiddlewareInterface; +use Countable; /** * RouteCollectionInterface */ -interface RouteCollectionInterface +interface RouteCollectionInterface extends Countable { /** @@ -116,13 +117,24 @@ public function addMethod(string ...$methods): RouteCollectionInterface; public function addMiddleware(MiddlewareInterface ...$middlewares): RouteCollectionInterface; /** - * Adds the given middleware(s) to the beginning of all routes in the collection + * Adds the given priority middleware(s) to all routes in the collection * * @param MiddlewareInterface ...$middlewares * * @return RouteCollectionInterface * - * @since 2.9.0 + * @since 3.0.0 + */ + public function addPriorityMiddleware(MiddlewareInterface ...$middlewares): RouteCollectionInterface; + + /** + * Adds the given tag(s) to all routes in the collection + * + * @param string ...$tags + * + * @return RouteCollectionInterface + * + * @since 3.0.0 */ - public function prependMiddleware(MiddlewareInterface ...$middlewares): RouteCollectionInterface; + public function addTag(string ...$tags): RouteCollectionInterface; } diff --git a/src/RouteCollector.php b/src/RouteCollector.php index 72208412..bdc9442d 100644 --- a/src/RouteCollector.php +++ b/src/RouteCollector.php @@ -102,6 +102,16 @@ public function getCollection(): RouteCollectionInterface return $this->collection; } + /** + * Gets the collector's routes + * + * @return list + */ + public function getRoutes(): array + { + return $this->collection->all(); + } + /** * Sets the given container to the parameter resolutioner * @@ -110,14 +120,16 @@ public function getCollection(): RouteCollectionInterface * @return void * * @throws LogicException - * If a custom reference resolver was setted. + * If a custom reference resolver was setted + * and a parameter resolutioner was not passed. */ public function setContainer(ContainerInterface $container): void { if (!isset($this->parameterResolutioner)) { throw new LogicException( 'The route collector cannot accept the container ' . - 'because a custom reference resolver was setted' + 'because a custom reference resolver was setted ' . + 'and a parameter resolutioner was not passed' ); } @@ -134,7 +146,8 @@ public function setContainer(ContainerInterface $container): void * @return void * * @throws LogicException - * If a custom reference resolver was setted. + * If a custom reference resolver was setted + * and a parameter resolutioner was not passed. * * @since 3.0.0 */ @@ -143,7 +156,8 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): if (!isset($this->parameterResolutioner)) { throw new LogicException( 'The route collector cannot accept the parameter resolver ' . - 'because a custom reference resolver was setted' + 'because a custom reference resolver was setted ' . + 'and a parameter resolutioner was not passed' ); } @@ -158,7 +172,8 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): * @return void * * @throws LogicException - * If a custom reference resolver was setted. + * If a custom reference resolver was setted + * and a response resolutioner was not passed. * * @since 3.0.0 */ @@ -167,7 +182,8 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo if (!isset($this->responseResolutioner)) { throw new LogicException( 'The route collector cannot accept the response resolver ' . - 'because a custom reference resolver was setted' + 'because a custom reference resolver was setted ' . + 'and a response resolutioner was not passed' ); } @@ -424,13 +440,11 @@ public function group(callable $callback, array $middlewares = []): RouteCollect $callback($collector); - $collector->collection->prependMiddleware( + $collector->collection->addPriorityMiddleware( ...$this->referenceResolver->resolveMiddlewares($middlewares) ); - $this->collection->add( - ...$collector->collection->all() - ); + $this->collection->add(...$collector->collection->all()); return $collector->collection; } diff --git a/src/RouteInterface.php b/src/RouteInterface.php index af817570..534b9928 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -29,7 +29,7 @@ interface RouteInterface extends RequestHandlerInterface, RequestMethodInterface { /** - * Request attribute name for the route instance + * Request attribute name for a route instance * * @var string * @@ -63,7 +63,7 @@ public function getPath(): string; /** * Gets the route methods * - * @return string[] + * @return list */ public function getMethods(): array; diff --git a/src/Router.php b/src/Router.php index 17eae62f..229cac16 100644 --- a/src/Router.php +++ b/src/Router.php @@ -477,17 +477,19 @@ public function match(ServerRequestInterface $request): RouteInterface public function run(ServerRequestInterface $request): ResponseInterface { // lazy resolving of the given request... - $routing = new UnsafeCallableRequestHandler(function (ServerRequestInterface $request): ResponseInterface { - $this->matchedRoute = $this->match($request); + $routing = new UnsafeCallableRequestHandler( + function (ServerRequestInterface $request): ResponseInterface { + $this->matchedRoute = $this->match($request); + + if (isset($this->eventDispatcher)) { + $this->eventDispatcher->dispatch( + new RouteEvent($this->matchedRoute, $request) + ); + } - if (isset($this->eventDispatcher)) { - $this->eventDispatcher->dispatch( - new RouteEvent($this->matchedRoute, $request) - ); + return $this->matchedRoute->handle($request); } - - return $this->matchedRoute->handle($request); - }); + ); $middlewares = $this->getMiddlewares(); if (empty($middlewares)) { From 486054215d4a5429a0bfabf700972e9b48ac9e89 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 27 Jan 2023 20:50:44 +0100 Subject: [PATCH 046/180] v3 --- src/Loader/ConfigLoader.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index 3beff857..809323b3 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -149,7 +149,7 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): if (!isset($this->parameterResolutioner)) { throw new LogicException( 'The config route loader cannot accept the parameter resolver ' . - 'because a custom reference resolver was setted' . + 'because a custom reference resolver was setted ' . 'and a parameter resolutioner was not passed' ); } @@ -175,7 +175,7 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo if (!isset($this->responseResolutioner)) { throw new LogicException( 'The config route loader cannot accept the response resolver ' . - 'because a custom reference resolver was setted' . + 'because a custom reference resolver was setted ' . 'and a response resolutioner was not passed' ); } From 0d27d08d8744ac042444dc0dd47e097fab9d4b82 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Wed, 1 Feb 2023 19:46:29 +0100 Subject: [PATCH 047/180] v3 --- composer.json | 4 +- src/Annotation/RequestEntity.php | 41 +++++ src/Annotation/Route.php | 2 +- src/AnnotationReader.php | 4 +- src/ClassResolver.php | 29 ++-- src/ClassResolverInterface.php | 12 +- src/Exception/EntityNotFoundException.php | 26 +++ .../UnprocessableRequestBodyException.php | 52 ++++++ .../UnprocessableRequestQueryException.php | 52 ++++++ src/Middleware/UnsafeCallableMiddleware.php | 7 +- src/ParameterResolutioner.php | 50 ++---- .../AbstractParameterResolver.php | 60 +++++++ .../KnownTypeParameterResolver.php | 10 +- .../RequestBodyParameterResolver.php | 27 ++- .../RequestEntityParameterResolver.php | 158 ++++++++++++++++++ .../RequestQueryParameterResolver.php | 27 ++- src/ParameterResolverInterface.php | 1 - src/ReferenceResolver.php | 52 +++--- .../UnsafeCallableRequestHandler.php | 7 +- src/Route.php | 30 +++- src/RouteCollection.php | 12 ++ src/RouteCollectionInterface.php | 12 ++ src/RouteCollector.php | 20 +-- src/RouteInterface.php | 31 +++- src/Router.php | 44 ++--- 25 files changed, 616 insertions(+), 154 deletions(-) create mode 100644 src/Annotation/RequestEntity.php create mode 100644 src/Exception/EntityNotFoundException.php create mode 100644 src/Exception/UnprocessableRequestBodyException.php create mode 100644 src/Exception/UnprocessableRequestQueryException.php create mode 100644 src/ParameterResolver/AbstractParameterResolver.php create mode 100644 src/ParameterResolver/RequestEntityParameterResolver.php diff --git a/composer.json b/composer.json index 8dc8187d..81fa0839 100644 --- a/composer.json +++ b/composer.json @@ -37,12 +37,14 @@ }, "require-dev": { "doctrine/annotations": "^2.0", + "doctrine/persistence": "^3.1", "phpunit/phpunit": "~9.5.0", "sunrise/coding-standard": "~1.0.0", "sunrise/http-message": "^3.0", "sunrise/hydrator": "^2.7", "symfony/console": "^5.4", - "symfony/event-dispatcher": "^4.4" + "symfony/event-dispatcher": "^4.4", + "symfony/validator": "^5.4" }, "autoload": { "files": [ diff --git a/src/Annotation/RequestEntity.php b/src/Annotation/RequestEntity.php new file mode 100644 index 00000000..56fac3de --- /dev/null +++ b/src/Annotation/RequestEntity.php @@ -0,0 +1,41 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Annotation; + +/** + * Import classes + */ +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_PARAMETER)] +final class RequestEntity +{ + + /** + * Constructor of the class + * + * @param string|null $em + * @param string $findBy + * @param string $paramKey + * @param array $criteria + */ + public function __construct( + public ?string $em = null, + public string $findBy = 'id', + public string $paramKey = 'id', + public array $criteria = [] + ) { + } +} diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index f2fce7b2..9f0d25f4 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -46,7 +46,7 @@ final class Route implements RequestMethodInterface /** * The descriptor holder * - * @var class-string|array{0: class-string, 1: string}|null + * @var class-string|array{0: class-string, 1: non-empty-string}|null * * @internal */ diff --git a/src/AnnotationReader.php b/src/AnnotationReader.php index 67f6321d..f20c850d 100644 --- a/src/AnnotationReader.php +++ b/src/AnnotationReader.php @@ -80,7 +80,7 @@ public function useDefaultAnnotationReader(): void /** * Gets annotations from the given class or method by the given annotation name * - * @param ReflectionClass|ReflectionMethod $classOrMethod + * @param Reflector $classOrMethod * @param class-string $annotationName * * @return list @@ -88,8 +88,6 @@ public function useDefaultAnnotationReader(): void * @throws InvalidArgumentException * If the given reflection isn't supported. * - * @psalm-suppress RedundantConditionGivenDocblockType - * * @template T */ public function getClassOrMethodAnnotations(Reflector $classOrMethod, string $annotationName): array diff --git a/src/ClassResolver.php b/src/ClassResolver.php index 403e9ff5..e3d14e26 100644 --- a/src/ClassResolver.php +++ b/src/ClassResolver.php @@ -28,6 +28,10 @@ * ClassResolver * * @since 3.0.0 + * + * @template T of object + * + * @implements ClassResolverInterface */ final class ClassResolver implements ClassResolverInterface { @@ -35,7 +39,7 @@ final class ClassResolver implements ClassResolverInterface /** * Map of classes that are already resolved * - * @var array + * @var array, T> */ private array $resolvedClasses = []; @@ -59,24 +63,24 @@ public function __construct(ParameterResolutionerInterface $parameterResolutione /** * {@inheritdoc} */ - public function resolveClass(string $classname): object + public function resolveClass(string $className): object { - if (isset($this->resolvedClasses[$classname])) { - return $this->resolvedClasses[$classname]; + if (isset($this->resolvedClasses[$className])) { + return $this->resolvedClasses[$className]; } - if (!class_exists($classname)) { + if (!class_exists($className)) { throw new InvalidArgumentException(sprintf( - 'The class %s was not found', - $classname + 'Class %s does not exist', + $className )); } - $reflection = new ReflectionClass($classname); + $reflection = new ReflectionClass($className); if (!$reflection->isInstantiable()) { throw new LogicException(sprintf( - 'The class %s cannot be initialized directly', - $classname + 'Class %s cannot be initialized', + $className )); } @@ -88,6 +92,9 @@ public function resolveClass(string $classname): object ); } - return $this->resolvedClasses[$classname] = $reflection->newInstance(...$arguments); + /** @var T */ + $this->resolvedClasses[$className] = $reflection->newInstance(...$arguments); + + return $this->resolvedClasses[$className]; } } diff --git a/src/ClassResolverInterface.php b/src/ClassResolverInterface.php index 2757e97d..c76bab7c 100644 --- a/src/ClassResolverInterface.php +++ b/src/ClassResolverInterface.php @@ -21,22 +21,24 @@ * ClassResolverInterface * * @since 3.0.0 + * + * @template T of object */ interface ClassResolverInterface { /** - * Resolves the given class by its name + * Resolves the given named class * - * @param class-string $classname + * @param class-string $className * - * @return object + * @return T * * @throws InvalidArgumentException * If the class doesn't exist. * * @throws LogicException - * If the class cannot be initialized directly. + * If the class cannot be resolved. */ - public function resolveClass(string $classname): object; + public function resolveClass(string $className): object; } diff --git a/src/Exception/EntityNotFoundException.php b/src/Exception/EntityNotFoundException.php new file mode 100644 index 00000000..460ead31 --- /dev/null +++ b/src/Exception/EntityNotFoundException.php @@ -0,0 +1,26 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; + +/** + * EntityNotFoundException + * + * @since 3.0.0 + */ +class EntityNotFoundException extends HttpNotFoundException +{ +} diff --git a/src/Exception/UnprocessableRequestBodyException.php b/src/Exception/UnprocessableRequestBodyException.php new file mode 100644 index 00000000..4cb2de1c --- /dev/null +++ b/src/Exception/UnprocessableRequestBodyException.php @@ -0,0 +1,52 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; +use Symfony\Component\Validator\ConstraintViolationListInterface; + +/** + * UnprocessableRequestBodyException + * + * @since 3.0.0 + */ +class UnprocessableRequestBodyException extends HttpUnprocessableEntityException +{ + + /** + * @var ConstraintViolationListInterface + */ + private ConstraintViolationListInterface $violations; + + /** + * Constructor of the class + * + * @param ConstraintViolationListInterface $violations + */ + public function __construct(ConstraintViolationListInterface $violations) + { + $this->violations = $violations; + } + + /** + * Gets the violations list + * + * @return ConstraintViolationListInterface + */ + final public function getViolations(): ConstraintViolationListInterface + { + return $this->violations; + } +} diff --git a/src/Exception/UnprocessableRequestQueryException.php b/src/Exception/UnprocessableRequestQueryException.php new file mode 100644 index 00000000..10193101 --- /dev/null +++ b/src/Exception/UnprocessableRequestQueryException.php @@ -0,0 +1,52 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; +use Symfony\Component\Validator\ConstraintViolationListInterface; + +/** + * UnprocessableRequestQueryException + * + * @since 3.0.0 + */ +class UnprocessableRequestQueryException extends HttpUnprocessableEntityException +{ + + /** + * @var ConstraintViolationListInterface + */ + private ConstraintViolationListInterface $violations; + + /** + * Constructor of the class + * + * @param ConstraintViolationListInterface $violations + */ + public function __construct(ConstraintViolationListInterface $violations) + { + $this->violations = $violations; + } + + /** + * Gets the violations list + * + * @return ConstraintViolationListInterface + */ + final public function getViolations(): ConstraintViolationListInterface + { + return $this->violations; + } +} diff --git a/src/Middleware/UnsafeCallableMiddleware.php b/src/Middleware/UnsafeCallableMiddleware.php index b8b570a0..430f0149 100644 --- a/src/Middleware/UnsafeCallableMiddleware.php +++ b/src/Middleware/UnsafeCallableMiddleware.php @@ -23,6 +23,8 @@ * UnsafeCallableMiddleware * * @since 3.0.0 + * + * @template T as callable(ServerRequestInterface=, RequestHandlerInterface=): ResponseInterface */ final class UnsafeCallableMiddleware implements MiddlewareInterface { @@ -30,14 +32,14 @@ final class UnsafeCallableMiddleware implements MiddlewareInterface /** * The middleware callback * - * @var callable + * @var T */ private $callback; /** * Constructor of the class * - * @param callable $callback + * @param T $callback */ public function __construct(callable $callback) { @@ -49,7 +51,6 @@ public function __construct(callable $callback) */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - /** @var ResponseInterface */ return ($this->callback)($request, $handler); } } diff --git a/src/ParameterResolutioner.php b/src/ParameterResolutioner.php index ed23459a..7004f4a0 100644 --- a/src/ParameterResolutioner.php +++ b/src/ParameterResolutioner.php @@ -15,7 +15,6 @@ * Import classes */ use Sunrise\Http\Router\Exception\ResolvingParameterException; -use ReflectionFunctionAbstract; use ReflectionMethod; use ReflectionParameter; @@ -104,7 +103,6 @@ public function resolveParameters(ReflectionParameter ...$parameters): array * @param ReflectionParameter $parameter * * @return mixed - * The ready-to-pass argument. * * @throws ResolvingParameterException * If the parameter cannot be resolved to an argument. @@ -136,47 +134,19 @@ private function resolveParameter(ReflectionParameter $parameter) */ private function stringifyParameter(ReflectionParameter $parameter): string { - return ($parameter->getDeclaringFunction() instanceof ReflectionMethod) ? - $this->stringifyMethodParameter($parameter->getDeclaringFunction(), $parameter) : - $this->stringifyFunctionParameter($parameter->getDeclaringFunction(), $parameter); - } - - /** - * Stringifies the given method parameter - * - * @param ReflectionMethod $method - * @param ReflectionParameter $parameter - * - * @return string - */ - private function stringifyMethodParameter( - ReflectionMethod $method, - ReflectionParameter $parameter - ) : string { - return sprintf( - '%s::%s($%s[%d])', - $method->getDeclaringClass()->getName(), - $method->getName(), - $parameter->getName(), - $parameter->getPosition() - ); - } + if ($parameter->getDeclaringFunction() instanceof ReflectionMethod) { + return sprintf( + '%s::%s($%s[%d])', + $parameter->getDeclaringFunction()->getDeclaringClass()->getName(), + $parameter->getDeclaringFunction()->getName(), + $parameter->getName(), + $parameter->getPosition() + ); + } - /** - * Stringifies the given function parameter - * - * @param ReflectionFunctionAbstract $function - * @param ReflectionParameter $parameter - * - * @return string - */ - private function stringifyFunctionParameter( - ReflectionFunctionAbstract $function, - ReflectionParameter $parameter - ) : string { return sprintf( '%s($%s[%d])', - $function->getName(), + $parameter->getDeclaringFunction()->getName(), $parameter->getName(), $parameter->getPosition() ); diff --git a/src/ParameterResolver/AbstractParameterResolver.php b/src/ParameterResolver/AbstractParameterResolver.php new file mode 100644 index 00000000..1d4c0898 --- /dev/null +++ b/src/ParameterResolver/AbstractParameterResolver.php @@ -0,0 +1,60 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\ParameterResolver; + +/** + * Import classes + */ +use Sunrise\Http\Router\ParameterResolverInterface; +use ReflectionMethod; +use ReflectionParameter; + +/** + * Import functions + */ +use function sprintf; + +/** + * AbstractParameterResolver + * + * @since 3.0.0 + */ +abstract class AbstractParameterResolver implements ParameterResolverInterface +{ + + /** + * Stringifies the given parameter + * + * @param ReflectionParameter $parameter + * + * @return string + */ + final protected function stringifyParameter(ReflectionParameter $parameter): string + { + if ($parameter->getDeclaringFunction() instanceof ReflectionMethod) { + return sprintf( + '%s::%s($%s[%d])', + $parameter->getDeclaringFunction()->getDeclaringClass()->getName(), + $parameter->getDeclaringFunction()->getName(), + $parameter->getName(), + $parameter->getPosition() + ); + } + + return sprintf( + '%s($%s[%d])', + $parameter->getDeclaringFunction()->getName(), + $parameter->getName(), + $parameter->getPosition() + ); + } +} diff --git a/src/ParameterResolver/KnownTypeParameterResolver.php b/src/ParameterResolver/KnownTypeParameterResolver.php index ad4373b9..bc5b1808 100644 --- a/src/ParameterResolver/KnownTypeParameterResolver.php +++ b/src/ParameterResolver/KnownTypeParameterResolver.php @@ -28,26 +28,24 @@ /** * KnownTypeParameterResolver * - * @template T as object - * * @since 3.0.0 */ final class KnownTypeParameterResolver implements ParameterResolverInterface { /** - * @var class-string + * @var class-string */ private string $type; /** - * @var T + * @var object */ private object $value; /** - * @param class-string $type - * @param T $value + * @param class-string $type + * @param object $value * * @throws InvalidArgumentException * If the given value is not an instance of the given type. diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index bf5936f9..674b0fba 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -18,11 +18,13 @@ use Sunrise\Http\Router\Annotation\RequestBody; use Sunrise\Http\Router\Exception\InvalidRequestBodyException; use Sunrise\Http\Router\Exception\ResolvingParameterException; +use Sunrise\Http\Router\Exception\UnprocessableRequestBodyException; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\RequestBodyInterface; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; +use Symfony\Component\Validator\Validator\ValidatorInterface; use ReflectionNamedType; use ReflectionParameter; @@ -51,12 +53,19 @@ final class RequestBodyParameterResolver implements ParameterResolverInterface */ private HydratorInterface $hydrator; + /** + * @var ValidatorInterface|null + */ + private ?ValidatorInterface $validator; + /** * @param HydratorInterface $hydrator + * @param ValidatorInterface|null $validator */ - public function __construct(HydratorInterface $hydrator) + public function __construct(HydratorInterface $hydrator, ?ValidatorInterface $validator = null) { $this->hydrator = $hydrator; + $this->validator = $validator; } /** @@ -94,7 +103,10 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo * If the object cannot be hydrated. * * @throws InvalidRequestBodyException - * If the request body isn't valid. + * If the request body structure isn't valid. + * + * @throws UnprocessableRequestBodyException + * If the request body data isn't valid. */ public function resolveParameter(ReflectionParameter $parameter, $context) { @@ -105,11 +117,20 @@ public function resolveParameter(ReflectionParameter $parameter, $context) $parameterType = $parameter->getType(); try { - return $this->hydrator->hydrate($parameterType->getName(), (array) $context->getParsedBody()); + $object = $this->hydrator->hydrate($parameterType->getName(), (array) $context->getParsedBody()); } catch (InvalidObjectException $e) { throw new ResolvingParameterException($e->getMessage(), 0, $e); } catch (InvalidValueException $e) { throw new InvalidRequestBodyException($e->getMessage(), 0, $e); } + + if (isset($this->validator)) { + $violations = $this->validator->validate($object); + if ($violations->count() > 0) { + throw new UnprocessableRequestBodyException($violations); + } + } + + return $object; } } diff --git a/src/ParameterResolver/RequestEntityParameterResolver.php b/src/ParameterResolver/RequestEntityParameterResolver.php new file mode 100644 index 00000000..8b91886f --- /dev/null +++ b/src/ParameterResolver/RequestEntityParameterResolver.php @@ -0,0 +1,158 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\ParameterResolver; + +/** + * Import classes + */ +use Doctrine\Persistence\ManagerRegistry as EntityManagerRegistryInterface; +use Psr\Http\Message\ServerRequestInterface; +use Sunrise\Http\Router\Annotation\RequestEntity; +use Sunrise\Http\Router\Exception\EntityNotFoundException; +use Sunrise\Http\Router\Exception\ResolvingParameterException; +use ReflectionAttribute; +use ReflectionNamedType; +use ReflectionParameter; + +/** + * Import functions + */ +use function class_exists; +use function sprintf; + +/** + * RequestEntityParameterResolver + * + * @since 3.0.0 + */ +final class RequestEntityParameterResolver extends AbstractParameterResolver +{ + + /** + * @var EntityManagerRegistryInterface + */ + private EntityManagerRegistryInterface $entityManagerRegistry; + + /** + * @param EntityManagerRegistryInterface $entityManagerRegistry + */ + public function __construct(EntityManagerRegistryInterface $entityManagerRegistry) + { + $this->entityManagerRegistry = $entityManagerRegistry; + } + + /** + * {@inheritdoc} + */ + public function supportsParameter(ReflectionParameter $parameter, $context): bool + { + if (!($context instanceof ServerRequestInterface)) { + return false; + } + + if (!($parameter->getType() instanceof ReflectionNamedType)) { + return false; + } + + if ($parameter->getType()->isBuiltin()) { + return false; + } + + if (8 === PHP_MAJOR_VERSION && $parameter->getAttributes(RequestEntity::class)) { + return true; + } + + return false; + } + + /** + * {@inheritdoc} + */ + public function resolveParameter(ReflectionParameter $parameter, $context) + { + /** @var ServerRequestInterface */ + $context = $context; + + /** @var ReflectionNamedType */ + $type = $parameter->getType(); + + /** @var array{0: ReflectionAttribute} */ + $attributes = $parameter->getAttributes(RequestEntity::class); + + /** @var RequestEntity */ + $requestEntity = $attributes[0]->newInstance(); + + /** @var mixed */ + $entityId = $context->getAttribute($requestEntity->paramKey); + if (!isset($entityId)) { + throw new ResolvingParameterException(sprintf( + '{%s} Unable to get Entity ID (%s) by key %s', + $this->stringifyParameter($parameter), + $requestEntity->findBy, + $requestEntity->paramKey + )); + } + + $entityName = $type->getName(); + if (!class_exists($entityName)) { + throw new ResolvingParameterException(sprintf( + '{%s} Entity %s does not exist', + $this->stringifyParameter($parameter), + $entityName + )); + } + + $entityManager = isset($requestEntity->em) ? + $this->entityManagerRegistry->getManager($requestEntity->em) : + $this->entityManagerRegistry->getManagerForClass($entityName); + + if (!isset($entityManager)) { + throw new ResolvingParameterException(sprintf( + '{%s} Unable to get Entity Manager for %s', + $this->stringifyParameter($parameter), + $entityName + )); + } + + $entityMetadata = $entityManager->getClassMetadata($entityName); + if (!$entityMetadata->hasField($requestEntity->findBy)) { + throw new ResolvingParameterException(sprintf( + '{%s} Entity %s does not contain field %s', + $this->stringifyParameter($parameter), + $entityName, + $requestEntity->findBy + )); + } + + $criteria = [ + $requestEntity->findBy => $entityId, + ]; + + $criteria += $requestEntity->criteria; + + $entity = $entityManager->getRepository($entityName) + ->findOneBy($criteria); + + if (isset($entity)) { + return $entity; + } + + if ($parameter->allowsNull()) { + return null; + } + + throw new EntityNotFoundException(sprintf( + '%s Not Found', + $entityMetadata->getReflectionClass()->getShortName() + )); + } +} diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 43ec85f7..cc529589 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -18,11 +18,13 @@ use Sunrise\Http\Router\Annotation\RequestQuery; use Sunrise\Http\Router\Exception\InvalidRequestQueryException; use Sunrise\Http\Router\Exception\ResolvingParameterException; +use Sunrise\Http\Router\Exception\UnprocessableRequestQueryException; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\RequestQueryInterface; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; +use Symfony\Component\Validator\Validator\ValidatorInterface; use ReflectionNamedType; use ReflectionParameter; @@ -51,12 +53,19 @@ final class RequestQueryParameterResolver implements ParameterResolverInterface */ private HydratorInterface $hydrator; + /** + * @var ValidatorInterface|null + */ + private ?ValidatorInterface $validator; + /** * @param HydratorInterface $hydrator + * @param ValidatorInterface|null $validator */ - public function __construct(HydratorInterface $hydrator) + public function __construct(HydratorInterface $hydrator, ?ValidatorInterface $validator = null) { $this->hydrator = $hydrator; + $this->validator = $validator; } /** @@ -94,7 +103,10 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo * If the object cannot be hydrated. * * @throws InvalidRequestQueryException - * If the request query isn't valid. + * If the request query structure isn't valid. + * + * @throws UnprocessableRequestQueryException + * If the request query data isn't valid. */ public function resolveParameter(ReflectionParameter $parameter, $context) { @@ -105,11 +117,20 @@ public function resolveParameter(ReflectionParameter $parameter, $context) $parameterType = $parameter->getType(); try { - return $this->hydrator->hydrate($parameterType->getName(), $context->getQueryParams()); + $object = $this->hydrator->hydrate($parameterType->getName(), $context->getQueryParams()); } catch (InvalidObjectException $e) { throw new ResolvingParameterException($e->getMessage(), 0, $e); } catch (InvalidValueException $e) { throw new InvalidRequestQueryException($e->getMessage(), 0, $e); } + + if (isset($this->validator)) { + $violations = $this->validator->validate($object); + if ($violations->count() > 0) { + throw new UnprocessableRequestQueryException($violations); + } + } + + return $object; } } diff --git a/src/ParameterResolverInterface.php b/src/ParameterResolverInterface.php index e3f6b46b..510d63f7 100644 --- a/src/ParameterResolverInterface.php +++ b/src/ParameterResolverInterface.php @@ -42,7 +42,6 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo * @param mixed $context * * @return mixed - * The ready-to-pass argument. * * @throws ResolvingParameterException * If the parameter cannot be resolved to an argument. diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index c48a3670..f76d2c0e 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -40,6 +40,13 @@ final class ReferenceResolver implements ReferenceResolverInterface { + /** + * The resolver's class resolver + * + * @var ClassResolverInterface + */ + private ClassResolverInterface $classResolver; + /** * The resolver's parameter resolutioner * @@ -54,13 +61,6 @@ final class ReferenceResolver implements ReferenceResolverInterface */ private ResponseResolutionerInterface $responseResolutioner; - /** - * The resolver's class resolver - * - * @var ClassResolverInterface - */ - private ClassResolverInterface $classResolver; - /** * Constructor of the class * @@ -75,9 +75,9 @@ public function __construct( ) { $classResolver ??= new ClassResolver($parameterResolutioner); + $this->classResolver = $classResolver; $this->parameterResolutioner = $parameterResolutioner; $this->responseResolutioner = $responseResolutioner; - $this->classResolver = $classResolver; } /** @@ -93,25 +93,27 @@ public function resolveRequestHandler($reference): RequestHandlerInterface return new CallableRequestHandler($reference, $this->parameterResolutioner, $this->responseResolutioner); } + if (is_string($reference) && is_subclass_of($reference, RequestHandlerInterface::class)) { + /** @var RequestHandlerInterface */ + return $this->classResolver->resolveClass($reference); + } + // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 /** @psalm-suppress MixedArgument */ if (is_array($reference) && is_callable($reference, true) && method_exists($reference[0], $reference[1])) { /** @var array{0: class-string|object, 1: non-empty-string} $reference */ - $object = is_string($reference[0]) ? $this->classResolver->resolveClass($reference[0]) : $reference[0]; + if (is_string($reference[0])) { + $reference[0] = $this->classResolver->resolveClass($reference[0]); + } return new CallableRequestHandler( - [$object, $reference[1]], + [$reference[0], $reference[1]], $this->parameterResolutioner, $this->responseResolutioner ); } - if (is_string($reference) && is_subclass_of($reference, RequestHandlerInterface::class)) { - /** @var RequestHandlerInterface */ - return $this->classResolver->resolveClass($reference); - } - throw new ResolvingReferenceException(sprintf( 'Unable to resolve the reference {%s}', $this->stringifyReference($reference) @@ -131,25 +133,27 @@ public function resolveMiddleware($reference): MiddlewareInterface return new CallableMiddleware($reference, $this->parameterResolutioner, $this->responseResolutioner); } + if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { + /** @var MiddlewareInterface */ + return $this->classResolver->resolveClass($reference); + } + // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 /** @psalm-suppress MixedArgument */ if (is_array($reference) && is_callable($reference, true) && method_exists($reference[0], $reference[1])) { /** @var array{0: class-string|object, 1: non-empty-string} $reference */ - $object = is_string($reference[0]) ? $this->classResolver->resolveClass($reference[0]) : $reference[0]; + if (is_string($reference[0])) { + $reference[0] = $this->classResolver->resolveClass($reference[0]); + } return new CallableMiddleware( - [$object, $reference[1]], + [$reference[0], $reference[1]], $this->parameterResolutioner, $this->responseResolutioner ); } - if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { - /** @var MiddlewareInterface */ - return $this->classResolver->resolveClass($reference); - } - throw new ResolvingReferenceException(sprintf( 'Unable to resolve the reference {%s}', $this->stringifyReference($reference) @@ -179,8 +183,8 @@ public function resolveMiddlewares(array $references): array */ private function stringifyReference($reference): string { - if (is_array($reference) && is_callable($reference, true, $refString)) { - return $refString; + if (is_array($reference) && is_callable($reference, true, $stringReference)) { + return $stringReference; } if (is_string($reference)) { diff --git a/src/RequestHandler/UnsafeCallableRequestHandler.php b/src/RequestHandler/UnsafeCallableRequestHandler.php index 36c46b15..2c08f3be 100644 --- a/src/RequestHandler/UnsafeCallableRequestHandler.php +++ b/src/RequestHandler/UnsafeCallableRequestHandler.php @@ -22,6 +22,8 @@ * UnsafeCallableRequestHandler * * @since 3.0.0 + * + * @template T as callable(ServerRequestInterface=): ResponseInterface */ final class UnsafeCallableRequestHandler implements RequestHandlerInterface { @@ -29,14 +31,14 @@ final class UnsafeCallableRequestHandler implements RequestHandlerInterface /** * The handler callback * - * @var callable + * @var T */ private $callback; /** * Constructor of the class * - * @param callable $callback + * @param T $callback */ public function __construct(callable $callback) { @@ -48,7 +50,6 @@ public function __construct(callable $callback) */ public function handle(ServerRequestInterface $request): ResponseInterface { - /** @var ResponseInterface */ return ($this->callback)($request); } } diff --git a/src/Route.php b/src/Route.php index e70a0c07..7df2afd4 100644 --- a/src/Route.php +++ b/src/Route.php @@ -218,9 +218,11 @@ public function getTags(): array */ public function getHolder(): Reflector { - return ($this->requestHandler instanceof CallableRequestHandler) ? - $this->requestHandler->getReflection() : - new ReflectionClass($this->requestHandler); + if ($this->requestHandler instanceof CallableRequestHandler) { + return $this->requestHandler->getReflection(); + } + + return new ReflectionClass($this->requestHandler); } /** @@ -298,6 +300,16 @@ public function setAttributes(array $attributes): RouteInterface return $this; } + /** + * {@inheritdoc} + */ + public function setAttribute(string $name, $value): RouteInterface + { + $this->attributes[$name] = $value; + + return $this; + } + /** * {@inheritdoc} */ @@ -377,6 +389,18 @@ public function addMiddleware(MiddlewareInterface ...$middlewares): RouteInterfa return $this; } + /** + * {@inheritdoc} + */ + public function addTag(string ...$tags): RouteInterface + { + foreach ($tags as $tag) { + $this->tags[] = $tag; + } + + return $this; + } + /** * {@inheritdoc} */ diff --git a/src/RouteCollection.php b/src/RouteCollection.php index 136131f9..4d40a35f 100644 --- a/src/RouteCollection.php +++ b/src/RouteCollection.php @@ -100,6 +100,18 @@ public function setHost(string $host): RouteCollectionInterface return $this; } + /** + * {@inheritdoc} + */ + public function setAttribute(string $name, $value): RouteCollectionInterface + { + foreach ($this->routes as $route) { + $route->setAttribute($name, $value); + } + + return $this; + } + /** * {@inheritdoc} */ diff --git a/src/RouteCollectionInterface.php b/src/RouteCollectionInterface.php index 6d5f1b17..5b00c533 100644 --- a/src/RouteCollectionInterface.php +++ b/src/RouteCollectionInterface.php @@ -72,6 +72,18 @@ public function add(RouteInterface ...$routes): RouteCollectionInterface; */ public function setHost(string $host): RouteCollectionInterface; + /** + * Sets the given attribute to all routes in the collection + * + * @param string $name + * @param mixed $value + * + * @return RouteCollectionInterface + * + * @since 3.0.0 + */ + public function setAttribute(string $name, $value): RouteCollectionInterface; + /** * Adds the given path prefix to all routes in the collection * diff --git a/src/RouteCollector.php b/src/RouteCollector.php index bdc9442d..043fbbda 100644 --- a/src/RouteCollector.php +++ b/src/RouteCollector.php @@ -195,9 +195,9 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo * * @param string $name * @param string $path - * @param array $methods + * @param list $methods * @param mixed $requestHandler - * @param array $middlewares + * @param list $middlewares * @param array $attributes * * @return RouteInterface @@ -230,7 +230,7 @@ public function route( * @param string $name * @param string $path * @param mixed $requestHandler - * @param array $middlewares + * @param list $middlewares * @param array $attributes * * @return RouteInterface @@ -258,7 +258,7 @@ public function head( * @param string $name * @param string $path * @param mixed $requestHandler - * @param array $middlewares + * @param list $middlewares * @param array $attributes * * @return RouteInterface @@ -286,7 +286,7 @@ public function get( * @param string $name * @param string $path * @param mixed $requestHandler - * @param array $middlewares + * @param list $middlewares * @param array $attributes * * @return RouteInterface @@ -314,7 +314,7 @@ public function post( * @param string $name * @param string $path * @param mixed $requestHandler - * @param array $middlewares + * @param list $middlewares * @param array $attributes * * @return RouteInterface @@ -342,7 +342,7 @@ public function put( * @param string $name * @param string $path * @param mixed $requestHandler - * @param array $middlewares + * @param list $middlewares * @param array $attributes * * @return RouteInterface @@ -370,7 +370,7 @@ public function patch( * @param string $name * @param string $path * @param mixed $requestHandler - * @param array $middlewares + * @param list $middlewares * @param array $attributes * * @return RouteInterface @@ -398,7 +398,7 @@ public function delete( * @param string $name * @param string $path * @param mixed $requestHandler - * @param array $middlewares + * @param list $middlewares * @param array $attributes * * @return RouteInterface @@ -424,7 +424,7 @@ public function purge( * Route grouping logic * * @param callable $callback - * @param array $middlewares + * @param list $middlewares * * @return RouteCollectionInterface */ diff --git a/src/RouteInterface.php b/src/RouteInterface.php index 534b9928..05fe3d96 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -77,7 +77,7 @@ public function getRequestHandler(): RequestHandlerInterface; /** * Gets the route middlewares * - * @return MiddlewareInterface[] + * @return list */ public function getMiddlewares(): array; @@ -109,7 +109,7 @@ public function getDescription(): string; /** * Gets the route tags * - * @return string[] + * @return list * * @since 2.4.0 */ @@ -189,6 +189,18 @@ public function setMiddlewares(MiddlewareInterface ...$middlewares): RouteInterf */ public function setAttributes(array $attributes): RouteInterface; + /** + * Sets the given attribute to the route + * + * @param string $name + * @param mixed $value + * + * @return RouteInterface + * + * @since 3.0.0 + */ + public function setAttribute(string $name, $value): RouteInterface; + /** * Sets the given summary to the route * @@ -258,14 +270,25 @@ public function addMethod(string ...$methods): RouteInterface; */ public function addMiddleware(MiddlewareInterface ...$middlewares): RouteInterface; + /** + * Adds the given tag(s) to the route + * + * @param string ...$tags + * + * @return RouteInterface + * + * @since 3.0.0 + */ + public function addTag(string ...$tags): RouteInterface; + /** * Returns the route clone with the given attributes * - * This method MUST NOT change the state of the object. + * This method MUST NOT change the object state. * * @param array $attributes * - * @return RouteInterface + * @return static */ public function withAddedAttributes(array $attributes): RouteInterface; } diff --git a/src/Router.php b/src/Router.php index 229cac16..ea3fe2b0 100644 --- a/src/Router.php +++ b/src/Router.php @@ -15,6 +15,7 @@ * Import classes */ use Fig\Http\Message\RequestMethodInterface; +use Psr\EventDispatcher\EventDispatcherInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; @@ -27,7 +28,6 @@ use Sunrise\Http\Router\Loader\LoaderInterface; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; use Sunrise\Http\Router\RequestHandler\UnsafeCallableRequestHandler; -use Symfony\Contracts\EventDispatcher\EventDispatcherInterface; /** * Import functions @@ -36,7 +36,6 @@ use function Sunrise\Http\Router\path_match; use function array_keys; use function get_class; -use function spl_object_hash; use function sprintf; /** @@ -178,12 +177,7 @@ public function getRoutesByHostname(string $hostname): array */ public function getMiddlewares(): array { - $middlewares = []; - foreach ($this->middlewares as $middleware) { - $middlewares[] = $middleware; - } - - return $middlewares; + return $this->middlewares; } /** @@ -308,22 +302,11 @@ public function addRoute(RouteInterface ...$routes): void * @param MiddlewareInterface ...$middlewares * * @return void - * - * @throws InvalidArgumentException - * if one of the given middlewares already exists. */ public function addMiddleware(MiddlewareInterface ...$middlewares): void { foreach ($middlewares as $middleware) { - $hash = spl_object_hash($middleware); - if (isset($this->middlewares[$hash])) { - throw new InvalidArgumentException(sprintf( - 'The middleware "%s" already exists.', - get_class($middleware) - )); - } - - $this->middlewares[$hash] = $middleware; + $this->middlewares[] = $middleware; } } @@ -421,8 +404,8 @@ public function generateUri(string $name, array $attributes = [], bool $strict = * * @return RouteInterface * - * @throws PageNotFoundException * @throws MethodNotAllowedException + * @throws PageNotFoundException */ public function match(ServerRequestInterface $request): RouteInterface { @@ -455,14 +438,11 @@ public function match(ServerRequestInterface $request): RouteInterface return $route->withAddedAttributes($attributes); } - if (empty($allowedMethods)) { - throw new PageNotFoundException(); + if (!empty($allowedMethods)) { + throw new MethodNotAllowedException($currentMethod, $allowedMethods); } - throw new MethodNotAllowedException( - $currentMethod, - $allowedMethods - ); + throw new PageNotFoundException(); } /** @@ -491,13 +471,12 @@ function (ServerRequestInterface $request): ResponseInterface { } ); - $middlewares = $this->getMiddlewares(); - if (empty($middlewares)) { + if (empty($this->middlewares)) { return $routing->handle($request); } $handler = new QueueableRequestHandler($routing); - $handler->add(...$middlewares); + $handler->add(...$this->middlewares); return $handler->handle($request); } @@ -515,13 +494,12 @@ public function handle(ServerRequestInterface $request): ResponseInterface ); } - $middlewares = $this->getMiddlewares(); - if (empty($middlewares)) { + if (empty($this->middlewares)) { return $this->matchedRoute->handle($request); } $handler = new QueueableRequestHandler($this->matchedRoute); - $handler->add(...$middlewares); + $handler->add(...$this->middlewares); return $handler->handle($request); } From c9dd0dc316b98fd64bd6d9372c3854317b33d2d9 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Wed, 1 Feb 2023 20:04:52 +0100 Subject: [PATCH 048/180] v3 --- composer.json | 2 +- src/Event/RouteEvent.php | 3 +- .../UnprocessableRequestBodyException.php | 33 +----------- .../UnprocessableRequestEntityException.php | 52 +++++++++++++++++++ .../UnprocessableRequestQueryException.php | 33 +----------- src/Router.php | 3 +- src/RouterBuilder.php | 2 +- 7 files changed, 58 insertions(+), 70 deletions(-) create mode 100644 src/Exception/UnprocessableRequestEntityException.php diff --git a/composer.json b/composer.json index 81fa0839..0682353f 100644 --- a/composer.json +++ b/composer.json @@ -30,6 +30,7 @@ "php": ">=7.4", "fig/http-message-util": "^1.1", "psr/container": "^1.0 || ^2.0", + "psr/event-dispatcher": "^1.0", "psr/http-message": "^1.0", "psr/http-server-handler": "^1.0", "psr/http-server-middleware": "^1.0", @@ -43,7 +44,6 @@ "sunrise/http-message": "^3.0", "sunrise/hydrator": "^2.7", "symfony/console": "^5.4", - "symfony/event-dispatcher": "^4.4", "symfony/validator": "^5.4" }, "autoload": { diff --git a/src/Event/RouteEvent.php b/src/Event/RouteEvent.php index af880bfb..54942692 100644 --- a/src/Event/RouteEvent.php +++ b/src/Event/RouteEvent.php @@ -16,14 +16,13 @@ */ use Psr\Http\Message\ServerRequestInterface; use Sunrise\Http\Router\RouteInterface; -use Symfony\Contracts\EventDispatcher\Event; /** * RouteEvent * * @since 2.13.0 */ -final class RouteEvent extends Event +final class RouteEvent { /** diff --git a/src/Exception/UnprocessableRequestBodyException.php b/src/Exception/UnprocessableRequestBodyException.php index 4cb2de1c..023741bf 100644 --- a/src/Exception/UnprocessableRequestBodyException.php +++ b/src/Exception/UnprocessableRequestBodyException.php @@ -11,42 +11,11 @@ namespace Sunrise\Http\Router\Exception; -/** - * Import classes - */ -use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; -use Symfony\Component\Validator\ConstraintViolationListInterface; - /** * UnprocessableRequestBodyException * * @since 3.0.0 */ -class UnprocessableRequestBodyException extends HttpUnprocessableEntityException +class UnprocessableRequestBodyException extends UnprocessableRequestEntityException { - - /** - * @var ConstraintViolationListInterface - */ - private ConstraintViolationListInterface $violations; - - /** - * Constructor of the class - * - * @param ConstraintViolationListInterface $violations - */ - public function __construct(ConstraintViolationListInterface $violations) - { - $this->violations = $violations; - } - - /** - * Gets the violations list - * - * @return ConstraintViolationListInterface - */ - final public function getViolations(): ConstraintViolationListInterface - { - return $this->violations; - } } diff --git a/src/Exception/UnprocessableRequestEntityException.php b/src/Exception/UnprocessableRequestEntityException.php new file mode 100644 index 00000000..d7d12cce --- /dev/null +++ b/src/Exception/UnprocessableRequestEntityException.php @@ -0,0 +1,52 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; +use Symfony\Component\Validator\ConstraintViolationListInterface; + +/** + * UnprocessableRequestEntityException + * + * @since 3.0.0 + */ +class UnprocessableRequestEntityException extends HttpUnprocessableEntityException +{ + + /** + * @var ConstraintViolationListInterface + */ + private ConstraintViolationListInterface $violations; + + /** + * Constructor of the class + * + * @param ConstraintViolationListInterface $violations + */ + public function __construct(ConstraintViolationListInterface $violations) + { + $this->violations = $violations; + } + + /** + * Gets the violations list + * + * @return ConstraintViolationListInterface + */ + final public function getViolations(): ConstraintViolationListInterface + { + return $this->violations; + } +} diff --git a/src/Exception/UnprocessableRequestQueryException.php b/src/Exception/UnprocessableRequestQueryException.php index 10193101..bcd1b8c8 100644 --- a/src/Exception/UnprocessableRequestQueryException.php +++ b/src/Exception/UnprocessableRequestQueryException.php @@ -11,42 +11,11 @@ namespace Sunrise\Http\Router\Exception; -/** - * Import classes - */ -use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; -use Symfony\Component\Validator\ConstraintViolationListInterface; - /** * UnprocessableRequestQueryException * * @since 3.0.0 */ -class UnprocessableRequestQueryException extends HttpUnprocessableEntityException +class UnprocessableRequestQueryException extends UnprocessableRequestEntityException { - - /** - * @var ConstraintViolationListInterface - */ - private ConstraintViolationListInterface $violations; - - /** - * Constructor of the class - * - * @param ConstraintViolationListInterface $violations - */ - public function __construct(ConstraintViolationListInterface $violations) - { - $this->violations = $violations; - } - - /** - * Gets the violations list - * - * @return ConstraintViolationListInterface - */ - final public function getViolations(): ConstraintViolationListInterface - { - return $this->violations; - } } diff --git a/src/Router.php b/src/Router.php index ea3fe2b0..bf5991e9 100644 --- a/src/Router.php +++ b/src/Router.php @@ -75,8 +75,7 @@ class Router implements RequestHandlerInterface, RequestMethodInterface /** * The router's middlewares * - * @var array - * The keys is an object hash. + * @var list */ private $middlewares = []; diff --git a/src/RouterBuilder.php b/src/RouterBuilder.php index fe1f96d7..94edd9bb 100644 --- a/src/RouterBuilder.php +++ b/src/RouterBuilder.php @@ -14,9 +14,9 @@ /** * Import classes */ +use Psr\EventDispatcher\EventDispatcherInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\SimpleCache\CacheInterface; -use Symfony\Contracts\EventDispatcher\EventDispatcherInterface; /** * RouterBuilder From a5a606c21c4b82abe6681786950b9ade02490589 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Wed, 1 Feb 2023 20:20:19 +0100 Subject: [PATCH 049/180] v3 --- src/Exception/PageNotFoundException.php | 7 +++- src/Exception/RouteNotFoundException.php | 7 +--- ...n.php => UnprocessableEntityException.php} | 4 +- .../UnprocessableRequestBodyException.php | 2 +- .../UnprocessableRequestQueryException.php | 2 +- .../Middleware/ErrorHandlingMiddleware.php | 42 +++++++++++++++++++ 6 files changed, 53 insertions(+), 11 deletions(-) rename src/Exception/{UnprocessableRequestEntityException.php => UnprocessableEntityException.php} (90%) create mode 100644 src/Rest/Middleware/ErrorHandlingMiddleware.php diff --git a/src/Exception/PageNotFoundException.php b/src/Exception/PageNotFoundException.php index 461cc136..4a47e46a 100644 --- a/src/Exception/PageNotFoundException.php +++ b/src/Exception/PageNotFoundException.php @@ -11,9 +11,14 @@ namespace Sunrise\Http\Router\Exception; +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; + /** * PageNotFoundException */ -class PageNotFoundException extends RouteNotFoundException +class PageNotFoundException extends HttpNotFoundException { } diff --git a/src/Exception/RouteNotFoundException.php b/src/Exception/RouteNotFoundException.php index 4e78d5d8..8b1f8bf8 100644 --- a/src/Exception/RouteNotFoundException.php +++ b/src/Exception/RouteNotFoundException.php @@ -11,14 +11,9 @@ namespace Sunrise\Http\Router\Exception; -/** - * Import classes - */ -use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; - /** * RouteNotFoundException */ -class RouteNotFoundException extends HttpNotFoundException +class RouteNotFoundException extends LogicException { } diff --git a/src/Exception/UnprocessableRequestEntityException.php b/src/Exception/UnprocessableEntityException.php similarity index 90% rename from src/Exception/UnprocessableRequestEntityException.php rename to src/Exception/UnprocessableEntityException.php index d7d12cce..c7a88561 100644 --- a/src/Exception/UnprocessableRequestEntityException.php +++ b/src/Exception/UnprocessableEntityException.php @@ -18,11 +18,11 @@ use Symfony\Component\Validator\ConstraintViolationListInterface; /** - * UnprocessableRequestEntityException + * UnprocessableEntityException * * @since 3.0.0 */ -class UnprocessableRequestEntityException extends HttpUnprocessableEntityException +class UnprocessableEntityException extends HttpUnprocessableEntityException { /** diff --git a/src/Exception/UnprocessableRequestBodyException.php b/src/Exception/UnprocessableRequestBodyException.php index 023741bf..5e06f180 100644 --- a/src/Exception/UnprocessableRequestBodyException.php +++ b/src/Exception/UnprocessableRequestBodyException.php @@ -16,6 +16,6 @@ * * @since 3.0.0 */ -class UnprocessableRequestBodyException extends UnprocessableRequestEntityException +class UnprocessableRequestBodyException extends UnprocessableEntityException { } diff --git a/src/Exception/UnprocessableRequestQueryException.php b/src/Exception/UnprocessableRequestQueryException.php index bcd1b8c8..c1bae14a 100644 --- a/src/Exception/UnprocessableRequestQueryException.php +++ b/src/Exception/UnprocessableRequestQueryException.php @@ -16,6 +16,6 @@ * * @since 3.0.0 */ -class UnprocessableRequestQueryException extends UnprocessableRequestEntityException +class UnprocessableRequestQueryException extends UnprocessableEntityException { } diff --git a/src/Rest/Middleware/ErrorHandlingMiddleware.php b/src/Rest/Middleware/ErrorHandlingMiddleware.php new file mode 100644 index 00000000..506d6e78 --- /dev/null +++ b/src/Rest/Middleware/ErrorHandlingMiddleware.php @@ -0,0 +1,42 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Rest\Middleware; + +/** + * Import classes + */ +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; +use Throwable; + +/** + * ErrorHandlingMiddleware + * + * @since 3.0.0 + */ +final class ErrorHandlingMiddleware implements MiddlewareInterface +{ + + /** + * {@inheritdoc} + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + try { + return $handler->handle($request); + } catch (Throwable $e) { + throw $e; + } + } +} From 325a3ef8af3e2e3ba2a5e38220f229413240c1a8 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Wed, 1 Feb 2023 20:30:08 +0100 Subject: [PATCH 050/180] v3 --- src/Rest/Middleware/ErrorHandlingMiddleware.php | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/Rest/Middleware/ErrorHandlingMiddleware.php b/src/Rest/Middleware/ErrorHandlingMiddleware.php index 506d6e78..c43dba62 100644 --- a/src/Rest/Middleware/ErrorHandlingMiddleware.php +++ b/src/Rest/Middleware/ErrorHandlingMiddleware.php @@ -14,6 +14,7 @@ /** * Import classes */ +use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; @@ -28,6 +29,19 @@ final class ErrorHandlingMiddleware implements MiddlewareInterface { + /** + * @var ResponseFactoryInterface + */ + private ResponseFactoryInterface $responseFactory; + + /** + * @param ResponseFactoryInterface $responseFactory + */ + public function __construct(ResponseFactoryInterface $responseFactory) + { + $this->responseFactory = $responseFactory; + } + /** * {@inheritdoc} */ From 8fed719077385306ac4d021c1530baf16a3dcc8e Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 2 Feb 2023 19:20:51 +0100 Subject: [PATCH 051/180] v3 --- src/Annotation/Tag.php | 52 ++++++++++++ src/Component/Rest/Dto/ErrorDto.php | 53 ++++++++++++ src/Component/Rest/Dto/ErrorsDto.php | 85 +++++++++++++++++++ .../Middleware/ErrorHandlingMiddleware.php | 21 ++++- src/Loader/DescriptorLoader.php | 6 ++ src/ParameterResolutioner.php | 12 +-- src/Route.php | 27 ++++-- src/RouteCollection.php | 3 +- src/RouteInterface.php | 11 +++ 9 files changed, 253 insertions(+), 17 deletions(-) create mode 100644 src/Annotation/Tag.php create mode 100644 src/Component/Rest/Dto/ErrorDto.php create mode 100644 src/Component/Rest/Dto/ErrorsDto.php rename src/{ => Component}/Rest/Middleware/ErrorHandlingMiddleware.php (53%) diff --git a/src/Annotation/Tag.php b/src/Annotation/Tag.php new file mode 100644 index 00000000..8af2e525 --- /dev/null +++ b/src/Annotation/Tag.php @@ -0,0 +1,52 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Annotation; + +/** + * Import classes + */ +use Attribute; + +/** + * @Annotation + * + * @Target({"CLASS", "METHOD"}) + * + * @NamedArgumentConstructor + * + * @Attributes({ + * @Attribute("value", type="string", required=true), + * }) + * + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS|Attribute::TARGET_METHOD|Attribute::IS_REPEATABLE)] +final class Tag +{ + + /** + * The attribute value + * + * @var string + */ + public string $value; + + /** + * Constructor of the class + * + * @param string $value + */ + public function __construct(string $value) + { + $this->value = $value; + } +} diff --git a/src/Component/Rest/Dto/ErrorDto.php b/src/Component/Rest/Dto/ErrorDto.php new file mode 100644 index 00000000..49f528a1 --- /dev/null +++ b/src/Component/Rest/Dto/ErrorDto.php @@ -0,0 +1,53 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Component\Rest\Dto; + +/** + * Import classes + */ +use Sunrise\Http\Router\OpenApi\Annotation\OpenApi as OA; +use Symfony\Component\Validator\ConstraintViolationInterface; +use JsonSerializable; + +/** + * Error DTO + * + * @OA\SchemaObject({ + * }) + * + * @link https://jsonapi.org/format/#error-objects + * + * @since 3.0.0 + */ +final class ErrorDto implements JsonSerializable +{ + + /** + * @param ConstraintViolationInterface $violation + * + * @return self + */ + public static function fromViolation(ConstraintViolationInterface $violation): self + { + return new ErrorDto(); + } + + /** + * @return array{ + * } + */ + public function jsonSerialize(): array + { + return [ + ]; + } +} diff --git a/src/Component/Rest/Dto/ErrorsDto.php b/src/Component/Rest/Dto/ErrorsDto.php new file mode 100644 index 00000000..b731c291 --- /dev/null +++ b/src/Component/Rest/Dto/ErrorsDto.php @@ -0,0 +1,85 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Component\Rest\Dto; + +/** + * Import classes + */ +use Sunrise\Http\Router\OpenApi\Annotation\OpenApi as OA; +use Symfony\Component\Validator\ConstraintViolationListInterface; +use JsonSerializable; + +/** + * Errors DTO + * + * @OA\SchemaObject({ + * "errors": @OA\SchemaReference(".errors"), + * }) + * + * @OA\Response( + * description="Something went wrong", + * content={ + * "application/json": @OA\MediaType( + * schema=@OA\SchemaReference("ErrorsDto"), + * ), + * }, + * ) + * + * @since 3.0.0 + */ +final class ErrorsDto implements JsonSerializable +{ + + /** + * @OA\SchemaArray( + * @OA\SchemaReference("ErrorDto") + * ) + * + * @var list + */ + private array $errors = []; + + /** + * @param ErrorDto ...$errors + */ + public function __construct(ErrorDto ...$errors) + { + foreach ($errors as $error) { + $this->errors[] = $error; + } + } + + /** + * @param ConstraintViolationListInterface $violations + * + * @return self + */ + public static function fromViolations(ConstraintViolationListInterface $violations): self + { + $errors = []; + foreach ($violations as $violation) { + $errors[] = ErrorDto::fromViolation($violation); + } + + return new self(...$errors); + } + + /** + * @return array{errors: list} + */ + public function jsonSerialize(): array + { + return [ + 'errors' => $this->errors, + ]; + } +} diff --git a/src/Rest/Middleware/ErrorHandlingMiddleware.php b/src/Component/Rest/Middleware/ErrorHandlingMiddleware.php similarity index 53% rename from src/Rest/Middleware/ErrorHandlingMiddleware.php rename to src/Component/Rest/Middleware/ErrorHandlingMiddleware.php index c43dba62..6f178da1 100644 --- a/src/Rest/Middleware/ErrorHandlingMiddleware.php +++ b/src/Component/Rest/Middleware/ErrorHandlingMiddleware.php @@ -9,7 +9,7 @@ * @link https://github.com/sunrise-php/http-router */ -namespace Sunrise\Http\Router\Rest\Middleware; +namespace Sunrise\Http\Router\Component\Rest\Middleware; /** * Import classes @@ -19,7 +19,10 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Throwable; +use Sunrise\Http\Router\Exception\Http\HttpExceptionInterface; +use Sunrise\Http\Router\Exception\Http\HttpMethodNotAllowedException; +use Sunrise\Http\Router\Exception\Http\HttpUnsupportedMediaTypeException; +use Sunrise\Http\Router\Exception\UnprocessableEntityException; /** * ErrorHandlingMiddleware @@ -49,8 +52,18 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface { try { return $handler->handle($request); - } catch (Throwable $e) { - throw $e; + } catch (HttpMethodNotAllowedException $e) { + /** @psalm-suppress TooFewArguments, MixedArgument */ + return $this->responseFactory->createResponse($e->getStatusCode()) + ->withHeader(...$e->getAllowHeaderArguments()); + } catch (HttpUnsupportedMediaTypeException $e) { + /** @psalm-suppress TooFewArguments, MixedArgument */ + return $this->responseFactory->createResponse($e->getStatusCode()) + ->withHeader(...$e->getAcceptHeaderArguments()); + } catch (UnprocessableEntityException $e) { + return $this->responseFactory->createResponse($e->getStatusCode()); + } catch (HttpExceptionInterface $e) { + return $this->responseFactory->createResponse($e->getStatusCode()); } } } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index a566d934..554a52c4 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -22,6 +22,7 @@ use Sunrise\Http\Router\Annotation\Postfix; use Sunrise\Http\Router\Annotation\Prefix; use Sunrise\Http\Router\Annotation\Route; +use Sunrise\Http\Router\Annotation\Tag; use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ParameterResolver\DependencyInjectionParameterResolver; @@ -481,5 +482,10 @@ private function supplementDescriptor(Route $descriptor, Reflector $classOrMetho foreach ($annotations as $annotation) { $descriptor->middlewares[] = $annotation->value; } + + $annotations = $this->annotationReader->getClassOrMethodAnnotations($classOrMethod, Tag::class); + foreach ($annotations as $annotation) { + $descriptor->tags[] = $annotation->value; + } } } diff --git a/src/ParameterResolutioner.php b/src/ParameterResolutioner.php index 7004f4a0..45682616 100644 --- a/src/ParameterResolutioner.php +++ b/src/ParameterResolutioner.php @@ -61,14 +61,16 @@ public function withContext($context): ParameterResolutionerInterface */ public function withPriorityResolver(ParameterResolverInterface ...$resolvers): ParameterResolutionerInterface { - /** @var list $resolvers */ + $clone = clone $this; + $clone->resolvers = []; - foreach ($this->resolvers as $resolver) { - $resolvers[] = $resolver; + foreach ($resolvers as $resolver) { + $clone->resolvers[] = $resolver; } - $clone = clone $this; - $clone->resolvers = $resolvers; + foreach ($this->resolvers as $resolver) { + $clone->resolvers[] = $resolver; + } return $clone; } diff --git a/src/Route.php b/src/Route.php index 7df2afd4..6358a15b 100644 --- a/src/Route.php +++ b/src/Route.php @@ -26,6 +26,7 @@ /** * Import functions */ +use function array_values; use function rtrim; use function strtoupper; @@ -283,9 +284,10 @@ public function setRequestHandler(RequestHandlerInterface $requestHandler): Rout */ public function setMiddlewares(MiddlewareInterface ...$middlewares): RouteInterface { - /** @var list $middlewares */ - - $this->middlewares = $middlewares; + $this->middlewares = []; + foreach ($middlewares as $middleware) { + $this->middlewares[] = $middleware; + } return $this; } @@ -335,9 +337,10 @@ public function setDescription(string $description): RouteInterface */ public function setTags(string ...$tags): RouteInterface { - /** @var list $tags */ - - $this->tags = $tags; + $this->tags = []; + foreach ($tags as $tag) { + $this->tags[] = $tag; + } return $this; } @@ -389,6 +392,18 @@ public function addMiddleware(MiddlewareInterface ...$middlewares): RouteInterfa return $this; } + /** + * {@inheritdoc} + */ + public function addPriorityMiddleware(MiddlewareInterface ...$middlewares): RouteInterface + { + $middlewares = array_values($middlewares); + + $this->middlewares = [...$middlewares, ...$this->middlewares]; + + return $this; + } + /** * {@inheritdoc} */ diff --git a/src/RouteCollection.php b/src/RouteCollection.php index 4d40a35f..c84cb11e 100644 --- a/src/RouteCollection.php +++ b/src/RouteCollection.php @@ -19,7 +19,6 @@ /** * Import functions */ -use function array_merge; use function count; /** @@ -166,7 +165,7 @@ public function addMiddleware(MiddlewareInterface ...$middlewares): RouteCollect public function addPriorityMiddleware(MiddlewareInterface ...$middlewares): RouteCollectionInterface { foreach ($this->routes as $route) { - $route->setMiddlewares(...array_merge($middlewares, $route->getMiddlewares())); + $route->addPriorityMiddleware(...$middlewares); } return $this; diff --git a/src/RouteInterface.php b/src/RouteInterface.php index 05fe3d96..42a7620f 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -270,6 +270,17 @@ public function addMethod(string ...$methods): RouteInterface; */ public function addMiddleware(MiddlewareInterface ...$middlewares): RouteInterface; + /** + * Adds the given priority middleware(s) to the route + * + * @param MiddlewareInterface ...$middlewares + * + * @return RouteInterface + * + * @since 3.0.0 + */ + public function addPriorityMiddleware(MiddlewareInterface ...$middlewares): RouteInterface; + /** * Adds the given tag(s) to the route * From ec1faa2866d640da914069f5af8d0d96f6b1e99d Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 2 Feb 2023 19:34:14 +0100 Subject: [PATCH 052/180] v3 --- src/Middleware/CallableMiddleware.php | 25 +++++++++++++++---- src/RequestHandler/CallableRequestHandler.php | 23 ++++++++++++++--- 2 files changed, 39 insertions(+), 9 deletions(-) diff --git a/src/Middleware/CallableMiddleware.php b/src/Middleware/CallableMiddleware.php index 67751e47..fb2874e7 100644 --- a/src/Middleware/CallableMiddleware.php +++ b/src/Middleware/CallableMiddleware.php @@ -24,6 +24,7 @@ use ReflectionFunctionAbstract; use ReflectionFunction; use ReflectionMethod; +use ReflectionParameter; /** * Import functions @@ -88,18 +89,32 @@ public function getReflection(): ReflectionFunctionAbstract return reflect_callable($this->callback); } + /** + * Gets the callback's parameters + * + * @return list + * + * @since 3.0.0 + */ + public function getParameters(): array + { + return $this->getReflection()->getParameters(); + } + /** * {@inheritdoc} */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { + $parameterResolvers = [ + new KnownTypeParameterResolver(ServerRequestInterface::class, $request), + new KnownTypeParameterResolver(RequestHandlerInterface::class, $handler), + ]; + $arguments = $this->parameterResolutioner ->withContext($request) - ->withPriorityResolver( - new KnownTypeParameterResolver(ServerRequestInterface::class, $request), - new KnownTypeParameterResolver(RequestHandlerInterface::class, $handler) - ) - ->resolveParameters(...$this->getReflection()->getParameters()); + ->withPriorityResolver(...$parameterResolvers) + ->resolveParameters(...$this->getParameters()); /** @var mixed */ $response = ($this->callback)(...$arguments); diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index 2b4552d5..8ea31019 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -23,6 +23,7 @@ use ReflectionFunctionAbstract; use ReflectionFunction; use ReflectionMethod; +use ReflectionParameter; /** * Import functions @@ -85,17 +86,31 @@ public function getReflection(): ReflectionFunctionAbstract return reflect_callable($this->callback); } + /** + * Gets the callback's parameters + * + * @return list + * + * @since 3.0.0 + */ + public function getParameters(): array + { + return $this->getReflection()->getParameters(); + } + /** * {@inheritdoc} */ public function handle(ServerRequestInterface $request): ResponseInterface { + $parameterResolvers = [ + new KnownTypeParameterResolver(ServerRequestInterface::class, $request), + ]; + $arguments = $this->parameterResolutioner ->withContext($request) - ->withPriorityResolver( - new KnownTypeParameterResolver(ServerRequestInterface::class, $request) - ) - ->resolveParameters(...$this->getReflection()->getParameters()); + ->withPriorityResolver(...$parameterResolvers) + ->resolveParameters(...$this->getParameters()); /** @var mixed */ $response = ($this->callback)(...$arguments); From 87e8987065bac6d5445c98a65c80b77399932d21 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Tue, 7 Feb 2023 21:55:06 +0100 Subject: [PATCH 053/180] v3 --- src/Component/Rest/Dto/ErrorDto.php | 53 ------------ src/Component/Rest/Dto/ErrorsDto.php | 85 ------------------- .../Middleware/ErrorHandlingMiddleware.php | 69 --------------- .../AbstractParameterResolver.php | 60 ------------- .../RequestBodyParameterResolver.php | 7 +- .../RequestEntityParameterResolver.php | 30 ++++++- .../RequestQueryParameterResolver.php | 7 +- 7 files changed, 39 insertions(+), 272 deletions(-) delete mode 100644 src/Component/Rest/Dto/ErrorDto.php delete mode 100644 src/Component/Rest/Dto/ErrorsDto.php delete mode 100644 src/Component/Rest/Middleware/ErrorHandlingMiddleware.php delete mode 100644 src/ParameterResolver/AbstractParameterResolver.php diff --git a/src/Component/Rest/Dto/ErrorDto.php b/src/Component/Rest/Dto/ErrorDto.php deleted file mode 100644 index 49f528a1..00000000 --- a/src/Component/Rest/Dto/ErrorDto.php +++ /dev/null @@ -1,53 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Component\Rest\Dto; - -/** - * Import classes - */ -use Sunrise\Http\Router\OpenApi\Annotation\OpenApi as OA; -use Symfony\Component\Validator\ConstraintViolationInterface; -use JsonSerializable; - -/** - * Error DTO - * - * @OA\SchemaObject({ - * }) - * - * @link https://jsonapi.org/format/#error-objects - * - * @since 3.0.0 - */ -final class ErrorDto implements JsonSerializable -{ - - /** - * @param ConstraintViolationInterface $violation - * - * @return self - */ - public static function fromViolation(ConstraintViolationInterface $violation): self - { - return new ErrorDto(); - } - - /** - * @return array{ - * } - */ - public function jsonSerialize(): array - { - return [ - ]; - } -} diff --git a/src/Component/Rest/Dto/ErrorsDto.php b/src/Component/Rest/Dto/ErrorsDto.php deleted file mode 100644 index b731c291..00000000 --- a/src/Component/Rest/Dto/ErrorsDto.php +++ /dev/null @@ -1,85 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Component\Rest\Dto; - -/** - * Import classes - */ -use Sunrise\Http\Router\OpenApi\Annotation\OpenApi as OA; -use Symfony\Component\Validator\ConstraintViolationListInterface; -use JsonSerializable; - -/** - * Errors DTO - * - * @OA\SchemaObject({ - * "errors": @OA\SchemaReference(".errors"), - * }) - * - * @OA\Response( - * description="Something went wrong", - * content={ - * "application/json": @OA\MediaType( - * schema=@OA\SchemaReference("ErrorsDto"), - * ), - * }, - * ) - * - * @since 3.0.0 - */ -final class ErrorsDto implements JsonSerializable -{ - - /** - * @OA\SchemaArray( - * @OA\SchemaReference("ErrorDto") - * ) - * - * @var list - */ - private array $errors = []; - - /** - * @param ErrorDto ...$errors - */ - public function __construct(ErrorDto ...$errors) - { - foreach ($errors as $error) { - $this->errors[] = $error; - } - } - - /** - * @param ConstraintViolationListInterface $violations - * - * @return self - */ - public static function fromViolations(ConstraintViolationListInterface $violations): self - { - $errors = []; - foreach ($violations as $violation) { - $errors[] = ErrorDto::fromViolation($violation); - } - - return new self(...$errors); - } - - /** - * @return array{errors: list} - */ - public function jsonSerialize(): array - { - return [ - 'errors' => $this->errors, - ]; - } -} diff --git a/src/Component/Rest/Middleware/ErrorHandlingMiddleware.php b/src/Component/Rest/Middleware/ErrorHandlingMiddleware.php deleted file mode 100644 index 6f178da1..00000000 --- a/src/Component/Rest/Middleware/ErrorHandlingMiddleware.php +++ /dev/null @@ -1,69 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Component\Rest\Middleware; - -/** - * Import classes - */ -use Psr\Http\Message\ResponseFactoryInterface; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\Http\HttpExceptionInterface; -use Sunrise\Http\Router\Exception\Http\HttpMethodNotAllowedException; -use Sunrise\Http\Router\Exception\Http\HttpUnsupportedMediaTypeException; -use Sunrise\Http\Router\Exception\UnprocessableEntityException; - -/** - * ErrorHandlingMiddleware - * - * @since 3.0.0 - */ -final class ErrorHandlingMiddleware implements MiddlewareInterface -{ - - /** - * @var ResponseFactoryInterface - */ - private ResponseFactoryInterface $responseFactory; - - /** - * @param ResponseFactoryInterface $responseFactory - */ - public function __construct(ResponseFactoryInterface $responseFactory) - { - $this->responseFactory = $responseFactory; - } - - /** - * {@inheritdoc} - */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface - { - try { - return $handler->handle($request); - } catch (HttpMethodNotAllowedException $e) { - /** @psalm-suppress TooFewArguments, MixedArgument */ - return $this->responseFactory->createResponse($e->getStatusCode()) - ->withHeader(...$e->getAllowHeaderArguments()); - } catch (HttpUnsupportedMediaTypeException $e) { - /** @psalm-suppress TooFewArguments, MixedArgument */ - return $this->responseFactory->createResponse($e->getStatusCode()) - ->withHeader(...$e->getAcceptHeaderArguments()); - } catch (UnprocessableEntityException $e) { - return $this->responseFactory->createResponse($e->getStatusCode()); - } catch (HttpExceptionInterface $e) { - return $this->responseFactory->createResponse($e->getStatusCode()); - } - } -} diff --git a/src/ParameterResolver/AbstractParameterResolver.php b/src/ParameterResolver/AbstractParameterResolver.php deleted file mode 100644 index 1d4c0898..00000000 --- a/src/ParameterResolver/AbstractParameterResolver.php +++ /dev/null @@ -1,60 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\ParameterResolver; - -/** - * Import classes - */ -use Sunrise\Http\Router\ParameterResolverInterface; -use ReflectionMethod; -use ReflectionParameter; - -/** - * Import functions - */ -use function sprintf; - -/** - * AbstractParameterResolver - * - * @since 3.0.0 - */ -abstract class AbstractParameterResolver implements ParameterResolverInterface -{ - - /** - * Stringifies the given parameter - * - * @param ReflectionParameter $parameter - * - * @return string - */ - final protected function stringifyParameter(ReflectionParameter $parameter): string - { - if ($parameter->getDeclaringFunction() instanceof ReflectionMethod) { - return sprintf( - '%s::%s($%s[%d])', - $parameter->getDeclaringFunction()->getDeclaringClass()->getName(), - $parameter->getDeclaringFunction()->getName(), - $parameter->getName(), - $parameter->getPosition() - ); - } - - return sprintf( - '%s($%s[%d])', - $parameter->getDeclaringFunction()->getName(), - $parameter->getName(), - $parameter->getPosition() - ); - } -} diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 674b0fba..24ca56ee 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -42,6 +42,7 @@ * RequestBodyParameterResolver * * @link https://github.com/sunrise-php/hydrator + * @link https://github.com/symfony/validator * * @since 3.0.0 */ @@ -62,8 +63,10 @@ final class RequestBodyParameterResolver implements ParameterResolverInterface * @param HydratorInterface $hydrator * @param ValidatorInterface|null $validator */ - public function __construct(HydratorInterface $hydrator, ?ValidatorInterface $validator = null) - { + public function __construct( + HydratorInterface $hydrator, + ?ValidatorInterface $validator = null + ) { $this->hydrator = $hydrator; $this->validator = $validator; } diff --git a/src/ParameterResolver/RequestEntityParameterResolver.php b/src/ParameterResolver/RequestEntityParameterResolver.php index 8b91886f..ac819d91 100644 --- a/src/ParameterResolver/RequestEntityParameterResolver.php +++ b/src/ParameterResolver/RequestEntityParameterResolver.php @@ -20,6 +20,7 @@ use Sunrise\Http\Router\Exception\EntityNotFoundException; use Sunrise\Http\Router\Exception\ResolvingParameterException; use ReflectionAttribute; +use ReflectionMethod; use ReflectionNamedType; use ReflectionParameter; @@ -34,7 +35,7 @@ * * @since 3.0.0 */ -final class RequestEntityParameterResolver extends AbstractParameterResolver +final class RequestEntityParameterResolver implements ParameterResolverInterface { /** @@ -155,4 +156,31 @@ public function resolveParameter(ReflectionParameter $parameter, $context) $entityMetadata->getReflectionClass()->getShortName() )); } + + /** + * Stringifies the given parameter + * + * @param ReflectionParameter $parameter + * + * @return string + */ + private function stringifyParameter(ReflectionParameter $parameter): string + { + if ($parameter->getDeclaringFunction() instanceof ReflectionMethod) { + return sprintf( + '%s::%s($%s[%d])', + $parameter->getDeclaringFunction()->getDeclaringClass()->getName(), + $parameter->getDeclaringFunction()->getName(), + $parameter->getName(), + $parameter->getPosition() + ); + } + + return sprintf( + '%s($%s[%d])', + $parameter->getDeclaringFunction()->getName(), + $parameter->getName(), + $parameter->getPosition() + ); + } } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index cc529589..da5997a8 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -42,6 +42,7 @@ * RequestQueryParameterResolver * * @link https://github.com/sunrise-php/hydrator + * @link https://github.com/symfony/validator * * @since 3.0.0 */ @@ -62,8 +63,10 @@ final class RequestQueryParameterResolver implements ParameterResolverInterface * @param HydratorInterface $hydrator * @param ValidatorInterface|null $validator */ - public function __construct(HydratorInterface $hydrator, ?ValidatorInterface $validator = null) - { + public function __construct( + HydratorInterface $hydrator, + ?ValidatorInterface $validator = null + ) { $this->hydrator = $hydrator; $this->validator = $validator; } From 6319e7f896ba30dddad47c83aa6a7e0e0ca78b3e Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Wed, 8 Feb 2023 01:32:58 +0100 Subject: [PATCH 054/180] v3 --- functions/get_debug_type.php | 2 + .../UnprocessableEntityException.php | 2 + .../KnownNameParameterResolver.php | 67 +++ .../KnownTypeParameterResolver.php | 6 +- .../RequestEntityParameterResolver.php | 1 + src/ReferenceResolverInterface.php | 4 + src/Route.php | 14 +- src/RouteInterface.php | 4 +- src/Router.php | 453 ++++++++++++------ 9 files changed, 392 insertions(+), 161 deletions(-) create mode 100644 src/ParameterResolver/KnownNameParameterResolver.php diff --git a/functions/get_debug_type.php b/functions/get_debug_type.php index ed2302a8..38d231bb 100644 --- a/functions/get_debug_type.php +++ b/functions/get_debug_type.php @@ -19,6 +19,8 @@ * @return string * * @since 3.0.0 + * + * @link https://www.php.net/get_debug_type */ function get_debug_type($value): string { diff --git a/src/Exception/UnprocessableEntityException.php b/src/Exception/UnprocessableEntityException.php index c7a88561..afe34b01 100644 --- a/src/Exception/UnprocessableEntityException.php +++ b/src/Exception/UnprocessableEntityException.php @@ -37,6 +37,8 @@ class UnprocessableEntityException extends HttpUnprocessableEntityException */ public function __construct(ConstraintViolationListInterface $violations) { + parent::__construct(); + $this->violations = $violations; } diff --git a/src/ParameterResolver/KnownNameParameterResolver.php b/src/ParameterResolver/KnownNameParameterResolver.php new file mode 100644 index 00000000..58f65db2 --- /dev/null +++ b/src/ParameterResolver/KnownNameParameterResolver.php @@ -0,0 +1,67 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\ParameterResolver; + +/** + * Import classes + */ +use Sunrise\Http\Router\ParameterResolverInterface; +use ReflectionParameter; + +/** + * KnownNameParameterResolver + * + * @since 3.0.0 + */ +final class KnownNameParameterResolver implements ParameterResolverInterface +{ + + /** + * @var string + */ + private string $name; + + /** + * @var mixed + */ + private $value; + + /** + * @param string $name + * @param mixed $value + */ + public function __construct(string $name, $value) + { + $this->name = $name; + $this->value = $value; + } + + /** + * {@inheritdoc} + */ + public function supportsParameter(ReflectionParameter $parameter, $context): bool + { + if ($parameter->hasType()) { + return false; + } + + return $this->name === $parameter->getName(); + } + + /** + * {@inheritdoc} + */ + public function resolveParameter(ReflectionParameter $parameter, $context) + { + return $this->value; + } +} diff --git a/src/ParameterResolver/KnownTypeParameterResolver.php b/src/ParameterResolver/KnownTypeParameterResolver.php index bc5b1808..574b0329 100644 --- a/src/ParameterResolver/KnownTypeParameterResolver.php +++ b/src/ParameterResolver/KnownTypeParameterResolver.php @@ -74,11 +74,7 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo return false; } - if (!($parameter->getType()->getName() === $this->type)) { - return false; - } - - return true; + return $this->type === $parameter->getType()->getName(); } /** diff --git a/src/ParameterResolver/RequestEntityParameterResolver.php b/src/ParameterResolver/RequestEntityParameterResolver.php index ac819d91..e3215720 100644 --- a/src/ParameterResolver/RequestEntityParameterResolver.php +++ b/src/ParameterResolver/RequestEntityParameterResolver.php @@ -19,6 +19,7 @@ use Sunrise\Http\Router\Annotation\RequestEntity; use Sunrise\Http\Router\Exception\EntityNotFoundException; use Sunrise\Http\Router\Exception\ResolvingParameterException; +use Sunrise\Http\Router\ParameterResolverInterface; use ReflectionAttribute; use ReflectionMethod; use ReflectionNamedType; diff --git a/src/ReferenceResolverInterface.php b/src/ReferenceResolverInterface.php index 9df2cd07..a4f04b8a 100644 --- a/src/ReferenceResolverInterface.php +++ b/src/ReferenceResolverInterface.php @@ -35,6 +35,8 @@ interface ReferenceResolverInterface * * @throws ResolvingReferenceException * If the reference cannot be resolved to a request handler. + * + * @since 3.0.0 */ public function resolveRequestHandler($reference): RequestHandlerInterface; @@ -47,6 +49,8 @@ public function resolveRequestHandler($reference): RequestHandlerInterface; * * @throws ResolvingReferenceException * If the reference cannot be resolved to a middleware. + * + * @since 3.0.0 */ public function resolveMiddleware($reference): MiddlewareInterface; diff --git a/src/Route.php b/src/Route.php index 6358a15b..140d8819 100644 --- a/src/Route.php +++ b/src/Route.php @@ -26,7 +26,6 @@ /** * Import functions */ -use function array_values; use function rtrim; use function strtoupper; @@ -395,11 +394,18 @@ public function addMiddleware(MiddlewareInterface ...$middlewares): RouteInterfa /** * {@inheritdoc} */ - public function addPriorityMiddleware(MiddlewareInterface ...$middlewares): RouteInterface + public function addPriorityMiddleware(MiddlewareInterface ...$priorityMiddlewares): RouteInterface { - $middlewares = array_values($middlewares); + $previousMiddlewares = $this->middlewares; + $this->middlewares = []; + + foreach ($priorityMiddlewares as $middleware) { + $this->middlewares[] = $middleware; + } - $this->middlewares = [...$middlewares, ...$this->middlewares]; + foreach ($previousMiddlewares as $middleware) { + $this->middlewares[] = $middleware; + } return $this; } diff --git a/src/RouteInterface.php b/src/RouteInterface.php index 42a7620f..d35b6509 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -273,13 +273,13 @@ public function addMiddleware(MiddlewareInterface ...$middlewares): RouteInterfa /** * Adds the given priority middleware(s) to the route * - * @param MiddlewareInterface ...$middlewares + * @param MiddlewareInterface ...$priorityMiddlewares * * @return RouteInterface * * @since 3.0.0 */ - public function addPriorityMiddleware(MiddlewareInterface ...$middlewares): RouteInterface; + public function addPriorityMiddleware(MiddlewareInterface ...$priorityMiddlewares): RouteInterface; /** * Adds the given tag(s) to the route diff --git a/src/Router.php b/src/Router.php index bf5991e9..10ca2ebd 100644 --- a/src/Router.php +++ b/src/Router.php @@ -28,14 +28,13 @@ use Sunrise\Http\Router\Loader\LoaderInterface; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; use Sunrise\Http\Router\RequestHandler\UnsafeCallableRequestHandler; +use Generator; /** * Import functions */ use function Sunrise\Http\Router\path_build; use function Sunrise\Http\Router\path_match; -use function array_keys; -use function get_class; use function sprintf; /** @@ -51,7 +50,7 @@ class Router implements RequestHandlerInterface, RequestMethodInterface * * @since 2.9.0 */ - public static $patterns = [ + public static array $patterns = [ '@slug' => '[0-9a-z-]+', '@uuid' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}', ]; @@ -59,46 +58,93 @@ class Router implements RequestHandlerInterface, RequestMethodInterface /** * The router's host table * - * @var array - * The key is a host alias and values are hostnames. + * @var array> */ - private $hosts = []; + private array $hosts = []; /** * The router's routes * - * @var array - * The key is a route name. + * @var array> */ - private $routes = []; + private array $routes = []; /** * The router's middlewares * * @var list */ - private $middlewares = []; + private array $middlewares = []; /** * The router's matched route * * @var RouteInterface|null */ - private $matchedRoute = null; + private ?RouteInterface $matchedRoute = null; /** * The router's event dispatcher * * @var EventDispatcherInterface|null - * - * @since 2.13.0 */ private ?EventDispatcherInterface $eventDispatcher = null; + /** + * Adds the given patterns to the router + * + * @param array $patterns + * + * @return void + * + * @since 2.11.0 + */ + public function addPatterns(array $patterns): void + { + foreach ($patterns as $alias => $pattern) { + self::$patterns[$alias] = $pattern; + } + } + + /** + * Adds the given host to the router's host table + * + * @param string $alias + * @param string ...$hostnames + * + * @return void + * + * @since 2.6.0 + */ + public function addHost(string $alias, string ...$hostnames): void + { + foreach ($hostnames as $hostname) { + $this->hosts[$alias][] = $hostname; + } + } + + /** + * Adds the given hosts to the router's host table + * + * @param array> $hosts + * + * @return void + * + * @since 2.11.0 + */ + public function addHosts(array $hosts): void + { + foreach ($hosts as $alias => $hostnames) { + foreach ($hostnames as $hostname) { + $this->hosts[$alias][] = $hostname; + } + } + } + /** * Gets the router's host table * - * @return array + * @return array> * * @since 2.6.0 */ @@ -108,7 +154,7 @@ public function getHosts(): array } /** - * Resolves the given hostname + * Resolves the given hostname to its alias * * @param string $hostname * @@ -129,19 +175,53 @@ public function resolveHostname(string $hostname): ?string return null; } + /** + * Adds the given route(s) to the router + * + * @param RouteInterface ...$routes + * + * @return void + */ + public function addRoute(RouteInterface ...$routes): void + { + foreach ($routes as $route) { + $host = $route->getHost() ?? '*'; + $name = $route->getName(); + + $this->routes[$host][$name] = $route; + } + } + /** * Gets all routes * - * @return RouteInterface[] + * @return Generator */ - public function getRoutes(): array + public function getRoutes(): Generator { - $routes = []; - foreach ($this->routes as $route) { - $routes[] = $route; + foreach ($this->routes as $routes) { + foreach ($routes as $route) { + yield $route; + } } + } - return $routes; + /** + * Gets routes by the given host + * + * @param string $host + * + * @return Generator + * + * @since 3.0.0 + */ + public function getRoutesByHost(string $host): Generator + { + if (isset($this->routes[$host])) { + foreach ($this->routes[$host] as $route) { + yield $route; + } + } } /** @@ -149,150 +229,235 @@ public function getRoutes(): array * * @param string $hostname * - * @return RouteInterface[] + * @return Generator * * @since 2.14.0 */ - public function getRoutesByHostname(string $hostname): array + public function getRoutesByHostname(string $hostname): Generator { - // the hostname's alias. - $alias = $this->resolveHostname($hostname); - - $routes = []; - foreach ($this->routes as $route) { - $host = $route->getHost(); - if ($host === null || $host === $alias) { - $routes[] = $route; + $host = $this->resolveHostname($hostname); + + if (isset($host) && isset($this->routes[$host])) { + foreach ($this->routes[$host] as $route) { + yield $route; } } - return $routes; + if (isset($this->routes['*'])) { + foreach ($this->routes['*'] as $route) { + yield $route; + } + } } /** - * Gets the router's middlewares + * Gets a route by the given name + * + * @param string $name * - * @return MiddlewareInterface[] + * @return RouteInterface + * + * @throws RouteNotFoundException + * If a route wasn't found by the given name. */ - public function getMiddlewares(): array + public function getRoute(string $name): RouteInterface { - return $this->middlewares; + foreach ($this->routes as $routes) { + if (isset($routes[$name])) { + return $routes[$name]; + } + } + + throw new RouteNotFoundException(sprintf( + 'No route found for name "%s"', + $name + )); } /** - * Gets the router's matched route + * Gets a route by the given name and host * - * @return RouteInterface|null + * @param string $name + * @param string $host + * + * @return RouteInterface + * + * @throws RouteNotFoundException + * If a route wasn't found by the given name and host. + * + * @since 3.0.0 */ - public function getMatchedRoute(): ?RouteInterface + public function getNamedRouteByHost(string $name, string $host): RouteInterface { - return $this->matchedRoute; + if (isset($this->routes[$host][$name])) { + return $this->routes[$host][$name]; + } + + throw new RouteNotFoundException(sprintf( + 'No route found for name "%s" and host "%s"', + $name, + $host + )); } /** - * Gets the router's event dispatcher + * Gets a route by the given name and hostname * - * @return EventDispatcherInterface|null + * @param string $name + * @param string $hostname * - * @since 2.13.0 + * @return RouteInterface + * + * @throws RouteNotFoundException + * If a route wasn't found by the given name and hostname. + * + * @since 3.0.0 */ - public function getEventDispatcher(): ?EventDispatcherInterface + public function getNamedRouteByHostname(string $name, string $hostname): RouteInterface { - return $this->eventDispatcher; + $host = $this->resolveHostname($hostname); + + if (isset($host) && isset($this->routes[$host][$name])) { + return $this->routes[$host][$name]; + } + + if (isset($this->routes['*'][$name])) { + return $this->routes['*'][$name]; + } + + throw new RouteNotFoundException(sprintf( + 'No route found for name "%s" and hostname "%s"', + $name, + $hostname + )); } /** - * Adds the given patterns to the router - * - * ```php - * $router->addPatterns([ - * '@digit' => '\d+', - * '@word' => '\w+', - * ]); - * ``` - * - * ```php - * $route->setPath('/{foo<@digit>}/{bar<@word>}'); - * ``` - * - * @param array $patterns - * - * @return void + * Checks if a route exists by the given name * - * @since 2.11.0 + * @return bool */ - public function addPatterns(array $patterns): void + public function hasRoute(string $name): bool { - foreach ($patterns as $alias => $pattern) { - self::$patterns[$alias] = $pattern; + foreach ($this->routes as $routes) { + if (isset($routes[$name])) { + return true; + } } + + return false; } /** - * Adds aliases for hostnames to the router's host table + * Checks if a route exists by the given name and host * - * ```php - * $router->addHosts([ - * 'local' => ['127.0.0.1', 'localhost'], - * ]); - * ``` + * @return bool * - * ```php - * // will be available at 127.0.0.1 - * $route->setHost('local'); - * ``` + * @since 3.0.0 + */ + public function existsNamedRouteByHost(string $name, string $host): bool + { + if (isset($this->routes[$host][$name])) { + return true; + } + + return false; + } + + /** + * Checks if a route exists by the given name and hostname * - * @param array $hosts + * @return bool * - * @return void + * @since 3.0.0 + */ + public function existsNamedRouteByHostname(string $name, string $hostname): bool + { + if (isset($this->routes['*'][$name])) { + return true; + } + + $host = $this->resolveHostname($hostname); + + if (isset($host) && isset($this->routes[$host][$name])) { + return true; + } + + return false; + } + + /** + * Gets allowed methods * - * @since 2.11.0 + * @return list */ - public function addHosts(array $hosts): void + public function getAllowedMethods(): array { - foreach ($hosts as $alias => $hostnames) { - $this->addHost($alias, ...$hostnames); + $methods = []; + foreach ($this->routes as $routes) { + foreach ($routes as $route) { + foreach ($route->getMethods() as $method) { + $methods[$method] = $method; + } + } } + + return empty($methods) ? [] : \array_values($methods); } /** - * Adds the given alias for the given hostname(s) to the router's host table + * Gets allowed methods by the given host * - * @param string $alias - * @param string ...$hostnames + * @param string $host * - * @return void + * @return list * - * @since 2.6.0 + * @since 3.0.0 */ - public function addHost(string $alias, string ...$hostnames): void + public function getAllowedMethodsByHost(string $host): array { - $this->hosts[$alias] = $hostnames; + $methods = []; + if (isset($this->routes[$host])) { + foreach ($this->routes[$host] as $route) { + foreach ($route->getMethods() as $method) { + $methods[$method] = $method; + } + } + } + + return empty($methods) ? [] : \array_values($methods); } /** - * Adds the given route(s) to the router + * Gets allowed methods by the given hostname * - * @param RouteInterface ...$routes + * @param string $hostname * - * @return void + * @return list * - * @throws InvalidArgumentException - * if one of the given routes already exists. + * @since 3.0.0 */ - public function addRoute(RouteInterface ...$routes): void + public function getAllowedMethodsByHostname(string $hostname): array { - foreach ($routes as $route) { - $name = $route->getName(); - if (isset($this->routes[$name])) { - throw new InvalidArgumentException(sprintf( - 'The route "%s" already exists.', - $name - )); + $methods = []; + if (isset($this->routes['*'])) { + foreach ($this->routes['*'] as $route) { + foreach ($route->getMethods() as $method) { + $methods[$method] = $method; + } } + } - $this->routes[$name] = $route; + $host = $this->resolveHostname($hostname); + if (isset($host) && isset($this->routes[$host])) { + foreach ($this->routes[$host] as $route) { + foreach ($route->getMethods() as $method) { + $methods[$method] = $method; + } + } } + + return empty($methods) ? [] : \array_values($methods); } /** @@ -310,65 +475,49 @@ public function addMiddleware(MiddlewareInterface ...$middlewares): void } /** - * Sets the given event dispatcher to the router - * - * @param EventDispatcherInterface|null $eventDispatcher - * - * @return void + * Gets the router's middlewares * - * @since 2.13.0 + * @return list */ - public function setEventDispatcher(?EventDispatcherInterface $eventDispatcher): void + public function getMiddlewares(): array { - $this->eventDispatcher = $eventDispatcher; + return $this->middlewares; } /** - * Gets allowed methods + * Gets the router's matched route * - * @return string[] + * @return RouteInterface|null */ - public function getAllowedMethods(): array + public function getMatchedRoute(): ?RouteInterface { - $methods = []; - foreach ($this->routes as $route) { - foreach ($route->getMethods() as $method) { - $methods[$method] = true; - } - } - - return array_keys($methods); + return $this->matchedRoute; } /** - * Checks if a route exists by the given name + * Sets the given event dispatcher to the router * - * @return bool + * @param EventDispatcherInterface|null $eventDispatcher + * + * @return void + * + * @since 2.13.0 */ - public function hasRoute(string $name): bool + public function setEventDispatcher(?EventDispatcherInterface $eventDispatcher): void { - return isset($this->routes[$name]); + $this->eventDispatcher = $eventDispatcher; } /** - * Gets a route for the given name - * - * @param string $name + * Gets the router's event dispatcher * - * @return RouteInterface + * @return EventDispatcherInterface|null * - * @throws RouteNotFoundException + * @since 2.13.0 */ - public function getRoute(string $name): RouteInterface + public function getEventDispatcher(): ?EventDispatcherInterface { - if (!isset($this->routes[$name])) { - throw new RouteNotFoundException(sprintf( - 'No route found for the name "%s".', - $name - )); - } - - return $this->routes[$name]; + return $this->eventDispatcher; } /** @@ -381,7 +530,7 @@ public function getRoute(string $name): RouteInterface * @return string * * @throws RouteNotFoundException - * If the given named route wasn't found. + * If a route wasn't found by the given name. * * @throws Exception\RoutePathBuildException * If a required attribute value is not given, @@ -403,22 +552,26 @@ public function generateUri(string $name, array $attributes = [], bool $strict = * * @return RouteInterface * - * @throws MethodNotAllowedException * @throws PageNotFoundException + * If the request URI cannot be matched against any route. + * + * @throws MethodNotAllowedException + * If the request method isn't allowed. */ public function match(ServerRequestInterface $request): RouteInterface { - $currentUri = $request->getUri(); - $currentHost = $currentUri->getHost(); - $currentPath = $currentUri->getPath(); - $currentMethod = $request->getMethod(); + $requestUri = $request->getUri(); + $requestHost = $requestUri->getHost(); + $requestPath = $requestUri->getPath(); + $requestMethod = $request->getMethod(); $allowedMethods = []; - $currentHostRoutes = $this->getRoutesByHostname($currentHost); - foreach ($currentHostRoutes as $route) { + $routes = $this->getRoutesByHostname($requestHost); + + foreach ($routes as $route) { // https://github.com/sunrise-php/http-router/issues/50 // https://tools.ietf.org/html/rfc7231#section-6.5.5 - if (!path_match($route->getPath(), $currentPath, $attributes)) { + if (!path_match($route->getPath(), $requestPath, $attributes)) { continue; } @@ -428,7 +581,7 @@ public function match(ServerRequestInterface $request): RouteInterface $allowedMethods[$routeMethod] = $routeMethod; } - if (!isset($routeMethods[$currentMethod])) { + if (!isset($routeMethods[$requestMethod])) { continue; } @@ -438,7 +591,7 @@ public function match(ServerRequestInterface $request): RouteInterface } if (!empty($allowedMethods)) { - throw new MethodNotAllowedException($currentMethod, $allowedMethods); + throw new MethodNotAllowedException($requestMethod, $allowedMethods); } throw new PageNotFoundException(); From c0af5575b11817078f2700afad61e95b3f73b3ff Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Wed, 8 Feb 2023 02:22:50 +0100 Subject: [PATCH 055/180] v3 --- src/Loader/ConfigLoader.php | 41 ++++--------------- src/Loader/DescriptorLoader.php | 39 ++++-------------- src/Middleware/CallableMiddleware.php | 17 ++------ .../RequestEntityParameterResolver.php | 9 +++- src/RequestHandler/CallableRequestHandler.php | 16 ++------ src/Route.php | 15 +++---- src/RouteCollector.php | 36 +++------------- src/RouteInterface.php | 4 +- 8 files changed, 46 insertions(+), 131 deletions(-) diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index 809323b3..b00acf26 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -14,10 +14,10 @@ /** * Import classes */ -use Psr\Container\ContainerInterface; use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ParameterResolver\DependencyInjectionParameterResolver; +use Sunrise\Http\Router\ClassResolver; +use Sunrise\Http\Router\ClassResolverInterface; use Sunrise\Http\Router\ParameterResolutioner; use Sunrise\Http\Router\ParameterResolutionerInterface; use Sunrise\Http\Router\ParameterResolverInterface; @@ -85,13 +85,15 @@ final class ConfigLoader implements LoaderInterface * @param ReferenceResolverInterface|null $referenceResolver * @param ParameterResolutionerInterface|null $parameterResolutioner * @param ResponseResolutionerInterface|null $responseResolutioner + * @param ClassResolverInterface|null $classResolver */ public function __construct( ?RouteCollectionFactoryInterface $collectionFactory = null, ?RouteFactoryInterface $routeFactory = null, ?ReferenceResolverInterface $referenceResolver = null, ?ParameterResolutionerInterface $parameterResolutioner = null, - ?ResponseResolutionerInterface $responseResolutioner = null + ?ResponseResolutionerInterface $responseResolutioner = null, + ?ClassResolverInterface $classResolver = null ) { $this->collectionFactory = $collectionFactory ?? new RouteCollectionFactory(); $this->routeFactory = $routeFactory ?? new RouteFactory(); @@ -101,33 +103,8 @@ public function __construct( $this->referenceResolver = $referenceResolver ?? new ReferenceResolver( $this->parameterResolutioner ??= new ParameterResolutioner(), - $this->responseResolutioner ??= new ResponseResolutioner() - ); - } - - /** - * Sets the given container to the parameter resolutioner - * - * @param ContainerInterface $container - * - * @return void - * - * @throws LogicException - * If a custom reference resolver was setted - * and a parameter resolutioner was not passed. - */ - public function setContainer(ContainerInterface $container): void - { - if (!isset($this->parameterResolutioner)) { - throw new LogicException( - 'The config route loader cannot accept the container ' . - 'because a custom reference resolver was setted ' . - 'and a parameter resolutioner was not passed' - ); - } - - $this->parameterResolutioner->addResolver( - new DependencyInjectionParameterResolver($container) + $this->responseResolutioner ??= new ResponseResolutioner(), + $classResolver ?? new ClassResolver($this->parameterResolutioner) ); } @@ -148,7 +125,7 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): { if (!isset($this->parameterResolutioner)) { throw new LogicException( - 'The config route loader cannot accept the parameter resolver ' . + 'The config route loader cannot accept the parameter resolver(s) ' . 'because a custom reference resolver was setted ' . 'and a parameter resolutioner was not passed' ); @@ -174,7 +151,7 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo { if (!isset($this->responseResolutioner)) { throw new LogicException( - 'The config route loader cannot accept the response resolver ' . + 'The config route loader cannot accept the response resolver(s) ' . 'because a custom reference resolver was setted ' . 'and a response resolutioner was not passed' ); diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 554a52c4..c313aaa3 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -14,7 +14,6 @@ /** * Import classes */ -use Psr\Container\ContainerInterface; use Psr\Http\Server\RequestHandlerInterface; use Psr\SimpleCache\CacheInterface; use Sunrise\Http\Router\Annotation\Host; @@ -25,8 +24,9 @@ use Sunrise\Http\Router\Annotation\Tag; use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ParameterResolver\DependencyInjectionParameterResolver; use Sunrise\Http\Router\AnnotationReader; +use Sunrise\Http\Router\ClassResolver; +use Sunrise\Http\Router\ClassResolverInterface; use Sunrise\Http\Router\ParameterResolutioner; use Sunrise\Http\Router\ParameterResolutionerInterface; use Sunrise\Http\Router\ParameterResolverInterface; @@ -118,6 +118,7 @@ final class DescriptorLoader implements LoaderInterface * @param ReferenceResolverInterface|null $referenceResolver * @param ParameterResolutionerInterface|null $parameterResolutioner * @param ResponseResolutionerInterface|null $responseResolutioner + * @param ClassResolverInterface|null $classResolver * @param \Doctrine\Common\Annotations\Reader|null $annotationReader */ public function __construct( @@ -126,6 +127,7 @@ public function __construct( ?ReferenceResolverInterface $referenceResolver = null, ?ParameterResolutionerInterface $parameterResolutioner = null, ?ResponseResolutionerInterface $responseResolutioner = null, + ?ClassResolverInterface $classResolver = null, ?\Doctrine\Common\Annotations\Reader $annotationReader = null ) { $this->collectionFactory = $collectionFactory ?? new RouteCollectionFactory(); @@ -136,7 +138,8 @@ public function __construct( $this->referenceResolver = $referenceResolver ?? new ReferenceResolver( $this->parameterResolutioner ??= new ParameterResolutioner(), - $this->responseResolutioner ??= new ResponseResolutioner() + $this->responseResolutioner ??= new ResponseResolutioner(), + $classResolver ?? new ClassResolver($this->parameterResolutioner) ); $this->annotationReader = new AnnotationReader(); @@ -148,32 +151,6 @@ public function __construct( } } - /** - * Sets the given container to the parameter resolutioner - * - * @param ContainerInterface $container - * - * @return void - * - * @throws LogicException - * If a custom reference resolver was setted - * and a parameter resolutioner was not passed. - */ - public function setContainer(ContainerInterface $container): void - { - if (!isset($this->parameterResolutioner)) { - throw new LogicException( - 'The descriptor route loader cannot accept the container ' . - 'because a custom reference resolver was setted ' . - 'and a parameter resolutioner was not passed' - ); - } - - $this->parameterResolutioner->addResolver( - new DependencyInjectionParameterResolver($container) - ); - } - /** * Adds the given parameter resolver(s) to the parameter resolutioner * @@ -191,7 +168,7 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): { if (!isset($this->parameterResolutioner)) { throw new LogicException( - 'The descriptor route loader cannot accept the parameter resolver ' . + 'The descriptor route loader cannot accept the parameter resolver(s) ' . 'because a custom reference resolver was setted ' . 'and a parameter resolutioner was not passed' ); @@ -217,7 +194,7 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo { if (!isset($this->responseResolutioner)) { throw new LogicException( - 'The descriptor route loader cannot accept the response resolver ' . + 'The descriptor route loader cannot accept the response resolver(s) ' . 'because a custom reference resolver was setted ' . 'and a response resolutioner was not passed' ); diff --git a/src/Middleware/CallableMiddleware.php b/src/Middleware/CallableMiddleware.php index fb2874e7..6b15b442 100644 --- a/src/Middleware/CallableMiddleware.php +++ b/src/Middleware/CallableMiddleware.php @@ -18,6 +18,7 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\ParameterResolver\KnownNameParameterResolver; use Sunrise\Http\Router\ParameterResolver\KnownTypeParameterResolver; use Sunrise\Http\Router\ParameterResolutionerInterface; use Sunrise\Http\Router\ResponseResolutionerInterface; @@ -89,18 +90,6 @@ public function getReflection(): ReflectionFunctionAbstract return reflect_callable($this->callback); } - /** - * Gets the callback's parameters - * - * @return list - * - * @since 3.0.0 - */ - public function getParameters(): array - { - return $this->getReflection()->getParameters(); - } - /** * {@inheritdoc} */ @@ -109,12 +98,14 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface $parameterResolvers = [ new KnownTypeParameterResolver(ServerRequestInterface::class, $request), new KnownTypeParameterResolver(RequestHandlerInterface::class, $handler), + new KnownNameParameterResolver('request', $request), + new KnownNameParameterResolver('handler', $handler), ]; $arguments = $this->parameterResolutioner ->withContext($request) ->withPriorityResolver(...$parameterResolvers) - ->resolveParameters(...$this->getParameters()); + ->resolveParameters(...$this->getReflection()->getParameters()); /** @var mixed */ $response = ($this->callback)(...$arguments); diff --git a/src/ParameterResolver/RequestEntityParameterResolver.php b/src/ParameterResolver/RequestEntityParameterResolver.php index e3215720..ab839bc3 100644 --- a/src/ParameterResolver/RequestEntityParameterResolver.php +++ b/src/ParameterResolver/RequestEntityParameterResolver.php @@ -167,19 +167,24 @@ public function resolveParameter(ReflectionParameter $parameter, $context) */ private function stringifyParameter(ReflectionParameter $parameter): string { + /** @var ReflectionNamedType */ + $parameterType = $parameter->getType(); + if ($parameter->getDeclaringFunction() instanceof ReflectionMethod) { return sprintf( - '%s::%s($%s[%d])', + '%s::%s(%s $%s[%d])', $parameter->getDeclaringFunction()->getDeclaringClass()->getName(), $parameter->getDeclaringFunction()->getName(), + $parameterType->getName(), $parameter->getName(), $parameter->getPosition() ); } return sprintf( - '%s($%s[%d])', + '%s(%s $%s[%d])', $parameter->getDeclaringFunction()->getName(), + $parameterType->getName(), $parameter->getName(), $parameter->getPosition() ); diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index 8ea31019..e94df3c8 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -17,6 +17,7 @@ use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\ParameterResolver\KnownNameParameterResolver; use Sunrise\Http\Router\ParameterResolver\KnownTypeParameterResolver; use Sunrise\Http\Router\ParameterResolutionerInterface; use Sunrise\Http\Router\ResponseResolutionerInterface; @@ -86,18 +87,6 @@ public function getReflection(): ReflectionFunctionAbstract return reflect_callable($this->callback); } - /** - * Gets the callback's parameters - * - * @return list - * - * @since 3.0.0 - */ - public function getParameters(): array - { - return $this->getReflection()->getParameters(); - } - /** * {@inheritdoc} */ @@ -105,12 +94,13 @@ public function handle(ServerRequestInterface $request): ResponseInterface { $parameterResolvers = [ new KnownTypeParameterResolver(ServerRequestInterface::class, $request), + new KnownNameParameterResolver('request', $request), ]; $arguments = $this->parameterResolutioner ->withContext($request) ->withPriorityResolver(...$parameterResolvers) - ->resolveParameters(...$this->getParameters()); + ->resolveParameters(...$this->getReflection()->getParameters()); /** @var mixed */ $response = ($this->callback)(...$arguments); diff --git a/src/Route.php b/src/Route.php index 140d8819..9963cd96 100644 --- a/src/Route.php +++ b/src/Route.php @@ -394,19 +394,20 @@ public function addMiddleware(MiddlewareInterface ...$middlewares): RouteInterfa /** * {@inheritdoc} */ - public function addPriorityMiddleware(MiddlewareInterface ...$priorityMiddlewares): RouteInterface + public function addPriorityMiddleware(MiddlewareInterface ...$middlewares): RouteInterface { - $previousMiddlewares = $this->middlewares; - $this->middlewares = []; + $newValue = []; - foreach ($priorityMiddlewares as $middleware) { - $this->middlewares[] = $middleware; + foreach ($middlewares as $middleware) { + $newValue[] = $middleware; } - foreach ($previousMiddlewares as $middleware) { - $this->middlewares[] = $middleware; + foreach ($this->middlewares as $middleware) { + $newValue[] = $middleware; } + $this->middlewares = $newValue; + return $this; } diff --git a/src/RouteCollector.php b/src/RouteCollector.php index 043fbbda..c6654eef 100644 --- a/src/RouteCollector.php +++ b/src/RouteCollector.php @@ -14,9 +14,7 @@ /** * Import classes */ -use Psr\Container\ContainerInterface; use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ParameterResolver\DependencyInjectionParameterResolver; /** * RouteCollector @@ -70,6 +68,7 @@ class RouteCollector * @param ReferenceResolverInterface|null $referenceResolver * @param ParameterResolutionerInterface|null $parameterResolutioner * @param ResponseResolutionerInterface|null $responseResolutioner + * @param ClassResolverInterface|null $classResolver */ public function __construct( ?RouteCollectionFactoryInterface $collectionFactory = null, @@ -86,7 +85,8 @@ public function __construct( $this->referenceResolver = $referenceResolver ?? new ReferenceResolver( $this->parameterResolutioner ??= new ParameterResolutioner(), - $this->responseResolutioner ??= new ResponseResolutioner() + $this->responseResolutioner ??= new ResponseResolutioner(), + $classResolver ?? new ClassResolver($this->parameterResolutioner) ); $this->collection = $this->collectionFactory->createCollection(); @@ -112,32 +112,6 @@ public function getRoutes(): array return $this->collection->all(); } - /** - * Sets the given container to the parameter resolutioner - * - * @param ContainerInterface $container - * - * @return void - * - * @throws LogicException - * If a custom reference resolver was setted - * and a parameter resolutioner was not passed. - */ - public function setContainer(ContainerInterface $container): void - { - if (!isset($this->parameterResolutioner)) { - throw new LogicException( - 'The route collector cannot accept the container ' . - 'because a custom reference resolver was setted ' . - 'and a parameter resolutioner was not passed' - ); - } - - $this->parameterResolutioner->addResolver( - new DependencyInjectionParameterResolver($container) - ); - } - /** * Adds the given parameter resolver(s) to the parameter resolutioner * @@ -155,7 +129,7 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): { if (!isset($this->parameterResolutioner)) { throw new LogicException( - 'The route collector cannot accept the parameter resolver ' . + 'The route collector cannot accept the parameter resolver(s) ' . 'because a custom reference resolver was setted ' . 'and a parameter resolutioner was not passed' ); @@ -181,7 +155,7 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo { if (!isset($this->responseResolutioner)) { throw new LogicException( - 'The route collector cannot accept the response resolver ' . + 'The route collector cannot accept the response resolver(s) ' . 'because a custom reference resolver was setted ' . 'and a response resolutioner was not passed' ); diff --git a/src/RouteInterface.php b/src/RouteInterface.php index d35b6509..42a7620f 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -273,13 +273,13 @@ public function addMiddleware(MiddlewareInterface ...$middlewares): RouteInterfa /** * Adds the given priority middleware(s) to the route * - * @param MiddlewareInterface ...$priorityMiddlewares + * @param MiddlewareInterface ...$middlewares * * @return RouteInterface * * @since 3.0.0 */ - public function addPriorityMiddleware(MiddlewareInterface ...$priorityMiddlewares): RouteInterface; + public function addPriorityMiddleware(MiddlewareInterface ...$middlewares): RouteInterface; /** * Adds the given tag(s) to the route From e5c9f7d0ea1123588938c7689a737a10bc259d9b Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 9 Feb 2023 01:07:31 +0100 Subject: [PATCH 056/180] v3 --- src/Annotation/Consume.php | 52 +++ src/Annotation/Method.php | 52 +++ src/Annotation/Produce.php | 52 +++ src/Annotation/Route.php | 26 ++ src/AnnotationReader.php | 178 --------- src/Loader/ConfigLoader.php | 25 +- src/Loader/DescriptorLoader.php | 159 +++++--- src/Middleware/CallableMiddleware.php | 13 +- .../JsonPayloadDecodingMiddleware.php | 42 +-- ...er.php => KnownTypedParameterResolver.php} | 33 +- ....php => KnownUntypedParameterResolver.php} | 10 +- .../ServerRequestParameterResolver.php | 66 ++++ src/RequestHandler/CallableRequestHandler.php | 9 +- src/Route.php | 80 ++++ src/RouteCollection.php | 48 +++ src/RouteCollectionInterface.php | 44 +++ src/RouteCollector.php | 31 +- src/RouteInterface.php | 62 +++ src/Router.php | 3 + src/ServerRequest.php | 357 ++++++++++++++++++ 20 files changed, 998 insertions(+), 344 deletions(-) create mode 100644 src/Annotation/Consume.php create mode 100644 src/Annotation/Method.php create mode 100644 src/Annotation/Produce.php delete mode 100644 src/AnnotationReader.php rename src/ParameterResolver/{KnownTypeParameterResolver.php => KnownTypedParameterResolver.php} (63%) rename src/ParameterResolver/{KnownNameParameterResolver.php => KnownUntypedParameterResolver.php} (84%) create mode 100644 src/ParameterResolver/ServerRequestParameterResolver.php create mode 100644 src/ServerRequest.php diff --git a/src/Annotation/Consume.php b/src/Annotation/Consume.php new file mode 100644 index 00000000..7e26f8aa --- /dev/null +++ b/src/Annotation/Consume.php @@ -0,0 +1,52 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Annotation; + +/** + * Import classes + */ +use Attribute; + +/** + * @Annotation + * + * @Target({"CLASS", "METHOD"}) + * + * @NamedArgumentConstructor + * + * @Attributes({ + * @Attribute("value", type="string", required=true), + * }) + * + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS|Attribute::TARGET_METHOD|Attribute::IS_REPEATABLE)] +final class Consume +{ + + /** + * The attribute value + * + * @var string + */ + public string $value; + + /** + * Constructor of the class + * + * @param string $value + */ + public function __construct(string $value) + { + $this->value = $value; + } +} diff --git a/src/Annotation/Method.php b/src/Annotation/Method.php new file mode 100644 index 00000000..e6ff17f2 --- /dev/null +++ b/src/Annotation/Method.php @@ -0,0 +1,52 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Annotation; + +/** + * Import classes + */ +use Attribute; + +/** + * @Annotation + * + * @Target({"CLASS", "METHOD"}) + * + * @NamedArgumentConstructor + * + * @Attributes({ + * @Attribute("value", type="string", required=true), + * }) + * + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS|Attribute::TARGET_METHOD|Attribute::IS_REPEATABLE)] +final class Method +{ + + /** + * The attribute value + * + * @var string + */ + public string $value; + + /** + * Constructor of the class + * + * @param string $value + */ + public function __construct(string $value) + { + $this->value = $value; + } +} diff --git a/src/Annotation/Produce.php b/src/Annotation/Produce.php new file mode 100644 index 00000000..16be685c --- /dev/null +++ b/src/Annotation/Produce.php @@ -0,0 +1,52 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Annotation; + +/** + * Import classes + */ +use Attribute; + +/** + * @Annotation + * + * @Target({"CLASS", "METHOD"}) + * + * @NamedArgumentConstructor + * + * @Attributes({ + * @Attribute("value", type="string", required=true), + * }) + * + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS|Attribute::TARGET_METHOD|Attribute::IS_REPEATABLE)] +final class Produce +{ + + /** + * The attribute value + * + * @var string + */ + public string $value; + + /** + * Constructor of the class + * + * @param string $value + */ + public function __construct(string $value) + { + $this->value = $value; + } +} diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index 9f0d25f4..2250b5c8 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -31,6 +31,8 @@ * @Attribute("path", type="string", required=true), * @Attribute("method", type="string"), * @Attribute("methods", type="array"), + * @Attribute("consumes", type="array"), + * @Attribute("produces", type="array"), * @Attribute("middlewares", type="array"), * @Attribute("attributes", type="array"), * @Attribute("summary", type="string"), @@ -80,6 +82,24 @@ final class Route implements RequestMethodInterface */ public array $methods; + /** + * The route's consumed content types + * + * @var list + * + * @since 3.0.0 + */ + public array $consumes; + + /** + * The route's produced content types + * + * @var list + * + * @since 3.0.0 + */ + public array $produces; + /** * The route middlewares * @@ -130,6 +150,8 @@ final class Route implements RequestMethodInterface * @param string $path The route path * @param string|null $method The route method * @param list $methods The route methods + * @param list $consumes The route's consumed content types + * @param list $produces The route's produced content types * @param list> $middlewares The route middlewares * @param array $attributes The route attributes * @param string $summary The route summary @@ -143,6 +165,8 @@ public function __construct( string $path = '/', ?string $method = null, array $methods = [], + array $consumes = [], + array $produces = [], array $middlewares = [], array $attributes = [], string $summary = '', @@ -164,6 +188,8 @@ public function __construct( $this->host = $host; $this->path = $path; $this->methods = $methods; + $this->consumes = $consumes; + $this->produces = $produces; $this->middlewares = $middlewares; $this->attributes = $attributes; $this->summary = $summary; diff --git a/src/AnnotationReader.php b/src/AnnotationReader.php deleted file mode 100644 index f20c850d..00000000 --- a/src/AnnotationReader.php +++ /dev/null @@ -1,178 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router; - -/** - * Import classes - */ -use Sunrise\Http\Router\Exception\InvalidArgumentException; -use Sunrise\Http\Router\Exception\LogicException; -use ReflectionAttribute; -use ReflectionClass; -use ReflectionMethod; -use Reflector; - -/** - * Import functions - */ -use function class_exists; -use function sprintf; - -/** - * Import constants - */ -use const PHP_MAJOR_VERSION; - -/** - * AnnotationReader - * - * @since 3.0.0 - */ -final class AnnotationReader -{ - - /** - * @var \Doctrine\Common\Annotations\Reader|null - */ - private ?\Doctrine\Common\Annotations\Reader $annotationReader = null; - - /** - * Sets the given annotation reader to the reader - * - * @param \Doctrine\Common\Annotations\Reader|null $annotationReader - * - * @return void - */ - public function setAnnotationReader(?\Doctrine\Common\Annotations\Reader $annotationReader): void - { - $this->annotationReader = $annotationReader; - } - - /** - * Uses the default annotation reader - * - * @return void - * - * @throws LogicException - * If the "doctrine/annotations" package isn't installed. - */ - public function useDefaultAnnotationReader(): void - { - if (!class_exists(\Doctrine\Common\Annotations\AnnotationReader::class)) { - throw new LogicException( - 'The annotations reading logic requires an uninstalled "doctrine/annotations" package, ' . - 'run the command "composer install doctrine/annotations" and try again' - ); - } - - $this->setAnnotationReader(new \Doctrine\Common\Annotations\AnnotationReader()); - } - - /** - * Gets annotations from the given class or method by the given annotation name - * - * @param Reflector $classOrMethod - * @param class-string $annotationName - * - * @return list - * - * @throws InvalidArgumentException - * If the given reflection isn't supported. - * - * @template T - */ - public function getClassOrMethodAnnotations(Reflector $classOrMethod, string $annotationName): array - { - if ($classOrMethod instanceof ReflectionClass) { - return $this->getClassAnnotations($classOrMethod, $annotationName); - } - - if ($classOrMethod instanceof ReflectionMethod) { - return $this->getMethodAnnotations($classOrMethod, $annotationName); - } - - throw new InvalidArgumentException(sprintf( - 'The %s method only handles class or method reflection', - __METHOD__ - )); - } - - /** - * Gets annotations from the given class by the given annotation name - * - * @param ReflectionClass $class - * @param class-string $annotationName - * - * @return list - * - * @template T - */ - public function getClassAnnotations(ReflectionClass $class, string $annotationName): array - { - $result = []; - - if (PHP_MAJOR_VERSION === 8) { - /** @var ReflectionAttribute[] */ - $attributes = $class->getAttributes($annotationName); - foreach ($attributes as $attribute) { - /** @var T */ - $result[] = $attribute->newInstance(); - } - } - - if (isset($this->annotationReader)) { - $annotations = $this->annotationReader->getClassAnnotations($class); - foreach ($annotations as $annotation) { - if ($annotation instanceof $annotationName) { - $result[] = $annotation; - } - } - } - - return $result; - } - - /** - * Gets annotations from the given method by the given annotation name - * - * @param ReflectionMethod $method - * @param class-string $annotationName - * - * @return list - * - * @template T - */ - public function getMethodAnnotations(ReflectionMethod $method, string $annotationName): array - { - $result = []; - - if (PHP_MAJOR_VERSION === 8) { - /** @var ReflectionAttribute[] */ - $attributes = $method->getAttributes($annotationName); - foreach ($attributes as $attribute) { - /** @var T */ - $result[] = $attribute->newInstance(); - } - } - - if (isset($this->annotationReader)) { - $annotations = $this->annotationReader->getMethodAnnotations($method); - foreach ($annotations as $annotation) { - if ($annotation instanceof $annotationName) { - $result[] = $annotation; - } - } - } - - return $result; - } -} diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index b00acf26..b746a240 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -16,8 +16,6 @@ */ use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ClassResolver; -use Sunrise\Http\Router\ClassResolverInterface; use Sunrise\Http\Router\ParameterResolutioner; use Sunrise\Http\Router\ParameterResolutionerInterface; use Sunrise\Http\Router\ParameterResolverInterface; @@ -70,12 +68,12 @@ final class ConfigLoader implements LoaderInterface /** * @var ParameterResolutionerInterface|null */ - private ?ParameterResolutionerInterface $parameterResolutioner = null; + private ?ParameterResolutionerInterface $parameterResolutioner; /** * @var ResponseResolutionerInterface|null */ - private ?ResponseResolutionerInterface $responseResolutioner = null; + private ?ResponseResolutionerInterface $responseResolutioner; /** * Constructor of the class @@ -85,15 +83,13 @@ final class ConfigLoader implements LoaderInterface * @param ReferenceResolverInterface|null $referenceResolver * @param ParameterResolutionerInterface|null $parameterResolutioner * @param ResponseResolutionerInterface|null $responseResolutioner - * @param ClassResolverInterface|null $classResolver */ public function __construct( ?RouteCollectionFactoryInterface $collectionFactory = null, ?RouteFactoryInterface $routeFactory = null, ?ReferenceResolverInterface $referenceResolver = null, ?ParameterResolutionerInterface $parameterResolutioner = null, - ?ResponseResolutionerInterface $responseResolutioner = null, - ?ClassResolverInterface $classResolver = null + ?ResponseResolutionerInterface $responseResolutioner = null ) { $this->collectionFactory = $collectionFactory ?? new RouteCollectionFactory(); $this->routeFactory = $routeFactory ?? new RouteFactory(); @@ -103,8 +99,7 @@ public function __construct( $this->referenceResolver = $referenceResolver ?? new ReferenceResolver( $this->parameterResolutioner ??= new ParameterResolutioner(), - $this->responseResolutioner ??= new ResponseResolutioner(), - $classResolver ?? new ClassResolver($this->parameterResolutioner) + $this->responseResolutioner ??= new ResponseResolutioner() ); } @@ -116,8 +111,7 @@ public function __construct( * @return void * * @throws LogicException - * If a custom reference resolver was setted - * and a parameter resolutioner was not passed. + * If a custom reference resolver was setted and a parameter resolutioner wasn't passed. * * @since 3.0.0 */ @@ -126,8 +120,7 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): if (!isset($this->parameterResolutioner)) { throw new LogicException( 'The config route loader cannot accept the parameter resolver(s) ' . - 'because a custom reference resolver was setted ' . - 'and a parameter resolutioner was not passed' + 'because a custom reference resolver was setted and a parameter resolutioner was not passed' ); } @@ -142,8 +135,7 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): * @return void * * @throws LogicException - * If a custom reference resolver was setted - * and a response resolutioner was not passed. + * If a custom reference resolver was setted and a response resolutioner wasn't passed. * * @since 3.0.0 */ @@ -152,8 +144,7 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo if (!isset($this->responseResolutioner)) { throw new LogicException( 'The config route loader cannot accept the response resolver(s) ' . - 'because a custom reference resolver was setted ' . - 'and a response resolutioner was not passed' + 'because a custom reference resolver was setted and a response resolutioner was not passed' ); } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index c313aaa3..51c5b896 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -14,19 +14,21 @@ /** * Import classes */ +use Doctrine\Common\Annotations\AnnotationReader; +use Doctrine\Common\Annotations\Reader as AnnotationReaderInterface; use Psr\Http\Server\RequestHandlerInterface; use Psr\SimpleCache\CacheInterface; +use Sunrise\Http\Router\Annotation\Consume; use Sunrise\Http\Router\Annotation\Host; +use Sunrise\Http\Router\Annotation\Method; use Sunrise\Http\Router\Annotation\Middleware; use Sunrise\Http\Router\Annotation\Postfix; use Sunrise\Http\Router\Annotation\Prefix; +use Sunrise\Http\Router\Annotation\Produce; use Sunrise\Http\Router\Annotation\Route; use Sunrise\Http\Router\Annotation\Tag; use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\AnnotationReader; -use Sunrise\Http\Router\ClassResolver; -use Sunrise\Http\Router\ClassResolverInterface; use Sunrise\Http\Router\ParameterResolutioner; use Sunrise\Http\Router\ParameterResolutionerInterface; use Sunrise\Http\Router\ParameterResolverInterface; @@ -40,6 +42,7 @@ use Sunrise\Http\Router\RouteCollectionInterface; use Sunrise\Http\Router\RouteFactory; use Sunrise\Http\Router\RouteFactoryInterface; +use ReflectionAttribute; use ReflectionClass; use ReflectionMethod; use Reflector; @@ -88,17 +91,17 @@ final class DescriptorLoader implements LoaderInterface /** * @var ParameterResolutionerInterface|null */ - private ?ParameterResolutionerInterface $parameterResolutioner = null; + private ?ParameterResolutionerInterface $parameterResolutioner; /** * @var ResponseResolutionerInterface|null */ - private ?ResponseResolutionerInterface $responseResolutioner = null; + private ?ResponseResolutionerInterface $responseResolutioner; /** - * @var AnnotationReader + * @var AnnotationReaderInterface|null */ - private AnnotationReader $annotationReader; + private ?AnnotationReaderInterface $annotationReader = null; /** * @var CacheInterface|null @@ -118,17 +121,13 @@ final class DescriptorLoader implements LoaderInterface * @param ReferenceResolverInterface|null $referenceResolver * @param ParameterResolutionerInterface|null $parameterResolutioner * @param ResponseResolutionerInterface|null $responseResolutioner - * @param ClassResolverInterface|null $classResolver - * @param \Doctrine\Common\Annotations\Reader|null $annotationReader */ public function __construct( ?RouteCollectionFactoryInterface $collectionFactory = null, ?RouteFactoryInterface $routeFactory = null, ?ReferenceResolverInterface $referenceResolver = null, ?ParameterResolutionerInterface $parameterResolutioner = null, - ?ResponseResolutionerInterface $responseResolutioner = null, - ?ClassResolverInterface $classResolver = null, - ?\Doctrine\Common\Annotations\Reader $annotationReader = null + ?ResponseResolutionerInterface $responseResolutioner = null ) { $this->collectionFactory = $collectionFactory ?? new RouteCollectionFactory(); $this->routeFactory = $routeFactory ?? new RouteFactory(); @@ -138,17 +137,8 @@ public function __construct( $this->referenceResolver = $referenceResolver ?? new ReferenceResolver( $this->parameterResolutioner ??= new ParameterResolutioner(), - $this->responseResolutioner ??= new ResponseResolutioner(), - $classResolver ?? new ClassResolver($this->parameterResolutioner) + $this->responseResolutioner ??= new ResponseResolutioner() ); - - $this->annotationReader = new AnnotationReader(); - - if (isset($annotationReader)) { - $this->annotationReader->setAnnotationReader($annotationReader); - } elseif (PHP_MAJOR_VERSION < 8) { - $this->annotationReader->useDefaultAnnotationReader(); - } } /** @@ -159,8 +149,7 @@ public function __construct( * @return void * * @throws LogicException - * If a custom reference resolver was setted - * and a parameter resolutioner was not passed. + * If a custom reference resolver was setted and a parameter resolutioner wasn't passed. * * @since 3.0.0 */ @@ -169,8 +158,7 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): if (!isset($this->parameterResolutioner)) { throw new LogicException( 'The descriptor route loader cannot accept the parameter resolver(s) ' . - 'because a custom reference resolver was setted ' . - 'and a parameter resolutioner was not passed' + 'because a custom reference resolver was setted and a parameter resolutioner was not passed' ); } @@ -185,8 +173,7 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): * @return void * * @throws LogicException - * If a custom reference resolver was setted - * and a response resolutioner was not passed. + * If a custom reference resolver was setted and a response resolutioner wasn't passed. * * @since 3.0.0 */ @@ -195,8 +182,7 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo if (!isset($this->responseResolutioner)) { throw new LogicException( 'The descriptor route loader cannot accept the response resolver(s) ' . - 'because a custom reference resolver was setted ' . - 'and a response resolutioner was not passed' + 'because a custom reference resolver was setted and a response resolutioner was not passed' ); } @@ -204,29 +190,39 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo } /** - * Sets the given annotation reader to the descriptor loader - * - * @param \Doctrine\Common\Annotations\Reader|null $annotationReader + * Uses the default annotation reader * * @return void * + * @throws LogicException + * If the "doctrine/annotations" package isn't installed. + * * @since 3.0.0 */ - public function setAnnotationReader(?\Doctrine\Common\Annotations\Reader $annotationReader): void + public function useDefaultAnnotationReader(): void { - $this->annotationReader->setAnnotationReader($annotationReader); + if (!class_exists(AnnotationReader::class)) { + throw new LogicException( + 'The annotations reading logic requires an uninstalled "doctrine/annotations" package, ' . + 'run the following command "composer install doctrine/annotations" and try again' + ); + } + + $this->annotationReader = new AnnotationReader(); } /** - * Uses the default annotation reader + * Sets the given annotation reader to the loader + * + * @param AnnotationReaderInterface|null $annotationReader * * @return void * * @since 3.0.0 */ - public function useDefaultAnnotationReader(): void + public function setAnnotationReader(?AnnotationReaderInterface $annotationReader): void { - $this->annotationReader->useDefaultAnnotationReader(); + $this->annotationReader = $annotationReader; } /** @@ -325,24 +321,28 @@ public function attachArray(array $resources): void */ public function load(): RouteCollectionInterface { - $routes = []; + $routes = $this->collectionFactory->createCollection(); + $descriptors = $this->getDescriptors(); foreach ($descriptors as $descriptor) { - $routes[] = $this->routeFactory->createRoute( + $route = $this->routeFactory->createRoute( $descriptor->name, $descriptor->path, $descriptor->methods, $this->referenceResolver->resolveRequestHandler($descriptor->holder), $this->referenceResolver->resolveMiddlewares($descriptor->middlewares), $descriptor->attributes - ) - ->setHost($descriptor->host) - ->setSummary($descriptor->summary) - ->setDescription($descriptor->description) - ->setTags(...$descriptor->tags); + ); + + $route->setHost($descriptor->host); + $route->setSummary($descriptor->summary); + $route->setDescription($descriptor->description); + $route->setTags(...$descriptor->tags); + + $routes->add($route); } - return $this->collectionFactory->createCollection(...$routes); + return $routes; } /** @@ -402,7 +402,7 @@ private function getClassDescriptors(ReflectionClass $class): array $result = []; if ($class->isSubclassOf(RequestHandlerInterface::class)) { - $annotations = $this->annotationReader->getClassAnnotations($class, Route::class); + $annotations = $this->getClassOrMethodAnnotations($class, Route::class); if (isset($annotations[0])) { $descriptor = $annotations[0]; $descriptor->holder = $class->getName(); @@ -417,7 +417,7 @@ private function getClassDescriptors(ReflectionClass $class): array continue; } - $annotations = $this->annotationReader->getMethodAnnotations($method, Route::class); + $annotations = $this->getClassOrMethodAnnotations($method, Route::class); if (isset($annotations[0])) { $descriptor = $annotations[0]; $descriptor->holder = [$class->getName(), $method->getName()]; @@ -430,6 +430,44 @@ private function getClassDescriptors(ReflectionClass $class): array return $result; } + /** + * Gets annotations from the given class or method + * + * @param ReflectionClass|ReflectionMethod $classOrMethod + * @param class-string $annotationName + * + * @return list + * + * @template T + */ + private function getClassOrMethodAnnotations(Reflector $classOrMethod, string $annotationName): array + { + $result = []; + + if (PHP_MAJOR_VERSION === 8) { + /** @var ReflectionAttribute[] */ + $attributes = $classOrMethod->getAttributes($annotationName); + foreach ($attributes as $attribute) { + /** @var T */ + $result[] = $attribute->newInstance(); + } + } + + if (isset($this->annotationReader)) { + $annotations = ($classOrMethod instanceof ReflectionClass) ? + $this->annotationReader->getClassAnnotations($classOrMethod) : + $this->annotationReader->getMethodAnnotations($classOrMethod); + + foreach ($annotations as $annotation) { + if ($annotation instanceof $annotationName) { + $result[] = $annotation; + } + } + } + + return $result; + } + /** * Supplements the given descriptor from the given class or method * @@ -440,27 +478,42 @@ private function getClassDescriptors(ReflectionClass $class): array */ private function supplementDescriptor(Route $descriptor, Reflector $classOrMethod): void { - $annotations = $this->annotationReader->getClassOrMethodAnnotations($classOrMethod, Host::class); + $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Host::class); if (isset($annotations[0])) { $descriptor->host = $annotations[0]->value; } - $annotations = $this->annotationReader->getClassOrMethodAnnotations($classOrMethod, Prefix::class); + $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Prefix::class); if (isset($annotations[0])) { $descriptor->path = $annotations[0]->value . $descriptor->path; } - $annotations = $this->annotationReader->getClassOrMethodAnnotations($classOrMethod, Postfix::class); + $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Postfix::class); if (isset($annotations[0])) { $descriptor->path = $descriptor->path . $annotations[0]->value; } - $annotations = $this->annotationReader->getClassOrMethodAnnotations($classOrMethod, Middleware::class); + $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Method::class); + foreach ($annotations as $annotation) { + $descriptor->methods[] = $annotation->value; + } + + $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Consume::class); + foreach ($annotations as $annotation) { + $descriptor->consumes[] = $annotation->value; + } + + $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Produce::class); + foreach ($annotations as $annotation) { + $descriptor->produces[] = $annotation->value; + } + + $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Middleware::class); foreach ($annotations as $annotation) { $descriptor->middlewares[] = $annotation->value; } - $annotations = $this->annotationReader->getClassOrMethodAnnotations($classOrMethod, Tag::class); + $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Tag::class); foreach ($annotations as $annotation) { $descriptor->tags[] = $annotation->value; } diff --git a/src/Middleware/CallableMiddleware.php b/src/Middleware/CallableMiddleware.php index 6b15b442..0e2e5502 100644 --- a/src/Middleware/CallableMiddleware.php +++ b/src/Middleware/CallableMiddleware.php @@ -18,14 +18,13 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\ParameterResolver\KnownNameParameterResolver; -use Sunrise\Http\Router\ParameterResolver\KnownTypeParameterResolver; +use Sunrise\Http\Router\ParameterResolver\KnownTypedParameterResolver; +use Sunrise\Http\Router\ParameterResolver\KnownUntypedParameterResolver; use Sunrise\Http\Router\ParameterResolutionerInterface; use Sunrise\Http\Router\ResponseResolutionerInterface; use ReflectionFunctionAbstract; use ReflectionFunction; use ReflectionMethod; -use ReflectionParameter; /** * Import functions @@ -96,10 +95,10 @@ public function getReflection(): ReflectionFunctionAbstract public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { $parameterResolvers = [ - new KnownTypeParameterResolver(ServerRequestInterface::class, $request), - new KnownTypeParameterResolver(RequestHandlerInterface::class, $handler), - new KnownNameParameterResolver('request', $request), - new KnownNameParameterResolver('handler', $handler), + new KnownTypedParameterResolver(ServerRequestInterface::class, $request), + new KnownUntypedParameterResolver('request', $request), + new KnownTypedParameterResolver(RequestHandlerInterface::class, $handler), + new KnownUntypedParameterResolver('handler', $handler), ]; $arguments = $this->parameterResolutioner diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 2bf508bb..4e12e4a2 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -19,6 +19,7 @@ use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Exception\InvalidRequestPayloadException; +use Sunrise\Http\Router\ServerRequest; use JsonException; /** @@ -27,9 +28,6 @@ use function is_array; use function json_decode; use function sprintf; -use function strpos; -use function strstr; -use function trim; /** * Import constants @@ -52,10 +50,8 @@ final class JsonPayloadDecodingMiddleware implements MiddlewareInterface public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { if ($this->supportsRequest($request)) { - return $handler->handle( - $request->withParsedBody( - $this->decodeRequestPayload($request) - ) + $request = $request->withParsedBody( + $this->decodeRequestPayload($request) ); } @@ -65,42 +61,17 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface /** * Checks if the given request is supported * - * @link https://datatracker.ietf.org/doc/html/rfc4627 - * * @param ServerRequestInterface $request * * @return bool */ private function supportsRequest(ServerRequestInterface $request): bool { - return $this->getRequestMediaType($request) === 'application/json'; - } - - /** - * Gets a media type from the given request - * - * Returns null if a media type cannot be retrieved. - * - * @link https://tools.ietf.org/html/rfc7231#section-3.1.1.1 - * - * @param ServerRequestInterface $request - * - * @return string|null - */ - private function getRequestMediaType(ServerRequestInterface $request): ?string - { - if (!$request->hasHeader('Content-Type')) { - return null; - } - - // type "/" subtype *( OWS ";" OWS parameter ) - $mediaType = $request->getHeaderLine('Content-Type'); - - if (false !== strpos($mediaType, ';')) { - $mediaType = strstr($mediaType, ';', true); + if (!($request instanceof ServerRequest)) { + $request = new ServerRequest($request); } - return trim($mediaType); + return $request->isJson(); } /** @@ -125,6 +96,7 @@ private function decodeRequestPayload(ServerRequestInterface $request): ?array throw new InvalidRequestPayloadException(sprintf('Invalid Payload: %s', $e->getMessage()), 0, $e); } + // according to PSR-7 the parsed body can be only an array or an object... return is_array($result) ? $result : null; } } diff --git a/src/ParameterResolver/KnownTypeParameterResolver.php b/src/ParameterResolver/KnownTypedParameterResolver.php similarity index 63% rename from src/ParameterResolver/KnownTypeParameterResolver.php rename to src/ParameterResolver/KnownTypedParameterResolver.php index 574b0329..59a42f3d 100644 --- a/src/ParameterResolver/KnownTypeParameterResolver.php +++ b/src/ParameterResolver/KnownTypedParameterResolver.php @@ -14,23 +14,16 @@ /** * Import classes */ -use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\ParameterResolverInterface; use ReflectionNamedType; use ReflectionParameter; /** - * Import classes - */ -use function get_class; -use function sprintf; - -/** - * KnownTypeParameterResolver + * KnownTypedParameterResolver * * @since 3.0.0 */ -final class KnownTypeParameterResolver implements ParameterResolverInterface +final class KnownTypedParameterResolver implements ParameterResolverInterface { /** @@ -46,21 +39,9 @@ final class KnownTypeParameterResolver implements ParameterResolverInterface /** * @param class-string $type * @param object $value - * - * @throws InvalidArgumentException - * If the given value is not an instance of the given type. */ public function __construct(string $type, object $value) { - if (!($value instanceof $type)) { - throw new InvalidArgumentException(sprintf( - 'The known type parameter resolver cannot accept the value "%s" ' . - 'because it is not an instance of the "%s"', - get_class($value), - $type - )); - } - $this->type = $type; $this->value = $value; } @@ -74,7 +55,15 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo return false; } - return $this->type === $parameter->getType()->getName(); + if ($parameter->getType()->isBuiltin()) { + return false; + } + + if (!($parameter->getType()->getName() === $this->type)) { + return false; + } + + return true; } /** diff --git a/src/ParameterResolver/KnownNameParameterResolver.php b/src/ParameterResolver/KnownUntypedParameterResolver.php similarity index 84% rename from src/ParameterResolver/KnownNameParameterResolver.php rename to src/ParameterResolver/KnownUntypedParameterResolver.php index 58f65db2..34c3ffe9 100644 --- a/src/ParameterResolver/KnownNameParameterResolver.php +++ b/src/ParameterResolver/KnownUntypedParameterResolver.php @@ -18,11 +18,11 @@ use ReflectionParameter; /** - * KnownNameParameterResolver + * KnownUntypedParameterResolver * * @since 3.0.0 */ -final class KnownNameParameterResolver implements ParameterResolverInterface +final class KnownUntypedParameterResolver implements ParameterResolverInterface { /** @@ -54,7 +54,11 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo return false; } - return $this->name === $parameter->getName(); + if (!($parameter->getName() === $this->name)) { + return false; + } + + return true; } /** diff --git a/src/ParameterResolver/ServerRequestParameterResolver.php b/src/ParameterResolver/ServerRequestParameterResolver.php new file mode 100644 index 00000000..f02d9b17 --- /dev/null +++ b/src/ParameterResolver/ServerRequestParameterResolver.php @@ -0,0 +1,66 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\ParameterResolver; + +/** + * Import classes + */ +use Psr\Http\Message\ServerRequestInterface; +use Sunrise\Http\Router\ParameterResolverInterface; +use Sunrise\Http\Router\ServerRequest; +use ReflectionNamedType; +use ReflectionParameter; + +/** + * ServerRequestParameterResolver + * + * @since 3.0.0 + */ +final class ServerRequestParameterResolver implements ParameterResolverInterface +{ + + /** + * {@inheritdoc} + */ + public function supportsParameter(ReflectionParameter $parameter, $context): bool + { + if (!($context instanceof ServerRequestInterface)) { + return false; + } + + if (!($parameter->getType() instanceof ReflectionNamedType)) { + return false; + } + + if (!($parameter->getType()->getName() === ServerRequest::class)) { + return false; + } + + return true; + } + + /** + * {@inheritdoc} + */ + public function resolveParameter(ReflectionParameter $parameter, $context) + { + /** @var ServerRequestInterface */ + $context = $context; + + if ($context instanceof ServerRequest) { + return $context; + } + + return new ServerRequest($context); + } +} + diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index e94df3c8..f655b6b4 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -17,14 +17,13 @@ use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\ParameterResolver\KnownNameParameterResolver; -use Sunrise\Http\Router\ParameterResolver\KnownTypeParameterResolver; +use Sunrise\Http\Router\ParameterResolver\KnownTypedParameterResolver; +use Sunrise\Http\Router\ParameterResolver\KnownUntypedParameterResolver; use Sunrise\Http\Router\ParameterResolutionerInterface; use Sunrise\Http\Router\ResponseResolutionerInterface; use ReflectionFunctionAbstract; use ReflectionFunction; use ReflectionMethod; -use ReflectionParameter; /** * Import functions @@ -93,8 +92,8 @@ public function getReflection(): ReflectionFunctionAbstract public function handle(ServerRequestInterface $request): ResponseInterface { $parameterResolvers = [ - new KnownTypeParameterResolver(ServerRequestInterface::class, $request), - new KnownNameParameterResolver('request', $request), + new KnownTypedParameterResolver(ServerRequestInterface::class, $request), + new KnownUntypedParameterResolver('request', $request), ]; $arguments = $this->parameterResolutioner diff --git a/src/Route.php b/src/Route.php index 9963cd96..47a86167 100644 --- a/src/Route.php +++ b/src/Route.php @@ -65,6 +65,20 @@ class Route implements RouteInterface */ private array $methods = []; + /** + * The route's consumed content types + * + * @var list + */ + private array $consumedContentTypes = []; + + /** + * The route's produced content types + * + * @var list + */ + private array $producedContentTypes = []; + /** * The route request handler * @@ -165,6 +179,22 @@ public function getMethods(): array return $this->methods; } + /** + * {@inheritdoc} + */ + public function getConsumedContentTypes(): array + { + return $this->consumedContentTypes; + } + + /** + * {@inheritdoc} + */ + public function getProducedContentTypes(): array + { + return $this->producedContentTypes; + } + /** * {@inheritdoc} */ @@ -268,6 +298,32 @@ public function setMethods(string ...$methods): RouteInterface return $this; } + /** + * {@inheritdoc} + */ + public function setConsumedContentTypes(string ...$contentTypes): RouteInterface + { + $this->consumedContentTypes = []; + foreach ($contentTypes as $contentType) { + $this->consumedContentTypes[] = $contentType; + } + + return $this; + } + + /** + * {@inheritdoc} + */ + public function setProducedContentTypes(string ...$contentTypes): RouteInterface + { + $this->producedContentTypes = []; + foreach ($contentTypes as $contentType) { + $this->producedContentTypes[] = $contentType; + } + + return $this; + } + /** * {@inheritdoc} */ @@ -379,6 +435,30 @@ public function addMethod(string ...$methods): RouteInterface return $this; } + /** + * {@inheritdoc} + */ + public function addConsumedContentType(string ...$contentTypes): RouteInterface + { + foreach ($contentTypes as $contentType) { + $this->consumedContentTypes[] = $contentType; + } + + return $this; + } + + /** + * {@inheritdoc} + */ + public function addProducedContentType(string ...$contentTypes): RouteInterface + { + foreach ($contentTypes as $contentType) { + $this->producedContentTypes[] = $contentType; + } + + return $this; + } + /** * {@inheritdoc} */ diff --git a/src/RouteCollection.php b/src/RouteCollection.php index c84cb11e..37bc8165 100644 --- a/src/RouteCollection.php +++ b/src/RouteCollection.php @@ -99,6 +99,30 @@ public function setHost(string $host): RouteCollectionInterface return $this; } + /** + * {@inheritdoc} + */ + public function setConsumedContentTypes(string ...$contentTypes): RouteCollectionInterface + { + foreach ($this->routes as $route) { + $route->setConsumedContentTypes(...$contentTypes); + } + + return $this; + } + + /** + * {@inheritdoc} + */ + public function setProducedContentTypes(string ...$contentTypes): RouteCollectionInterface + { + foreach ($this->routes as $route) { + $route->setProducedContentTypes(...$contentTypes); + } + + return $this; + } + /** * {@inheritdoc} */ @@ -147,6 +171,30 @@ public function addMethod(string ...$methods): RouteCollectionInterface return $this; } + /** + * {@inheritdoc} + */ + public function addConsumedContentType(string ...$contentTypes): RouteCollectionInterface + { + foreach ($this->routes as $route) { + $route->addConsumedContentType(...$contentTypes); + } + + return $this; + } + + /** + * {@inheritdoc} + */ + public function addProducedContentType(string ...$contentTypes): RouteCollectionInterface + { + foreach ($this->routes as $route) { + $route->addProducedContentType(...$contentTypes); + } + + return $this; + } + /** * {@inheritdoc} */ diff --git a/src/RouteCollectionInterface.php b/src/RouteCollectionInterface.php index 5b00c533..9809a0d7 100644 --- a/src/RouteCollectionInterface.php +++ b/src/RouteCollectionInterface.php @@ -72,6 +72,28 @@ public function add(RouteInterface ...$routes): RouteCollectionInterface; */ public function setHost(string $host): RouteCollectionInterface; + /** + * Sets the given consumed content type(s) to all routes in the collection + * + * @param string ...$contentTypes + * + * @return RouteCollectionInterface + * + * @since 3.0.0 + */ + public function setConsumedContentTypes(string ...$contentTypes): RouteCollectionInterface; + + /** + * Sets the given produced content type(s) to all routes in the collection + * + * @param string ...$contentTypes + * + * @return RouteCollectionInterface + * + * @since 3.0.0 + */ + public function setProducedContentTypes(string ...$contentTypes): RouteCollectionInterface; + /** * Sets the given attribute to all routes in the collection * @@ -117,6 +139,28 @@ public function addSuffix(string $suffix): RouteCollectionInterface; */ public function addMethod(string ...$methods): RouteCollectionInterface; + /** + * Adds the given consumed content type(s) to all routes in the collection + * + * @param string ...$contentTypes + * + * @return RouteCollectionInterface + * + * @since 3.0.0 + */ + public function addConsumedContentType(string ...$contentTypes): RouteCollectionInterface; + + /** + * Adds the given produced content type(s) to all routes in the collection + * + * @param string ...$contentTypes + * + * @return RouteCollectionInterface + * + * @since 3.0.0 + */ + public function addProducedContentType(string ...$contentTypes): RouteCollectionInterface; + /** * Adds the given middleware(s) to all routes in the collection * diff --git a/src/RouteCollector.php b/src/RouteCollector.php index c6654eef..e4fd9912 100644 --- a/src/RouteCollector.php +++ b/src/RouteCollector.php @@ -53,13 +53,12 @@ class RouteCollector /** * @var ParameterResolutionerInterface|null */ - private ?ParameterResolutionerInterface $parameterResolutioner = null; + private ?ParameterResolutionerInterface $parameterResolutioner; /** * @var ResponseResolutionerInterface|null */ - private ?ResponseResolutionerInterface $responseResolutioner = null; - + private ?ResponseResolutionerInterface $responseResolutioner; /** * Constructor of the class * @@ -68,7 +67,6 @@ class RouteCollector * @param ReferenceResolverInterface|null $referenceResolver * @param ParameterResolutionerInterface|null $parameterResolutioner * @param ResponseResolutionerInterface|null $responseResolutioner - * @param ClassResolverInterface|null $classResolver */ public function __construct( ?RouteCollectionFactoryInterface $collectionFactory = null, @@ -85,8 +83,7 @@ public function __construct( $this->referenceResolver = $referenceResolver ?? new ReferenceResolver( $this->parameterResolutioner ??= new ParameterResolutioner(), - $this->responseResolutioner ??= new ResponseResolutioner(), - $classResolver ?? new ClassResolver($this->parameterResolutioner) + $this->responseResolutioner ??= new ResponseResolutioner() ); $this->collection = $this->collectionFactory->createCollection(); @@ -102,16 +99,6 @@ public function getCollection(): RouteCollectionInterface return $this->collection; } - /** - * Gets the collector's routes - * - * @return list - */ - public function getRoutes(): array - { - return $this->collection->all(); - } - /** * Adds the given parameter resolver(s) to the parameter resolutioner * @@ -120,8 +107,7 @@ public function getRoutes(): array * @return void * * @throws LogicException - * If a custom reference resolver was setted - * and a parameter resolutioner was not passed. + * If a custom reference resolver was setted and a parameter resolutioner wasn't passed. * * @since 3.0.0 */ @@ -130,8 +116,7 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): if (!isset($this->parameterResolutioner)) { throw new LogicException( 'The route collector cannot accept the parameter resolver(s) ' . - 'because a custom reference resolver was setted ' . - 'and a parameter resolutioner was not passed' + 'because a custom reference resolver was setted and a parameter resolutioner was not passed' ); } @@ -146,8 +131,7 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): * @return void * * @throws LogicException - * If a custom reference resolver was setted - * and a response resolutioner was not passed. + * If a custom reference resolver was setted and a response resolutioner wasn't passed. * * @since 3.0.0 */ @@ -156,8 +140,7 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo if (!isset($this->responseResolutioner)) { throw new LogicException( 'The route collector cannot accept the response resolver(s) ' . - 'because a custom reference resolver was setted ' . - 'and a response resolutioner was not passed' + 'because a custom reference resolver was setted and a response resolutioner was not passed' ); } diff --git a/src/RouteInterface.php b/src/RouteInterface.php index 42a7620f..c1d71beb 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -67,6 +67,24 @@ public function getPath(): string; */ public function getMethods(): array; + /** + * Gets the route's consumed content types + * + * @return list + * + * @since 3.0.0 + */ + public function getConsumedContentTypes(): array; + + /** + * Gets the route's produced content types + * + * @return list + * + * @since 3.0.0 + */ + public function getProducedContentTypes(): array; + /** * Gets the route request handler * @@ -162,6 +180,28 @@ public function setPath(string $path): RouteInterface; */ public function setMethods(string ...$methods): RouteInterface; + /** + * Sets the given consumed content type(s) to the route + * + * @param string ...$contentTypes + * + * @return RouteInterface + * + * @since 3.0.0 + */ + public function setConsumedContentTypes(string ...$contentTypes): RouteInterface; + + /** + * Sets the given produced content type(s) to the route + * + * @param string ...$contentTypes + * + * @return RouteInterface + * + * @since 3.0.0 + */ + public function setProducedContentTypes(string ...$contentTypes): RouteInterface; + /** * Sets the given request handler to the route * @@ -261,6 +301,28 @@ public function addSuffix(string $suffix): RouteInterface; */ public function addMethod(string ...$methods): RouteInterface; + /** + * Adds the given consumed content type(s) to the route + * + * @param string ...$contentTypes + * + * @return RouteInterface + * + * @since 3.0.0 + */ + public function addConsumedContentType(string ...$contentTypes): RouteInterface; + + /** + * Adds the given produced content type(s) to the route + * + * @param string ...$contentTypes + * + * @return RouteInterface + * + * @since 3.0.0 + */ + public function addProducedContentType(string ...$contentTypes): RouteInterface; + /** * Adds the given middleware(s) to the route * diff --git a/src/Router.php b/src/Router.php index 10ca2ebd..5f24013e 100644 --- a/src/Router.php +++ b/src/Router.php @@ -585,6 +585,9 @@ public function match(ServerRequestInterface $request): RouteInterface continue; } + // $routeConsumedContentTypes = $route->getConsumedContentTypes(); + // $routeProducedContentTypes = $route->getProducedContentTypes(); + /** @var array $attributes */ return $route->withAddedAttributes($attributes); diff --git a/src/ServerRequest.php b/src/ServerRequest.php new file mode 100644 index 00000000..fbb3792f --- /dev/null +++ b/src/ServerRequest.php @@ -0,0 +1,357 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router; + +/** + * Import classes + */ +use Psr\Http\Message\ServerRequestInterface; + +/** + * ServerRequest + * + * @since 3.0.0 + */ +final class ServerRequest implements ServerRequestInterface +{ + + /** + * @var ServerRequestInterface + */ + private ServerRequestInterface $request; + + /** + * Constructor of the class + * + * @param ServerRequestInterface $request + */ + public function __construct(ServerRequestInterface $request) + { + $this->request = $request; + } + + /** + * Checks if the request is JSON + * + * @link https://datatracker.ietf.org/doc/html/rfc4627 + * + * @return bool + */ + public function isJson(): bool + { + return $this->getContentType() === 'application/json'; + } + + /** + * Gets the request media type + * + * @link https://tools.ietf.org/html/rfc7231#section-3.1.1.1 + * + * @return string|null + */ + public function getContentType(): ?string + { + if (!$this->request->hasHeader('Content-Type')) { + return null; + } + + $result = $this->request->getHeaderLine('Content-Type'); + + if (false !== \strpos($result, ';')) { + $result = \strstr($result, ';', true); + } + + return \trim($result); + } + + /** + * {@inheritdoc} + */ + public function getProtocolVersion(): string + { + return $this->request->getProtocolVersion(); + } + + /** + * {@inheritdoc} + */ + public function withProtocolVersion($version) + { + $clone = clone $this; + $clone->request = $clone->request->withProtocolVersion($version); + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function getHeaders(): array + { + return $this->request->getHeaders(); + } + + /** + * {@inheritdoc} + */ + public function hasHeader($name): bool + { + return $this->request->hasHeader($name); + } + + /** + * {@inheritdoc} + */ + public function getHeader($name): array + { + return $this->request->getHeader($name); + } + + /** + * {@inheritdoc} + */ + public function getHeaderLine($name): string + { + return $this->request->getHeaderLine($name); + } + + /** + * {@inheritdoc} + */ + public function withHeader($name, $value) + { + $clone = clone $this; + $clone->request = $clone->request->withHeader($name, $value); + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function withAddedHeader($name, $value) + { + $clone = clone $this; + $clone->request = $clone->request->withAddedHeader($name, $value); + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function withoutHeader($name) + { + $clone = clone $this; + $clone->request = $clone->request->withoutHeader($name); + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function getBody(): \Psr\Http\Message\StreamInterface + { + return $this->request->getBody(); + } + + /** + * {@inheritdoc} + */ + public function withBody(\Psr\Http\Message\StreamInterface $body) + { + $clone = clone $this; + $clone->request = $clone->request->withBody($body); + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function getMethod(): string + { + return $this->request->getMethod(); + } + + /** + * {@inheritdoc} + */ + public function withMethod($method) + { + $clone = clone $this; + $clone->request = $clone->request->withMethod($method); + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function getUri(): \Psr\Http\Message\UriInterface + { + return $this->request->getUri(); + } + + /** + * {@inheritdoc} + */ + public function withUri(\Psr\Http\Message\UriInterface $uri, $preserveHost = false) + { + $clone = clone $this; + $clone->request = $clone->request->withUri($uri, $preserveHost); + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function getRequestTarget(): string + { + return $this->request->getRequestTarget(); + } + + /** + * {@inheritdoc} + */ + public function withRequestTarget($requestTarget) + { + $clone = clone $this; + $clone->request = $clone->request->withRequestTarget($requestTarget); + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function getServerParams(): array + { + return $this->request->getServerParams(); + } + + /** + * {@inheritdoc} + */ + public function getQueryParams(): array + { + return $this->request->getQueryParams(); + } + + /** + * {@inheritdoc} + */ + public function withQueryParams(array $query) + { + $clone = clone $this; + $clone->request = $clone->request->withQueryParams($query); + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function getCookieParams(): array + { + return $this->request->getCookieParams(); + } + + /** + * {@inheritdoc} + */ + public function withCookieParams(array $cookies) + { + $clone = clone $this; + $clone->request = $clone->request->withCookieParams($cookies); + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function getUploadedFiles(): array + { + return $this->request->getUploadedFiles(); + } + + /** + * {@inheritdoc} + */ + public function withUploadedFiles(array $uploadedFiles) + { + $clone = clone $this; + $clone->request = $clone->request->withUploadedFiles($uploadedFiles); + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function getParsedBody() + { + return $this->request->getParsedBody(); + } + + /** + * {@inheritdoc} + */ + public function withParsedBody($data) + { + $clone = clone $this; + $clone->request = $clone->request->withParsedBody($data); + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function getAttributes(): array + { + return $this->request->getAttributes(); + } + + /** + * {@inheritdoc} + */ + public function getAttribute($name, $default = null) + { + return $this->request->getAttribute($name, $default); + } + + /** + * {@inheritdoc} + */ + public function withAttribute($name, $value) + { + $clone = clone $this; + $clone->request = $clone->request->withAttribute($name, $value); + + return $clone; + } + + /** + * {@inheritdoc} + */ + public function withoutAttribute($name) + { + $clone = clone $this; + $clone->request = $clone->request->withoutAttribute($name); + + return $clone; + } +} From 2189b3aa70bafffb32d7e7c6f71c8c2e260b5c65 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 9 Feb 2023 01:12:26 +0100 Subject: [PATCH 057/180] v3 --- src/Router.php | 74 -------------------------------------------------- 1 file changed, 74 deletions(-) diff --git a/src/Router.php b/src/Router.php index 5f24013e..bd794545 100644 --- a/src/Router.php +++ b/src/Router.php @@ -386,80 +386,6 @@ public function existsNamedRouteByHostname(string $name, string $hostname): bool return false; } - /** - * Gets allowed methods - * - * @return list - */ - public function getAllowedMethods(): array - { - $methods = []; - foreach ($this->routes as $routes) { - foreach ($routes as $route) { - foreach ($route->getMethods() as $method) { - $methods[$method] = $method; - } - } - } - - return empty($methods) ? [] : \array_values($methods); - } - - /** - * Gets allowed methods by the given host - * - * @param string $host - * - * @return list - * - * @since 3.0.0 - */ - public function getAllowedMethodsByHost(string $host): array - { - $methods = []; - if (isset($this->routes[$host])) { - foreach ($this->routes[$host] as $route) { - foreach ($route->getMethods() as $method) { - $methods[$method] = $method; - } - } - } - - return empty($methods) ? [] : \array_values($methods); - } - - /** - * Gets allowed methods by the given hostname - * - * @param string $hostname - * - * @return list - * - * @since 3.0.0 - */ - public function getAllowedMethodsByHostname(string $hostname): array - { - $methods = []; - if (isset($this->routes['*'])) { - foreach ($this->routes['*'] as $route) { - foreach ($route->getMethods() as $method) { - $methods[$method] = $method; - } - } - } - - $host = $this->resolveHostname($hostname); - if (isset($host) && isset($this->routes[$host])) { - foreach ($this->routes[$host] as $route) { - foreach ($route->getMethods() as $method) { - $methods[$method] = $method; - } - } - } - - return empty($methods) ? [] : \array_values($methods); - } - /** * Adds the given middleware(s) to the router * From 576da85655310e2b9afe173f3bc53ac869bf0602 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 9 Feb 2023 01:16:03 +0100 Subject: [PATCH 058/180] v3 --- src/Loader/DescriptorLoader.php | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 51c5b896..3cde3e61 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -335,6 +335,8 @@ public function load(): RouteCollectionInterface ); $route->setHost($descriptor->host); + $route->setConsumedContentTypes(...$descriptor->consumes); + $route->setProducedContentTypes(...$descriptor->produces); $route->setSummary($descriptor->summary); $route->setDescription($descriptor->description); $route->setTags(...$descriptor->tags); From 34333e207f896cdea9c50fbcd012595afd33723e Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 9 Feb 2023 19:34:32 +0100 Subject: [PATCH 059/180] v3 --- src/Annotation/Description.php | 52 +++++++++++++++++++++++++++++++++ src/Annotation/Summary.php | 52 +++++++++++++++++++++++++++++++++ src/Loader/ConfigLoader.php | 1 + src/Loader/DescriptorLoader.php | 13 +++++++++ 4 files changed, 118 insertions(+) create mode 100644 src/Annotation/Description.php create mode 100644 src/Annotation/Summary.php diff --git a/src/Annotation/Description.php b/src/Annotation/Description.php new file mode 100644 index 00000000..0457e99c --- /dev/null +++ b/src/Annotation/Description.php @@ -0,0 +1,52 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Annotation; + +/** + * Import classes + */ +use Attribute; + +/** + * @Annotation + * + * @Target({"CLASS", "METHOD"}) + * + * @NamedArgumentConstructor + * + * @Attributes({ + * @Attribute("value", type="string", required=true), + * }) + * + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS|Attribute::TARGET_METHOD|Attribute::IS_REPEATABLE)] +final class Description +{ + + /** + * The attribute value + * + * @var string + */ + public string $value; + + /** + * Constructor of the class + * + * @param string $value + */ + public function __construct(string $value) + { + $this->value = $value; + } +} diff --git a/src/Annotation/Summary.php b/src/Annotation/Summary.php new file mode 100644 index 00000000..c19eaaa0 --- /dev/null +++ b/src/Annotation/Summary.php @@ -0,0 +1,52 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Annotation; + +/** + * Import classes + */ +use Attribute; + +/** + * @Annotation + * + * @Target({"CLASS", "METHOD"}) + * + * @NamedArgumentConstructor + * + * @Attributes({ + * @Attribute("value", type="string", required=true), + * }) + * + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS|Attribute::TARGET_METHOD|Attribute::IS_REPEATABLE)] +final class Summary +{ + + /** + * The attribute value + * + * @var string + */ + public string $value; + + /** + * Constructor of the class + * + * @param string $value + */ + public function __construct(string $value) + { + $this->value = $value; + } +} diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index b746a240..9643b2fe 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -38,6 +38,7 @@ use function is_dir; use function is_file; use function is_string; +use function sprintf; /** * ConfigLoader diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 3cde3e61..13d6bc1d 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -19,6 +19,7 @@ use Psr\Http\Server\RequestHandlerInterface; use Psr\SimpleCache\CacheInterface; use Sunrise\Http\Router\Annotation\Consume; +use Sunrise\Http\Router\Annotation\Description; use Sunrise\Http\Router\Annotation\Host; use Sunrise\Http\Router\Annotation\Method; use Sunrise\Http\Router\Annotation\Middleware; @@ -26,6 +27,7 @@ use Sunrise\Http\Router\Annotation\Prefix; use Sunrise\Http\Router\Annotation\Produce; use Sunrise\Http\Router\Annotation\Route; +use Sunrise\Http\Router\Annotation\Summary; use Sunrise\Http\Router\Annotation\Tag; use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Exception\LogicException; @@ -54,6 +56,7 @@ use function hash; use function is_dir; use function is_string; +use function sprintf; use function usort; use function Sunrise\Http\Router\get_dir_classes; @@ -515,6 +518,16 @@ private function supplementDescriptor(Route $descriptor, Reflector $classOrMetho $descriptor->middlewares[] = $annotation->value; } + $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Summary::class); + foreach ($annotations as $annotation) { + $descriptor->summary .= $annotation->value; + } + + $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Description::class); + foreach ($annotations as $annotation) { + $descriptor->description .= $annotation->value; + } + $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Tag::class); foreach ($annotations as $annotation) { $descriptor->tags[] = $annotation->value; From 4b5e5354dca7c10bb56b086a2cc9b15dfc03f0d1 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 10 Feb 2023 03:07:37 +0100 Subject: [PATCH 060/180] v3 --- .../Http/HttpMethodNotAllowedException.php | 20 - .../Http/HttpNotAcceptableException.php | 30 +- .../HttpUnsupportedMediaTypeException.php | 20 - src/Exception/MethodNotAllowedException.php | 24 -- ...on.php => RouteAlreadyExistsException.php} | 11 +- ...n.php => UnprocessableObjectException.php} | 4 +- .../UnprocessableRequestBodyException.php | 2 +- .../UnprocessableRequestQueryException.php | 2 +- src/HostTable.php | 77 ++++ src/Loader/DescriptorLoader.php | 4 +- src/Route.php | 44 +-- src/RouteCollection.php | 89 ++++- src/RouteCollectionInterface.php | 66 +++- src/RouteInterface.php | 32 +- src/Router.php | 346 +++--------------- src/ServerRequest.php | 136 ++++++- 16 files changed, 450 insertions(+), 457 deletions(-) delete mode 100644 src/Exception/MethodNotAllowedException.php rename src/Exception/{PageNotFoundException.php => RouteAlreadyExistsException.php} (69%) rename src/Exception/{UnprocessableEntityException.php => UnprocessableObjectException.php} (92%) create mode 100644 src/HostTable.php diff --git a/src/Exception/Http/HttpMethodNotAllowedException.php b/src/Exception/Http/HttpMethodNotAllowedException.php index 5c61c488..8dc9c424 100644 --- a/src/Exception/Http/HttpMethodNotAllowedException.php +++ b/src/Exception/Http/HttpMethodNotAllowedException.php @@ -34,13 +34,6 @@ class HttpMethodNotAllowedException extends HttpException { - /** - * Unallowed HTTP method - * - * @var string - */ - private string $unallowedMethod; - /** * Allowed HTTP methods * @@ -51,14 +44,12 @@ class HttpMethodNotAllowedException extends HttpException /** * Constructor of the class * - * @param string $unallowedMethod * @param string[] $allowedMethods * @param ?string $message * @param int $code * @param ?Throwable $previous */ public function __construct( - string $unallowedMethod, array $allowedMethods, ?string $message = null, int $code = 0, @@ -68,22 +59,11 @@ public function __construct( parent::__construct(self::STATUS_METHOD_NOT_ALLOWED, $message, $code, $previous); - $this->unallowedMethod = $unallowedMethod; foreach ($allowedMethods as $allowedMethod) { $this->allowedMethods[] = $allowedMethod; } } - /** - * Gets unallowed HTTP method - * - * @return string - */ - final public function getMethod(): string - { - return $this->unallowedMethod; - } - /** * Gets allowed HTTP methods * diff --git a/src/Exception/Http/HttpNotAcceptableException.php b/src/Exception/Http/HttpNotAcceptableException.php index b0eb0f19..66490101 100644 --- a/src/Exception/Http/HttpNotAcceptableException.php +++ b/src/Exception/Http/HttpNotAcceptableException.php @@ -29,17 +29,43 @@ class HttpNotAcceptableException extends HttpException { + /** + * Supported media types + * + * @var list + */ + private array $supportedMediaTypes = []; + /** * Constructor of the class * + * @param string[] $supportedMediaTypes * @param ?string $message * @param int $code * @param ?Throwable $previous */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { + public function __construct( + array $supportedMediaTypes, + ?string $message = null, + int $code = 0, + ?Throwable $previous = null + ) { $message ??= 'Not Acceptable'; parent::__construct(self::STATUS_NOT_ACCEPTABLE, $message, $code, $previous); + + foreach ($supportedMediaTypes as $supportedMediaType) { + $this->supportedMediaTypes[] = $supportedMediaType; + } + } + + /** + * Gets supported media types + * + * @return list + */ + final public function getSupportedTypes(): array + { + return $this->supportedMediaTypes; } } diff --git a/src/Exception/Http/HttpUnsupportedMediaTypeException.php b/src/Exception/Http/HttpUnsupportedMediaTypeException.php index 090887b7..de81ac2d 100644 --- a/src/Exception/Http/HttpUnsupportedMediaTypeException.php +++ b/src/Exception/Http/HttpUnsupportedMediaTypeException.php @@ -33,13 +33,6 @@ class HttpUnsupportedMediaTypeException extends HttpException { - /** - * Unsupported media type - * - * @var string - */ - private string $unsupportedMediaType; - /** * Supported media types * @@ -50,14 +43,12 @@ class HttpUnsupportedMediaTypeException extends HttpException /** * Constructor of the class * - * @param string $unsupportedMediaType * @param string[] $supportedMediaTypes * @param ?string $message * @param int $code * @param ?Throwable $previous */ public function __construct( - string $unsupportedMediaType, array $supportedMediaTypes, ?string $message = null, int $code = 0, @@ -67,22 +58,11 @@ public function __construct( parent::__construct(self::STATUS_UNSUPPORTED_MEDIA_TYPE, $message, $code, $previous); - $this->unsupportedMediaType = $unsupportedMediaType; foreach ($supportedMediaTypes as $supportedMediaType) { $this->supportedMediaTypes[] = $supportedMediaType; } } - /** - * Gets unsupported media type - * - * @return string - */ - final public function getType(): string - { - return $this->unsupportedMediaType; - } - /** * Gets supported media types * diff --git a/src/Exception/MethodNotAllowedException.php b/src/Exception/MethodNotAllowedException.php deleted file mode 100644 index b2edb2f4..00000000 --- a/src/Exception/MethodNotAllowedException.php +++ /dev/null @@ -1,24 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Exception; - -/** - * Import classes - */ -use Sunrise\Http\Router\Exception\Http\HttpMethodNotAllowedException; - -/** - * MethodNotAllowedException - */ -class MethodNotAllowedException extends HttpMethodNotAllowedException -{ -} diff --git a/src/Exception/PageNotFoundException.php b/src/Exception/RouteAlreadyExistsException.php similarity index 69% rename from src/Exception/PageNotFoundException.php rename to src/Exception/RouteAlreadyExistsException.php index 4a47e46a..33227f58 100644 --- a/src/Exception/PageNotFoundException.php +++ b/src/Exception/RouteAlreadyExistsException.php @@ -12,13 +12,10 @@ namespace Sunrise\Http\Router\Exception; /** - * Import classes - */ -use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; - -/** - * PageNotFoundException + * RouteAlreadyExistsException + * + * @since 3.0.0 */ -class PageNotFoundException extends HttpNotFoundException +class RouteAlreadyExistsException extends LogicException { } diff --git a/src/Exception/UnprocessableEntityException.php b/src/Exception/UnprocessableObjectException.php similarity index 92% rename from src/Exception/UnprocessableEntityException.php rename to src/Exception/UnprocessableObjectException.php index afe34b01..78bf3f50 100644 --- a/src/Exception/UnprocessableEntityException.php +++ b/src/Exception/UnprocessableObjectException.php @@ -18,11 +18,11 @@ use Symfony\Component\Validator\ConstraintViolationListInterface; /** - * UnprocessableEntityException + * UnprocessableObjectException * * @since 3.0.0 */ -class UnprocessableEntityException extends HttpUnprocessableEntityException +class UnprocessableObjectException extends HttpUnprocessableEntityException { /** diff --git a/src/Exception/UnprocessableRequestBodyException.php b/src/Exception/UnprocessableRequestBodyException.php index 5e06f180..8615eede 100644 --- a/src/Exception/UnprocessableRequestBodyException.php +++ b/src/Exception/UnprocessableRequestBodyException.php @@ -16,6 +16,6 @@ * * @since 3.0.0 */ -class UnprocessableRequestBodyException extends UnprocessableEntityException +class UnprocessableRequestBodyException extends UnprocessableObjectException { } diff --git a/src/Exception/UnprocessableRequestQueryException.php b/src/Exception/UnprocessableRequestQueryException.php index c1bae14a..6ab74b68 100644 --- a/src/Exception/UnprocessableRequestQueryException.php +++ b/src/Exception/UnprocessableRequestQueryException.php @@ -16,6 +16,6 @@ * * @since 3.0.0 */ -class UnprocessableRequestQueryException extends UnprocessableEntityException +class UnprocessableRequestQueryException extends UnprocessableObjectException { } diff --git a/src/HostTable.php b/src/HostTable.php new file mode 100644 index 00000000..8a8256c4 --- /dev/null +++ b/src/HostTable.php @@ -0,0 +1,77 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router; + +/** + * The router host table + * + * @since 3.0.0 + */ +final class HostTable +{ + + /** + * @var array> + */ + private array $hosts = []; + + /** + * Adds the given alias with its hostnames to the table + * + * @param string $alias + * @param string ...$hostnames + * + * @return void + */ + public function add(string $alias, string ...$hostnames): void + { + foreach ($hostnames as $hostname) { + $this->hosts[$alias][] = $hostname; + } + } + + /** + * Loads the given hosts to the table + * + * @param array> $hosts + * + * @return void + */ + public function load(array $hosts): void + { + foreach ($hosts as $alias => $hostnames) { + foreach ($hostnames as $hostname) { + $this->hosts[$alias][] = $hostname; + } + } + } + + /** + * Resolves the given hostname to its alias if it exists in the table otherwise returns null + * + * @param string $hostname + * + * @return string|null + */ + public function resolve(string $hostname): ?string + { + foreach ($this->hosts as $alias => $hostnames) { + foreach ($hostnames as $value) { + if ($hostname === $value) { + return $alias; + } + } + } + + return null; + } +} diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 13d6bc1d..858f8e16 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -338,8 +338,8 @@ public function load(): RouteCollectionInterface ); $route->setHost($descriptor->host); - $route->setConsumedContentTypes(...$descriptor->consumes); - $route->setProducedContentTypes(...$descriptor->produces); + $route->setConsumedMediaTypes(...$descriptor->consumes); + $route->setProducedMediaTypes(...$descriptor->produces); $route->setSummary($descriptor->summary); $route->setDescription($descriptor->description); $route->setTags(...$descriptor->tags); diff --git a/src/Route.php b/src/Route.php index 47a86167..fff78338 100644 --- a/src/Route.php +++ b/src/Route.php @@ -66,18 +66,18 @@ class Route implements RouteInterface private array $methods = []; /** - * The route's consumed content types + * The route's consumed media types * * @var list */ - private array $consumedContentTypes = []; + private array $consumedMediaTypes = []; /** - * The route's produced content types + * The route's produced media types * * @var list */ - private array $producedContentTypes = []; + private array $producedMediaTypes = []; /** * The route request handler @@ -182,17 +182,17 @@ public function getMethods(): array /** * {@inheritdoc} */ - public function getConsumedContentTypes(): array + public function getConsumedMediaTypes(): array { - return $this->consumedContentTypes; + return $this->consumedMediaTypes; } /** * {@inheritdoc} */ - public function getProducedContentTypes(): array + public function getProducedMediaTypes(): array { - return $this->producedContentTypes; + return $this->producedMediaTypes; } /** @@ -301,11 +301,11 @@ public function setMethods(string ...$methods): RouteInterface /** * {@inheritdoc} */ - public function setConsumedContentTypes(string ...$contentTypes): RouteInterface + public function setConsumedMediaTypes(string ...$mediaTypes): RouteInterface { - $this->consumedContentTypes = []; - foreach ($contentTypes as $contentType) { - $this->consumedContentTypes[] = $contentType; + $this->consumedMediaTypes = []; + foreach ($mediaTypes as $mediaType) { + $this->consumedMediaTypes[] = $mediaType; } return $this; @@ -314,11 +314,11 @@ public function setConsumedContentTypes(string ...$contentTypes): RouteInterface /** * {@inheritdoc} */ - public function setProducedContentTypes(string ...$contentTypes): RouteInterface + public function setProducedMediaTypes(string ...$mediaTypes): RouteInterface { - $this->producedContentTypes = []; - foreach ($contentTypes as $contentType) { - $this->producedContentTypes[] = $contentType; + $this->producedMediaTypes = []; + foreach ($mediaTypes as $mediaType) { + $this->producedMediaTypes[] = $mediaType; } return $this; @@ -438,10 +438,10 @@ public function addMethod(string ...$methods): RouteInterface /** * {@inheritdoc} */ - public function addConsumedContentType(string ...$contentTypes): RouteInterface + public function addConsumedMediaType(string ...$mediaTypes): RouteInterface { - foreach ($contentTypes as $contentType) { - $this->consumedContentTypes[] = $contentType; + foreach ($mediaTypes as $mediaType) { + $this->consumedMediaTypes[] = $mediaType; } return $this; @@ -450,10 +450,10 @@ public function addConsumedContentType(string ...$contentTypes): RouteInterface /** * {@inheritdoc} */ - public function addProducedContentType(string ...$contentTypes): RouteInterface + public function addProducedMediaType(string ...$mediaTypes): RouteInterface { - foreach ($contentTypes as $contentType) { - $this->producedContentTypes[] = $contentType; + foreach ($mediaTypes as $mediaType) { + $this->producedMediaTypes[] = $mediaType; } return $this; diff --git a/src/RouteCollection.php b/src/RouteCollection.php index 37bc8165..37db2551 100644 --- a/src/RouteCollection.php +++ b/src/RouteCollection.php @@ -15,11 +15,15 @@ * Import classes */ use Psr\Http\Server\MiddlewareInterface; +use Sunrise\Http\Router\Exception\RouteAlreadyExistsException; +use Sunrise\Http\Router\Exception\RouteNotFoundException; +use Iterator; /** * Import functions */ use function count; +use function sprintf; /** * RouteCollection @@ -30,12 +34,20 @@ class RouteCollection implements RouteCollectionInterface { /** - * The collection routes - * + * @var string + */ + private const ANY_HOST = '*'; + + /** * @var array */ private array $routes = []; + /** + * @var array> + */ + private array $hostMap = []; + /** * Constructor of the class * @@ -49,22 +61,39 @@ public function __construct(RouteInterface ...$routes) /** * {@inheritdoc} */ - public function all(): array + public function getIterator(): Iterator { - $routes = []; foreach ($this->routes as $route) { - $routes[] = $route; + yield $route; } + } - return $routes; + /** + * {@inheritdoc} + */ + public function all(): Iterator + { + foreach ($this->routes as $route) { + yield $route; + } } /** * {@inheritdoc} */ - public function get(string $name): ?RouteInterface + public function allByHost(?string $host): Iterator { - return $this->routes[$name] ?? null; + if (isset($host, $this->hostMap[$host])) { + foreach ($this->hostMap[$host] as $name) { + yield $this->routes[$name]; + } + } + + if (isset($this->hostMap[self::ANY_HOST])) { + foreach ($this->hostMap[self::ANY_HOST] as $name) { + yield $this->routes[$name]; + } + } } /** @@ -75,13 +104,39 @@ public function has(string $name): bool return isset($this->routes[$name]); } + /** + * {@inheritdoc} + */ + public function get(string $name): RouteInterface + { + if (!isset($this->routes[$name])) { + throw new RouteNotFoundException(sprintf( + 'The collection does not contain a route with the name %s', + $name + )); + } + + return $this->routes[$name]; + } + /** * {@inheritdoc} */ public function add(RouteInterface ...$routes): RouteCollectionInterface { foreach ($routes as $route) { - $this->routes[$route->getName()] = $route; + $name = $route->getName(); + $host = $route->getHost() ?? self::ANY_HOST; + + if (isset($this->routes[$name])) { + throw new RouteAlreadyExistsException(sprintf( + 'The collection already contains a route with the name %s', + $name + )); + } + + $this->routes[$name] = $route; + $this->hostMap[$host][] = $name; } return $this; @@ -102,10 +157,10 @@ public function setHost(string $host): RouteCollectionInterface /** * {@inheritdoc} */ - public function setConsumedContentTypes(string ...$contentTypes): RouteCollectionInterface + public function setConsumedMediaTypes(string ...$mediaTypes): RouteCollectionInterface { foreach ($this->routes as $route) { - $route->setConsumedContentTypes(...$contentTypes); + $route->setConsumedMediaTypes(...$mediaTypes); } return $this; @@ -114,10 +169,10 @@ public function setConsumedContentTypes(string ...$contentTypes): RouteCollectio /** * {@inheritdoc} */ - public function setProducedContentTypes(string ...$contentTypes): RouteCollectionInterface + public function setProducedMediaTypes(string ...$mediaTypes): RouteCollectionInterface { foreach ($this->routes as $route) { - $route->setProducedContentTypes(...$contentTypes); + $route->setProducedMediaTypes(...$mediaTypes); } return $this; @@ -174,10 +229,10 @@ public function addMethod(string ...$methods): RouteCollectionInterface /** * {@inheritdoc} */ - public function addConsumedContentType(string ...$contentTypes): RouteCollectionInterface + public function addConsumedMediaType(string ...$mediaTypes): RouteCollectionInterface { foreach ($this->routes as $route) { - $route->addConsumedContentType(...$contentTypes); + $route->addConsumedMediaType(...$mediaTypes); } return $this; @@ -186,10 +241,10 @@ public function addConsumedContentType(string ...$contentTypes): RouteCollection /** * {@inheritdoc} */ - public function addProducedContentType(string ...$contentTypes): RouteCollectionInterface + public function addProducedMediaType(string ...$mediaTypes): RouteCollectionInterface { foreach ($this->routes as $route) { - $route->addProducedContentType(...$contentTypes); + $route->addProducedMediaType(...$mediaTypes); } return $this; diff --git a/src/RouteCollectionInterface.php b/src/RouteCollectionInterface.php index 9809a0d7..3c224262 100644 --- a/src/RouteCollectionInterface.php +++ b/src/RouteCollectionInterface.php @@ -15,31 +15,40 @@ * Import classes */ use Psr\Http\Server\MiddlewareInterface; +use Sunrise\Http\Router\Exception\RouteAlreadyExistsException; +use Sunrise\Http\Router\Exception\RouteNotFoundException; use Countable; +use Iterator; +use IteratorAggregate; /** * RouteCollectionInterface + * + * @extends IteratorAggregate */ -interface RouteCollectionInterface extends Countable +interface RouteCollectionInterface extends Countable, IteratorAggregate { /** * Gets all routes from the collection * - * @return list + * @return Iterator */ - public function all(): array; + public function all(): Iterator; /** - * Gets a route by the given name + * Gets all routes from the collection by the given host * - * @param string $name + * This method should first return all routes that are served on the given host, + * and then return all routes that are not bound to any host. * - * @return RouteInterface|null + * @param string|null $host * - * @since 2.10.0 + * @return Iterator + * + * @since 3.0.0 */ - public function get(string $name): ?RouteInterface; + public function allByHost(?string $host): Iterator; /** * Checks by the given name if a route exists in the collection @@ -52,12 +61,29 @@ public function get(string $name): ?RouteInterface; */ public function has(string $name): bool; + /** + * Gets a route by the given name + * + * @param string $name + * + * @return RouteInterface + * + * @throws RouteNotFoundException + * If the collection doesn't contain a route with the name. + * + * @since 2.10.0 + */ + public function get(string $name): RouteInterface; + /** * Adds the given route(s) to the collection * * @param RouteInterface ...$routes * * @return RouteCollectionInterface + * + * @throws RouteAlreadyExistsException + * If the collection already contains a route with the name. */ public function add(RouteInterface ...$routes): RouteCollectionInterface; @@ -73,26 +99,26 @@ public function add(RouteInterface ...$routes): RouteCollectionInterface; public function setHost(string $host): RouteCollectionInterface; /** - * Sets the given consumed content type(s) to all routes in the collection + * Sets the given consumed media type(s) to all routes in the collection * - * @param string ...$contentTypes + * @param string ...$mediaTypes * * @return RouteCollectionInterface * * @since 3.0.0 */ - public function setConsumedContentTypes(string ...$contentTypes): RouteCollectionInterface; + public function setConsumedMediaTypes(string ...$mediaTypes): RouteCollectionInterface; /** - * Sets the given produced content type(s) to all routes in the collection + * Sets the given produced media type(s) to all routes in the collection * - * @param string ...$contentTypes + * @param string ...$mediaTypes * * @return RouteCollectionInterface * * @since 3.0.0 */ - public function setProducedContentTypes(string ...$contentTypes): RouteCollectionInterface; + public function setProducedMediaTypes(string ...$mediaTypes): RouteCollectionInterface; /** * Sets the given attribute to all routes in the collection @@ -140,26 +166,26 @@ public function addSuffix(string $suffix): RouteCollectionInterface; public function addMethod(string ...$methods): RouteCollectionInterface; /** - * Adds the given consumed content type(s) to all routes in the collection + * Adds the given consumed media type(s) to all routes in the collection * - * @param string ...$contentTypes + * @param string ...$mediaTypes * * @return RouteCollectionInterface * * @since 3.0.0 */ - public function addConsumedContentType(string ...$contentTypes): RouteCollectionInterface; + public function addConsumedMediaType(string ...$mediaTypes): RouteCollectionInterface; /** - * Adds the given produced content type(s) to all routes in the collection + * Adds the given produced media type(s) to all routes in the collection * - * @param string ...$contentTypes + * @param string ...$mediaTypes * * @return RouteCollectionInterface * * @since 3.0.0 */ - public function addProducedContentType(string ...$contentTypes): RouteCollectionInterface; + public function addProducedMediaType(string ...$mediaTypes): RouteCollectionInterface; /** * Adds the given middleware(s) to all routes in the collection diff --git a/src/RouteInterface.php b/src/RouteInterface.php index c1d71beb..2baef204 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -68,22 +68,22 @@ public function getPath(): string; public function getMethods(): array; /** - * Gets the route's consumed content types + * Gets the route's consumed media types * * @return list * * @since 3.0.0 */ - public function getConsumedContentTypes(): array; + public function getConsumedMediaTypes(): array; /** - * Gets the route's produced content types + * Gets the route's produced media types * * @return list * * @since 3.0.0 */ - public function getProducedContentTypes(): array; + public function getProducedMediaTypes(): array; /** * Gets the route request handler @@ -181,26 +181,26 @@ public function setPath(string $path): RouteInterface; public function setMethods(string ...$methods): RouteInterface; /** - * Sets the given consumed content type(s) to the route + * Sets the given consumed media type(s) to the route * - * @param string ...$contentTypes + * @param string ...$mediaTypes * * @return RouteInterface * * @since 3.0.0 */ - public function setConsumedContentTypes(string ...$contentTypes): RouteInterface; + public function setConsumedMediaTypes(string ...$mediaTypes): RouteInterface; /** - * Sets the given produced content type(s) to the route + * Sets the given produced media type(s) to the route * - * @param string ...$contentTypes + * @param string ...$mediaTypes * * @return RouteInterface * * @since 3.0.0 */ - public function setProducedContentTypes(string ...$contentTypes): RouteInterface; + public function setProducedMediaTypes(string ...$mediaTypes): RouteInterface; /** * Sets the given request handler to the route @@ -302,26 +302,26 @@ public function addSuffix(string $suffix): RouteInterface; public function addMethod(string ...$methods): RouteInterface; /** - * Adds the given consumed content type(s) to the route + * Adds the given consumed media type(s) to the route * - * @param string ...$contentTypes + * @param string ...$mediaTypes * * @return RouteInterface * * @since 3.0.0 */ - public function addConsumedContentType(string ...$contentTypes): RouteInterface; + public function addConsumedMediaType(string ...$mediaTypes): RouteInterface; /** - * Adds the given produced content type(s) to the route + * Adds the given produced media type(s) to the route * - * @param string ...$contentTypes + * @param string ...$mediaTypes * * @return RouteInterface * * @since 3.0.0 */ - public function addProducedContentType(string ...$contentTypes): RouteInterface; + public function addProducedMediaType(string ...$mediaTypes): RouteInterface; /** * Adds the given middleware(s) to the route diff --git a/src/Router.php b/src/Router.php index bd794545..4ce6810e 100644 --- a/src/Router.php +++ b/src/Router.php @@ -21,21 +21,19 @@ use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Event\RouteEvent; -use Sunrise\Http\Router\Exception\InvalidArgumentException; -use Sunrise\Http\Router\Exception\PageNotFoundException; -use Sunrise\Http\Router\Exception\RouteNotFoundException; -use Sunrise\Http\Router\Exception\MethodNotAllowedException; +use Sunrise\Http\Router\Exception\Http\HttpMethodNotAllowedException; +use Sunrise\Http\Router\Exception\Http\HttpNotAcceptableException; +use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; +use Sunrise\Http\Router\Exception\Http\HttpUnsupportedMediaTypeException; use Sunrise\Http\Router\Loader\LoaderInterface; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; use Sunrise\Http\Router\RequestHandler\UnsafeCallableRequestHandler; -use Generator; /** * Import functions */ use function Sunrise\Http\Router\path_build; use function Sunrise\Http\Router\path_match; -use function sprintf; /** * Router @@ -58,16 +56,16 @@ class Router implements RequestHandlerInterface, RequestMethodInterface /** * The router's host table * - * @var array> + * @var HostTable */ - private array $hosts = []; + private HostTable $hosts; /** * The router's routes * - * @var array> + * @var RouteCollectionInterface */ - private array $routes = []; + private RouteCollectionInterface $routes; /** * The router's middlewares @@ -76,13 +74,6 @@ class Router implements RequestHandlerInterface, RequestMethodInterface */ private array $middlewares = []; - /** - * The router's matched route - * - * @var RouteInterface|null - */ - private ?RouteInterface $matchedRoute = null; - /** * The router's event dispatcher * @@ -91,299 +82,64 @@ class Router implements RequestHandlerInterface, RequestMethodInterface private ?EventDispatcherInterface $eventDispatcher = null; /** - * Adds the given patterns to the router - * - * @param array $patterns - * - * @return void + * The router's matched route * - * @since 2.11.0 + * @var RouteInterface|null */ - public function addPatterns(array $patterns): void - { - foreach ($patterns as $alias => $pattern) { - self::$patterns[$alias] = $pattern; - } - } + private ?RouteInterface $matchedRoute = null; /** - * Adds the given host to the router's host table - * - * @param string $alias - * @param string ...$hostnames + * Constructor of the class * - * @return void + * @param HostTable|null $hosts + * @param RouteCollectionInterface|null $routes * - * @since 2.6.0 + * @since 3.0.0 */ - public function addHost(string $alias, string ...$hostnames): void - { - foreach ($hostnames as $hostname) { - $this->hosts[$alias][] = $hostname; - } + public function __construct( + ?HostTable $hosts = null, + ?RouteCollectionInterface $routes = null + ) { + $this->hosts = $hosts ?? new HostTable(); + $this->routes = $routes ?? new RouteCollection(); } /** - * Adds the given hosts to the router's host table + * Adds the given patterns to the router * - * @param array> $hosts + * @param array $patterns * * @return void * * @since 2.11.0 */ - public function addHosts(array $hosts): void + public function addPatterns(array $patterns): void { - foreach ($hosts as $alias => $hostnames) { - foreach ($hostnames as $hostname) { - $this->hosts[$alias][] = $hostname; - } + foreach ($patterns as $alias => $pattern) { + self::$patterns[$alias] = $pattern; } } /** * Gets the router's host table * - * @return array> + * @return HostTable * * @since 2.6.0 */ - public function getHosts(): array + public function getHosts(): HostTable { return $this->hosts; } /** - * Resolves the given hostname to its alias - * - * @param string $hostname - * - * @return string|null - * - * @since 2.14.0 - */ - public function resolveHostname(string $hostname): ?string - { - foreach ($this->hosts as $alias => $hostnames) { - foreach ($hostnames as $value) { - if ($hostname === $value) { - return $alias; - } - } - } - - return null; - } - - /** - * Adds the given route(s) to the router - * - * @param RouteInterface ...$routes - * - * @return void - */ - public function addRoute(RouteInterface ...$routes): void - { - foreach ($routes as $route) { - $host = $route->getHost() ?? '*'; - $name = $route->getName(); - - $this->routes[$host][$name] = $route; - } - } - - /** - * Gets all routes - * - * @return Generator - */ - public function getRoutes(): Generator - { - foreach ($this->routes as $routes) { - foreach ($routes as $route) { - yield $route; - } - } - } - - /** - * Gets routes by the given host - * - * @param string $host - * - * @return Generator - * - * @since 3.0.0 - */ - public function getRoutesByHost(string $host): Generator - { - if (isset($this->routes[$host])) { - foreach ($this->routes[$host] as $route) { - yield $route; - } - } - } - - /** - * Gets routes by the given hostname - * - * @param string $hostname - * - * @return Generator - * - * @since 2.14.0 - */ - public function getRoutesByHostname(string $hostname): Generator - { - $host = $this->resolveHostname($hostname); - - if (isset($host) && isset($this->routes[$host])) { - foreach ($this->routes[$host] as $route) { - yield $route; - } - } - - if (isset($this->routes['*'])) { - foreach ($this->routes['*'] as $route) { - yield $route; - } - } - } - - /** - * Gets a route by the given name - * - * @param string $name - * - * @return RouteInterface - * - * @throws RouteNotFoundException - * If a route wasn't found by the given name. - */ - public function getRoute(string $name): RouteInterface - { - foreach ($this->routes as $routes) { - if (isset($routes[$name])) { - return $routes[$name]; - } - } - - throw new RouteNotFoundException(sprintf( - 'No route found for name "%s"', - $name - )); - } - - /** - * Gets a route by the given name and host - * - * @param string $name - * @param string $host - * - * @return RouteInterface - * - * @throws RouteNotFoundException - * If a route wasn't found by the given name and host. - * - * @since 3.0.0 - */ - public function getNamedRouteByHost(string $name, string $host): RouteInterface - { - if (isset($this->routes[$host][$name])) { - return $this->routes[$host][$name]; - } - - throw new RouteNotFoundException(sprintf( - 'No route found for name "%s" and host "%s"', - $name, - $host - )); - } - - /** - * Gets a route by the given name and hostname - * - * @param string $name - * @param string $hostname - * - * @return RouteInterface - * - * @throws RouteNotFoundException - * If a route wasn't found by the given name and hostname. - * - * @since 3.0.0 - */ - public function getNamedRouteByHostname(string $name, string $hostname): RouteInterface - { - $host = $this->resolveHostname($hostname); - - if (isset($host) && isset($this->routes[$host][$name])) { - return $this->routes[$host][$name]; - } - - if (isset($this->routes['*'][$name])) { - return $this->routes['*'][$name]; - } - - throw new RouteNotFoundException(sprintf( - 'No route found for name "%s" and hostname "%s"', - $name, - $hostname - )); - } - - /** - * Checks if a route exists by the given name - * - * @return bool - */ - public function hasRoute(string $name): bool - { - foreach ($this->routes as $routes) { - if (isset($routes[$name])) { - return true; - } - } - - return false; - } - - /** - * Checks if a route exists by the given name and host - * - * @return bool - * - * @since 3.0.0 - */ - public function existsNamedRouteByHost(string $name, string $host): bool - { - if (isset($this->routes[$host][$name])) { - return true; - } - - return false; - } - - /** - * Checks if a route exists by the given name and hostname + * Gets the router's route collection * - * @return bool - * - * @since 3.0.0 + * @return RouteCollectionInterface */ - public function existsNamedRouteByHostname(string $name, string $hostname): bool + public function getRoutes(): RouteCollectionInterface { - if (isset($this->routes['*'][$name])) { - return true; - } - - $host = $this->resolveHostname($hostname); - - if (isset($host) && isset($this->routes[$host][$name])) { - return true; - } - - return false; + return $this->routes; } /** @@ -454,17 +210,10 @@ public function getEventDispatcher(): ?EventDispatcherInterface * @param bool $strict * * @return string - * - * @throws RouteNotFoundException - * If a route wasn't found by the given name. - * - * @throws Exception\RoutePathBuildException - * If a required attribute value is not given, - * or if an attribute value is not valid in strict mode. */ public function generateUri(string $name, array $attributes = [], bool $strict = false): string { - $route = $this->getRoute($name); + $route = $this->routes->get($name); $attributes += $route->getAttributes(); @@ -478,11 +227,15 @@ public function generateUri(string $name, array $attributes = [], bool $strict = * * @return RouteInterface * - * @throws PageNotFoundException + * @throws HttpNotFoundException * If the request URI cannot be matched against any route. * - * @throws MethodNotAllowedException + * @throws HttpMethodNotAllowedException * If the request method isn't allowed. + * + * @throws HttpUnsupportedMediaTypeException + * + * @throws HttpNotAcceptableException */ public function match(ServerRequestInterface $request): RouteInterface { @@ -492,7 +245,9 @@ public function match(ServerRequestInterface $request): RouteInterface $requestMethod = $request->getMethod(); $allowedMethods = []; - $routes = $this->getRoutesByHostname($requestHost); + $routes = $this->routes->allByHost($this->hosts->resolve($requestHost)); + + $request = new ServerRequest($request); foreach ($routes as $route) { // https://github.com/sunrise-php/http-router/issues/50 @@ -511,8 +266,15 @@ public function match(ServerRequestInterface $request): RouteInterface continue; } - // $routeConsumedContentTypes = $route->getConsumedContentTypes(); - // $routeProducedContentTypes = $route->getProducedContentTypes(); + $consumedMediaTypes = $route->getConsumedMediaTypes(); + if (!empty($consumedMediaTypes) && !$request->clientProducesMediaType($consumedMediaTypes)) { + throw new HttpUnsupportedMediaTypeException($consumedMediaTypes); + } + + $producedMediaTypes = $route->getProducedMediaTypes(); + if (!empty($producedMediaTypes) && !$request->clientConsumesMediaType($producedMediaTypes)) { + throw new HttpNotAcceptableException($producedMediaTypes); + } /** @var array $attributes */ @@ -520,10 +282,10 @@ public function match(ServerRequestInterface $request): RouteInterface } if (!empty($allowedMethods)) { - throw new MethodNotAllowedException($requestMethod, $allowedMethods); + throw new HttpMethodNotAllowedException($allowedMethods); } - throw new PageNotFoundException(); + throw new HttpNotFoundException(); } /** @@ -595,7 +357,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface public function load(LoaderInterface ...$loaders): void { foreach ($loaders as $loader) { - $this->addRoute(...$loader->load()->all()); + $this->routes->add(...$loader->load()->all()); } } } diff --git a/src/ServerRequest.php b/src/ServerRequest.php index fbb3792f..0dc4c75a 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -16,6 +16,15 @@ */ use Psr\Http\Message\ServerRequestInterface; +/** + * Import functions + */ +use function explode; +use function strpos; +use function strstr; +use function strtolower; +use function trim; + /** * ServerRequest * @@ -42,35 +51,140 @@ public function __construct(ServerRequestInterface $request) /** * Checks if the request is JSON * - * @link https://datatracker.ietf.org/doc/html/rfc4627 + * @link https://tools.ietf.org/html/rfc4627 * * @return bool */ public function isJson(): bool { - return $this->getContentType() === 'application/json'; + return $this->getClientProducedMediaType() === 'application/json'; } /** - * Gets the request media type + * Gets the client's produced media type * * @link https://tools.ietf.org/html/rfc7231#section-3.1.1.1 + * @link https://tools.ietf.org/html/rfc7231#section-3.1.1.5 * - * @return string|null + * @return string */ - public function getContentType(): ?string + public function getClientProducedMediaType(): string { - if (!$this->request->hasHeader('Content-Type')) { - return null; + $header = $this->request->getHeaderLine('Content-Type'); + if ($header === '') { + return ''; + } + + if (strpos($header, ';') !== false) { + $header = strstr($header, ';', true); + } + + $header = trim($header); + if ($header === '') { + return ''; } - $result = $this->request->getHeaderLine('Content-Type'); + return strtolower($header); + } + + /** + * Gets the client's consumed media types + * + * @link https://tools.ietf.org/html/rfc7231#section-1.2 + * @link https://tools.ietf.org/html/rfc7231#section-3.1.1.1 + * @link https://tools.ietf.org/html/rfc7231#section-5.3.2 + * + * @return list + */ + public function getClientConsumedMediaTypes(): array + { + $header = $this->request->getHeaderLine('Accept'); + if ($header === '') { + return []; + } + + $result = []; + $accepts = explode(',', $header); + foreach ($accepts as $accept) { + if (strpos($accept, ';') !== false) { + $accept = strstr($accept, ';', true); + } + + $accept = trim($accept); + if ($accept === '') { + continue; + } + + if ($accept === '*/*') { + return []; + } + + $result[] = strtolower($accept); + } + + return $result; + } + + /** + * Checks if the client produces one of the given media types + * + * @param list $consumedMediaTypes + * + * @return bool + */ + public function clientProducesMediaType(array $consumedMediaTypes): bool + { + if ($consumedMediaTypes === []) { + return true; + } + + $producedMediaType = $this->getClientProducedMediaType(); + if ($producedMediaType === '') { + return false; + } + + foreach ($consumedMediaTypes as $consumedMediaType) { + if ($consumedMediaType === $producedMediaType) { + return true; + } + } + + return false; + } + + /** + * Checks if the client consumes one of the given media types + * + * @param list $producedMediaTypes + * + * @return bool + */ + public function clientConsumesMediaType(array $producedMediaTypes): bool + { + if ($producedMediaTypes === []) { + return true; + } + + $consumedMediaTypes = $this->getClientConsumedMediaTypes(); + if ($consumedMediaTypes === []) { + return true; + } + + foreach ($producedMediaTypes as $producedMediaType) { + if (strpos($producedMediaType, '/') !== false) { + $producedMediaTypes[] = strstr($producedMediaType, '/', true) . '/*'; + } + } - if (false !== \strpos($result, ';')) { - $result = \strstr($result, ';', true); + foreach ($consumedMediaTypes as $consumedMediaType) { + foreach ($producedMediaTypes as $producedMediaType) { + if ($consumedMediaType === $producedMediaType) { + return true; + } + } } - return \trim($result); + return false; } /** From bf51ff8a4c122533952a534236e39b190c2a28c8 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 11 Feb 2023 04:52:40 +0100 Subject: [PATCH 061/180] v3 --- src/Command/RouteListCommand.php | 4 +- .../Http/HttpMethodNotAllowedException.php | 18 ++-- .../Http/HttpNotAcceptableException.php | 18 ++-- .../HttpUnsupportedMediaTypeException.php | 18 ++-- src/Exception/UnhydrableObjectException.php | 21 +++++ ...n.php => UnprocessableEntityException.php} | 4 +- .../UnprocessableRequestBodyException.php | 2 +- .../UnprocessableRequestQueryException.php | 2 +- src/Loader/ConfigLoader.php | 10 ++- src/Loader/DescriptorLoader.php | 22 ++--- src/Middleware/CallableMiddleware.php | 11 +-- .../JsonPayloadDecodingMiddleware.php | 22 +---- .../XmlPayloadDecodingMiddleware.php | 85 +++++++++++++++++++ .../DependencyInjectionParameterResolver.php | 4 +- .../KnownTypedParameterResolver.php | 10 ++- .../RequestBodyParameterResolver.php | 12 +-- .../RequestEntityParameterResolver.php | 2 +- .../RequestQueryParameterResolver.php | 12 +-- .../ServerRequestParameterResolver.php | 6 +- src/RequestHandler/CallableRequestHandler.php | 8 +- src/RouteCollector.php | 10 ++- src/ServerRequest.php | 81 +++++++++++++++--- 22 files changed, 255 insertions(+), 127 deletions(-) create mode 100644 src/Exception/UnhydrableObjectException.php rename src/Exception/{UnprocessableObjectException.php => UnprocessableEntityException.php} (92%) create mode 100644 src/Middleware/XmlPayloadDecodingMiddleware.php diff --git a/src/Command/RouteListCommand.php b/src/Command/RouteListCommand.php index 65052713..817aee44 100644 --- a/src/Command/RouteListCommand.php +++ b/src/Command/RouteListCommand.php @@ -74,7 +74,7 @@ protected function getRouter(): Router if (!isset($this->router)) { throw new LogicException(sprintf( 'The %2$s() method MUST return the %1$s class instance. ' . - 'Pass the %1$s class instance to the constructor, ' . + 'Pass the %1$s class instance to the constructor ' . 'or override the %2$s() method.', Router::class, __METHOD__ @@ -107,7 +107,7 @@ final protected function execute(InputInterface $input, OutputInterface $output) 'Verb', ]); - foreach ($this->getRouter()->getRoutes() as $route) { + foreach ($this->getRouter()->getRoutes()->all() as $route) { $table->addRow([ $route->getName(), $route->getHost() ?? 'ANY', diff --git a/src/Exception/Http/HttpMethodNotAllowedException.php b/src/Exception/Http/HttpMethodNotAllowedException.php index 8dc9c424..b2eae99e 100644 --- a/src/Exception/Http/HttpMethodNotAllowedException.php +++ b/src/Exception/Http/HttpMethodNotAllowedException.php @@ -44,23 +44,19 @@ class HttpMethodNotAllowedException extends HttpException /** * Constructor of the class * - * @param string[] $allowedMethods - * @param ?string $message + * @param array $allowed + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ - public function __construct( - array $allowedMethods, - ?string $message = null, - int $code = 0, - ?Throwable $previous = null - ) { + public function __construct(array $allowed, ?string $message = null, int $code = 0, ?Throwable $previous = null) + { $message ??= 'Method Not Allowed'; parent::__construct(self::STATUS_METHOD_NOT_ALLOWED, $message, $code, $previous); - foreach ($allowedMethods as $allowedMethod) { - $this->allowedMethods[] = $allowedMethod; + foreach ($allowed as $method) { + $this->allowedMethods[] = $method; } } diff --git a/src/Exception/Http/HttpNotAcceptableException.php b/src/Exception/Http/HttpNotAcceptableException.php index 66490101..e0bd105d 100644 --- a/src/Exception/Http/HttpNotAcceptableException.php +++ b/src/Exception/Http/HttpNotAcceptableException.php @@ -39,23 +39,19 @@ class HttpNotAcceptableException extends HttpException /** * Constructor of the class * - * @param string[] $supportedMediaTypes - * @param ?string $message + * @param array $supported + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ - public function __construct( - array $supportedMediaTypes, - ?string $message = null, - int $code = 0, - ?Throwable $previous = null - ) { + public function __construct(array $supported, ?string $message = null, int $code = 0, ?Throwable $previous = null) + { $message ??= 'Not Acceptable'; parent::__construct(self::STATUS_NOT_ACCEPTABLE, $message, $code, $previous); - foreach ($supportedMediaTypes as $supportedMediaType) { - $this->supportedMediaTypes[] = $supportedMediaType; + foreach ($supported as $mediaType) { + $this->supportedMediaTypes[] = $mediaType; } } diff --git a/src/Exception/Http/HttpUnsupportedMediaTypeException.php b/src/Exception/Http/HttpUnsupportedMediaTypeException.php index de81ac2d..9db05489 100644 --- a/src/Exception/Http/HttpUnsupportedMediaTypeException.php +++ b/src/Exception/Http/HttpUnsupportedMediaTypeException.php @@ -43,23 +43,19 @@ class HttpUnsupportedMediaTypeException extends HttpException /** * Constructor of the class * - * @param string[] $supportedMediaTypes - * @param ?string $message + * @param array $supported + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ - public function __construct( - array $supportedMediaTypes, - ?string $message = null, - int $code = 0, - ?Throwable $previous = null - ) { + public function __construct(array $supported, ?string $message = null, int $code = 0, ?Throwable $previous = null) + { $message ??= 'Unsupported Media Type'; parent::__construct(self::STATUS_UNSUPPORTED_MEDIA_TYPE, $message, $code, $previous); - foreach ($supportedMediaTypes as $supportedMediaType) { - $this->supportedMediaTypes[] = $supportedMediaType; + foreach ($supported as $mediaType) { + $this->supportedMediaTypes[] = $mediaType; } } diff --git a/src/Exception/UnhydrableObjectException.php b/src/Exception/UnhydrableObjectException.php new file mode 100644 index 00000000..23ba90a2 --- /dev/null +++ b/src/Exception/UnhydrableObjectException.php @@ -0,0 +1,21 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * UnhydrableObjectException + * + * @since 3.0.0 + */ +class UnhydrableObjectException extends LogicException +{ +} diff --git a/src/Exception/UnprocessableObjectException.php b/src/Exception/UnprocessableEntityException.php similarity index 92% rename from src/Exception/UnprocessableObjectException.php rename to src/Exception/UnprocessableEntityException.php index 78bf3f50..afe34b01 100644 --- a/src/Exception/UnprocessableObjectException.php +++ b/src/Exception/UnprocessableEntityException.php @@ -18,11 +18,11 @@ use Symfony\Component\Validator\ConstraintViolationListInterface; /** - * UnprocessableObjectException + * UnprocessableEntityException * * @since 3.0.0 */ -class UnprocessableObjectException extends HttpUnprocessableEntityException +class UnprocessableEntityException extends HttpUnprocessableEntityException { /** diff --git a/src/Exception/UnprocessableRequestBodyException.php b/src/Exception/UnprocessableRequestBodyException.php index 8615eede..5e06f180 100644 --- a/src/Exception/UnprocessableRequestBodyException.php +++ b/src/Exception/UnprocessableRequestBodyException.php @@ -16,6 +16,6 @@ * * @since 3.0.0 */ -class UnprocessableRequestBodyException extends UnprocessableObjectException +class UnprocessableRequestBodyException extends UnprocessableEntityException { } diff --git a/src/Exception/UnprocessableRequestQueryException.php b/src/Exception/UnprocessableRequestQueryException.php index 6ab74b68..c1bae14a 100644 --- a/src/Exception/UnprocessableRequestQueryException.php +++ b/src/Exception/UnprocessableRequestQueryException.php @@ -16,6 +16,6 @@ * * @since 3.0.0 */ -class UnprocessableRequestQueryException extends UnprocessableObjectException +class UnprocessableRequestQueryException extends UnprocessableEntityException { } diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index 9643b2fe..1d4d6697 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -120,8 +120,9 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): { if (!isset($this->parameterResolutioner)) { throw new LogicException( - 'The config route loader cannot accept the parameter resolver(s) ' . - 'because a custom reference resolver was setted and a parameter resolutioner was not passed' + 'The config route loader cannot accept parameter resolvers ' . + 'because a custom reference resolver was setted ' . + 'and a parameter resolutioner was not passed' ); } @@ -144,8 +145,9 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo { if (!isset($this->responseResolutioner)) { throw new LogicException( - 'The config route loader cannot accept the response resolver(s) ' . - 'because a custom reference resolver was setted and a response resolutioner was not passed' + 'The config route loader cannot accept response resolvers ' . + 'because a custom reference resolver was setted ' . + 'and a response resolutioner was not passed' ); } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 858f8e16..885dd4ee 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -160,8 +160,9 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): { if (!isset($this->parameterResolutioner)) { throw new LogicException( - 'The descriptor route loader cannot accept the parameter resolver(s) ' . - 'because a custom reference resolver was setted and a parameter resolutioner was not passed' + 'The descriptor route loader cannot accept parameter resolvers ' . + 'because a custom reference resolver was setted ' . + 'and a parameter resolutioner was not passed' ); } @@ -184,8 +185,9 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo { if (!isset($this->responseResolutioner)) { throw new LogicException( - 'The descriptor route loader cannot accept the response resolver(s) ' . - 'because a custom reference resolver was setted and a response resolutioner was not passed' + 'The descriptor route loader cannot accept response resolvers ' . + 'because a custom reference resolver was setted ' . + 'and a response resolutioner was not passed' ); } @@ -206,8 +208,9 @@ public function useDefaultAnnotationReader(): void { if (!class_exists(AnnotationReader::class)) { throw new LogicException( - 'The annotations reading logic requires an uninstalled "doctrine/annotations" package, ' . - 'run the following command "composer install doctrine/annotations" and try again' + 'The descriptor route loader cannot use the default annotation reader ' . + 'because the annotation reading logic requires the "doctrine/annotations" package, ' . + 'run the "composer install doctrine/annotations" command and try again' ); } @@ -324,8 +327,7 @@ public function attachArray(array $resources): void */ public function load(): RouteCollectionInterface { - $routes = $this->collectionFactory->createCollection(); - + $routes = []; $descriptors = $this->getDescriptors(); foreach ($descriptors as $descriptor) { $route = $this->routeFactory->createRoute( @@ -344,10 +346,10 @@ public function load(): RouteCollectionInterface $route->setDescription($descriptor->description); $route->setTags(...$descriptor->tags); - $routes->add($route); + $routes[] = $route; } - return $routes; + return $this->collectionFactory->createCollection(...$routes); } /** diff --git a/src/Middleware/CallableMiddleware.php b/src/Middleware/CallableMiddleware.php index 0e2e5502..18da1c0a 100644 --- a/src/Middleware/CallableMiddleware.php +++ b/src/Middleware/CallableMiddleware.php @@ -19,7 +19,6 @@ use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\ParameterResolver\KnownTypedParameterResolver; -use Sunrise\Http\Router\ParameterResolver\KnownUntypedParameterResolver; use Sunrise\Http\Router\ParameterResolutionerInterface; use Sunrise\Http\Router\ResponseResolutionerInterface; use ReflectionFunctionAbstract; @@ -94,16 +93,10 @@ public function getReflection(): ReflectionFunctionAbstract */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - $parameterResolvers = [ - new KnownTypedParameterResolver(ServerRequestInterface::class, $request), - new KnownUntypedParameterResolver('request', $request), - new KnownTypedParameterResolver(RequestHandlerInterface::class, $handler), - new KnownUntypedParameterResolver('handler', $handler), - ]; - $arguments = $this->parameterResolutioner ->withContext($request) - ->withPriorityResolver(...$parameterResolvers) + ->withPriorityResolver(new KnownTypedParameterResolver(ServerRequestInterface::class, $request)) + ->withPriorityResolver(new KnownTypedParameterResolver(RequestHandlerInterface::class, $handler)) ->resolveParameters(...$this->getReflection()->getParameters()); /** @var mixed */ diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 4e12e4a2..9078474f 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -49,7 +49,7 @@ final class JsonPayloadDecodingMiddleware implements MiddlewareInterface */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if ($this->supportsRequest($request)) { + if (ServerRequest::from($request)->isJson()) { $request = $request->withParsedBody( $this->decodeRequestPayload($request) ); @@ -58,22 +58,6 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface return $handler->handle($request); } - /** - * Checks if the given request is supported - * - * @param ServerRequestInterface $request - * - * @return bool - */ - private function supportsRequest(ServerRequestInterface $request): bool - { - if (!($request instanceof ServerRequest)) { - $request = new ServerRequest($request); - } - - return $request->isJson(); - } - /** * Tries to decode the given request's payload * @@ -87,11 +71,11 @@ private function supportsRequest(ServerRequestInterface $request): bool private function decodeRequestPayload(ServerRequestInterface $request): ?array { // https://www.php.net/json.constants - $flags = JSON_BIGINT_AS_STRING | JSON_OBJECT_AS_ARRAY | JSON_THROW_ON_ERROR; + $options = JSON_BIGINT_AS_STRING | JSON_OBJECT_AS_ARRAY | JSON_THROW_ON_ERROR; try { /** @var mixed */ - $result = json_decode($request->getBody()->__toString(), null, 512, $flags); + $result = json_decode($request->getBody()->__toString(), null, 512, $options); } catch (JsonException $e) { throw new InvalidRequestPayloadException(sprintf('Invalid Payload: %s', $e->getMessage()), 0, $e); } diff --git a/src/Middleware/XmlPayloadDecodingMiddleware.php b/src/Middleware/XmlPayloadDecodingMiddleware.php new file mode 100644 index 00000000..4c716dd7 --- /dev/null +++ b/src/Middleware/XmlPayloadDecodingMiddleware.php @@ -0,0 +1,85 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Middleware; + +/** + * Import classes + */ +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\Exception\InvalidRequestPayloadException; +use Sunrise\Http\Router\ServerRequest; +use SimpleXMLElement; +use Throwable; + +/** + * Import functions + */ +use function sprintf; + +/** + * Import constants + */ +use const LIBXML_COMPACT; +use const LIBXML_NONET; +use const LIBXML_NOERROR; +use const LIBXML_NOWARNING; +use const LIBXML_PARSEHUGE; + +/** + * XmlPayloadDecodingMiddleware + * + * @since 3.0.0 + */ +final class XmlPayloadDecodingMiddleware implements MiddlewareInterface +{ + + /** + * {@inheritdoc} + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + if (ServerRequest::from($request)->isXml()) { + $request = $request->withParsedBody( + $this->decodeRequestPayload($request) + ); + } + + return $handler->handle($request); + } + + /** + * Tries to decode the given request's payload + * + * @param ServerRequestInterface $request + * + * @return SimpleXMLElement + * + * @throws InvalidRequestPayloadException + * If the request's payload cannot be decoded. + */ + private function decodeRequestPayload(ServerRequestInterface $request): SimpleXMLElement + { + // https://www.php.net/manual/en/libxml.constants.php + $options = LIBXML_COMPACT | LIBXML_NONET | LIBXML_NOERROR | LIBXML_NOWARNING | LIBXML_PARSEHUGE; + + try { + $result = new SimpleXMLElement($request->getBody()->__toString(), $options); + } catch (Throwable $e) { + throw new InvalidRequestPayloadException(sprintf('Invalid Payload: %s', $e->getMessage()), 0, $e); + } + + return $result; + } +} diff --git a/src/ParameterResolver/DependencyInjectionParameterResolver.php b/src/ParameterResolver/DependencyInjectionParameterResolver.php index 38eb7df1..8530be49 100644 --- a/src/ParameterResolver/DependencyInjectionParameterResolver.php +++ b/src/ParameterResolver/DependencyInjectionParameterResolver.php @@ -66,8 +66,8 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo public function resolveParameter(ReflectionParameter $parameter, $context) { /** @var ReflectionNamedType */ - $parameterType = $parameter->getType(); + $type = $parameter->getType(); - return $this->container->get($parameterType->getName()); + return $this->container->get($type->getName()); } } diff --git a/src/ParameterResolver/KnownTypedParameterResolver.php b/src/ParameterResolver/KnownTypedParameterResolver.php index 59a42f3d..9121c02c 100644 --- a/src/ParameterResolver/KnownTypedParameterResolver.php +++ b/src/ParameterResolver/KnownTypedParameterResolver.php @@ -21,24 +21,26 @@ /** * KnownTypedParameterResolver * + * @template T as object + * * @since 3.0.0 */ final class KnownTypedParameterResolver implements ParameterResolverInterface { /** - * @var class-string + * @var class-string */ private string $type; /** - * @var object + * @var T */ private object $value; /** - * @param class-string $type - * @param object $value + * @param class-string $type + * @param T $value */ public function __construct(string $type, object $value) { diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 24ca56ee..dd231633 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -17,7 +17,7 @@ use Psr\Http\Message\ServerRequestInterface; use Sunrise\Http\Router\Annotation\RequestBody; use Sunrise\Http\Router\Exception\InvalidRequestBodyException; -use Sunrise\Http\Router\Exception\ResolvingParameterException; +use Sunrise\Http\Router\Exception\UnhydrableObjectException; use Sunrise\Http\Router\Exception\UnprocessableRequestBodyException; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\RequestBodyInterface; @@ -102,8 +102,8 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo /** * {@inheritdoc} * - * @throws ResolvingParameterException - * If the object cannot be hydrated. + * @throws UnhydrableObjectException + * If an object isn't valid. * * @throws InvalidRequestBodyException * If the request body structure isn't valid. @@ -117,12 +117,12 @@ public function resolveParameter(ReflectionParameter $parameter, $context) $context = $context; /** @var ReflectionNamedType */ - $parameterType = $parameter->getType(); + $type = $parameter->getType(); try { - $object = $this->hydrator->hydrate($parameterType->getName(), (array) $context->getParsedBody()); + $object = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidObjectException $e) { - throw new ResolvingParameterException($e->getMessage(), 0, $e); + throw new UnhydrableObjectException($e->getMessage(), 0, $e); } catch (InvalidValueException $e) { throw new InvalidRequestBodyException($e->getMessage(), 0, $e); } diff --git a/src/ParameterResolver/RequestEntityParameterResolver.php b/src/ParameterResolver/RequestEntityParameterResolver.php index ab839bc3..4ad6b936 100644 --- a/src/ParameterResolver/RequestEntityParameterResolver.php +++ b/src/ParameterResolver/RequestEntityParameterResolver.php @@ -97,7 +97,7 @@ public function resolveParameter(ReflectionParameter $parameter, $context) $entityId = $context->getAttribute($requestEntity->paramKey); if (!isset($entityId)) { throw new ResolvingParameterException(sprintf( - '{%s} Unable to get Entity ID (%s) by key %s', + '{%s} Unable to get Entity ID (%s) by key %s from the request attributes', $this->stringifyParameter($parameter), $requestEntity->findBy, $requestEntity->paramKey diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index da5997a8..c59b5863 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -17,7 +17,7 @@ use Psr\Http\Message\ServerRequestInterface; use Sunrise\Http\Router\Annotation\RequestQuery; use Sunrise\Http\Router\Exception\InvalidRequestQueryException; -use Sunrise\Http\Router\Exception\ResolvingParameterException; +use Sunrise\Http\Router\Exception\UnhydrableObjectException; use Sunrise\Http\Router\Exception\UnprocessableRequestQueryException; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\RequestQueryInterface; @@ -102,8 +102,8 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo /** * {@inheritdoc} * - * @throws ResolvingParameterException - * If the object cannot be hydrated. + * @throws UnhydrableObjectException + * If an object isn't valid. * * @throws InvalidRequestQueryException * If the request query structure isn't valid. @@ -117,12 +117,12 @@ public function resolveParameter(ReflectionParameter $parameter, $context) $context = $context; /** @var ReflectionNamedType */ - $parameterType = $parameter->getType(); + $type = $parameter->getType(); try { - $object = $this->hydrator->hydrate($parameterType->getName(), $context->getQueryParams()); + $object = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidObjectException $e) { - throw new ResolvingParameterException($e->getMessage(), 0, $e); + throw new UnhydrableObjectException($e->getMessage(), 0, $e); } catch (InvalidValueException $e) { throw new InvalidRequestQueryException($e->getMessage(), 0, $e); } diff --git a/src/ParameterResolver/ServerRequestParameterResolver.php b/src/ParameterResolver/ServerRequestParameterResolver.php index f02d9b17..8510933b 100644 --- a/src/ParameterResolver/ServerRequestParameterResolver.php +++ b/src/ParameterResolver/ServerRequestParameterResolver.php @@ -56,11 +56,7 @@ public function resolveParameter(ReflectionParameter $parameter, $context) /** @var ServerRequestInterface */ $context = $context; - if ($context instanceof ServerRequest) { - return $context; - } - - return new ServerRequest($context); + return ServerRequest::from($context); } } diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index f655b6b4..9fac178a 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -18,7 +18,6 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\ParameterResolver\KnownTypedParameterResolver; -use Sunrise\Http\Router\ParameterResolver\KnownUntypedParameterResolver; use Sunrise\Http\Router\ParameterResolutionerInterface; use Sunrise\Http\Router\ResponseResolutionerInterface; use ReflectionFunctionAbstract; @@ -91,14 +90,9 @@ public function getReflection(): ReflectionFunctionAbstract */ public function handle(ServerRequestInterface $request): ResponseInterface { - $parameterResolvers = [ - new KnownTypedParameterResolver(ServerRequestInterface::class, $request), - new KnownUntypedParameterResolver('request', $request), - ]; - $arguments = $this->parameterResolutioner ->withContext($request) - ->withPriorityResolver(...$parameterResolvers) + ->withPriorityResolver(new KnownTypedParameterResolver(ServerRequestInterface::class, $request)) ->resolveParameters(...$this->getReflection()->getParameters()); /** @var mixed */ diff --git a/src/RouteCollector.php b/src/RouteCollector.php index e4fd9912..380614f1 100644 --- a/src/RouteCollector.php +++ b/src/RouteCollector.php @@ -115,8 +115,9 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): { if (!isset($this->parameterResolutioner)) { throw new LogicException( - 'The route collector cannot accept the parameter resolver(s) ' . - 'because a custom reference resolver was setted and a parameter resolutioner was not passed' + 'The route collector cannot accept parameter resolvers ' . + 'because a custom reference resolver was setted ' . + 'and a parameter resolutioner was not passed' ); } @@ -139,8 +140,9 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo { if (!isset($this->responseResolutioner)) { throw new LogicException( - 'The route collector cannot accept the response resolver(s) ' . - 'because a custom reference resolver was setted and a response resolutioner was not passed' + 'The route collector cannot accept response resolvers ' . + 'because a custom reference resolver was setted ' . + 'and a response resolutioner was not passed' ); } diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 0dc4c75a..29ac7592 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -20,6 +20,7 @@ * Import functions */ use function explode; +use function strncmp; use function strpos; use function strstr; use function strtolower; @@ -48,6 +49,22 @@ public function __construct(ServerRequestInterface $request) $this->request = $request; } + /** + * Creates the class from the given request + * + * @param ServerRequestInterface $request + * + * @return self + */ + public static function from(ServerRequestInterface $request): self + { + if ($request instanceof self) { + return $request; + } + + return new self($request); + } + /** * Checks if the request is JSON * @@ -57,7 +74,24 @@ public function __construct(ServerRequestInterface $request) */ public function isJson(): bool { - return $this->getClientProducedMediaType() === 'application/json'; + return $this->clientProducesMediaType([ + 'application/json', + ]); + } + + /** + * Checks if the request is XML + * + * @link https://tools.ietf.org/html/rfc2376 + * + * @return bool + */ + public function isXml(): bool + { + return $this->clientProducesMediaType([ + 'application/xml', + 'text/xml', + ]); } /** @@ -144,7 +178,7 @@ public function clientProducesMediaType(array $consumedMediaTypes): bool } foreach ($consumedMediaTypes as $consumedMediaType) { - if ($consumedMediaType === $producedMediaType) { + if ($this->compareMediaTypes($consumedMediaType, $producedMediaType)) { return true; } } @@ -170,15 +204,9 @@ public function clientConsumesMediaType(array $producedMediaTypes): bool return true; } - foreach ($producedMediaTypes as $producedMediaType) { - if (strpos($producedMediaType, '/') !== false) { - $producedMediaTypes[] = strstr($producedMediaType, '/', true) . '/*'; - } - } - - foreach ($consumedMediaTypes as $consumedMediaType) { - foreach ($producedMediaTypes as $producedMediaType) { - if ($consumedMediaType === $producedMediaType) { + foreach ($producedMediaTypes as $a) { + foreach ($consumedMediaTypes as $b) { + if ($this->compareMediaTypes($a, $b)) { return true; } } @@ -187,6 +215,37 @@ public function clientConsumesMediaType(array $producedMediaTypes): bool return false; } + /** + * Compares the given media types + * + * @param string $a + * @param string $b + * + * @return bool + */ + public function compareMediaTypes(string $a, string $b): bool + { + if ($a === $b) { + return true; + } + + $slash = strpos($a, '/'); + if ($slash === false) { + return false; + } + + $star = $slash + 1; + if (!isset($a[$star], $b[$star])) { + return false; + } + + if (!($a[$star] === '*' || $b[$star] === '*')) { + return false; + } + + return strncmp($a, $b, $star) === 0; + } + /** * {@inheritdoc} */ From 945de828a2b08e090a2da35e03406ce9fbf1bbe8 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 11 Feb 2023 04:53:48 +0100 Subject: [PATCH 062/180] v3 --- src/ServerRequest.php | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 29ac7592..8d4113e4 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -178,7 +178,7 @@ public function clientProducesMediaType(array $consumedMediaTypes): bool } foreach ($consumedMediaTypes as $consumedMediaType) { - if ($this->compareMediaTypes($consumedMediaType, $producedMediaType)) { + if ($this->equalsMediaTypes($consumedMediaType, $producedMediaType)) { return true; } } @@ -206,7 +206,7 @@ public function clientConsumesMediaType(array $producedMediaTypes): bool foreach ($producedMediaTypes as $a) { foreach ($consumedMediaTypes as $b) { - if ($this->compareMediaTypes($a, $b)) { + if ($this->equalsMediaTypes($a, $b)) { return true; } } @@ -216,14 +216,14 @@ public function clientConsumesMediaType(array $producedMediaTypes): bool } /** - * Compares the given media types + * Checks if the given media types are equal * * @param string $a * @param string $b * * @return bool */ - public function compareMediaTypes(string $a, string $b): bool + public function equalsMediaTypes(string $a, string $b): bool { if ($a === $b) { return true; From 7a27390cef78516ea2a6640775356f31135a5acd Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 11 Feb 2023 18:09:18 +0100 Subject: [PATCH 063/180] v3 --- src/Entity/IpAddress.php | 141 ++++++++++++++++++ src/Middleware/ClientIpAddressMiddleware.php | 55 +++++++ .../ClientIpAddressParameterResolver.php | 77 ++++++++++ src/ServerRequest.php | 36 +++++ 4 files changed, 309 insertions(+) create mode 100644 src/Entity/IpAddress.php create mode 100644 src/Middleware/ClientIpAddressMiddleware.php create mode 100644 src/ParameterResolver/ClientIpAddressParameterResolver.php diff --git a/src/Entity/IpAddress.php b/src/Entity/IpAddress.php new file mode 100644 index 00000000..59c6e2a5 --- /dev/null +++ b/src/Entity/IpAddress.php @@ -0,0 +1,141 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Entity; + +/** + * Import functions + */ +use function filter_var; + +/** + * Import constants + */ +use const FILTER_FLAG_GLOBAL_RANGE; +use const FILTER_FLAG_IPV4; +use const FILTER_FLAG_IPV6; +use const FILTER_FLAG_NO_PRIV_RANGE; +use const FILTER_FLAG_NO_RES_RANGE; +use const FILTER_VALIDATE_IP; + +/** + * IP address entity + * + * @since 3.0.0 + */ +final class IpAddress +{ + + /** + * The IP address value + * + * @var string + */ + private string $value; + + /** + * Constructor of the class + * + * @param string $value + */ + public function __construct(string $value) + { + $this->value = $value; + } + + /** + * Gets the IP address value + * + * @return string + */ + public function getValue(): string + { + return $this->value; + } + + /** + * Checks if the IP address is valid + * + * @return bool + */ + public function isValid(): bool + { + return false !== filter_var($this->value, FILTER_VALIDATE_IP); + } + + /** + * Checks if the IP address is IPv4 + * + * @return bool + */ + public function isVersion4(): bool + { + return false !== filter_var($this->value, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4); + } + + /** + * Checks if the IP address is IPv6 + * + * @return bool + */ + public function isVersion6(): bool + { + return false !== filter_var($this->value, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6); + } + + /** + * Checks if the IP address is in the global range + * + * @return bool + */ + public function isInGlobalRange(): bool + { + return false !== filter_var($this->value, FILTER_VALIDATE_IP, FILTER_FLAG_GLOBAL_RANGE); + } + + /** + * Checks if the IP address is in the private range + * + * @return bool + */ + public function isInPrivateRange(): bool + { + if (!$this->isValid()) { + return false; + } + + return false === filter_var($this->value, FILTER_VALIDATE_IP, FILTER_FLAG_NO_PRIV_RANGE); + } + + /** + * Checks if the IP address is in the reserved range + * + * @return bool + */ + public function isInReservedRange(): bool + { + if (!$this->isValid()) { + return false; + } + + return false === filter_var($this->value, FILTER_VALIDATE_IP, FILTER_FLAG_NO_RES_RANGE); + } + + /** + * Converts the object to a string + * + * @return string + */ + public function __toString(): string + { + return $this->value; + } +} diff --git a/src/Middleware/ClientIpAddressMiddleware.php b/src/Middleware/ClientIpAddressMiddleware.php new file mode 100644 index 00000000..b408548e --- /dev/null +++ b/src/Middleware/ClientIpAddressMiddleware.php @@ -0,0 +1,55 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Middleware; + +/** + * Import classes + */ +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\ServerRequest; + +/** + * ClientIpAddressMiddleware + * + * @since 3.0.0 + */ +final class ClientIpAddressMiddleware implements MiddlewareInterface +{ + + /** + * @var array + */ + private array $proxyChain; + + /** + * Constructor of the class + * + * @param array $proxyChain + */ + public function __construct(array $proxyChain = []) + { + $this->proxyChain = $proxyChain; + } + + /** + * {@inheritdoc} + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + $clientIp = ServerRequest::from($request)->getClientIpAddress($this->proxyChain); + + return $handler->handle($request->withAttribute('@clientIp', $clientIp)); + } +} diff --git a/src/ParameterResolver/ClientIpAddressParameterResolver.php b/src/ParameterResolver/ClientIpAddressParameterResolver.php new file mode 100644 index 00000000..321e46fe --- /dev/null +++ b/src/ParameterResolver/ClientIpAddressParameterResolver.php @@ -0,0 +1,77 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\ParameterResolver; + +/** + * Import classes + */ +use Psr\Http\Message\ServerRequestInterface; +use Sunrise\Http\Router\Entity\IpAddress; +use Sunrise\Http\Router\ParameterResolverInterface; +use Sunrise\Http\Router\ServerRequest; +use ReflectionNamedType; +use ReflectionParameter; + +/** + * ClientIpAddressParameterResolver + * + * @since 3.0.0 + */ +final class ClientIpAddressParameterResolver implements ParameterResolverInterface +{ + + /** + * @var array + */ + private array $proxyChain; + + /** + * Constructor of the class + * + * @param array $proxyChain + */ + public function __construct(array $proxyChain = []) + { + $this->proxyChain = $proxyChain; + } + + /** + * {@inheritdoc} + */ + public function supportsParameter(ReflectionParameter $parameter, $context): bool + { + if (!($context instanceof ServerRequestInterface)) { + return false; + } + + if (!($parameter->getType() instanceof ReflectionNamedType)) { + return false; + } + + if (!($parameter->getType()->getName() === IpAddress::class)) { + return false; + } + + return true; + } + + /** + * {@inheritdoc} + */ + public function resolveParameter(ReflectionParameter $parameter, $context) + { + /** @var ServerRequestInterface */ + $context = $context; + + return ServerRequest::from($context)->getClientIpAddress($this->proxyChain); + } +} diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 8d4113e4..af9dd4fc 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -15,6 +15,7 @@ * Import classes */ use Psr\Http\Message\ServerRequestInterface; +use Sunrise\Http\Router\Entity\IpAddress; /** * Import functions @@ -94,6 +95,41 @@ public function isXml(): bool ]); } + /** + * Gets the client's IP address + * + * @param array $proxyChain + * + * @return IpAddress + */ + public function getClientIpAddress(array $proxyChain = []): IpAddress + { + $env = $this->request->getServerParams(); + + /** @var string */ + $clientIp = $env['REMOTE_ADDR'] ?? '::1'; + + while (isset($proxyChain[$clientIp])) { + $trustedHeader = $proxyChain[$clientIp]; + unset($proxyChain[$clientIp]); + + // the chain can't be untangled... + if (!$this->request->hasHeader($trustedHeader)) { + break; + } + + // X-Forwarded-For: , , + $clientIp = $this->request->getHeaderLine($trustedHeader); + if (strpos($clientIp, ',') !== false) { + $clientIp = strstr($clientIp, ',', true); + } + + $clientIp = trim($clientIp); + } + + return new IpAddress($clientIp); + } + /** * Gets the client's produced media type * From e1046c921c3ce8dfa8bae2bd4d23747a9b5715df Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 11 Feb 2023 18:17:08 +0100 Subject: [PATCH 064/180] v3 --- src/Entity/IpAddress.php | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/src/Entity/IpAddress.php b/src/Entity/IpAddress.php index 59c6e2a5..ce603b0b 100644 --- a/src/Entity/IpAddress.php +++ b/src/Entity/IpAddress.php @@ -19,7 +19,6 @@ /** * Import constants */ -use const FILTER_FLAG_GLOBAL_RANGE; use const FILTER_FLAG_IPV4; use const FILTER_FLAG_IPV6; use const FILTER_FLAG_NO_PRIV_RANGE; @@ -91,16 +90,6 @@ public function isVersion6(): bool return false !== filter_var($this->value, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6); } - /** - * Checks if the IP address is in the global range - * - * @return bool - */ - public function isInGlobalRange(): bool - { - return false !== filter_var($this->value, FILTER_VALIDATE_IP, FILTER_FLAG_GLOBAL_RANGE); - } - /** * Checks if the IP address is in the private range * From cd3ab2b51c8b56e8534ec036c30db185b714b6aa Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 11 Feb 2023 23:40:52 +0100 Subject: [PATCH 065/180] v3 --- src/Annotation/RequestEntity.php | 4 +- src/Dto/ErrorDto.php | 21 ++++ src/Dto/ErrorsDto.php | 21 ++++ src/Entity/IpAddress.php | 20 ++++ .../MissingRequestParameterException.php | 26 ++++ .../CommittingEntityChangesMiddleware.php | 70 +++++++++++ .../JsonErrorHandlingMiddleware.php | 70 +++++++++++ .../DependencyInjectionParameterResolver.php | 4 +- .../RequestBodyParameterResolver.php | 10 +- .../RequestEntityParameterResolver.php | 112 +++++------------- .../RequestQueryParameterResolver.php | 10 +- .../ServerRequestParameterResolver.php | 1 - src/Router.php | 2 +- 13 files changed, 270 insertions(+), 101 deletions(-) create mode 100644 src/Dto/ErrorDto.php create mode 100644 src/Dto/ErrorsDto.php create mode 100644 src/Exception/MissingRequestParameterException.php create mode 100644 src/Middleware/CommittingEntityChangesMiddleware.php create mode 100644 src/Middleware/JsonErrorHandlingMiddleware.php diff --git a/src/Annotation/RequestEntity.php b/src/Annotation/RequestEntity.php index 56fac3de..562039b4 100644 --- a/src/Annotation/RequestEntity.php +++ b/src/Annotation/RequestEntity.php @@ -28,13 +28,13 @@ final class RequestEntity * * @param string|null $em * @param string $findBy - * @param string $paramKey + * @param string|null $paramKey * @param array $criteria */ public function __construct( public ?string $em = null, public string $findBy = 'id', - public string $paramKey = 'id', + public ?string $paramKey = null, public array $criteria = [] ) { } diff --git a/src/Dto/ErrorDto.php b/src/Dto/ErrorDto.php new file mode 100644 index 00000000..0e0b4a76 --- /dev/null +++ b/src/Dto/ErrorDto.php @@ -0,0 +1,21 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Dto; + +/** + * Error DTO + * + * @since 3.0.0 + */ +final class ErrorDto +{ +} diff --git a/src/Dto/ErrorsDto.php b/src/Dto/ErrorsDto.php new file mode 100644 index 00000000..14ec2696 --- /dev/null +++ b/src/Dto/ErrorsDto.php @@ -0,0 +1,21 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Dto; + +/** + * Errors DTO + * + * @since 3.0.0 + */ +final class ErrorsDto +{ +} diff --git a/src/Entity/IpAddress.php b/src/Entity/IpAddress.php index ce603b0b..0b6c6ec5 100644 --- a/src/Entity/IpAddress.php +++ b/src/Entity/IpAddress.php @@ -15,6 +15,7 @@ * Import functions */ use function filter_var; +use function ip2long; /** * Import constants @@ -118,6 +119,25 @@ public function isInReservedRange(): bool return false === filter_var($this->value, FILTER_VALIDATE_IP, FILTER_FLAG_NO_RES_RANGE); } + /** + * Converts the IP address to an integer if it possible + * + * @return int|null + */ + public function toLong(): ?int + { + if (!$this->isVersion4()) { + return null; + } + + $long = ip2long($this->value); + if ($long === false) { + return null; + } + + return $long; + } + /** * Converts the object to a string * diff --git a/src/Exception/MissingRequestParameterException.php b/src/Exception/MissingRequestParameterException.php new file mode 100644 index 00000000..343ec870 --- /dev/null +++ b/src/Exception/MissingRequestParameterException.php @@ -0,0 +1,26 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; + +/** + * MissingRequestParameterException + * + * @since 3.0.0 + */ +class MissingRequestParameterException extends HttpBadRequestException +{ +} diff --git a/src/Middleware/CommittingEntityChangesMiddleware.php b/src/Middleware/CommittingEntityChangesMiddleware.php new file mode 100644 index 00000000..9a27e6c0 --- /dev/null +++ b/src/Middleware/CommittingEntityChangesMiddleware.php @@ -0,0 +1,70 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Middleware; + +/** + * Import classes + */ +use Doctrine\Persistence\ManagerRegistry as EntityManagerRegistryInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; + +/** + * CommittingEntityChangesMiddleware + * + * @since 3.0.0 + */ +final class CommittingEntityChangesMiddleware implements MiddlewareInterface +{ + + /** + * @var EntityManagerRegistryInterface + */ + private EntityManagerRegistryInterface $entityManagerRegistry; + + /** + * @var list + */ + private array $entityManagerNames; + + /** + * @param EntityManagerRegistryInterface $entityManagerRegistry + * @param list $entityManagerNames + */ + public function __construct( + EntityManagerRegistryInterface $entityManagerRegistry, + array $entityManagerNames = [] + ) { + $this->entityManagerRegistry = $entityManagerRegistry; + $this->entityManagerNames = $entityManagerNames; + } + + /** + * {@inheritdoc} + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + $response = $handler->handle($request); + + if (empty($this->entityManagerNames)) { + $this->entityManagerRegistry->getManager()->flush(); + } + + foreach ($this->entityManagerNames as $entityManagerName) { + $this->entityManagerRegistry->getManager($entityManagerName)->flush(); + } + + return $response; + } +} diff --git a/src/Middleware/JsonErrorHandlingMiddleware.php b/src/Middleware/JsonErrorHandlingMiddleware.php new file mode 100644 index 00000000..66fab0c2 --- /dev/null +++ b/src/Middleware/JsonErrorHandlingMiddleware.php @@ -0,0 +1,70 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Middleware; + +/** + * Import classes + */ +use Psr\Http\Message\ResponseFactoryInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; +use Psr\Log\LoggerInterface; +use Sunrise\Http\Router\Exception\Http\HttpExceptionInterface; + +/** + * JsonErrorHandlingMiddleware + * + * @since 3.0.0 + */ +final class JsonErrorHandlingMiddleware implements MiddlewareInterface +{ + + /** + * @var ResponseFactoryInterface + */ + private ResponseFactoryInterface $responseFactory; + + /** + * @var LoggerInterface + */ + private LoggerInterface $logger; + + /** + * @param ResponseFactoryInterface $responseFactory + * @param LoggerInterface $logger + */ + public function __construct(ResponseFactoryInterface $responseFactory, LoggerInterface $logger) + { + $this->responseFactory = $responseFactory; + $this->logger = $logger; + } + + /** + * {@inheritdoc} + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + try { + return $handler->handle($request); + } catch (HttpExceptionInterface $e) { + $this->logger->debug($e->getMessage()); + + return $this->responseFactory->createResponse($e->getStatusCode()); + } catch (Throwable $e) { + $this->logger->error($e->getMessage()); + + return $this->responseFactory->createResponse(500); + } + } +} diff --git a/src/ParameterResolver/DependencyInjectionParameterResolver.php b/src/ParameterResolver/DependencyInjectionParameterResolver.php index 8530be49..38eb7df1 100644 --- a/src/ParameterResolver/DependencyInjectionParameterResolver.php +++ b/src/ParameterResolver/DependencyInjectionParameterResolver.php @@ -66,8 +66,8 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo public function resolveParameter(ReflectionParameter $parameter, $context) { /** @var ReflectionNamedType */ - $type = $parameter->getType(); + $parameterType = $parameter->getType(); - return $this->container->get($type->getName()); + return $this->container->get($parameterType->getName()); } } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index dd231633..b42ba750 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -102,14 +102,14 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo /** * {@inheritdoc} * - * @throws UnhydrableObjectException - * If an object isn't valid. - * * @throws InvalidRequestBodyException * If the request body structure isn't valid. * * @throws UnprocessableRequestBodyException * If the request body data isn't valid. + * + * @throws UnhydrableObjectException + * If an object isn't valid. */ public function resolveParameter(ReflectionParameter $parameter, $context) { @@ -117,10 +117,10 @@ public function resolveParameter(ReflectionParameter $parameter, $context) $context = $context; /** @var ReflectionNamedType */ - $type = $parameter->getType(); + $parameterType = $parameter->getType(); try { - $object = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); + $object = $this->hydrator->hydrate($parameterType->getName(), (array) $context->getParsedBody()); } catch (InvalidObjectException $e) { throw new UnhydrableObjectException($e->getMessage(), 0, $e); } catch (InvalidValueException $e) { diff --git a/src/ParameterResolver/RequestEntityParameterResolver.php b/src/ParameterResolver/RequestEntityParameterResolver.php index 4ad6b936..6903cd01 100644 --- a/src/ParameterResolver/RequestEntityParameterResolver.php +++ b/src/ParameterResolver/RequestEntityParameterResolver.php @@ -18,17 +18,15 @@ use Psr\Http\Message\ServerRequestInterface; use Sunrise\Http\Router\Annotation\RequestEntity; use Sunrise\Http\Router\Exception\EntityNotFoundException; -use Sunrise\Http\Router\Exception\ResolvingParameterException; +use Sunrise\Http\Router\Exception\MissingRequestParameterException; use Sunrise\Http\Router\ParameterResolverInterface; use ReflectionAttribute; -use ReflectionMethod; use ReflectionNamedType; use ReflectionParameter; /** * Import functions */ -use function class_exists; use function sprintf; /** @@ -78,6 +76,12 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo /** * {@inheritdoc} + * + * @throws MissingRequestParameterException + * If an entity ID was not found in the request parameters. + * + * @throws EntityNotFoundException + * If an entity was not found. */ public function resolveParameter(ReflectionParameter $parameter, $context) { @@ -85,63 +89,36 @@ public function resolveParameter(ReflectionParameter $parameter, $context) $context = $context; /** @var ReflectionNamedType */ - $type = $parameter->getType(); + $parameterType = $parameter->getType(); - /** @var array{0: ReflectionAttribute} */ - $attributes = $parameter->getAttributes(RequestEntity::class); + /** @var non-empty-list */ + $parameterRequestEntityAttributes = $parameter->getAttributes(RequestEntity::class); /** @var RequestEntity */ - $requestEntity = $attributes[0]->newInstance(); + $requestEntity = $parameterRequestEntityAttributes[0]->newInstance(); - /** @var mixed */ - $entityId = $context->getAttribute($requestEntity->paramKey); - if (!isset($entityId)) { - throw new ResolvingParameterException(sprintf( - '{%s} Unable to get Entity ID (%s) by key %s from the request attributes', - $this->stringifyParameter($parameter), - $requestEntity->findBy, - $requestEntity->paramKey - )); - } + // if no request parameter key was assigned, the entity field name will be used... + $requestParameterKey = $requestEntity->paramKey ?? $requestEntity->findBy; - $entityName = $type->getName(); - if (!class_exists($entityName)) { - throw new ResolvingParameterException(sprintf( - '{%s} Entity %s does not exist', - $this->stringifyParameter($parameter), - $entityName - )); - } - - $entityManager = isset($requestEntity->em) ? - $this->entityManagerRegistry->getManager($requestEntity->em) : - $this->entityManagerRegistry->getManagerForClass($entityName); - - if (!isset($entityManager)) { - throw new ResolvingParameterException(sprintf( - '{%s} Unable to get Entity Manager for %s', - $this->stringifyParameter($parameter), - $entityName - )); - } + /** @var string|null */ + $entityId = $context->getAttribute($requestParameterKey); - $entityMetadata = $entityManager->getClassMetadata($entityName); - if (!$entityMetadata->hasField($requestEntity->findBy)) { - throw new ResolvingParameterException(sprintf( - '{%s} Entity %s does not contain field %s', - $this->stringifyParameter($parameter), - $entityName, - $requestEntity->findBy + if (!isset($entityId)) { + throw new MissingRequestParameterException(sprintf( + 'Missing the %s parameter in the request', + $requestParameterKey )); } - $criteria = [ - $requestEntity->findBy => $entityId, - ]; + $criteria = $requestEntity->criteria; + $criteria[$requestEntity->findBy] = $entityId; - $criteria += $requestEntity->criteria; + /** @var class-string */ + $entityName = $parameterType->getName(); - $entity = $entityManager->getRepository($entityName) + $entity = $this->entityManagerRegistry + ->getManager($requestEntity->em) + ->getRepository($entityName) ->findOneBy($criteria); if (isset($entity)) { @@ -152,41 +129,6 @@ public function resolveParameter(ReflectionParameter $parameter, $context) return null; } - throw new EntityNotFoundException(sprintf( - '%s Not Found', - $entityMetadata->getReflectionClass()->getShortName() - )); - } - - /** - * Stringifies the given parameter - * - * @param ReflectionParameter $parameter - * - * @return string - */ - private function stringifyParameter(ReflectionParameter $parameter): string - { - /** @var ReflectionNamedType */ - $parameterType = $parameter->getType(); - - if ($parameter->getDeclaringFunction() instanceof ReflectionMethod) { - return sprintf( - '%s::%s(%s $%s[%d])', - $parameter->getDeclaringFunction()->getDeclaringClass()->getName(), - $parameter->getDeclaringFunction()->getName(), - $parameterType->getName(), - $parameter->getName(), - $parameter->getPosition() - ); - } - - return sprintf( - '%s(%s $%s[%d])', - $parameter->getDeclaringFunction()->getName(), - $parameterType->getName(), - $parameter->getName(), - $parameter->getPosition() - ); + throw new EntityNotFoundException('Entity Not Found'); } } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index c59b5863..070daab4 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -102,14 +102,14 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo /** * {@inheritdoc} * - * @throws UnhydrableObjectException - * If an object isn't valid. - * * @throws InvalidRequestQueryException * If the request query structure isn't valid. * * @throws UnprocessableRequestQueryException * If the request query data isn't valid. + * + * @throws UnhydrableObjectException + * If an object isn't valid. */ public function resolveParameter(ReflectionParameter $parameter, $context) { @@ -117,10 +117,10 @@ public function resolveParameter(ReflectionParameter $parameter, $context) $context = $context; /** @var ReflectionNamedType */ - $type = $parameter->getType(); + $parameterType = $parameter->getType(); try { - $object = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); + $object = $this->hydrator->hydrate($parameterType->getName(), $context->getQueryParams()); } catch (InvalidObjectException $e) { throw new UnhydrableObjectException($e->getMessage(), 0, $e); } catch (InvalidValueException $e) { diff --git a/src/ParameterResolver/ServerRequestParameterResolver.php b/src/ParameterResolver/ServerRequestParameterResolver.php index 8510933b..58753289 100644 --- a/src/ParameterResolver/ServerRequestParameterResolver.php +++ b/src/ParameterResolver/ServerRequestParameterResolver.php @@ -59,4 +59,3 @@ public function resolveParameter(ReflectionParameter $parameter, $context) return ServerRequest::from($context); } } - diff --git a/src/Router.php b/src/Router.php index 4ce6810e..09b932b2 100644 --- a/src/Router.php +++ b/src/Router.php @@ -285,7 +285,7 @@ public function match(ServerRequestInterface $request): RouteInterface throw new HttpMethodNotAllowedException($allowedMethods); } - throw new HttpNotFoundException(); + throw new HttpNotFoundException('Page Not Found'); } /** From eaa4ec431c3eea63a2379e621f9a8d7a59db799e Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 11 Feb 2023 23:50:42 +0100 Subject: [PATCH 066/180] v3 --- src/Dto/ErrorDto.php | 21 ------ src/Dto/ErrorsDto.php | 21 ------ .../JsonErrorHandlingMiddleware.php | 70 ------------------- 3 files changed, 112 deletions(-) delete mode 100644 src/Dto/ErrorDto.php delete mode 100644 src/Dto/ErrorsDto.php delete mode 100644 src/Middleware/JsonErrorHandlingMiddleware.php diff --git a/src/Dto/ErrorDto.php b/src/Dto/ErrorDto.php deleted file mode 100644 index 0e0b4a76..00000000 --- a/src/Dto/ErrorDto.php +++ /dev/null @@ -1,21 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Dto; - -/** - * Error DTO - * - * @since 3.0.0 - */ -final class ErrorDto -{ -} diff --git a/src/Dto/ErrorsDto.php b/src/Dto/ErrorsDto.php deleted file mode 100644 index 14ec2696..00000000 --- a/src/Dto/ErrorsDto.php +++ /dev/null @@ -1,21 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Dto; - -/** - * Errors DTO - * - * @since 3.0.0 - */ -final class ErrorsDto -{ -} diff --git a/src/Middleware/JsonErrorHandlingMiddleware.php b/src/Middleware/JsonErrorHandlingMiddleware.php deleted file mode 100644 index 66fab0c2..00000000 --- a/src/Middleware/JsonErrorHandlingMiddleware.php +++ /dev/null @@ -1,70 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Middleware; - -/** - * Import classes - */ -use Psr\Http\Message\ResponseFactoryInterface; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; -use Psr\Log\LoggerInterface; -use Sunrise\Http\Router\Exception\Http\HttpExceptionInterface; - -/** - * JsonErrorHandlingMiddleware - * - * @since 3.0.0 - */ -final class JsonErrorHandlingMiddleware implements MiddlewareInterface -{ - - /** - * @var ResponseFactoryInterface - */ - private ResponseFactoryInterface $responseFactory; - - /** - * @var LoggerInterface - */ - private LoggerInterface $logger; - - /** - * @param ResponseFactoryInterface $responseFactory - * @param LoggerInterface $logger - */ - public function __construct(ResponseFactoryInterface $responseFactory, LoggerInterface $logger) - { - $this->responseFactory = $responseFactory; - $this->logger = $logger; - } - - /** - * {@inheritdoc} - */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface - { - try { - return $handler->handle($request); - } catch (HttpExceptionInterface $e) { - $this->logger->debug($e->getMessage()); - - return $this->responseFactory->createResponse($e->getStatusCode()); - } catch (Throwable $e) { - $this->logger->error($e->getMessage()); - - return $this->responseFactory->createResponse(500); - } - } -} From 44b0aecf42ef8b2d1da27e8a161347b0c5772943 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 12 Feb 2023 01:59:26 +0100 Subject: [PATCH 067/180] v3 --- .../ClientNotConsumedMediaTypeException.php | 26 ++++++++ .../ClientNotProducedMediaTypeException.php | 26 ++++++++ src/Exception/MethodNotAllowedException.php | 24 +++++++ src/Exception/PageNotFoundException.php | 26 ++++++++ src/RouteCollection.php | 12 ++-- src/RouteCollectionInterface.php | 2 +- src/Router.php | 64 ++++++++++--------- 7 files changed, 142 insertions(+), 38 deletions(-) create mode 100644 src/Exception/ClientNotConsumedMediaTypeException.php create mode 100644 src/Exception/ClientNotProducedMediaTypeException.php create mode 100644 src/Exception/MethodNotAllowedException.php create mode 100644 src/Exception/PageNotFoundException.php diff --git a/src/Exception/ClientNotConsumedMediaTypeException.php b/src/Exception/ClientNotConsumedMediaTypeException.php new file mode 100644 index 00000000..ec11ce1f --- /dev/null +++ b/src/Exception/ClientNotConsumedMediaTypeException.php @@ -0,0 +1,26 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\Http\HttpNotAcceptableException; + +/** + * ClientNotConsumedMediaTypeException + * + * @since 3.0.0 + */ +class ClientNotConsumedMediaTypeException extends HttpNotAcceptableException +{ +} diff --git a/src/Exception/ClientNotProducedMediaTypeException.php b/src/Exception/ClientNotProducedMediaTypeException.php new file mode 100644 index 00000000..d6664161 --- /dev/null +++ b/src/Exception/ClientNotProducedMediaTypeException.php @@ -0,0 +1,26 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\Http\HttpUnsupportedMediaTypeException; + +/** + * ClientNotProducedMediaTypeException + * + * @since 3.0.0 + */ +class ClientNotProducedMediaTypeException extends HttpUnsupportedMediaTypeException +{ +} diff --git a/src/Exception/MethodNotAllowedException.php b/src/Exception/MethodNotAllowedException.php new file mode 100644 index 00000000..b2edb2f4 --- /dev/null +++ b/src/Exception/MethodNotAllowedException.php @@ -0,0 +1,24 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\Http\HttpMethodNotAllowedException; + +/** + * MethodNotAllowedException + */ +class MethodNotAllowedException extends HttpMethodNotAllowedException +{ +} diff --git a/src/Exception/PageNotFoundException.php b/src/Exception/PageNotFoundException.php new file mode 100644 index 00000000..0a8ad15d --- /dev/null +++ b/src/Exception/PageNotFoundException.php @@ -0,0 +1,26 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +namespace Sunrise\Http\Router\Exception; + +/** + * Import classes + */ +use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; + +/** + * PageNotFoundException + * + * @since 2.4.2 + */ +class PageNotFoundException extends HttpNotFoundException +{ +} diff --git a/src/RouteCollection.php b/src/RouteCollection.php index 37db2551..53f42485 100644 --- a/src/RouteCollection.php +++ b/src/RouteCollection.php @@ -36,7 +36,7 @@ class RouteCollection implements RouteCollectionInterface /** * @var string */ - private const ANY_HOST = '*'; + private const ANY = '*'; /** * @var array @@ -81,16 +81,16 @@ public function all(): Iterator /** * {@inheritdoc} */ - public function allByHost(?string $host): Iterator + public function allOnHost(?string $host): Iterator { - if (isset($host, $this->hostMap[$host])) { + if (isset($host) && isset($this->hostMap[$host])) { foreach ($this->hostMap[$host] as $name) { yield $this->routes[$name]; } } - if (isset($this->hostMap[self::ANY_HOST])) { - foreach ($this->hostMap[self::ANY_HOST] as $name) { + if (isset($this->hostMap[self::ANY])) { + foreach ($this->hostMap[self::ANY] as $name) { yield $this->routes[$name]; } } @@ -126,7 +126,7 @@ public function add(RouteInterface ...$routes): RouteCollectionInterface { foreach ($routes as $route) { $name = $route->getName(); - $host = $route->getHost() ?? self::ANY_HOST; + $host = $route->getHost() ?? self::ANY; if (isset($this->routes[$name])) { throw new RouteAlreadyExistsException(sprintf( diff --git a/src/RouteCollectionInterface.php b/src/RouteCollectionInterface.php index 3c224262..554861e9 100644 --- a/src/RouteCollectionInterface.php +++ b/src/RouteCollectionInterface.php @@ -48,7 +48,7 @@ public function all(): Iterator; * * @since 3.0.0 */ - public function allByHost(?string $host): Iterator; + public function allOnHost(?string $host): Iterator; /** * Checks by the given name if a route exists in the collection diff --git a/src/Router.php b/src/Router.php index 09b932b2..6eae4458 100644 --- a/src/Router.php +++ b/src/Router.php @@ -21,10 +21,10 @@ use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Event\RouteEvent; -use Sunrise\Http\Router\Exception\Http\HttpMethodNotAllowedException; -use Sunrise\Http\Router\Exception\Http\HttpNotAcceptableException; -use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; -use Sunrise\Http\Router\Exception\Http\HttpUnsupportedMediaTypeException; +use Sunrise\Http\Router\Exception\ClientNotConsumedMediaTypeException; +use Sunrise\Http\Router\Exception\ClientNotProducedMediaTypeException; +use Sunrise\Http\Router\Exception\MethodNotAllowedException; +use Sunrise\Http\Router\Exception\PageNotFoundException; use Sunrise\Http\Router\Loader\LoaderInterface; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; use Sunrise\Http\Router\RequestHandler\UnsafeCallableRequestHandler; @@ -227,65 +227,67 @@ public function generateUri(string $name, array $attributes = [], bool $strict = * * @return RouteInterface * - * @throws HttpNotFoundException - * If the request URI cannot be matched against any route. + * @throws PageNotFoundException + * If the request URI isn't served. * - * @throws HttpMethodNotAllowedException + * @throws MethodNotAllowedException * If the request method isn't allowed. * - * @throws HttpUnsupportedMediaTypeException + * @throws ClientNotProducedMediaTypeException + * If the client not produces required media types. * - * @throws HttpNotAcceptableException + * @throws ClientNotConsumedMediaTypeException + * If the client not consumed provided media types. */ public function match(ServerRequestInterface $request): RouteInterface { $requestUri = $request->getUri(); $requestHost = $requestUri->getHost(); $requestPath = $requestUri->getPath(); - $requestMethod = $request->getMethod(); - $allowedMethods = []; + $requestVerb = $request->getMethod(); + $allowedVerbs = []; - $routes = $this->routes->allByHost($this->hosts->resolve($requestHost)); - - $request = new ServerRequest($request); + $host = $this->hosts->resolve($requestHost); + $routes = $this->routes->allOnHost($host); + $request = ServerRequest::from($request); foreach ($routes as $route) { // https://github.com/sunrise-php/http-router/issues/50 // https://tools.ietf.org/html/rfc7231#section-6.5.5 - if (!path_match($route->getPath(), $requestPath, $attributes)) { + if (!path_match($route->getPath(), $requestPath, $routeAttributes)) { continue; } - $routeMethods = []; - foreach ($route->getMethods() as $routeMethod) { - $routeMethods[$routeMethod] = true; - $allowedMethods[$routeMethod] = $routeMethod; + $routeVerbs = []; + foreach ($route->getMethods() as $routeVerb) { + $routeVerbs[$routeVerb] = true; + $allowedVerbs[$routeVerb] = $routeVerb; } - if (!isset($routeMethods[$requestMethod])) { + if (!isset($routeVerbs[$requestVerb])) { continue; } - $consumedMediaTypes = $route->getConsumedMediaTypes(); - if (!empty($consumedMediaTypes) && !$request->clientProducesMediaType($consumedMediaTypes)) { - throw new HttpUnsupportedMediaTypeException($consumedMediaTypes); + $routeConsumed = $route->getConsumedMediaTypes(); + if (!empty($routeConsumed) && !$request->clientProducesMediaType($routeConsumed)) { + throw new ClientNotProducedMediaTypeException($routeConsumed); } - $producedMediaTypes = $route->getProducedMediaTypes(); - if (!empty($producedMediaTypes) && !$request->clientConsumesMediaType($producedMediaTypes)) { - throw new HttpNotAcceptableException($producedMediaTypes); + $routeProduced = $route->getProducedMediaTypes(); + if (!empty($routeProduced) && !$request->clientConsumesMediaType($routeProduced)) { + throw new ClientNotConsumedMediaTypeException($routeProduced); } - /** @var array $attributes */ + /** @var array $routeAttributes */ - return $route->withAddedAttributes($attributes); + return $route->withAddedAttributes($routeAttributes); } - if (!empty($allowedMethods)) { - throw new HttpMethodNotAllowedException($allowedMethods); + if (!empty($allowedVerbs)) { + throw new MethodNotAllowedException($allowedVerbs); } - throw new HttpNotFoundException('Page Not Found'); + throw new PageNotFoundException('Page Not Found'); } /** From e49f4c487f587606ed85899221fa7cee0c494c31 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 12 Feb 2023 06:39:13 +0100 Subject: [PATCH 068/180] v3 --- src/Router.php | 96 +++++++++++++++++------------------ src/ServerRequest.php | 113 +++++++++++++++++++++++++++++++++++------- 2 files changed, 144 insertions(+), 65 deletions(-) diff --git a/src/Router.php b/src/Router.php index 6eae4458..061e15c9 100644 --- a/src/Router.php +++ b/src/Router.php @@ -61,7 +61,7 @@ class Router implements RequestHandlerInterface, RequestMethodInterface private HostTable $hosts; /** - * The router's routes + * The router's route collection * * @var RouteCollectionInterface */ @@ -104,22 +104,6 @@ public function __construct( $this->routes = $routes ?? new RouteCollection(); } - /** - * Adds the given patterns to the router - * - * @param array $patterns - * - * @return void - * - * @since 2.11.0 - */ - public function addPatterns(array $patterns): void - { - foreach ($patterns as $alias => $pattern) { - self::$patterns[$alias] = $pattern; - } - } - /** * Gets the router's host table * @@ -143,33 +127,33 @@ public function getRoutes(): RouteCollectionInterface } /** - * Adds the given middleware(s) to the router - * - * @param MiddlewareInterface ...$middlewares + * Gets the router's middlewares * - * @return void + * @return list */ - public function addMiddleware(MiddlewareInterface ...$middlewares): void + public function getMiddlewares(): array { - foreach ($middlewares as $middleware) { - $this->middlewares[] = $middleware; - } + return $this->middlewares; } /** - * Gets the router's middlewares + * Gets the router's event dispatcher * - * @return list + * @return EventDispatcherInterface|null + * + * @since 2.13.0 */ - public function getMiddlewares(): array + public function getEventDispatcher(): ?EventDispatcherInterface { - return $this->middlewares; + return $this->eventDispatcher; } /** * Gets the router's matched route * * @return RouteInterface|null + * + * @since 2.12.0 */ public function getMatchedRoute(): ?RouteInterface { @@ -177,29 +161,47 @@ public function getMatchedRoute(): ?RouteInterface } /** - * Sets the given event dispatcher to the router + * Adds the given patterns to the router * - * @param EventDispatcherInterface|null $eventDispatcher + * @param array $patterns * * @return void * - * @since 2.13.0 + * @since 2.11.0 */ - public function setEventDispatcher(?EventDispatcherInterface $eventDispatcher): void + public function addPatterns(array $patterns): void { - $this->eventDispatcher = $eventDispatcher; + foreach ($patterns as $alias => $pattern) { + self::$patterns[$alias] = $pattern; + } } /** - * Gets the router's event dispatcher + * Adds the given middleware(s) to the router * - * @return EventDispatcherInterface|null + * @param MiddlewareInterface ...$middlewares + * + * @return void + */ + public function addMiddleware(MiddlewareInterface ...$middlewares): void + { + foreach ($middlewares as $middleware) { + $this->middlewares[] = $middleware; + } + } + + /** + * Sets the given event dispatcher to the router + * + * @param EventDispatcherInterface|null $eventDispatcher + * + * @return void * * @since 2.13.0 */ - public function getEventDispatcher(): ?EventDispatcherInterface + public function setEventDispatcher(?EventDispatcherInterface $eventDispatcher): void { - return $this->eventDispatcher; + $this->eventDispatcher = $eventDispatcher; } /** @@ -254,7 +256,7 @@ public function match(ServerRequestInterface $request): RouteInterface foreach ($routes as $route) { // https://github.com/sunrise-php/http-router/issues/50 // https://tools.ietf.org/html/rfc7231#section-6.5.5 - if (!path_match($route->getPath(), $requestPath, $routeAttributes)) { + if (!path_match($route->getPath(), $requestPath, $attributes)) { continue; } @@ -268,19 +270,19 @@ public function match(ServerRequestInterface $request): RouteInterface continue; } - $routeConsumed = $route->getConsumedMediaTypes(); - if (!empty($routeConsumed) && !$request->clientProducesMediaType($routeConsumed)) { - throw new ClientNotProducedMediaTypeException($routeConsumed); + $routeConsumes = $route->getConsumedMediaTypes(); + if (!empty($routeConsumes) && !$request->clientProducesMediaType($routeConsumes)) { + throw new ClientNotProducedMediaTypeException($routeConsumes); } - $routeProduced = $route->getProducedMediaTypes(); - if (!empty($routeProduced) && !$request->clientConsumesMediaType($routeProduced)) { - throw new ClientNotConsumedMediaTypeException($routeProduced); + $routeProduces = $route->getProducedMediaTypes(); + if (!empty($routeProduces) && !$request->clientConsumesMediaType($routeProduces)) { + throw new ClientNotConsumedMediaTypeException($routeProduces); } - /** @var array $routeAttributes */ + /** @var array $attributes */ - return $route->withAddedAttributes($routeAttributes); + return $route->withAddedAttributes($attributes); } if (!empty($allowedVerbs)) { diff --git a/src/ServerRequest.php b/src/ServerRequest.php index af9dd4fc..f73996de 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -95,6 +95,16 @@ public function isXml(): bool ]); } + /** + * Checks if the request is XMLHttpRequest + * + * @return bool + */ + public function isXmlHttpRequest(): bool + { + return $this->request->getHeaderLine('X-Requested-With') === 'XMLHttpRequest'; + } + /** * Gets the client's IP address * @@ -113,18 +123,22 @@ public function getClientIpAddress(array $proxyChain = []): IpAddress $trustedHeader = $proxyChain[$clientIp]; unset($proxyChain[$clientIp]); - // the chain can't be untangled... - if (!$this->request->hasHeader($trustedHeader)) { + $header = $this->request->getHeaderLine($trustedHeader); + if ($header === '') { break; } - // X-Forwarded-For: , , - $clientIp = $this->request->getHeaderLine($trustedHeader); - if (strpos($clientIp, ',') !== false) { - $clientIp = strstr($clientIp, ',', true); + $proxiedClientIp = strstr($header, ',', true); + if ($proxiedClientIp === false) { + $proxiedClientIp = $header; } - $clientIp = trim($clientIp); + $proxiedClientIp = trim($proxiedClientIp); + if ($proxiedClientIp === '') { + break; + } + + $clientIp = $proxiedClientIp; } return new IpAddress($clientIp); @@ -145,16 +159,17 @@ public function getClientProducedMediaType(): string return ''; } - if (strpos($header, ';') !== false) { - $header = strstr($header, ';', true); + $mediaType = strstr($header, ';', true); + if ($mediaType === false) { + $mediaType = $header; } - $header = trim($header); - if ($header === '') { + $mediaType = trim($mediaType); + if ($mediaType === '') { return ''; } - return strtolower($header); + return strtolower($mediaType); } /** @@ -176,20 +191,82 @@ public function getClientConsumedMediaTypes(): array $result = []; $accepts = explode(',', $header); foreach ($accepts as $accept) { - if (strpos($accept, ';') !== false) { - $accept = strstr($accept, ';', true); + $mediaType = strstr($accept, ';', true); + if ($mediaType === false) { + $mediaType = $accept; } - $accept = trim($accept); - if ($accept === '') { + $mediaType = trim($mediaType); + if ($mediaType === '') { continue; } - if ($accept === '*/*') { + if ($mediaType === '*/*') { return []; } - $result[] = strtolower($accept); + $result[] = strtolower($mediaType); + } + + return $result; + } + + /** + * Gets the client's consumed languages + * + * @return array + */ + public function getClientConsumedLanguages(): array + { + $header = $this->request->getHeaderLine('Accept-Language'); + if ($header === '') { + return []; + } + + $cursor = -1; + $inLanguage = true; + $inWeight = false; + $rows = []; + $i = 0; + + while (true) { + $char = $header[++$cursor] ?? null; + + if ($char === null) { + break; + } + if ($char === ' ') { + continue; + } + if ($char === ';') { + $inLanguage = false; + continue; + } + if ($char === '=') { + $inWeight = true; + continue; + } + if ($char === ',') { + $inLanguage = true; + $inWeight = false; + $i++; + continue; + } + if ($inLanguage) { + $rows[$i][0] ??= ''; + $rows[$i][0] .= $char; + continue; + } + if ($inWeight) { + $rows[$i][1] ??= ''; + $rows[$i][1] .= $char; + continue; + } + } + + $result = []; + foreach ($rows as $row) { + $result[$row[0]] = $row[1] ?? '1'; } return $result; From 686c335ff47d0e85c15d744dd16cce6e654d6cc1 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 12 Feb 2023 19:08:00 +0100 Subject: [PATCH 069/180] v3 --- composer.json | 5 ++-- .../StatusCodeResponseResolver.php | 2 +- src/ServerRequest.php | 25 +++++++++++++------ 3 files changed, 21 insertions(+), 11 deletions(-) diff --git a/composer.json b/composer.json index 0682353f..bbe87bd1 100644 --- a/composer.json +++ b/composer.json @@ -37,14 +37,15 @@ "psr/simple-cache": "^1.0" }, "require-dev": { + "phpunit/phpunit": "^9.6", "doctrine/annotations": "^2.0", "doctrine/persistence": "^3.1", - "phpunit/phpunit": "~9.5.0", "sunrise/coding-standard": "~1.0.0", "sunrise/http-message": "^3.0", "sunrise/hydrator": "^2.7", "symfony/console": "^5.4", - "symfony/validator": "^5.4" + "symfony/validator": "^5.4", + "psr/log": "^1.1" }, "autoload": { "files": [ diff --git a/src/ResponseResolver/StatusCodeResponseResolver.php b/src/ResponseResolver/StatusCodeResponseResolver.php index c7b97262..064f1e23 100644 --- a/src/ResponseResolver/StatusCodeResponseResolver.php +++ b/src/ResponseResolver/StatusCodeResponseResolver.php @@ -57,7 +57,7 @@ public function supportsResponse($response, $context): bool */ public function resolveResponse($response, $context): ResponseInterface { - /** @var int $response */ + /** @var int<100, 599> $response */ return $this->responseFactory->createResponse($response); } diff --git a/src/ServerRequest.php b/src/ServerRequest.php index f73996de..d6035bc2 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -20,6 +20,7 @@ /** * Import functions */ +use function arsort; use function explode; use function strncmp; use function strpos; @@ -27,6 +28,11 @@ use function strtolower; use function trim; +/** + * Import constants + */ +use const SORT_NUMERIC; + /** * ServerRequest * @@ -214,7 +220,7 @@ public function getClientConsumedMediaTypes(): array /** * Gets the client's consumed languages * - * @return array + * @return array */ public function getClientConsumedLanguages(): array { @@ -226,7 +232,7 @@ public function getClientConsumedLanguages(): array $cursor = -1; $inLanguage = true; $inWeight = false; - $rows = []; + $data = []; $i = 0; while (true) { @@ -253,22 +259,25 @@ public function getClientConsumedLanguages(): array continue; } if ($inLanguage) { - $rows[$i][0] ??= ''; - $rows[$i][0] .= $char; + $data[$i][0] ??= ''; + $data[$i][0] .= $char; continue; } if ($inWeight) { - $rows[$i][1] ??= ''; - $rows[$i][1] .= $char; + $data[$i][1] ??= ''; + $data[$i][1] .= $char; continue; } } $result = []; - foreach ($rows as $row) { - $result[$row[0]] = $row[1] ?? '1'; + foreach ($data as $item) { + /** @var array{0: string, 1?: numeric-string} $item */ + $result[$item[0]] = (float) ($item[1] ?? 1.0); } + arsort($result, SORT_NUMERIC); + return $result; } From 8e3aab012f363da238f95be6a5c9dc7272c7cb3b Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Mon, 13 Feb 2023 02:37:17 +0100 Subject: [PATCH 070/180] v3 --- .../Http/HttpBadRequestException.php | 8 +- src/Exception/Http/HttpConflictException.php | 7 +- .../Http/HttpExpectationFailedException.php | 7 +- .../Http/HttpFailedDependencyException.php | 7 +- src/Exception/Http/HttpForbiddenException.php | 8 +- src/Exception/Http/HttpGoneException.php | 10 +-- .../Http/HttpLengthRequiredException.php | 7 +- src/Exception/Http/HttpLockedException.php | 7 +- .../Http/HttpMisdirectedRequestException.php | 8 +- .../Http/HttpNotAcceptableException.php | 18 ++-- src/Exception/Http/HttpNotFoundException.php | 10 +-- .../Http/HttpPayloadTooLargeException.php | 8 +- .../Http/HttpPaymentRequiredException.php | 8 +- .../Http/HttpPreconditionFailedException.php | 7 +- .../HttpPreconditionRequiredException.php | 9 +- ...tpProxyAuthenticationRequiredException.php | 7 +- .../Http/HttpRangeNotSatisfiableException.php | 8 +- ...tpRequestHeaderFieldsTooLargeException.php | 8 +- .../Http/HttpRequestTimeoutException.php | 10 +-- .../Http/HttpServiceUnavailableException.php | 11 +-- src/Exception/Http/HttpTooEarlyException.php | 7 +- .../Http/HttpTooManyRequestsException.php | 7 +- .../Http/HttpUnauthorizedException.php | 8 +- ...ttpUnavailableForLegalReasonsException.php | 8 +- .../Http/HttpUnprocessableEntityException.php | 7 +- .../HttpUnsupportedMediaTypeException.php | 39 +++------ .../Http/HttpUpgradeRequiredException.php | 9 +- .../Http/HttpUriTooLongException.php | 7 +- src/Exception/{Http => }/HttpException.php | 42 ++++++++-- .../{Http => }/HttpExceptionInterface.php | 12 ++- .../ServerRequestParameterResolver.php | 61 -------------- src/ServerRequest.php | 84 +------------------ 32 files changed, 146 insertions(+), 318 deletions(-) rename src/Exception/{Http => }/HttpException.php (52%) rename src/Exception/{Http => }/HttpExceptionInterface.php (74%) delete mode 100644 src/ParameterResolver/ServerRequestParameterResolver.php diff --git a/src/Exception/Http/HttpBadRequestException.php b/src/Exception/Http/HttpBadRequestException.php index efdd06bd..cbc905d9 100644 --- a/src/Exception/Http/HttpBadRequestException.php +++ b/src/Exception/Http/HttpBadRequestException.php @@ -14,14 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Bad Request Exception * - * The server cannot or will not process the request due to something that is perceived to be a client error (e.g., - * malformed request syntax, invalid request message framing, or deceptive request routing). - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400 * * @since 3.0.0 @@ -32,9 +30,9 @@ class HttpBadRequestException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpConflictException.php b/src/Exception/Http/HttpConflictException.php index 6e5115fa..0996af75 100644 --- a/src/Exception/Http/HttpConflictException.php +++ b/src/Exception/Http/HttpConflictException.php @@ -14,13 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Conflict Exception * - * This response is sent when a request conflicts with the current state of the server. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409 * * @since 3.0.0 @@ -31,9 +30,9 @@ class HttpConflictException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpExpectationFailedException.php b/src/Exception/Http/HttpExpectationFailedException.php index 4d976867..2c0945eb 100644 --- a/src/Exception/Http/HttpExpectationFailedException.php +++ b/src/Exception/Http/HttpExpectationFailedException.php @@ -14,13 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Expectation Failed Exception * - * This response code means the expectation indicated by the Expect request header field cannot be met by the server. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/417 * * @since 3.0.0 @@ -31,9 +30,9 @@ class HttpExpectationFailedException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpFailedDependencyException.php b/src/Exception/Http/HttpFailedDependencyException.php index c895fd6a..878ca548 100644 --- a/src/Exception/Http/HttpFailedDependencyException.php +++ b/src/Exception/Http/HttpFailedDependencyException.php @@ -14,12 +14,13 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Failed Dependency Exception * - * The request failed due to failure of a previous request. + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/424 * * @since 3.0.0 */ @@ -29,9 +30,9 @@ class HttpFailedDependencyException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpForbiddenException.php b/src/Exception/Http/HttpForbiddenException.php index a1b03951..b2f50362 100644 --- a/src/Exception/Http/HttpForbiddenException.php +++ b/src/Exception/Http/HttpForbiddenException.php @@ -14,14 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Forbidden Exception * - * The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give - * the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/403 * * @since 3.0.0 @@ -32,9 +30,9 @@ class HttpForbiddenException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpGoneException.php b/src/Exception/Http/HttpGoneException.php index 0eae223b..e7e7734a 100644 --- a/src/Exception/Http/HttpGoneException.php +++ b/src/Exception/Http/HttpGoneException.php @@ -14,16 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Gone Exception * - * This response is sent when the requested content has been permanently deleted from server, with no forwarding - * address. Clients are expected to remove their caches and links to the resource. The HTTP specification intends this - * status code to be used for "limited-time, promotional services". APIs should not feel compelled to indicate resources - * that have been deleted with this status code. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/410 * * @since 3.0.0 @@ -34,9 +30,9 @@ class HttpGoneException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpLengthRequiredException.php b/src/Exception/Http/HttpLengthRequiredException.php index bf1e58cf..622b5579 100644 --- a/src/Exception/Http/HttpLengthRequiredException.php +++ b/src/Exception/Http/HttpLengthRequiredException.php @@ -14,13 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Length Required Exception * - * Server rejected the request because the Content-Length header field is not defined and the server requires it. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/411 * * @since 3.0.0 @@ -31,9 +30,9 @@ class HttpLengthRequiredException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpLockedException.php b/src/Exception/Http/HttpLockedException.php index 6b280521..d53dfdeb 100644 --- a/src/Exception/Http/HttpLockedException.php +++ b/src/Exception/Http/HttpLockedException.php @@ -14,13 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Locked Exception * - * The resource that is being accessed is locked. - * * @since 3.0.0 */ class HttpLockedException extends HttpException @@ -29,9 +28,9 @@ class HttpLockedException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpMisdirectedRequestException.php b/src/Exception/Http/HttpMisdirectedRequestException.php index 14228d90..03886cf2 100644 --- a/src/Exception/Http/HttpMisdirectedRequestException.php +++ b/src/Exception/Http/HttpMisdirectedRequestException.php @@ -14,14 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Misdirected Request Exception * - * The request was directed at a server that is not able to produce a response. This can be sent by a server that is not - * configured to produce responses for the combination of scheme and authority that are included in the request URI. - * * @since 3.0.0 */ class HttpMisdirectedRequestException extends HttpException @@ -30,9 +28,9 @@ class HttpMisdirectedRequestException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpNotAcceptableException.php b/src/Exception/Http/HttpNotAcceptableException.php index e0bd105d..4f775ee2 100644 --- a/src/Exception/Http/HttpNotAcceptableException.php +++ b/src/Exception/Http/HttpNotAcceptableException.php @@ -14,14 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Not Acceptable Exception * - * This response is sent when the web server, after performing server-driven content negotiation, doesn't find any - * content that conforms to the criteria given by the user agent. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/406 * * @since 3.0.0 @@ -39,20 +37,22 @@ class HttpNotAcceptableException extends HttpException /** * Constructor of the class * - * @param array $supported + * @param list $supportedMediaTypes * @param string|null $message * @param int $code * @param Throwable|null $previous */ - public function __construct(array $supported, ?string $message = null, int $code = 0, ?Throwable $previous = null) - { + public function __construct( + array $supportedMediaTypes, + ?string $message = null, + int $code = 0, + ?Throwable $previous = null + ) { $message ??= 'Not Acceptable'; parent::__construct(self::STATUS_NOT_ACCEPTABLE, $message, $code, $previous); - foreach ($supported as $mediaType) { - $this->supportedMediaTypes[] = $mediaType; - } + $this->supportedMediaTypes = $supportedMediaTypes; } /** diff --git a/src/Exception/Http/HttpNotFoundException.php b/src/Exception/Http/HttpNotFoundException.php index 8ee9fada..ea27916c 100644 --- a/src/Exception/Http/HttpNotFoundException.php +++ b/src/Exception/Http/HttpNotFoundException.php @@ -14,16 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Not Found Exception * - * The server cannot find the requested resource. In the browser, this means the URL is not recognized. In an API, this - * can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response - * instead of 403 Forbidden to hide the existence of a resource from an unauthorized client. This response code is - * probably the most well known due to its frequent occurrence on the web. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404 * * @since 3.0.0 @@ -34,9 +30,9 @@ class HttpNotFoundException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpPayloadTooLargeException.php b/src/Exception/Http/HttpPayloadTooLargeException.php index 6a411a43..1d838c34 100644 --- a/src/Exception/Http/HttpPayloadTooLargeException.php +++ b/src/Exception/Http/HttpPayloadTooLargeException.php @@ -14,14 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Payload Too Large Exception * - * Request entity is larger than limits defined by server. The server might close the connection or return an - * Retry-After header field. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/413 * * @since 3.0.0 @@ -32,9 +30,9 @@ class HttpPayloadTooLargeException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpPaymentRequiredException.php b/src/Exception/Http/HttpPaymentRequiredException.php index d5684ef7..23318337 100644 --- a/src/Exception/Http/HttpPaymentRequiredException.php +++ b/src/Exception/Http/HttpPaymentRequiredException.php @@ -14,14 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Payment Required Exception * - * This response code is reserved for future use. The initial aim for creating this code was using it for digital - * payment systems, however this status code is used very rarely and no standard convention exists. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402 * * @since 3.0.0 @@ -32,9 +30,9 @@ class HttpPaymentRequiredException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpPreconditionFailedException.php b/src/Exception/Http/HttpPreconditionFailedException.php index 18ab7ba3..79695132 100644 --- a/src/Exception/Http/HttpPreconditionFailedException.php +++ b/src/Exception/Http/HttpPreconditionFailedException.php @@ -14,13 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Precondition Failed Exception * - * The server does not meet one of the preconditions that the requester put on the request header fields. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/412 * * @since 3.0.0 @@ -31,9 +30,9 @@ class HttpPreconditionFailedException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpPreconditionRequiredException.php b/src/Exception/Http/HttpPreconditionRequiredException.php index 44eb6c51..fbdf469e 100644 --- a/src/Exception/Http/HttpPreconditionRequiredException.php +++ b/src/Exception/Http/HttpPreconditionRequiredException.php @@ -14,15 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Precondition Required Exception * - * The origin server requires the request to be conditional. This response is intended to prevent the 'lost update' - * problem, where a client GETs a resource's state, modifies it and PUTs it back to the server, when meanwhile a third - * party has modified the state on the server, leading to a conflict. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/428 * * @since 3.0.0 @@ -33,9 +30,9 @@ class HttpPreconditionRequiredException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpProxyAuthenticationRequiredException.php b/src/Exception/Http/HttpProxyAuthenticationRequiredException.php index 0fed38a5..48c2120d 100644 --- a/src/Exception/Http/HttpProxyAuthenticationRequiredException.php +++ b/src/Exception/Http/HttpProxyAuthenticationRequiredException.php @@ -14,13 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Proxy Authentication Required Exception * - * This is similar to 401 Unauthorized but authentication is needed to be done by a proxy. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/407 * * @since 3.0.0 @@ -31,9 +30,9 @@ class HttpProxyAuthenticationRequiredException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpRangeNotSatisfiableException.php b/src/Exception/Http/HttpRangeNotSatisfiableException.php index 66bb81ad..05c7b47e 100644 --- a/src/Exception/Http/HttpRangeNotSatisfiableException.php +++ b/src/Exception/Http/HttpRangeNotSatisfiableException.php @@ -14,14 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Range Not Satisfiable Exception * - * The range specified by the Range header field in the request cannot be fulfilled. It's possible that the range is - * outside the size of the target URI's data. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/416 * * @since 3.0.0 @@ -32,9 +30,9 @@ class HttpRangeNotSatisfiableException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpRequestHeaderFieldsTooLargeException.php b/src/Exception/Http/HttpRequestHeaderFieldsTooLargeException.php index c0c31e8b..dfdfd852 100644 --- a/src/Exception/Http/HttpRequestHeaderFieldsTooLargeException.php +++ b/src/Exception/Http/HttpRequestHeaderFieldsTooLargeException.php @@ -14,14 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Request Header Fields Too Large Exception * - * The server is unwilling to process the request because its header fields are too large. The request may be - * resubmitted after reducing the size of the request header fields. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/431 * * @since 3.0.0 @@ -32,9 +30,9 @@ class HttpRequestHeaderFieldsTooLargeException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpRequestTimeoutException.php b/src/Exception/Http/HttpRequestTimeoutException.php index f667cb26..86232169 100644 --- a/src/Exception/Http/HttpRequestTimeoutException.php +++ b/src/Exception/Http/HttpRequestTimeoutException.php @@ -14,16 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Request Timeout Exception * - * This response is sent on an idle connection by some servers, even without any previous request by the client. It - * means that the server would like to shut down this unused connection. This response is used much more since some - * browsers, like Chrome, Firefox 27+, or IE9, use HTTP pre-connection mechanisms to speed up surfing. Also note that - * some servers merely shut down the connection without sending this message. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408 * * @since 3.0.0 @@ -34,9 +30,9 @@ class HttpRequestTimeoutException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpServiceUnavailableException.php b/src/Exception/Http/HttpServiceUnavailableException.php index fc974870..0cdaf959 100644 --- a/src/Exception/Http/HttpServiceUnavailableException.php +++ b/src/Exception/Http/HttpServiceUnavailableException.php @@ -14,17 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Service Unavailable Exception * - * The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is - * overloaded. Note that together with this response, a user-friendly page explaining the problem should be sent. This - * response should be used for temporary conditions and the Retry-After HTTP header should, if possible, contain the - * estimated time before the recovery of the service. The webmaster must also take care about the caching-related - * headers that are sent along with this response, as these temporary condition responses should usually not be cached. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503 * * @since 3.0.0 @@ -35,9 +30,9 @@ class HttpServiceUnavailableException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpTooEarlyException.php b/src/Exception/Http/HttpTooEarlyException.php index e2837cc2..e8415193 100644 --- a/src/Exception/Http/HttpTooEarlyException.php +++ b/src/Exception/Http/HttpTooEarlyException.php @@ -14,13 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Too Early Exception * - * Indicates that the server is unwilling to risk processing a request that might be replayed. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/425 * * @since 3.0.0 @@ -31,9 +30,9 @@ class HttpTooEarlyException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpTooManyRequestsException.php b/src/Exception/Http/HttpTooManyRequestsException.php index 812cb313..a30a3c30 100644 --- a/src/Exception/Http/HttpTooManyRequestsException.php +++ b/src/Exception/Http/HttpTooManyRequestsException.php @@ -14,13 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Too Many Requests Exception * - * The user has sent too many requests in a given amount of time ("rate limiting"). - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429 * * @since 3.0.0 @@ -31,9 +30,9 @@ class HttpTooManyRequestsException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpUnauthorizedException.php b/src/Exception/Http/HttpUnauthorizedException.php index c6e2a006..f236fd07 100644 --- a/src/Exception/Http/HttpUnauthorizedException.php +++ b/src/Exception/Http/HttpUnauthorizedException.php @@ -14,14 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Unauthorized Exception * - * Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the - * client must authenticate itself to get the requested response. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401 * * @since 3.0.0 @@ -32,9 +30,9 @@ class HttpUnauthorizedException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpUnavailableForLegalReasonsException.php b/src/Exception/Http/HttpUnavailableForLegalReasonsException.php index 728e0bff..5c7e49c4 100644 --- a/src/Exception/Http/HttpUnavailableForLegalReasonsException.php +++ b/src/Exception/Http/HttpUnavailableForLegalReasonsException.php @@ -14,14 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Unavailable For Legal Reasons Exception * - * The server is unwilling to process the request because its header fields are too large. The request may be - * resubmitted after reducing the size of the request header fields. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/451 * * @since 3.0.0 @@ -32,9 +30,9 @@ class HttpUnavailableForLegalReasonsException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpUnprocessableEntityException.php b/src/Exception/Http/HttpUnprocessableEntityException.php index 34f8f121..543f906c 100644 --- a/src/Exception/Http/HttpUnprocessableEntityException.php +++ b/src/Exception/Http/HttpUnprocessableEntityException.php @@ -14,13 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Unprocessable Entity Exception * - * The request was well-formed but was unable to be followed due to semantic errors. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422 * * @since 3.0.0 @@ -31,9 +30,9 @@ class HttpUnprocessableEntityException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpUnsupportedMediaTypeException.php b/src/Exception/Http/HttpUnsupportedMediaTypeException.php index 9db05489..b8b6f4f4 100644 --- a/src/Exception/Http/HttpUnsupportedMediaTypeException.php +++ b/src/Exception/Http/HttpUnsupportedMediaTypeException.php @@ -14,6 +14,7 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** @@ -24,8 +25,6 @@ /** * HTTP Unsupported Media Type Exception * - * The media format of the requested data is not supported by the server, so the server is rejecting the request. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/415 * * @since 3.0.0 @@ -43,20 +42,24 @@ class HttpUnsupportedMediaTypeException extends HttpException /** * Constructor of the class * - * @param array $supported + * @param list $supportedMediaTypes * @param string|null $message * @param int $code * @param Throwable|null $previous */ - public function __construct(array $supported, ?string $message = null, int $code = 0, ?Throwable $previous = null) - { + public function __construct( + array $supportedMediaTypes, + ?string $message = null, + int $code = 0, + ?Throwable $previous = null + ) { $message ??= 'Unsupported Media Type'; parent::__construct(self::STATUS_UNSUPPORTED_MEDIA_TYPE, $message, $code, $previous); - foreach ($supported as $mediaType) { - $this->supportedMediaTypes[] = $mediaType; - } + $this->supportedMediaTypes = $supportedMediaTypes; + + $this->addHeaderField('Accept', $this->getJoinedSupportedTypes()); } /** @@ -76,24 +79,6 @@ final public function getSupportedTypes(): array */ final public function getJoinedSupportedTypes(): string { - return join(',', $this->getSupportedTypes()); - } - - /** - * Gets arguments for an Accept header field - * - * Returns an array where key 0 contains the header name and key 1 contains its value. - * - * - * $response = $response - * ->withStatus($e->getStatusCode()) - * ->withHeader(...$e->getAcceptHeaderArguments()); - * - * - * @return array{0: string, 1: string} - */ - final public function getAcceptHeaderArguments(): array - { - return ['Accept', $this->getJoinedSupportedTypes()]; + return join(',', $this->supportedMediaTypes); } } diff --git a/src/Exception/Http/HttpUpgradeRequiredException.php b/src/Exception/Http/HttpUpgradeRequiredException.php index 4d0d4d88..02752367 100644 --- a/src/Exception/Http/HttpUpgradeRequiredException.php +++ b/src/Exception/Http/HttpUpgradeRequiredException.php @@ -14,15 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP Upgrade Required Exception * - * The server refuses to perform the request using the current protocol but might be willing to do so after the client - * upgrades to a different protocol. The server sends an Upgrade header in a 426 response to indicate the required - * protocol(s). - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/426 * * @since 3.0.0 @@ -33,9 +30,9 @@ class HttpUpgradeRequiredException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpUriTooLongException.php b/src/Exception/Http/HttpUriTooLongException.php index 5b92cce5..c0aaac09 100644 --- a/src/Exception/Http/HttpUriTooLongException.php +++ b/src/Exception/Http/HttpUriTooLongException.php @@ -14,13 +14,12 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** * HTTP URI Too Long Exception * - * The URI requested by the client is longer than the server is willing to interpret. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/414 * * @since 3.0.0 @@ -31,9 +30,9 @@ class HttpUriTooLongException extends HttpException /** * Constructor of the class * - * @param ?string $message + * @param string|null $message * @param int $code - * @param ?Throwable $previous + * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpException.php b/src/Exception/HttpException.php similarity index 52% rename from src/Exception/Http/HttpException.php rename to src/Exception/HttpException.php index 9c01bcf1..9b982406 100644 --- a/src/Exception/Http/HttpException.php +++ b/src/Exception/HttpException.php @@ -9,7 +9,7 @@ * @link https://github.com/sunrise-php/http-router */ -namespace Sunrise\Http\Router\Exception\Http; +namespace Sunrise\Http\Router\Exception; /** * Import classes @@ -28,21 +28,28 @@ class HttpException extends RuntimeException implements HttpExceptionInterface /** * HTTP status code * - * @var int + * @var int<100, 599> */ private int $statusCode; + /** + * HTTP header fields + * + * @var list + */ + private array $headerFields = []; + /** * Constructor of the class * - * @param int $statusCode + * @param int<100, 599> $statusCode * @param string $message - * @param int $errorCode - * @param ?Throwable $previous + * @param int $code + * @param Throwable|null $previous */ - public function __construct(int $statusCode, string $message, int $errorCode = 0, ?Throwable $previous = null) + public function __construct(int $statusCode, string $message, int $code = 0, ?Throwable $previous = null) { - parent::__construct($message, $errorCode, $previous); + parent::__construct($message, $code, $previous); $this->statusCode = $statusCode; } @@ -54,4 +61,25 @@ final public function getStatusCode(): int { return $this->statusCode; } + + /** + * {@inheritdoc} + */ + final public function getHeaderFields(): array + { + return $this->headerFields; + } + + /** + * Adds the given header field to the exception + * + * @param string $fieldName + * @param string $fieldValue + * + * @return void + */ + final public function addHeaderField(string $fieldName, string $fieldValue): void + { + $this->headerFields[] = [$fieldName, $fieldValue]; + } } diff --git a/src/Exception/Http/HttpExceptionInterface.php b/src/Exception/HttpExceptionInterface.php similarity index 74% rename from src/Exception/Http/HttpExceptionInterface.php rename to src/Exception/HttpExceptionInterface.php index f56a38a7..364098b8 100644 --- a/src/Exception/Http/HttpExceptionInterface.php +++ b/src/Exception/HttpExceptionInterface.php @@ -9,13 +9,12 @@ * @link https://github.com/sunrise-php/http-router */ -namespace Sunrise\Http\Router\Exception\Http; +namespace Sunrise\Http\Router\Exception; /** * Import classes */ use Fig\Http\Message\StatusCodeInterface; -use Sunrise\Http\Router\Exception\ExceptionInterface; /** * Base HTTP exception interface @@ -28,7 +27,14 @@ interface HttpExceptionInterface extends ExceptionInterface, StatusCodeInterface /** * Gets HTTP status code * - * @return int + * @return int<100, 599> */ public function getStatusCode(): int; + + /** + * Gets HTTP header fields + * + * @return list + */ + public function getHeaderFields(): array; } diff --git a/src/ParameterResolver/ServerRequestParameterResolver.php b/src/ParameterResolver/ServerRequestParameterResolver.php deleted file mode 100644 index 58753289..00000000 --- a/src/ParameterResolver/ServerRequestParameterResolver.php +++ /dev/null @@ -1,61 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\ParameterResolver; - -/** - * Import classes - */ -use Psr\Http\Message\ServerRequestInterface; -use Sunrise\Http\Router\ParameterResolverInterface; -use Sunrise\Http\Router\ServerRequest; -use ReflectionNamedType; -use ReflectionParameter; - -/** - * ServerRequestParameterResolver - * - * @since 3.0.0 - */ -final class ServerRequestParameterResolver implements ParameterResolverInterface -{ - - /** - * {@inheritdoc} - */ - public function supportsParameter(ReflectionParameter $parameter, $context): bool - { - if (!($context instanceof ServerRequestInterface)) { - return false; - } - - if (!($parameter->getType() instanceof ReflectionNamedType)) { - return false; - } - - if (!($parameter->getType()->getName() === ServerRequest::class)) { - return false; - } - - return true; - } - - /** - * {@inheritdoc} - */ - public function resolveParameter(ReflectionParameter $parameter, $context) - { - /** @var ServerRequestInterface */ - $context = $context; - - return ServerRequest::from($context); - } -} diff --git a/src/ServerRequest.php b/src/ServerRequest.php index d6035bc2..1eb2bffe 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -20,7 +20,6 @@ /** * Import functions */ -use function arsort; use function explode; use function strncmp; use function strpos; @@ -28,11 +27,6 @@ use function strtolower; use function trim; -/** - * Import constants - */ -use const SORT_NUMERIC; - /** * ServerRequest * @@ -101,16 +95,6 @@ public function isXml(): bool ]); } - /** - * Checks if the request is XMLHttpRequest - * - * @return bool - */ - public function isXmlHttpRequest(): bool - { - return $this->request->getHeaderLine('X-Requested-With') === 'XMLHttpRequest'; - } - /** * Gets the client's IP address * @@ -126,10 +110,10 @@ public function getClientIpAddress(array $proxyChain = []): IpAddress $clientIp = $env['REMOTE_ADDR'] ?? '::1'; while (isset($proxyChain[$clientIp])) { - $trustedHeader = $proxyChain[$clientIp]; + $proxyHeader = $proxyChain[$clientIp]; unset($proxyChain[$clientIp]); - $header = $this->request->getHeaderLine($trustedHeader); + $header = $this->request->getHeaderLine($proxyHeader); if ($header === '') { break; } @@ -217,70 +201,6 @@ public function getClientConsumedMediaTypes(): array return $result; } - /** - * Gets the client's consumed languages - * - * @return array - */ - public function getClientConsumedLanguages(): array - { - $header = $this->request->getHeaderLine('Accept-Language'); - if ($header === '') { - return []; - } - - $cursor = -1; - $inLanguage = true; - $inWeight = false; - $data = []; - $i = 0; - - while (true) { - $char = $header[++$cursor] ?? null; - - if ($char === null) { - break; - } - if ($char === ' ') { - continue; - } - if ($char === ';') { - $inLanguage = false; - continue; - } - if ($char === '=') { - $inWeight = true; - continue; - } - if ($char === ',') { - $inLanguage = true; - $inWeight = false; - $i++; - continue; - } - if ($inLanguage) { - $data[$i][0] ??= ''; - $data[$i][0] .= $char; - continue; - } - if ($inWeight) { - $data[$i][1] ??= ''; - $data[$i][1] .= $char; - continue; - } - } - - $result = []; - foreach ($data as $item) { - /** @var array{0: string, 1?: numeric-string} $item */ - $result[$item[0]] = (float) ($item[1] ?? 1.0); - } - - arsort($result, SORT_NUMERIC); - - return $result; - } - /** * Checks if the client produces one of the given media types * From 65098dd93e884a8f6ece38624ba45e97dd1da2a0 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Mon, 13 Feb 2023 02:37:25 +0100 Subject: [PATCH 071/180] v3 --- .../Http/HttpInternalServerErrorException.php | 44 ----------------- .../Http/HttpMethodNotAllowedException.php | 46 +++++------------ src/Router.php | 49 ++++++++++--------- 3 files changed, 39 insertions(+), 100 deletions(-) delete mode 100644 src/Exception/Http/HttpInternalServerErrorException.php diff --git a/src/Exception/Http/HttpInternalServerErrorException.php b/src/Exception/Http/HttpInternalServerErrorException.php deleted file mode 100644 index 9f43458e..00000000 --- a/src/Exception/Http/HttpInternalServerErrorException.php +++ /dev/null @@ -1,44 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Exception\Http; - -/** - * Import classes - */ -use Throwable; - -/** - * HTTP Internal Server Error Exception - * - * The server has encountered a situation it does not know how to handle. - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500 - * - * @since 3.0.0 - */ -class HttpInternalServerErrorException extends HttpException -{ - - /** - * Constructor of the class - * - * @param ?string $message - * @param int $code - * @param ?Throwable $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - $message ??= 'Internal Server Error'; - - parent::__construct(self::STATUS_INTERNAL_SERVER_ERROR, $message, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpMethodNotAllowedException.php b/src/Exception/Http/HttpMethodNotAllowedException.php index b2eae99e..5f696179 100644 --- a/src/Exception/Http/HttpMethodNotAllowedException.php +++ b/src/Exception/Http/HttpMethodNotAllowedException.php @@ -14,6 +14,7 @@ /** * Import classes */ +use Sunrise\Http\Router\Exception\HttpException; use Throwable; /** @@ -24,9 +25,6 @@ /** * HTTP Method Not Allowed Exception * - * The request method is known by the server but is not supported by the target resource. For example, an API may not - * allow calling DELETE to remove a resource. - * * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/405 * * @since 3.0.0 @@ -39,25 +37,29 @@ class HttpMethodNotAllowedException extends HttpException * * @var list */ - private array $allowedMethods = []; + private array $allowedMethods; /** * Constructor of the class * - * @param array $allowed + * @param list $allowedMethods * @param string|null $message * @param int $code * @param Throwable|null $previous */ - public function __construct(array $allowed, ?string $message = null, int $code = 0, ?Throwable $previous = null) - { + public function __construct( + array $allowedMethods, + ?string $message = null, + int $code = 0, + ?Throwable $previous = null + ) { $message ??= 'Method Not Allowed'; parent::__construct(self::STATUS_METHOD_NOT_ALLOWED, $message, $code, $previous); - foreach ($allowed as $method) { - $this->allowedMethods[] = $method; - } + $this->allowedMethods = $allowedMethods; + + $this->addHeaderField('Allow', $this->getJoinedAllowedMethods()); } /** @@ -77,28 +79,6 @@ final public function getAllowedMethods(): array */ final public function getJoinedAllowedMethods(): string { - return join(',', $this->getAllowedMethods()); - } - - /** - * Gets arguments for an Allow header field - * - * The server must generate an Allow header field in a 405 status code response. - * - * The field must contain a list of methods that the target resource currently supports. - * - * Returns an array where key 0 contains the header name and key 1 contains its value. - * - * - * $response = $response - * ->withStatus($e->getStatusCode()) - * ->withHeader(...$e->getAllowHeaderArguments()); - * - * - * @return array{0: string, 1: string} - */ - final public function getAllowHeaderArguments(): array - { - return ['Allow', $this->getJoinedAllowedMethods()]; + return join(',', $this->allowedMethods); } } diff --git a/src/Router.php b/src/Router.php index 061e15c9..57a20dd0 100644 --- a/src/Router.php +++ b/src/Router.php @@ -32,6 +32,7 @@ /** * Import functions */ +use function array_keys; use function Sunrise\Http\Router\path_build; use function Sunrise\Http\Router\path_match; @@ -104,6 +105,20 @@ public function __construct( $this->routes = $routes ?? new RouteCollection(); } + /** + * Loads routes through the given loaders + * + * @param LoaderInterface ...$loaders + * + * @return void + */ + public function load(LoaderInterface ...$loaders): void + { + foreach ($loaders as $loader) { + $this->routes->add(...$loader->load()->all()); + } + } + /** * Gets the router's host table * @@ -246,8 +261,8 @@ public function match(ServerRequestInterface $request): RouteInterface $requestUri = $request->getUri(); $requestHost = $requestUri->getHost(); $requestPath = $requestUri->getPath(); - $requestVerb = $request->getMethod(); - $allowedVerbs = []; + $requestMethod = $request->getMethod(); + $allowedMethods = []; $host = $this->hosts->resolve($requestHost); $routes = $this->routes->allOnHost($host); @@ -260,13 +275,13 @@ public function match(ServerRequestInterface $request): RouteInterface continue; } - $routeVerbs = []; - foreach ($route->getMethods() as $routeVerb) { - $routeVerbs[$routeVerb] = true; - $allowedVerbs[$routeVerb] = $routeVerb; + $routeMethods = []; + foreach ($route->getMethods() as $routeMethod) { + $routeMethods[$routeMethod] = true; + $allowedMethods[$routeMethod] = true; } - if (!isset($routeVerbs[$requestVerb])) { + if (!isset($routeMethods[$requestMethod])) { continue; } @@ -285,8 +300,10 @@ public function match(ServerRequestInterface $request): RouteInterface return $route->withAddedAttributes($attributes); } - if (!empty($allowedVerbs)) { - throw new MethodNotAllowedException($allowedVerbs); + if (!empty($allowedMethods)) { + $allowedMethods = array_keys($allowedMethods); + + throw new MethodNotAllowedException($allowedMethods); } throw new PageNotFoundException('Page Not Found'); @@ -350,18 +367,4 @@ public function handle(ServerRequestInterface $request): ResponseInterface return $handler->handle($request); } - - /** - * Loads routes through the given loaders - * - * @param LoaderInterface ...$loaders - * - * @return void - */ - public function load(LoaderInterface ...$loaders): void - { - foreach ($loaders as $loader) { - $this->routes->add(...$loader->load()->all()); - } - } } From dc4e4e38d1f23e77042024cb0a4bc1f3ee081f7b Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 23 Jul 2023 06:31:53 +0200 Subject: [PATCH 072/180] v3 --- README.md | 4 +- composer.json | 20 +- functions/emit.php | 10 +- functions/get_debug_type.php | 49 --- functions/get_dir_classes.php | 53 --- functions/get_file_classes.php | 38 -- functions/parse_accept_like_header.php | 198 +++++++++ functions/path_build.php | 10 +- functions/path_match.php | 7 +- functions/path_parse.php | 10 +- functions/path_plain.php | 7 +- functions/path_regex.php | 7 +- functions/reflect_callable.php | 10 +- src/Annotation/Consume.php | 31 +- src/Annotation/Description.php | 31 +- src/Annotation/Host.php | 31 +- src/Annotation/Method.php | 34 +- src/Annotation/Middleware.php | 29 +- src/Annotation/Postfix.php | 31 +- src/Annotation/Prefix.php | 31 +- src/Annotation/Produce.php | 31 +- src/Annotation/RequestBody.php | 7 +- src/Annotation/RequestEntity.php | 41 -- src/Annotation/RequestQuery.php | 7 +- .../ResponseBody.php} | 13 +- src/Annotation/Route.php | 199 ++-------- src/Annotation/Summary.php | 31 +- src/Annotation/Tag.php | 31 +- src/Annotation/Version.php | 33 ++ src/ClassResolver.php | 14 +- src/ClassResolverInterface.php | 7 +- src/Command/RouteListCommand.php | 41 +- src/Entity/IpAddress.php | 121 +----- src/Entity/MediaType.php | 56 +++ src/Event/RouteEvent.php | 31 +- .../ClientNotConsumedMediaTypeException.php | 7 +- .../ClientNotProducedMediaTypeException.php | 7 +- src/Exception/EntityNotFoundException.php | 7 +- src/Exception/Exception.php | 7 +- src/Exception/ExceptionInterface.php | 7 +- .../Http/HttpBadRequestException.php | 7 +- src/Exception/Http/HttpConflictException.php | 7 +- .../Http/HttpExpectationFailedException.php | 7 +- .../Http/HttpFailedDependencyException.php | 7 +- src/Exception/Http/HttpForbiddenException.php | 7 +- src/Exception/Http/HttpGoneException.php | 7 +- .../Http/HttpLengthRequiredException.php | 7 +- src/Exception/Http/HttpLockedException.php | 7 +- .../Http/HttpMethodNotAllowedException.php | 10 +- .../Http/HttpMisdirectedRequestException.php | 7 +- .../Http/HttpNotAcceptableException.php | 7 +- src/Exception/Http/HttpNotFoundException.php | 7 +- .../Http/HttpPayloadTooLargeException.php | 7 +- .../Http/HttpPaymentRequiredException.php | 7 +- .../Http/HttpPreconditionFailedException.php | 7 +- .../HttpPreconditionRequiredException.php | 7 +- ...tpProxyAuthenticationRequiredException.php | 7 +- .../Http/HttpRangeNotSatisfiableException.php | 7 +- ...tpRequestHeaderFieldsTooLargeException.php | 7 +- .../Http/HttpRequestTimeoutException.php | 7 +- .../Http/HttpServiceUnavailableException.php | 7 +- src/Exception/Http/HttpTooEarlyException.php | 7 +- .../Http/HttpTooManyRequestsException.php | 7 +- .../Http/HttpUnauthorizedException.php | 7 +- ...ttpUnavailableForLegalReasonsException.php | 7 +- .../Http/HttpUnprocessableEntityException.php | 7 +- .../HttpUnsupportedMediaTypeException.php | 10 +- .../Http/HttpUpgradeRequiredException.php | 7 +- .../Http/HttpUriTooLongException.php | 7 +- src/Exception/HttpException.php | 7 +- src/Exception/HttpExceptionInterface.php | 7 +- src/Exception/InvalidArgumentException.php | 7 +- src/Exception/InvalidRequestBodyException.php | 26 -- .../InvalidRequestPayloadException.php | 7 +- .../InvalidRequestQueryException.php | 26 -- src/Exception/LogicException.php | 7 +- src/Exception/MethodNotAllowedException.php | 7 +- .../MissingRequestParameterException.php | 7 +- src/Exception/PageNotFoundException.php | 7 +- src/Exception/ResolvingParameterException.php | 4 +- src/Exception/ResolvingReferenceException.php | 4 +- src/Exception/ResolvingResponseException.php | 4 +- src/Exception/RouteAlreadyExistsException.php | 4 +- src/Exception/RouteNotFoundException.php | 4 +- src/Exception/RoutePathBuildException.php | 4 +- src/Exception/RoutePathParseException.php | 4 +- .../RoutePathProcessingException.php | 4 +- src/Exception/UnhydrableObjectException.php | 4 +- .../UnprocessableEntityException.php | 7 +- .../UnprocessableRequestBodyException.php | 4 +- .../UnprocessableRequestQueryException.php | 4 +- src/HostTable.php | 7 +- src/Loader/ConfigLoader.php | 74 ++-- src/Loader/DescriptorLoader.php | 375 +++++++++--------- src/Loader/LoaderInterface.php | 16 +- src/Middleware/CallableMiddleware.php | 76 +--- src/Middleware/CallbackMiddleware.php | 90 +++++ src/Middleware/ClientIpAddressMiddleware.php | 55 --- .../CommittingEntityChangesMiddleware.php | 70 ---- .../JsonPayloadDecodingMiddleware.php | 37 +- ...arsedBodyWhitespaceStrippingMiddleware.php | 62 --- src/Middleware/UnsafeCallableMiddleware.php | 56 --- .../XmlPayloadDecodingMiddleware.php | 85 ---- src/ParameterResolutioner.php | 32 +- src/ParameterResolutionerInterface.php | 23 +- .../ClientIpAddressParameterResolver.php | 77 ---- .../DependencyInjectionParameterResolver.php | 18 +- .../KnownUntypedParameterResolver.php | 71 ---- .../ParameterResolverInterface.php | 18 +- ...r.php => PresetTypedParameterResolver.php} | 43 +- .../RequestBodyParameterResolver.php | 80 +--- .../RequestEntityParameterResolver.php | 134 ------- .../RequestQueryParameterResolver.php | 56 +-- .../RequestRouteParameterResolver.php | 23 +- src/ReferenceResolver.php | 22 +- src/ReferenceResolverInterface.php | 7 +- src/RequestHandler/CallableRequestHandler.php | 27 +- .../QueueableRequestHandler.php | 16 +- .../UnsafeCallableRequestHandler.php | 9 +- src/RequestQueryInterface.php | 21 - src/ResponseResolutioner.php | 44 +- src/ResponseResolutionerInterface.php | 13 +- .../ObjectResponseResolver.php | 56 +++ .../ResponseResolverInterface.php | 13 +- .../RouteResponseResolver.php | 19 +- .../StatusCodeResponseResolver.php | 12 +- src/Route.php | 10 +- src/RouteCollection.php | 10 +- src/RouteCollectionFactory.php | 4 +- src/RouteCollectionFactoryInterface.php | 4 +- src/RouteCollectionInterface.php | 7 +- src/RouteCollector.php | 17 +- src/RouteFactory.php | 7 +- src/RouteFactoryInterface.php | 9 +- src/RouteInterface.php | 7 +- src/Router.php | 35 +- src/RouterBuilder.php | 7 +- src/ServerRequest.php | 216 +++++----- tests/Command/RouteListCommandTest.php | 3 - tests/Exception/BadRequestExceptionTest.php | 3 - tests/Exception/ExceptionTest.php | 3 - .../InvalidArgumentExceptionTest.php | 3 - .../InvalidAttributeValueExceptionTest.php | 3 - .../InvalidLoaderResourceExceptionTest.php | 3 - tests/Exception/InvalidPathExceptionTest.php | 3 - .../MethodNotAllowedExceptionTest.php | 6 - .../MissingAttributeValueExceptionTest.php | 3 - tests/Exception/PageNotFoundExceptionTest.php | 3 - .../Exception/RouteNotFoundExceptionTest.php | 3 - .../UnresolvableReferenceExceptionTest.php | 3 - .../UnsupportedMediaTypeExceptionTest.php | 6 - tests/Functions/FunctionPathBuildTest.php | 6 - tests/Functions/FunctionPathMatchTest.php | 6 - tests/Functions/FunctionPathParseTest.php | 6 - tests/Functions/FunctionPathPlainTest.php | 6 - tests/Functions/FunctionPathRegexTest.php | 6 - tests/Loader/ConfigLoaderTest.php | 3 - tests/Loader/DescriptorLoaderTest.php | 16 - tests/Middleware/CallableMiddlewareTest.php | 9 +- .../JsonPayloadDecodingMiddlewareTest.php | 3 - tests/ReferenceResolverTest.php | 3 - .../CallableRequestHandlerTest.php | 3 - .../QueueableRequestHandlerTest.php | 3 - tests/RouteCollectionFactoryTest.php | 3 - tests/RouteCollectionTest.php | 6 - tests/RouteCollectorTest.php | 3 - tests/RouteFactoryTest.php | 3 - tests/RouteTest.php | 6 - tests/RouterBuilderTest.php | 3 - tests/RouterTest.php | 12 +- 170 files changed, 1396 insertions(+), 2632 deletions(-) delete mode 100644 functions/get_debug_type.php delete mode 100644 functions/get_dir_classes.php delete mode 100644 functions/get_file_classes.php create mode 100644 functions/parse_accept_like_header.php delete mode 100644 src/Annotation/RequestEntity.php rename src/{RequestBodyInterface.php => Annotation/ResponseBody.php} (68%) create mode 100644 src/Annotation/Version.php create mode 100644 src/Entity/MediaType.php delete mode 100644 src/Exception/InvalidRequestBodyException.php delete mode 100644 src/Exception/InvalidRequestQueryException.php create mode 100644 src/Middleware/CallbackMiddleware.php delete mode 100644 src/Middleware/ClientIpAddressMiddleware.php delete mode 100644 src/Middleware/CommittingEntityChangesMiddleware.php delete mode 100644 src/Middleware/ParsedBodyWhitespaceStrippingMiddleware.php delete mode 100644 src/Middleware/UnsafeCallableMiddleware.php delete mode 100644 src/Middleware/XmlPayloadDecodingMiddleware.php delete mode 100644 src/ParameterResolver/ClientIpAddressParameterResolver.php delete mode 100644 src/ParameterResolver/KnownUntypedParameterResolver.php rename src/{ => ParameterResolver}/ParameterResolverInterface.php (78%) rename src/ParameterResolver/{KnownTypedParameterResolver.php => PresetTypedParameterResolver.php} (56%) delete mode 100644 src/ParameterResolver/RequestEntityParameterResolver.php delete mode 100644 src/RequestQueryInterface.php create mode 100644 src/ResponseResolver/ObjectResponseResolver.php rename src/{ => ResponseResolver}/ResponseResolverInterface.php (79%) diff --git a/README.md b/README.md index a20787bf..8ac4eb00 100644 --- a/README.md +++ b/README.md @@ -264,7 +264,7 @@ $response = $router->process($request, $handler); use Sunrise\Http\Message\ResponseFactory; use Sunrise\Http\Router\Exception\MethodNotAllowedException; use Sunrise\Http\Router\Exception\RouteNotFoundException; -use Sunrise\Http\Router\Middleware\CallableMiddleware; +use Sunrise\Http\Router\Middleware\CallbackMiddleware; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use Sunrise\Http\Router\RouteCollector; use Sunrise\Http\Router\Router; @@ -281,7 +281,7 @@ $collector->get('home', '/', new CallableRequestHandler(function ($request) { $router = new Router(); $router->addRoute(...$collector->getCollection()->all()); -$router->addMiddleware(new CallableMiddleware(function ($request, $handler) { +$router->addMiddleware(new CallbackMiddleware(function ($request, $handler) { try { return $handler->handle($request); } catch (MethodNotAllowedException $e) { diff --git a/composer.json b/composer.json index bbe87bd1..e9823858 100644 --- a/composer.json +++ b/composer.json @@ -27,32 +27,27 @@ } ], "require": { - "php": ">=7.4", + "php": ">=8.0", "fig/http-message-util": "^1.1", "psr/container": "^1.0 || ^2.0", "psr/event-dispatcher": "^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", - "psr/simple-cache": "^1.0" + "psr/simple-cache": "^1.0 || ^2.0 || ^3.0" }, "require-dev": { "phpunit/phpunit": "^9.6", - "doctrine/annotations": "^2.0", - "doctrine/persistence": "^3.1", - "sunrise/coding-standard": "~1.0.0", + "sunrise/coding-standard": "^1.0", "sunrise/http-message": "^3.0", - "sunrise/hydrator": "^2.7", + "sunrise/hydrator": "^3.0", "symfony/console": "^5.4", "symfony/validator": "^5.4", - "psr/log": "^1.1" + "vimeo/psalm": "^5.13" }, "autoload": { "files": [ "functions/emit.php", - "functions/get_debug_type.php", - "functions/get_dir_classes.php", - "functions/get_file_classes.php", "functions/path_build.php", "functions/path_match.php", "functions/path_parse.php", @@ -72,7 +67,8 @@ "scripts": { "test": [ "phpcs", - "psalm", + "psalm --no-cache", + "phpstan analyse src --level=5", "XDEBUG_MODE=coverage phpunit --coverage-text --colors=always" ], "build": [ diff --git a/functions/emit.php b/functions/emit.php index 38251649..50bf35c6 100644 --- a/functions/emit.php +++ b/functions/emit.php @@ -1,4 +1,4 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -if (!function_exists('get_debug_type')) { - - /** - * Polyfill for the get_debug_type function - * - * @param mixed $value - * - * @return string - * - * @since 3.0.0 - * - * @link https://www.php.net/get_debug_type - */ - function get_debug_type($value): string - { - if (null === $value) { - return 'null'; - } - - if (is_bool($value)) { - return 'bool'; - } - - if (is_int($value)) { - return 'int'; - } - - if (is_float($value)) { - return 'float'; - } - - if (is_object($value)) { - return get_class($value); - } - - return gettype($value); - } -} diff --git a/functions/get_dir_classes.php b/functions/get_dir_classes.php deleted file mode 100644 index c32ff6e6..00000000 --- a/functions/get_dir_classes.php +++ /dev/null @@ -1,53 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router; - -/** - * Import classes - */ -use Iterator; -use RecursiveDirectoryIterator; -use RecursiveIteratorIterator; -use SplFileInfo; - -/** - * Scans the given directory and returns the found classes - * - * @param string $dirname - * - * @return class-string[] - * - * @since 3.0.0 - */ -function get_dir_classes(string $dirname): array -{ - /** @var Iterator */ - $files = new RecursiveIteratorIterator( - new RecursiveDirectoryIterator($dirname) - ); - - $result = []; - - foreach ($files as $file) { - // only php files... - if ($file->getExtension() !== 'php') { - continue; - } - - $classnames = get_file_classes($file->getPathname()); - foreach ($classnames as $classname) { - $result[] = $classname; - } - } - - return $result; -} diff --git a/functions/get_file_classes.php b/functions/get_file_classes.php deleted file mode 100644 index 58b17e38..00000000 --- a/functions/get_file_classes.php +++ /dev/null @@ -1,38 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router; - -/** - * Import functions - */ -use function array_diff; -use function get_declared_classes; - -/** - * Scans the given file and returns the found classes - * - * @param string $filename - * - * @return class-string[] - * - * @since 3.0.0 - * - * @todo https://www.php.net/manual/en/book.tokenizer.php - */ -function get_file_classes(string $filename): array -{ - $snapshot = get_declared_classes(); - - require_once $filename; - - return array_diff(get_declared_classes(), $snapshot); -} diff --git a/functions/parse_accept_like_header.php b/functions/parse_accept_like_header.php new file mode 100644 index 00000000..c8b41ee9 --- /dev/null +++ b/functions/parse_accept_like_header.php @@ -0,0 +1,198 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-message/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-message + */ + +namespace Sunrise\Http\Message; + +use function uasort; + +/** + * Parses the given accept-like header + * + * Returns null if the header isn't valid. + * + * @param string $header + * + * @return ?array> + */ +function parse_accept_header(string $header): ?array +{ + // OWS according to RFC-7230 + static $ows = [ + "\x09" => 1, "\x20" => 1, + ]; + + // token according to RFC-7230 + static $token = [ + "\x21" => 1, "\x23" => 1, "\x24" => 1, "\x25" => 1, "\x26" => 1, "\x27" => 1, "\x2a" => 1, "\x2b" => 1, + "\x2d" => 1, "\x2e" => 1, "\x30" => 1, "\x31" => 1, "\x32" => 1, "\x33" => 1, "\x34" => 1, "\x35" => 1, + "\x36" => 1, "\x37" => 1, "\x38" => 1, "\x39" => 1, "\x41" => 1, "\x42" => 1, "\x43" => 1, "\x44" => 1, + "\x45" => 1, "\x46" => 1, "\x47" => 1, "\x48" => 1, "\x49" => 1, "\x4a" => 1, "\x4b" => 1, "\x4c" => 1, + "\x4d" => 1, "\x4e" => 1, "\x4f" => 1, "\x50" => 1, "\x51" => 1, "\x52" => 1, "\x53" => 1, "\x54" => 1, + "\x55" => 1, "\x56" => 1, "\x57" => 1, "\x58" => 1, "\x59" => 1, "\x5a" => 1, "\x5e" => 1, "\x5f" => 1, + "\x60" => 1, "\x61" => 1, "\x62" => 1, "\x63" => 1, "\x64" => 1, "\x65" => 1, "\x66" => 1, "\x67" => 1, + "\x68" => 1, "\x69" => 1, "\x6a" => 1, "\x6b" => 1, "\x6c" => 1, "\x6d" => 1, "\x6e" => 1, "\x6f" => 1, + "\x70" => 1, "\x71" => 1, "\x72" => 1, "\x73" => 1, "\x74" => 1, "\x75" => 1, "\x76" => 1, "\x77" => 1, + "\x78" => 1, "\x79" => 1, "\x7a" => 1, "\x7c" => 1, "\x7e" => 1, + ]; + + // quoted-string according to RFC-7230 + static $quotedString = [ + "\x09" => 1, "\x20" => 1, "\x21" => 1, "\x23" => 1, "\x24" => 1, "\x25" => 1, "\x26" => 1, "\x27" => 1, + "\x28" => 1, "\x29" => 1, "\x2a" => 1, "\x2b" => 1, "\x2c" => 1, "\x2d" => 1, "\x2e" => 1, "\x2f" => 1, + "\x30" => 1, "\x31" => 1, "\x32" => 1, "\x33" => 1, "\x34" => 1, "\x35" => 1, "\x36" => 1, "\x37" => 1, + "\x38" => 1, "\x39" => 1, "\x3a" => 1, "\x3b" => 1, "\x3c" => 1, "\x3d" => 1, "\x3e" => 1, "\x3f" => 1, + "\x40" => 1, "\x41" => 1, "\x42" => 1, "\x43" => 1, "\x44" => 1, "\x45" => 1, "\x46" => 1, "\x47" => 1, + "\x48" => 1, "\x49" => 1, "\x4a" => 1, "\x4b" => 1, "\x4c" => 1, "\x4d" => 1, "\x4e" => 1, "\x4f" => 1, + "\x50" => 1, "\x51" => 1, "\x52" => 1, "\x53" => 1, "\x54" => 1, "\x55" => 1, "\x56" => 1, "\x57" => 1, + "\x58" => 1, "\x59" => 1, "\x5a" => 1, "\x5b" => 1, "\x5d" => 1, "\x5e" => 1, "\x5f" => 1, "\x60" => 1, + "\x61" => 1, "\x62" => 1, "\x63" => 1, "\x64" => 1, "\x65" => 1, "\x66" => 1, "\x67" => 1, "\x68" => 1, + "\x69" => 1, "\x6a" => 1, "\x6b" => 1, "\x6c" => 1, "\x6d" => 1, "\x6e" => 1, "\x6f" => 1, "\x70" => 1, + "\x71" => 1, "\x72" => 1, "\x73" => 1, "\x74" => 1, "\x75" => 1, "\x76" => 1, "\x77" => 1, "\x78" => 1, + "\x79" => 1, "\x7a" => 1, "\x7b" => 1, "\x7c" => 1, "\x7d" => 1, "\x7e" => 1, "\x80" => 1, "\x81" => 1, + "\x82" => 1, "\x83" => 1, "\x84" => 1, "\x85" => 1, "\x86" => 1, "\x87" => 1, "\x88" => 1, "\x89" => 1, + "\x8a" => 1, "\x8b" => 1, "\x8c" => 1, "\x8d" => 1, "\x8e" => 1, "\x8f" => 1, "\x90" => 1, "\x91" => 1, + "\x92" => 1, "\x93" => 1, "\x94" => 1, "\x95" => 1, "\x96" => 1, "\x97" => 1, "\x98" => 1, "\x99" => 1, + "\x9a" => 1, "\x9b" => 1, "\x9c" => 1, "\x9d" => 1, "\x9e" => 1, "\x9f" => 1, "\xa0" => 1, "\xa1" => 1, + "\xa2" => 1, "\xa3" => 1, "\xa4" => 1, "\xa5" => 1, "\xa6" => 1, "\xa7" => 1, "\xa8" => 1, "\xa9" => 1, + "\xaa" => 1, "\xab" => 1, "\xac" => 1, "\xad" => 1, "\xae" => 1, "\xaf" => 1, "\xb0" => 1, "\xb1" => 1, + "\xb2" => 1, "\xb3" => 1, "\xb4" => 1, "\xb5" => 1, "\xb6" => 1, "\xb7" => 1, "\xb8" => 1, "\xb9" => 1, + "\xba" => 1, "\xbb" => 1, "\xbc" => 1, "\xbd" => 1, "\xbe" => 1, "\xbf" => 1, "\xc0" => 1, "\xc1" => 1, + "\xc2" => 1, "\xc3" => 1, "\xc4" => 1, "\xc5" => 1, "\xc6" => 1, "\xc7" => 1, "\xc8" => 1, "\xc9" => 1, + "\xca" => 1, "\xcb" => 1, "\xcc" => 1, "\xcd" => 1, "\xce" => 1, "\xcf" => 1, "\xd0" => 1, "\xd1" => 1, + "\xd2" => 1, "\xd3" => 1, "\xd4" => 1, "\xd5" => 1, "\xd6" => 1, "\xd7" => 1, "\xd8" => 1, "\xd9" => 1, + "\xda" => 1, "\xdb" => 1, "\xdc" => 1, "\xdd" => 1, "\xde" => 1, "\xdf" => 1, "\xe0" => 1, "\xe1" => 1, + "\xe2" => 1, "\xe3" => 1, "\xe4" => 1, "\xe5" => 1, "\xe6" => 1, "\xe7" => 1, "\xe8" => 1, "\xe9" => 1, + "\xea" => 1, "\xeb" => 1, "\xec" => 1, "\xed" => 1, "\xee" => 1, "\xef" => 1, "\xf0" => 1, "\xf1" => 1, + "\xf2" => 1, "\xf3" => 1, "\xf4" => 1, "\xf5" => 1, "\xf6" => 1, "\xf7" => 1, "\xf8" => 1, "\xf9" => 1, + "\xfa" => 1, "\xfb" => 1, "\xfc" => 1, "\xfd" => 1, "\xfe" => 1, "\xff" => 1, + ]; + + $offset = -1; + + $inToken = true; + $inParamName = false; + $inParamValue = false; + $inQuotes = false; + + $data = []; + + $i = 0; + $p = 0; + + while (true) { + $char = $header[++$offset] ?? null; + + if (!isset($char)) { + break; + } + + $prev = $header[$offset-1] ?? null; + $next = $header[$offset+1] ?? null; + + if ($char === ',' && !$inQuotes) { + $inToken = true; + $inParamName = false; + $inParamValue = false; + $i++; + $p = 0; + continue; + } + if ($char === ';' && !$inQuotes) { + $inToken = false; + $inParamName = true; + $inParamValue = false; + $p++; + continue; + } + if ($char === '=' && !$inQuotes) { + $inToken = false; + $inParamName = false; + $inParamValue = true; + continue; + } + + // ignoring whitespaces around tokens... + if (isset($ows[$char]) && !$inQuotes) { + // en-GB[ ], ... + // ~~~~~~^~~~~~~ + if ($inToken && isset($data[$i][0])) { + $inToken = false; + } + // en-GB; q[ ]= 0.8, ... + // ~~~~~~~~~^~~~~~~~~~~~ + if ($inParamName && isset($data[$i][1][$p][0])) { + $inParamName = false; + } + // en-GB; q = 0.8[ ], ... + // ~~~~~~~~~~~~~~~^~~~~~~ + if ($inParamValue && isset($data[$i][1][$p][1])) { + $inParamValue = false; + } + + continue; + } + + // ignoring backslashes before double quotes in the quoted parameter value... + if ($char === '\\' && $next === '"' && $inQuotes) { + continue; + } + + if ($char === '"' && $inParamValue && !$inQuotes && !isset($data[$i][1][$p][1])) { + $inQuotes = true; + continue; + } + if ($char === '"' && $prev !== '\\' && $inQuotes) { + $inParamValue = false; + $inQuotes = false; + continue; + } + + // [en-GB]; q=0.8, ... + // ~^^^^^~~~~~~~~~~~~~ + if ($inToken && (isset($token[$char]) || $char === '/')) { + $data[$i][0] ??= ''; + $data[$i][0] .= $char; + continue; + } + // en-GB; [q]=0.8, ... + // ~~~~~~~~^~~~~~~~~~~ + if ($inParamName && isset($token[$char]) && isset($data[$i][0])) { + $data[$i][1][$p][0] ??= ''; + $data[$i][1][$p][0] .= $char; + continue; + } + // en-GB; q=[0.8], ... + // ~~~~~~~~~~^^^~~~~~~ + // phpcs:ignore Generic.Files.LineLength + if ($inParamValue && (isset($token[$char]) || ($inQuotes && (isset($quotedString[$char]) || ($prev . $char) === '\"'))) && isset($data[$i][1][$p][0])) { + $data[$i][1][$p][1] ??= ''; + $data[$i][1][$p][1] .= $char; + continue; + } + + // the header is invalid... + return null; + } + + $result = []; + foreach ($data as $item) { + $result[$item[0]] = []; + if (isset($item[1])) { + foreach ($item[1] as $param) { + $result[$item[0]][$param[0]] = $param[1] ?? ''; + } + } + } + + uasort($result, static fn(array $a, array $b): int => ($b['q'] ?? 1) <=> ($a['q'] ?? 1)); + + return $result; +} diff --git a/functions/path_build.php b/functions/path_build.php index 4ebff507..c9c5340d 100644 --- a/functions/path_build.php +++ b/functions/path_build.php @@ -1,4 +1,4 @@ -value = $value; } } diff --git a/src/Annotation/Description.php b/src/Annotation/Description.php index 0457e99c..32773539 100644 --- a/src/Annotation/Description.php +++ b/src/Annotation/Description.php @@ -1,4 +1,4 @@ -value = $value; } } diff --git a/src/Annotation/Host.php b/src/Annotation/Host.php index 4b4f9c8d..95f0a5c0 100644 --- a/src/Annotation/Host.php +++ b/src/Annotation/Host.php @@ -1,4 +1,4 @@ -value = $value; } } diff --git a/src/Annotation/Method.php b/src/Annotation/Method.php index e6ff17f2..f2544223 100644 --- a/src/Annotation/Method.php +++ b/src/Annotation/Method.php @@ -1,4 +1,4 @@ -value = $value; } } diff --git a/src/Annotation/Middleware.php b/src/Annotation/Middleware.php index 1d339476..980dc8ff 100644 --- a/src/Annotation/Middleware.php +++ b/src/Annotation/Middleware.php @@ -1,4 +1,4 @@ - - */ - public string $value; - /** * Constructor of the class * * @param class-string $value */ - public function __construct(string $value) + public function __construct(public string $value) { - $this->value = $value; } } diff --git a/src/Annotation/Postfix.php b/src/Annotation/Postfix.php index c2bb2a7d..48ff6d85 100644 --- a/src/Annotation/Postfix.php +++ b/src/Annotation/Postfix.php @@ -1,4 +1,4 @@ -value = $value; } } diff --git a/src/Annotation/Prefix.php b/src/Annotation/Prefix.php index 71f3baa8..aaccdeca 100644 --- a/src/Annotation/Prefix.php +++ b/src/Annotation/Prefix.php @@ -1,4 +1,4 @@ -value = $value; } } diff --git a/src/Annotation/Produce.php b/src/Annotation/Produce.php index 16be685c..ccac05ce 100644 --- a/src/Annotation/Produce.php +++ b/src/Annotation/Produce.php @@ -1,4 +1,4 @@ -value = $value; } } diff --git a/src/Annotation/RequestBody.php b/src/Annotation/RequestBody.php index 56ae949a..149c5d8f 100644 --- a/src/Annotation/RequestBody.php +++ b/src/Annotation/RequestBody.php @@ -1,4 +1,4 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Annotation; - -/** - * Import classes - */ -use Attribute; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_PARAMETER)] -final class RequestEntity -{ - - /** - * Constructor of the class - * - * @param string|null $em - * @param string $findBy - * @param string|null $paramKey - * @param array $criteria - */ - public function __construct( - public ?string $em = null, - public string $findBy = 'id', - public ?string $paramKey = null, - public array $criteria = [] - ) { - } -} diff --git a/src/Annotation/RequestQuery.php b/src/Annotation/RequestQuery.php index e2aa1e52..a064389b 100644 --- a/src/Annotation/RequestQuery.php +++ b/src/Annotation/RequestQuery.php @@ -1,4 +1,4 @@ -"), - * @Attribute("consumes", type="array"), - * @Attribute("produces", type="array"), - * @Attribute("middlewares", type="array"), - * @Attribute("attributes", type="array"), - * @Attribute("summary", type="string"), - * @Attribute("description", type="string"), - * @Attribute("tags", type="array"), - * @Attribute("priority", type="integer"), - * }) - */ -#[Attribute(Attribute::TARGET_CLASS|Attribute::TARGET_METHOD)] +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] final class Route implements RequestMethodInterface { /** - * The descriptor holder - * - * @var class-string|array{0: class-string, 1: non-empty-string}|null + * The annotation's holder * * @internal */ - public $holder = null; - - /** - * The route name - * - * @var string - */ - public string $name; - - /** - * The route host - * - * @var string|null - */ - public ?string $host; - - /** - * The route path - * - * @var string - */ - public string $path; - - /** - * The route methods - * - * @var list - */ - public array $methods; - - /** - * The route's consumed content types - * - * @var list - * - * @since 3.0.0 - */ - public array $consumes; - - /** - * The route's produced content types - * - * @var list - * - * @since 3.0.0 - */ - public array $produces; - - /** - * The route middlewares - * - * @var list> - */ - public array $middlewares; - - /** - * The route attributes - * - * @var array - */ - public array $attributes; - - /** - * The route summary - * - * @var string - */ - public string $summary; - - /** - * The route description - * - * @var string - */ - public string $description; - - /** - * The route tags - * - * @var list - */ - public array $tags; - - /** - * The route priority - * - * @var int - */ - public int $priority; + public mixed $holder = null; /** * Constructor of the class * - * @param string $name The route name - * @param string|null $host The route host - * @param string $path The route path - * @param string|null $method The route method - * @param list $methods The route methods - * @param list $consumes The route's consumed content types - * @param list $produces The route's produced content types - * @param list> $middlewares The route middlewares - * @param array $attributes The route attributes - * @param string $summary The route summary - * @param string $description The route description - * @param list $tags The route tags - * @param int $priority The route priority (default 0) + * @param non-empty-string $name The route's name + * @param non-empty-string|null $host The route's host + * @param non-empty-string $path The route's path + * @param non-empty-string|null $method The route's method + * @param list $methods The route's methods + * @param list $consumes The route's consumed media types + * @param list $produces The route's produced media types + * @param list> $middlewares The route's middlewares + * @param array $attributes The route's attributes + * @param string $summary The route's summary + * @param string $description The route's description + * @param list $tags The route's tags + * @param int $priority The route's priority (default 0) */ public function __construct( - string $name, - ?string $host = null, - string $path = '/', + public string $name, + public ?string $host = null, + public string $path = '/', ?string $method = null, - array $methods = [], - array $consumes = [], - array $produces = [], - array $middlewares = [], - array $attributes = [], - string $summary = '', - string $description = '', - array $tags = [], - int $priority = 0 + public array $methods = [], + public array $consumes = [], + public array $produces = [], + public array $middlewares = [], + public array $attributes = [], + public string $summary = '', + public string $description = '', + public array $tags = [], + public int $priority = 0, ) { if (isset($method)) { - $methods[] = $method; + $this->methods[] = $method; + } elseif (empty($this->methods)) { + $this->methods[] = self::METHOD_GET; } - - // if no methods are specified, - // such a route is a GET route. - if (empty($methods)) { - $methods[] = self::METHOD_GET; - } - - $this->name = $name; - $this->host = $host; - $this->path = $path; - $this->methods = $methods; - $this->consumes = $consumes; - $this->produces = $produces; - $this->middlewares = $middlewares; - $this->attributes = $attributes; - $this->summary = $summary; - $this->description = $description; - $this->tags = $tags; - $this->priority = $priority; } } diff --git a/src/Annotation/Summary.php b/src/Annotation/Summary.php index c19eaaa0..0e294cea 100644 --- a/src/Annotation/Summary.php +++ b/src/Annotation/Summary.php @@ -1,4 +1,4 @@ -value = $value; } } diff --git a/src/Annotation/Tag.php b/src/Annotation/Tag.php index 8af2e525..8cbe90f2 100644 --- a/src/Annotation/Tag.php +++ b/src/Annotation/Tag.php @@ -1,4 +1,4 @@ -value = $value; } } diff --git a/src/Annotation/Version.php b/src/Annotation/Version.php new file mode 100644 index 00000000..8d018ab9 --- /dev/null +++ b/src/Annotation/Version.php @@ -0,0 +1,33 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] +final class Version +{ + + /** + * Constructor of the class + * + * @param non-empty-string $value + */ + public function __construct(public string $value) + { + } +} diff --git a/src/ClassResolver.php b/src/ClassResolver.php index e3d14e26..24e45e30 100644 --- a/src/ClassResolver.php +++ b/src/ClassResolver.php @@ -1,4 +1,4 @@ -, T> */ private array $resolvedClasses = []; /** - * The resolver's parameter resolutioner - * * @var ParameterResolutionerInterface */ private ParameterResolutionerInterface $parameterResolutioner; diff --git a/src/ClassResolverInterface.php b/src/ClassResolverInterface.php index c76bab7c..164b08d6 100644 --- a/src/ClassResolverInterface.php +++ b/src/ClassResolverInterface.php @@ -1,4 +1,4 @@ -router = $router; } /** @@ -72,12 +56,11 @@ public function __construct(?Router $router = null) protected function getRouter(): Router { if (!isset($this->router)) { - throw new LogicException(sprintf( + throw new LogicException(\sprintf( 'The %2$s() method MUST return the %1$s class instance. ' . - 'Pass the %1$s class instance to the constructor ' . - 'or override the %2$s() method.', + 'Pass the %1$s class instance to the constructor or override the %2$s() method.', Router::class, - __METHOD__ + __METHOD__, )); } @@ -110,14 +93,14 @@ final protected function execute(InputInterface $input, OutputInterface $output) foreach ($this->getRouter()->getRoutes()->all() as $route) { $table->addRow([ $route->getName(), - $route->getHost() ?? 'ANY', + $route->getHost() ?? '*', path_plain($route->getPath()), - join(', ', $route->getMethods()), + \join(', ', $route->getMethods()), ]); } $table->render(); - return 0; + return self::SUCCESS; } } diff --git a/src/Entity/IpAddress.php b/src/Entity/IpAddress.php index 0b6c6ec5..4e5477a8 100644 --- a/src/Entity/IpAddress.php +++ b/src/Entity/IpAddress.php @@ -1,4 +1,4 @@ - $proxies The list of proxies in front of this IP address */ - public function __construct(string $value) + public function __construct(private string $value, private array $proxies = []) { - $this->value = $value; } /** * Gets the IP address value * - * @return string + * @return non-empty-string */ public function getValue(): string { @@ -62,89 +42,12 @@ public function getValue(): string } /** - * Checks if the IP address is valid - * - * @return bool - */ - public function isValid(): bool - { - return false !== filter_var($this->value, FILTER_VALIDATE_IP); - } - - /** - * Checks if the IP address is IPv4 - * - * @return bool - */ - public function isVersion4(): bool - { - return false !== filter_var($this->value, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4); - } - - /** - * Checks if the IP address is IPv6 - * - * @return bool - */ - public function isVersion6(): bool - { - return false !== filter_var($this->value, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6); - } - - /** - * Checks if the IP address is in the private range - * - * @return bool - */ - public function isInPrivateRange(): bool - { - if (!$this->isValid()) { - return false; - } - - return false === filter_var($this->value, FILTER_VALIDATE_IP, FILTER_FLAG_NO_PRIV_RANGE); - } - - /** - * Checks if the IP address is in the reserved range - * - * @return bool - */ - public function isInReservedRange(): bool - { - if (!$this->isValid()) { - return false; - } - - return false === filter_var($this->value, FILTER_VALIDATE_IP, FILTER_FLAG_NO_RES_RANGE); - } - - /** - * Converts the IP address to an integer if it possible + * Gets the list of proxies in front of this IP address * - * @return int|null + * @return list */ - public function toLong(): ?int + public function getProxies(): array { - if (!$this->isVersion4()) { - return null; - } - - $long = ip2long($this->value); - if ($long === false) { - return null; - } - - return $long; - } - - /** - * Converts the object to a string - * - * @return string - */ - public function __toString(): string - { - return $this->value; + return $this->proxies; } } diff --git a/src/Entity/MediaType.php b/src/Entity/MediaType.php new file mode 100644 index 00000000..87fea982 --- /dev/null +++ b/src/Entity/MediaType.php @@ -0,0 +1,56 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Entity; + +/** + * Media type + * + * @since 3.0.0 + */ +final class MediaType +{ + public const APPLICATION_JSON = 'application/json'; + public const APPLICATION_XML = 'application/xml'; + public const TEXT_XML = 'text/xml'; + + /** + * Constructor of the class + * + * @param non-empty-string $value + * @param array $parameters + */ + public function __construct(private string $value, private array $parameters = []) + { + } + + /** + * Gets the media type value + * + * @return non-empty-string + */ + public function getValue(): string + { + return $this->value; + } + + /** + * Gets the media type parameters + * + * @return array + */ + public function getParameters(): array + { + return $this->parameters; + } +} diff --git a/src/Event/RouteEvent.php b/src/Event/RouteEvent.php index 54942692..45c9b9c0 100644 --- a/src/Event/RouteEvent.php +++ b/src/Event/RouteEvent.php @@ -1,4 +1,4 @@ -route = $route; - $this->request = $request; } /** @@ -62,4 +49,14 @@ public function getRequest(): ServerRequestInterface { return $this->request; } + + /** + * @param ServerRequestInterface $request + * + * @return void + */ + public function setRequest(ServerRequestInterface $request): void + { + $this->request = $request; + } } diff --git a/src/Exception/ClientNotConsumedMediaTypeException.php b/src/Exception/ClientNotConsumedMediaTypeException.php index ec11ce1f..ab2f8af9 100644 --- a/src/Exception/ClientNotConsumedMediaTypeException.php +++ b/src/Exception/ClientNotConsumedMediaTypeException.php @@ -1,4 +1,4 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Exception; - -/** - * Import classes - */ -use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; - -/** - * InvalidRequestBodyException - * - * @since 3.0.0 - */ -class InvalidRequestBodyException extends HttpBadRequestException -{ -} diff --git a/src/Exception/InvalidRequestPayloadException.php b/src/Exception/InvalidRequestPayloadException.php index 24c8c478..4e6c96c9 100644 --- a/src/Exception/InvalidRequestPayloadException.php +++ b/src/Exception/InvalidRequestPayloadException.php @@ -1,4 +1,4 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Exception; - -/** - * Import classes - */ -use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; - -/** - * InvalidRequestQueryException - * - * @since 3.0.0 - */ -class InvalidRequestQueryException extends HttpBadRequestException -{ -} diff --git a/src/Exception/LogicException.php b/src/Exception/LogicException.php index 17c8238b..6070fa3c 100644 --- a/src/Exception/LogicException.php +++ b/src/Exception/LogicException.php @@ -1,4 +1,4 @@ - */ private array $resources = []; @@ -90,7 +90,7 @@ public function __construct( ?RouteFactoryInterface $routeFactory = null, ?ReferenceResolverInterface $referenceResolver = null, ?ParameterResolutionerInterface $parameterResolutioner = null, - ?ResponseResolutionerInterface $responseResolutioner = null + ?ResponseResolutionerInterface $responseResolutioner = null, ) { $this->collectionFactory = $collectionFactory ?? new RouteCollectionFactory(); $this->routeFactory = $routeFactory ?? new RouteFactory(); @@ -100,10 +100,28 @@ public function __construct( $this->referenceResolver = $referenceResolver ?? new ReferenceResolver( $this->parameterResolutioner ??= new ParameterResolutioner(), - $this->responseResolutioner ??= new ResponseResolutioner() + $this->responseResolutioner ??= new ResponseResolutioner(), ); } + /** + * Sets the given container to the loader + * + * @param ContainerInterface $container + * + * @return void + * + * @throws LogicException + * If a custom reference resolver has been set, + * but a parameter resolutioner has not been set. + * + * @since 2.9.0 + */ + public function setContainer(ContainerInterface $container): void + { + $this->addParameterResolver(new DependencyInjectionParameterResolver($container)); + } + /** * Adds the given parameter resolver(s) to the parameter resolutioner * @@ -112,7 +130,8 @@ public function __construct( * @return void * * @throws LogicException - * If a custom reference resolver was setted and a parameter resolutioner wasn't passed. + * If a custom reference resolver has been set, + * but a parameter resolutioner has not been set. * * @since 3.0.0 */ @@ -121,8 +140,8 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): if (!isset($this->parameterResolutioner)) { throw new LogicException( 'The config route loader cannot accept parameter resolvers ' . - 'because a custom reference resolver was setted ' . - 'and a parameter resolutioner was not passed' + 'because a custom reference resolver has been set, ' . + 'but a parameter resolutioner has not been set.' ); } @@ -137,7 +156,8 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): * @return void * * @throws LogicException - * If a custom reference resolver was setted and a response resolutioner wasn't passed. + * If a custom reference resolver has been set, + * but a response resolutioner has not been set. * * @since 3.0.0 */ @@ -146,8 +166,8 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo if (!isset($this->responseResolutioner)) { throw new LogicException( 'The config route loader cannot accept response resolvers ' . - 'because a custom reference resolver was setted ' . - 'and a response resolutioner was not passed' + 'because a custom reference resolver has been set, ' . + 'but a response resolutioner has not been set.' ); } @@ -156,12 +176,15 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo /** * {@inheritdoc} + * + * @throws InvalidArgumentException + * If the resource isn't valid. */ - public function attach($resource): void + public function attach(mixed $resource): void { if (!is_string($resource)) { throw new InvalidArgumentException( - 'The config route loader only handles string resources' + 'The config route loader only handles string resources.' ); } @@ -181,13 +204,16 @@ public function attach($resource): void throw new InvalidArgumentException(sprintf( 'The config route loader only handles file or directory paths, ' . - 'however the given resource "%s" is not one of them', - $resource + 'however the given resource "%s" is not one of them.', + $resource, )); } /** * {@inheritdoc} + * + * @throws InvalidArgumentException + * If one of the given resources isn't valid. */ public function attachArray(array $resources): void { @@ -205,14 +231,14 @@ public function load(): RouteCollectionInterface $collector = new RouteCollector( $this->collectionFactory, $this->routeFactory, - $this->referenceResolver + $this->referenceResolver, ); - foreach ($this->resources as $filename) { + foreach ($this->resources as $resource) { (function (string $filename): void { /** @psalm-suppress UnresolvableInclude */ require $filename; - })->call($collector, $filename); + })->call($collector, $resource); } return $collector->getCollection(); diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 885dd4ee..00dcfdf0 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -1,4 +1,4 @@ - + * List of classes or directories + * + * @var list */ private array $resources = []; @@ -101,18 +97,13 @@ final class DescriptorLoader implements LoaderInterface */ private ?ResponseResolutionerInterface $responseResolutioner; - /** - * @var AnnotationReaderInterface|null - */ - private ?AnnotationReaderInterface $annotationReader = null; - /** * @var CacheInterface|null */ - private ?CacheInterface $cache = null; + private ?CacheInterface $cache; /** - * @var string|null + * @var non-empty-string|null */ private ?string $cacheKey = null; @@ -124,13 +115,15 @@ final class DescriptorLoader implements LoaderInterface * @param ReferenceResolverInterface|null $referenceResolver * @param ParameterResolutionerInterface|null $parameterResolutioner * @param ResponseResolutionerInterface|null $responseResolutioner + * @param CacheInterface|null $cache */ public function __construct( ?RouteCollectionFactoryInterface $collectionFactory = null, ?RouteFactoryInterface $routeFactory = null, ?ReferenceResolverInterface $referenceResolver = null, ?ParameterResolutionerInterface $parameterResolutioner = null, - ?ResponseResolutionerInterface $responseResolutioner = null + ?ResponseResolutionerInterface $responseResolutioner = null, + ?CacheInterface $cache = null, ) { $this->collectionFactory = $collectionFactory ?? new RouteCollectionFactory(); $this->routeFactory = $routeFactory ?? new RouteFactory(); @@ -140,8 +133,26 @@ public function __construct( $this->referenceResolver = $referenceResolver ?? new ReferenceResolver( $this->parameterResolutioner ??= new ParameterResolutioner(), - $this->responseResolutioner ??= new ResponseResolutioner() + $this->responseResolutioner ??= new ResponseResolutioner(), ); + + $this->cache = $cache; + } + + /** + * Sets the given container to the loader + * + * @param ContainerInterface $container + * + * @return void + * + * @throws LogicException + * If a custom reference resolver has been set, + * but a parameter resolutioner has not been set. + */ + public function setContainer(ContainerInterface $container): void + { + $this->addParameterResolver(new DependencyInjectionParameterResolver($container)); } /** @@ -152,7 +163,8 @@ public function __construct( * @return void * * @throws LogicException - * If a custom reference resolver was setted and a parameter resolutioner wasn't passed. + * If a custom reference resolver has been set, + * but a parameter resolutioner has not been set. * * @since 3.0.0 */ @@ -161,8 +173,8 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): if (!isset($this->parameterResolutioner)) { throw new LogicException( 'The descriptor route loader cannot accept parameter resolvers ' . - 'because a custom reference resolver was setted ' . - 'and a parameter resolutioner was not passed' + 'because a custom reference resolver has been set, ' . + 'but a parameter resolutioner has not been set.' ); } @@ -177,7 +189,8 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): * @return void * * @throws LogicException - * If a custom reference resolver was setted and a response resolutioner wasn't passed. + * If a custom reference resolver has been set, + * but a response resolutioner has not been set. * * @since 3.0.0 */ @@ -186,8 +199,8 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo if (!isset($this->responseResolutioner)) { throw new LogicException( 'The descriptor route loader cannot accept response resolvers ' . - 'because a custom reference resolver was setted ' . - 'and a response resolutioner was not passed' + 'because a custom reference resolver has been set, ' . + 'but a response resolutioner has not been set.' ); } @@ -195,40 +208,15 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo } /** - * Uses the default annotation reader - * - * @return void - * - * @throws LogicException - * If the "doctrine/annotations" package isn't installed. - * - * @since 3.0.0 - */ - public function useDefaultAnnotationReader(): void - { - if (!class_exists(AnnotationReader::class)) { - throw new LogicException( - 'The descriptor route loader cannot use the default annotation reader ' . - 'because the annotation reading logic requires the "doctrine/annotations" package, ' . - 'run the "composer install doctrine/annotations" command and try again' - ); - } - - $this->annotationReader = new AnnotationReader(); - } - - /** - * Sets the given annotation reader to the loader + * Sets the given cache to the loader * - * @param AnnotationReaderInterface|null $annotationReader + * @param CacheInterface|null $cache * * @return void - * - * @since 3.0.0 */ - public function setAnnotationReader(?AnnotationReaderInterface $annotationReader): void + public function setCache(?CacheInterface $cache): void { - $this->annotationReader = $annotationReader; + $this->cache = $cache; } /** @@ -242,77 +230,61 @@ public function getCache(): ?CacheInterface } /** - * Sets the given cache to the loader + * Sets the given cache key to the loader * - * @param CacheInterface|null $cache + * @param non-empty-string|null $cacheKey * * @return void - */ - public function setCache(?CacheInterface $cache): void - { - $this->cache = $cache; - } - - /** - * Gets the loader cache key - * - * @return string * * @since 2.10.0 */ - public function getCacheKey(): string + public function setCacheKey(?string $cacheKey): void { - return $this->cacheKey ??= hash('md5', 'router:descriptors'); + $this->cacheKey = $cacheKey; } /** - * Sets the given cache key to the loader - * - * @param string|null $cacheKey + * Gets the loader cache key * - * @return void + * @return non-empty-string * * @since 2.10.0 */ - public function setCacheKey(?string $cacheKey): void + public function getCacheKey(): string { - $this->cacheKey = $cacheKey; + return $this->cacheKey ??= hash('md5', __METHOD__); } /** * {@inheritdoc} + * + * @throws InvalidArgumentException + * If the resource isn't valid. */ - public function attach($resource): void + public function attach(mixed $resource): void { if (!is_string($resource)) { throw new InvalidArgumentException( - 'The descriptor route loader only handles string resources' + 'The descriptor route loader only handles string resources.' ); } - if (is_dir($resource)) { - $classnames = get_dir_classes($resource); - foreach ($classnames as $classname) { - $this->resources[] = $classname; - } - - return; + if (!class_exists($resource) && !is_dir($resource)) { + throw new InvalidArgumentException(sprintf( + 'The descriptor route loader only handles class names or directory paths, ' . + 'however the given resource "%s" is not one of them.', + $resource, + )); } - if (class_exists($resource)) { - $this->resources[] = $resource; - return; - } - - throw new InvalidArgumentException(sprintf( - 'The descriptor route loader only handles class names or directory paths, ' . - 'however the given resource "%s" is not one of them', - $resource - )); + $this->resources[] = $resource; } /** * {@inheritdoc} + * + * @throws InvalidArgumentException + * If one of the given resources isn't valid. */ public function attachArray(array $resources): void { @@ -327,7 +299,7 @@ public function attachArray(array $resources): void */ public function load(): RouteCollectionInterface { - $routes = []; + $routes = $this->collectionFactory->createCollection(); $descriptors = $this->getDescriptors(); foreach ($descriptors as $descriptor) { $route = $this->routeFactory->createRoute( @@ -336,7 +308,7 @@ public function load(): RouteCollectionInterface $descriptor->methods, $this->referenceResolver->resolveRequestHandler($descriptor->holder), $this->referenceResolver->resolveMiddlewares($descriptor->middlewares), - $descriptor->attributes + $descriptor->attributes, ); $route->setHost($descriptor->host); @@ -346,193 +318,222 @@ public function load(): RouteCollectionInterface $route->setDescription($descriptor->description); $route->setTags(...$descriptor->tags); - $routes[] = $route; + $routes->add($route); } - return $this->collectionFactory->createCollection(...$routes); + return $routes; } /** * Gets descriptors from the cache if they are stored in it, * otherwise collects them from the loader resources, - * then tries to cache and return them + * then tries to cache and return them. * * @return list */ private function getDescriptors(): array { - $key = $this->getCacheKey(); + $cacheKey = $this->getCacheKey(); - if (isset($this->cache) && $this->cache->has($key)) { + if (isset($this->cache) && $this->cache->has($cacheKey)) { /** @var list */ - return $this->cache->get($key); + return $this->cache->get($cacheKey); } $result = []; - foreach ($this->resources as $resource) { - $descriptors = $this->getClassDescriptors( - new ReflectionClass($resource) - ); - + $descriptors = $this->getResourceDescriptors($resource); foreach ($descriptors as $descriptor) { $result[] = $descriptor; } } - usort($result, static function (Route $a, Route $b): int { - return $b->priority <=> $a->priority; - }); + usort($result, static fn(Route $a, Route $b): int => $b->priority <=> $a->priority); if (isset($this->cache)) { - $this->cache->set($key, $result); + $this->cache->set($cacheKey, $result); } return $result; } + /** + * Gets descriptors from the given resource + * + * @param string $resource + * + * @return iterable + */ + private function getResourceDescriptors(string $resource): iterable + { + if (class_exists($resource)) { + yield from $this->getClassDescriptors(new ReflectionClass($resource)); + } + + if (is_dir($resource)) { + foreach ($this->getDirectoryClasses($resource) as $class) { + yield from $this->getClassDescriptors($class); + } + } + } + /** * Gets descriptors from the given class * * @param ReflectionClass $class * - * @return list + * @return iterable */ - private function getClassDescriptors(ReflectionClass $class): array + private function getClassDescriptors(ReflectionClass $class): iterable { - // e.g., interfaces, traits, enums, abstract classes, - // classes with private constructor... if (!$class->isInstantiable()) { - return []; + return; } - $result = []; - if ($class->isSubclassOf(RequestHandlerInterface::class)) { - $annotations = $this->getClassOrMethodAnnotations($class, Route::class); + $annotations = $this->getAnnotations(Route::class, $class); if (isset($annotations[0])) { $descriptor = $annotations[0]; $descriptor->holder = $class->getName(); $this->supplementDescriptor($descriptor, $class); - $result[] = $descriptor; + yield $descriptor; } } - foreach ($class->getMethods() as $method) { - // ignore non-public methods... - if (!$method->isPublic()) { + foreach ($class->getMethods(ReflectionMethod::IS_PUBLIC) as $method) { + // Statical methods must be ignored... + if ($method->isStatic()) { continue; } - $annotations = $this->getClassOrMethodAnnotations($method, Route::class); + $annotations = $this->getAnnotations(Route::class, $method); if (isset($annotations[0])) { $descriptor = $annotations[0]; $descriptor->holder = [$class->getName(), $method->getName()]; $this->supplementDescriptor($descriptor, $class); $this->supplementDescriptor($descriptor, $method); - $result[] = $descriptor; + yield $descriptor; } } - - return $result; - } - - /** - * Gets annotations from the given class or method - * - * @param ReflectionClass|ReflectionMethod $classOrMethod - * @param class-string $annotationName - * - * @return list - * - * @template T - */ - private function getClassOrMethodAnnotations(Reflector $classOrMethod, string $annotationName): array - { - $result = []; - - if (PHP_MAJOR_VERSION === 8) { - /** @var ReflectionAttribute[] */ - $attributes = $classOrMethod->getAttributes($annotationName); - foreach ($attributes as $attribute) { - /** @var T */ - $result[] = $attribute->newInstance(); - } - } - - if (isset($this->annotationReader)) { - $annotations = ($classOrMethod instanceof ReflectionClass) ? - $this->annotationReader->getClassAnnotations($classOrMethod) : - $this->annotationReader->getMethodAnnotations($classOrMethod); - - foreach ($annotations as $annotation) { - if ($annotation instanceof $annotationName) { - $result[] = $annotation; - } - } - } - - return $result; } /** * Supplements the given descriptor from the given class or method * * @param Route $descriptor - * @param ReflectionClass|ReflectionMethod $classOrMethod + * @param ReflectionClass|ReflectionMethod $holder * * @return void */ - private function supplementDescriptor(Route $descriptor, Reflector $classOrMethod): void + private function supplementDescriptor(Route $descriptor, ReflectionClass|ReflectionMethod $holder): void { - $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Host::class); + $annotations = $this->getAnnotations(Host::class, $holder); if (isset($annotations[0])) { $descriptor->host = $annotations[0]->value; } - $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Prefix::class); + $annotations = $this->getAnnotations(Prefix::class, $holder); if (isset($annotations[0])) { $descriptor->path = $annotations[0]->value . $descriptor->path; } - $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Postfix::class); + $annotations = $this->getAnnotations(Postfix::class, $holder); if (isset($annotations[0])) { - $descriptor->path = $descriptor->path . $annotations[0]->value; + $descriptor->path .= $annotations[0]->value; } - $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Method::class); + $annotations = $this->getAnnotations(Method::class, $holder); foreach ($annotations as $annotation) { $descriptor->methods[] = $annotation->value; } - $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Consume::class); + $annotations = $this->getAnnotations(Consume::class, $holder); foreach ($annotations as $annotation) { $descriptor->consumes[] = $annotation->value; } - $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Produce::class); + $annotations = $this->getAnnotations(Produce::class, $holder); foreach ($annotations as $annotation) { $descriptor->produces[] = $annotation->value; } - $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Middleware::class); + $annotations = $this->getAnnotations(Middleware::class, $holder); foreach ($annotations as $annotation) { $descriptor->middlewares[] = $annotation->value; } - $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Summary::class); + $annotations = $this->getAnnotations(Summary::class, $holder); foreach ($annotations as $annotation) { $descriptor->summary .= $annotation->value; } - $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Description::class); + $annotations = $this->getAnnotations(Description::class, $holder); foreach ($annotations as $annotation) { $descriptor->description .= $annotation->value; } - $annotations = $this->getClassOrMethodAnnotations($classOrMethod, Tag::class); + $annotations = $this->getAnnotations(Tag::class, $holder); foreach ($annotations as $annotation) { $descriptor->tags[] = $annotation->value; } } + + /** + * Gets the named annotations from the given class or method + * + * @param class-string $name + * @param ReflectionClass|ReflectionMethod $source + * + * @return list + * + * @template T of object + */ + private function getAnnotations(string $name, ReflectionClass|ReflectionMethod $source): array + { + $result = []; + $attributes = $source->getAttributes($name); + foreach ($attributes as $attribute) { + $result[] = $attribute->newInstance(); + } + + return $result; + } + + /** + * Scans the given directory and returns the found classes + * + * @param string $dirname + * + * @return iterable + */ + private function getDirectoryClasses(string $dirname): iterable + { + /** @var array $filenames */ + $filenames = iterator_to_array( + new RegexIterator( + new RecursiveIteratorIterator( + new RecursiveDirectoryIterator( + $dirname, + FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_PATHNAME, + ) + ), + '/\.php$/', + ) + ); + + foreach ($filenames as $filename) { + (static function (string $filename): void { + /** @psalm-suppress UnresolvableInclude */ + require_once $filename; + })($filename); + } + + foreach (get_declared_classes() as $fqn) { + $class = new ReflectionClass($fqn); + $filename = $class->getFileName(); + if (isset($filenames[$filename])) { + yield $class; + } + } + } } diff --git a/src/Loader/LoaderInterface.php b/src/Loader/LoaderInterface.php index be6408b4..3659e862 100644 --- a/src/Loader/LoaderInterface.php +++ b/src/Loader/LoaderInterface.php @@ -1,4 +1,4 @@ - $resources * * @return void - * - * @throws InvalidArgumentException - * If one of the given resources isn't valid. */ public function attachArray(array $resources): void; diff --git a/src/Middleware/CallableMiddleware.php b/src/Middleware/CallableMiddleware.php index 18da1c0a..c42a2a38 100644 --- a/src/Middleware/CallableMiddleware.php +++ b/src/Middleware/CallableMiddleware.php @@ -1,4 +1,4 @@ -callback = $callback; - $this->parameterResolutioner = $parameterResolutioner; - $this->responseResolutioner = $responseResolutioner; - } - - /** - * Gets the callback's reflection - * - * @return ReflectionFunction|ReflectionMethod - * - * @since 3.0.0 + * @param T $callback */ - public function getReflection(): ReflectionFunctionAbstract + public function __construct(callable $callback) { - return reflect_callable($this->callback); + $this->callback = $callback; } /** @@ -93,17 +50,6 @@ public function getReflection(): ReflectionFunctionAbstract */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - $arguments = $this->parameterResolutioner - ->withContext($request) - ->withPriorityResolver(new KnownTypedParameterResolver(ServerRequestInterface::class, $request)) - ->withPriorityResolver(new KnownTypedParameterResolver(RequestHandlerInterface::class, $handler)) - ->resolveParameters(...$this->getReflection()->getParameters()); - - /** @var mixed */ - $response = ($this->callback)(...$arguments); - - return $this->responseResolutioner - ->withContext($request) - ->resolveResponse($response); + return ($this->callback)($request, $handler); } } diff --git a/src/Middleware/CallbackMiddleware.php b/src/Middleware/CallbackMiddleware.php new file mode 100644 index 00000000..77e10b43 --- /dev/null +++ b/src/Middleware/CallbackMiddleware.php @@ -0,0 +1,90 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Middleware; + +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\ParameterResolutionerInterface; +use Sunrise\Http\Router\ParameterResolver\PresetTypedParameterResolver; +use Sunrise\Http\Router\ResponseResolutionerInterface; + +use function Sunrise\Http\Router\reflect_callable; + +/** + * CallbackMiddleware + * + * @since 3.0.0 + */ +final class CallbackMiddleware implements MiddlewareInterface +{ + + /** + * The middleware's callback + * + * @var callable + */ + private $callback; + + /** + * The callback's parameter resolutioner + * + * @var ParameterResolutionerInterface + */ + private ParameterResolutionerInterface $parameterResolutioner; + + /** + * The callback's response resolutioner + * + * @var ResponseResolutionerInterface + */ + private ResponseResolutionerInterface $responseResolutioner; + + /** + * Constructor of the class + * + * @param callable $callback + * @param ParameterResolutionerInterface $parameterResolutioner + * @param ResponseResolutionerInterface $responseResolutioner + */ + public function __construct( + callable $callback, + ParameterResolutionerInterface $parameterResolutioner, + ResponseResolutionerInterface $responseResolutioner, + ) { + $this->callback = $callback; + $this->parameterResolutioner = $parameterResolutioner; + $this->responseResolutioner = $responseResolutioner; + } + + /** + * {@inheritdoc} + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + $args = $this->parameterResolutioner + ->withRequest($request) + ->withPriorityResolver( + new PresetTypedParameterResolver(ServerRequestInterface::class, $request), + new PresetTypedParameterResolver(RequestHandlerInterface::class, $handler), + ) + ->resolveParameters(...reflect_callable($this->callback)->getParameters()); + + /** @var mixed $response */ + $response = ($this->callback)(...$args); + + return $this->responseResolutioner->withRequest($request)->resolveResponse($response); + } +} diff --git a/src/Middleware/ClientIpAddressMiddleware.php b/src/Middleware/ClientIpAddressMiddleware.php deleted file mode 100644 index b408548e..00000000 --- a/src/Middleware/ClientIpAddressMiddleware.php +++ /dev/null @@ -1,55 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Middleware; - -/** - * Import classes - */ -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\ServerRequest; - -/** - * ClientIpAddressMiddleware - * - * @since 3.0.0 - */ -final class ClientIpAddressMiddleware implements MiddlewareInterface -{ - - /** - * @var array - */ - private array $proxyChain; - - /** - * Constructor of the class - * - * @param array $proxyChain - */ - public function __construct(array $proxyChain = []) - { - $this->proxyChain = $proxyChain; - } - - /** - * {@inheritdoc} - */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface - { - $clientIp = ServerRequest::from($request)->getClientIpAddress($this->proxyChain); - - return $handler->handle($request->withAttribute('@clientIp', $clientIp)); - } -} diff --git a/src/Middleware/CommittingEntityChangesMiddleware.php b/src/Middleware/CommittingEntityChangesMiddleware.php deleted file mode 100644 index 9a27e6c0..00000000 --- a/src/Middleware/CommittingEntityChangesMiddleware.php +++ /dev/null @@ -1,70 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Middleware; - -/** - * Import classes - */ -use Doctrine\Persistence\ManagerRegistry as EntityManagerRegistryInterface; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; - -/** - * CommittingEntityChangesMiddleware - * - * @since 3.0.0 - */ -final class CommittingEntityChangesMiddleware implements MiddlewareInterface -{ - - /** - * @var EntityManagerRegistryInterface - */ - private EntityManagerRegistryInterface $entityManagerRegistry; - - /** - * @var list - */ - private array $entityManagerNames; - - /** - * @param EntityManagerRegistryInterface $entityManagerRegistry - * @param list $entityManagerNames - */ - public function __construct( - EntityManagerRegistryInterface $entityManagerRegistry, - array $entityManagerNames = [] - ) { - $this->entityManagerRegistry = $entityManagerRegistry; - $this->entityManagerNames = $entityManagerNames; - } - - /** - * {@inheritdoc} - */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface - { - $response = $handler->handle($request); - - if (empty($this->entityManagerNames)) { - $this->entityManagerRegistry->getManager()->flush(); - } - - foreach ($this->entityManagerNames as $entityManagerName) { - $this->entityManagerRegistry->getManager($entityManagerName)->flush(); - } - - return $response; - } -} diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 9078474f..b7eba786 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -1,4 +1,4 @@ - * * @throws InvalidRequestPayloadException * If the request's payload cannot be decoded. */ - private function decodeRequestPayload(ServerRequestInterface $request): ?array + private function decodeRequestPayload(ServerRequestInterface $request): array { - // https://www.php.net/json.constants - $options = JSON_BIGINT_AS_STRING | JSON_OBJECT_AS_ARRAY | JSON_THROW_ON_ERROR; + $json = $request->getBody()->__toString(); try { - /** @var mixed */ - $result = json_decode($request->getBody()->__toString(), null, 512, $options); + $data = json_decode($json, true, 512, JSON_BIGINT_AS_STRING | JSON_THROW_ON_ERROR); } catch (JsonException $e) { throw new InvalidRequestPayloadException(sprintf('Invalid Payload: %s', $e->getMessage()), 0, $e); } - // according to PSR-7 the parsed body can be only an array or an object... - return is_array($result) ? $result : null; + if (!is_array($data)) { + throw new InvalidRequestPayloadException('Unexpected JSON: Expects an array or object.'); + } + + return $data; } } diff --git a/src/Middleware/ParsedBodyWhitespaceStrippingMiddleware.php b/src/Middleware/ParsedBodyWhitespaceStrippingMiddleware.php deleted file mode 100644 index 656cec85..00000000 --- a/src/Middleware/ParsedBodyWhitespaceStrippingMiddleware.php +++ /dev/null @@ -1,62 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Middleware; - -/** - * Import classes - */ -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; - -/** - * Import functions - */ -use function array_walk_recursive; -use function is_array; -use function is_string; -use function trim; - -/** - * ParsedBodyWhitespaceStrippingMiddleware - * - * @since 3.0.0 - */ -final class ParsedBodyWhitespaceStrippingMiddleware implements MiddlewareInterface -{ - - /** - * {@inheritdoc} - */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface - { - $parsedBody = $request->getParsedBody(); - - if (empty($parsedBody) || !is_array($parsedBody)) { - return $handler->handle($request); - } - - /** @psalm-suppress MissingClosureParamType, MixedAssignment */ - $walker = static function (&$value): void { - if (is_string($value)) { - $value = trim($value); - } - }; - - array_walk_recursive($parsedBody, $walker); - - return $handler->handle( - $request->withParsedBody($parsedBody) - ); - } -} diff --git a/src/Middleware/UnsafeCallableMiddleware.php b/src/Middleware/UnsafeCallableMiddleware.php deleted file mode 100644 index 430f0149..00000000 --- a/src/Middleware/UnsafeCallableMiddleware.php +++ /dev/null @@ -1,56 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Middleware; - -/** - * Import classes - */ -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; - -/** - * UnsafeCallableMiddleware - * - * @since 3.0.0 - * - * @template T as callable(ServerRequestInterface=, RequestHandlerInterface=): ResponseInterface - */ -final class UnsafeCallableMiddleware implements MiddlewareInterface -{ - - /** - * The middleware callback - * - * @var T - */ - private $callback; - - /** - * Constructor of the class - * - * @param T $callback - */ - public function __construct(callable $callback) - { - $this->callback = $callback; - } - - /** - * {@inheritdoc} - */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface - { - return ($this->callback)($request, $handler); - } -} diff --git a/src/Middleware/XmlPayloadDecodingMiddleware.php b/src/Middleware/XmlPayloadDecodingMiddleware.php deleted file mode 100644 index 4c716dd7..00000000 --- a/src/Middleware/XmlPayloadDecodingMiddleware.php +++ /dev/null @@ -1,85 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\Middleware; - -/** - * Import classes - */ -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\InvalidRequestPayloadException; -use Sunrise\Http\Router\ServerRequest; -use SimpleXMLElement; -use Throwable; - -/** - * Import functions - */ -use function sprintf; - -/** - * Import constants - */ -use const LIBXML_COMPACT; -use const LIBXML_NONET; -use const LIBXML_NOERROR; -use const LIBXML_NOWARNING; -use const LIBXML_PARSEHUGE; - -/** - * XmlPayloadDecodingMiddleware - * - * @since 3.0.0 - */ -final class XmlPayloadDecodingMiddleware implements MiddlewareInterface -{ - - /** - * {@inheritdoc} - */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface - { - if (ServerRequest::from($request)->isXml()) { - $request = $request->withParsedBody( - $this->decodeRequestPayload($request) - ); - } - - return $handler->handle($request); - } - - /** - * Tries to decode the given request's payload - * - * @param ServerRequestInterface $request - * - * @return SimpleXMLElement - * - * @throws InvalidRequestPayloadException - * If the request's payload cannot be decoded. - */ - private function decodeRequestPayload(ServerRequestInterface $request): SimpleXMLElement - { - // https://www.php.net/manual/en/libxml.constants.php - $options = LIBXML_COMPACT | LIBXML_NONET | LIBXML_NOERROR | LIBXML_NOWARNING | LIBXML_PARSEHUGE; - - try { - $result = new SimpleXMLElement($request->getBody()->__toString(), $options); - } catch (Throwable $e) { - throw new InvalidRequestPayloadException(sprintf('Invalid Payload: %s', $e->getMessage()), 0, $e); - } - - return $result; - } -} diff --git a/src/ParameterResolutioner.php b/src/ParameterResolutioner.php index 45682616..4c0a3cd9 100644 --- a/src/ParameterResolutioner.php +++ b/src/ParameterResolutioner.php @@ -1,4 +1,4 @@ - */ private array $resolvers = []; @@ -48,10 +42,10 @@ final class ParameterResolutioner implements ParameterResolutionerInterface /** * {@inheritdoc} */ - public function withContext($context): ParameterResolutionerInterface + public function withRequest(RequestInterface $request): static { $clone = clone $this; - $clone->context = $context; + $clone->request = $request; return $clone; } @@ -59,7 +53,7 @@ public function withContext($context): ParameterResolutionerInterface /** * {@inheritdoc} */ - public function withPriorityResolver(ParameterResolverInterface ...$resolvers): ParameterResolutionerInterface + public function withPriorityResolver(ParameterResolverInterface ...$resolvers): static { $clone = clone $this; $clone->resolvers = []; @@ -112,8 +106,8 @@ public function resolveParameters(ReflectionParameter ...$parameters): array private function resolveParameter(ReflectionParameter $parameter) { foreach ($this->resolvers as $resolver) { - if ($resolver->supportsParameter($parameter, $this->context)) { - return $resolver->resolveParameter($parameter, $this->context); + if ($resolver->supportsParameter($parameter, $this->request)) { + return $resolver->resolveParameter($parameter, $this->request); } } diff --git a/src/ParameterResolutionerInterface.php b/src/ParameterResolutionerInterface.php index 1d04ea3e..255eca11 100644 --- a/src/ParameterResolutionerInterface.php +++ b/src/ParameterResolutionerInterface.php @@ -1,4 +1,4 @@ - - * List of ready-to-pass arguments. + * @return list List of ready-to-pass arguments. * - * @throws ResolvingParameterException - * If one of the parameters cannot be resolved to an argument. + * @throws ResolvingParameterException If one of the parameters cannot be resolved to an argument. */ public function resolveParameters(ReflectionParameter ...$parameters): array; } diff --git a/src/ParameterResolver/ClientIpAddressParameterResolver.php b/src/ParameterResolver/ClientIpAddressParameterResolver.php deleted file mode 100644 index 321e46fe..00000000 --- a/src/ParameterResolver/ClientIpAddressParameterResolver.php +++ /dev/null @@ -1,77 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\ParameterResolver; - -/** - * Import classes - */ -use Psr\Http\Message\ServerRequestInterface; -use Sunrise\Http\Router\Entity\IpAddress; -use Sunrise\Http\Router\ParameterResolverInterface; -use Sunrise\Http\Router\ServerRequest; -use ReflectionNamedType; -use ReflectionParameter; - -/** - * ClientIpAddressParameterResolver - * - * @since 3.0.0 - */ -final class ClientIpAddressParameterResolver implements ParameterResolverInterface -{ - - /** - * @var array - */ - private array $proxyChain; - - /** - * Constructor of the class - * - * @param array $proxyChain - */ - public function __construct(array $proxyChain = []) - { - $this->proxyChain = $proxyChain; - } - - /** - * {@inheritdoc} - */ - public function supportsParameter(ReflectionParameter $parameter, $context): bool - { - if (!($context instanceof ServerRequestInterface)) { - return false; - } - - if (!($parameter->getType() instanceof ReflectionNamedType)) { - return false; - } - - if (!($parameter->getType()->getName() === IpAddress::class)) { - return false; - } - - return true; - } - - /** - * {@inheritdoc} - */ - public function resolveParameter(ReflectionParameter $parameter, $context) - { - /** @var ServerRequestInterface */ - $context = $context; - - return ServerRequest::from($context)->getClientIpAddress($this->proxyChain); - } -} diff --git a/src/ParameterResolver/DependencyInjectionParameterResolver.php b/src/ParameterResolver/DependencyInjectionParameterResolver.php index 38eb7df1..39aa2c2e 100644 --- a/src/ParameterResolver/DependencyInjectionParameterResolver.php +++ b/src/ParameterResolver/DependencyInjectionParameterResolver.php @@ -1,4 +1,4 @@ -getType() instanceof ReflectionNamedType)) { return false; @@ -63,11 +62,8 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo /** * {@inheritdoc} */ - public function resolveParameter(ReflectionParameter $parameter, $context) + public function resolveParameter(ReflectionParameter $parameter, RequestInterface $request): mixed { - /** @var ReflectionNamedType */ - $parameterType = $parameter->getType(); - - return $this->container->get($parameterType->getName()); + return $this->container->get($parameter->getType()->getName()); } } diff --git a/src/ParameterResolver/KnownUntypedParameterResolver.php b/src/ParameterResolver/KnownUntypedParameterResolver.php deleted file mode 100644 index 34c3ffe9..00000000 --- a/src/ParameterResolver/KnownUntypedParameterResolver.php +++ /dev/null @@ -1,71 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\ParameterResolver; - -/** - * Import classes - */ -use Sunrise\Http\Router\ParameterResolverInterface; -use ReflectionParameter; - -/** - * KnownUntypedParameterResolver - * - * @since 3.0.0 - */ -final class KnownUntypedParameterResolver implements ParameterResolverInterface -{ - - /** - * @var string - */ - private string $name; - - /** - * @var mixed - */ - private $value; - - /** - * @param string $name - * @param mixed $value - */ - public function __construct(string $name, $value) - { - $this->name = $name; - $this->value = $value; - } - - /** - * {@inheritdoc} - */ - public function supportsParameter(ReflectionParameter $parameter, $context): bool - { - if ($parameter->hasType()) { - return false; - } - - if (!($parameter->getName() === $this->name)) { - return false; - } - - return true; - } - - /** - * {@inheritdoc} - */ - public function resolveParameter(ReflectionParameter $parameter, $context) - { - return $this->value; - } -} diff --git a/src/ParameterResolverInterface.php b/src/ParameterResolver/ParameterResolverInterface.php similarity index 78% rename from src/ParameterResolverInterface.php rename to src/ParameterResolver/ParameterResolverInterface.php index 510d63f7..581631a0 100644 --- a/src/ParameterResolverInterface.php +++ b/src/ParameterResolver/ParameterResolverInterface.php @@ -1,4 +1,4 @@ - - */ - private string $type; - - /** - * @var T - */ - private object $value; - /** * @param class-string $type * @param T $value + * + * @template T of object */ - public function __construct(string $type, object $value) + public function __construct(private string $type, private object $value) { - $this->type = $type; - $this->value = $value; } /** * {@inheritdoc} */ - public function supportsParameter(ReflectionParameter $parameter, $context): bool + public function supportsParameter(ReflectionParameter $parameter, RequestInterface $request): bool { - if (!($parameter->getType() instanceof ReflectionNamedType)) { + $type = $parameter->getType(); + + if (!($type instanceof ReflectionNamedType)) { return false; } - if ($parameter->getType()->isBuiltin()) { + if ($type->isBuiltin()) { return false; } - if (!($parameter->getType()->getName() === $this->type)) { + if (!($type->getName() === $this->type)) { return false; } @@ -71,7 +62,7 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo /** * {@inheritdoc} */ - public function resolveParameter(ReflectionParameter $parameter, $context) + public function resolveParameter(ReflectionParameter $parameter, RequestInterface $request): mixed { return $this->value; } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index b42ba750..b5061a91 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -1,4 +1,4 @@ -hydrator = $hydrator; - $this->validator = $validator; + public function __construct(private HydratorInterface $hydrator, private ?ValidatorInterface $validator = null) + { } /** * {@inheritdoc} */ - public function supportsParameter(ReflectionParameter $parameter, $context): bool + public function supportsParameter(ReflectionParameter $parameter, RequestInterface $request): bool { - if (!($context instanceof ServerRequestInterface)) { - return false; - } - if (!($parameter->getType() instanceof ReflectionNamedType)) { return false; } @@ -88,11 +57,7 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo return false; } - if (8 === PHP_MAJOR_VERSION && $parameter->getAttributes(RequestBody::class)) { - return true; - } - - if (is_subclass_of($parameter->getType()->getName(), RequestBodyInterface::class)) { + if ($parameter->getAttributes(RequestBody::class)) { return true; } @@ -102,29 +67,26 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo /** * {@inheritdoc} * - * @throws InvalidRequestBodyException - * If the request body structure isn't valid. + * @throws UnhydrableObjectException + * If an object isn't valid. * * @throws UnprocessableRequestBodyException * If the request body data isn't valid. - * - * @throws UnhydrableObjectException - * If an object isn't valid. */ - public function resolveParameter(ReflectionParameter $parameter, $context) + public function resolveParameter(ReflectionParameter $parameter, RequestInterface $request): mixed { - /** @var ServerRequestInterface */ - $context = $context; + /** @var ReflectionNamedType $type */ + $type = $parameter->getType(); - /** @var ReflectionNamedType */ - $parameterType = $parameter->getType(); + /** @var class-string $typeName */ + $typeName = $type->getName(); try { - $object = $this->hydrator->hydrate($parameterType->getName(), (array) $context->getParsedBody()); + $object = $this->hydrator->hydrate($typeName, (array) $request->getParsedBody()); } catch (InvalidObjectException $e) { throw new UnhydrableObjectException($e->getMessage(), 0, $e); - } catch (InvalidValueException $e) { - throw new InvalidRequestBodyException($e->getMessage(), 0, $e); + } catch (InvalidDataException $e) { + throw new UnprocessableRequestBodyException($e->getViolations()); } if (isset($this->validator)) { diff --git a/src/ParameterResolver/RequestEntityParameterResolver.php b/src/ParameterResolver/RequestEntityParameterResolver.php deleted file mode 100644 index 6903cd01..00000000 --- a/src/ParameterResolver/RequestEntityParameterResolver.php +++ /dev/null @@ -1,134 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router\ParameterResolver; - -/** - * Import classes - */ -use Doctrine\Persistence\ManagerRegistry as EntityManagerRegistryInterface; -use Psr\Http\Message\ServerRequestInterface; -use Sunrise\Http\Router\Annotation\RequestEntity; -use Sunrise\Http\Router\Exception\EntityNotFoundException; -use Sunrise\Http\Router\Exception\MissingRequestParameterException; -use Sunrise\Http\Router\ParameterResolverInterface; -use ReflectionAttribute; -use ReflectionNamedType; -use ReflectionParameter; - -/** - * Import functions - */ -use function sprintf; - -/** - * RequestEntityParameterResolver - * - * @since 3.0.0 - */ -final class RequestEntityParameterResolver implements ParameterResolverInterface -{ - - /** - * @var EntityManagerRegistryInterface - */ - private EntityManagerRegistryInterface $entityManagerRegistry; - - /** - * @param EntityManagerRegistryInterface $entityManagerRegistry - */ - public function __construct(EntityManagerRegistryInterface $entityManagerRegistry) - { - $this->entityManagerRegistry = $entityManagerRegistry; - } - - /** - * {@inheritdoc} - */ - public function supportsParameter(ReflectionParameter $parameter, $context): bool - { - if (!($context instanceof ServerRequestInterface)) { - return false; - } - - if (!($parameter->getType() instanceof ReflectionNamedType)) { - return false; - } - - if ($parameter->getType()->isBuiltin()) { - return false; - } - - if (8 === PHP_MAJOR_VERSION && $parameter->getAttributes(RequestEntity::class)) { - return true; - } - - return false; - } - - /** - * {@inheritdoc} - * - * @throws MissingRequestParameterException - * If an entity ID was not found in the request parameters. - * - * @throws EntityNotFoundException - * If an entity was not found. - */ - public function resolveParameter(ReflectionParameter $parameter, $context) - { - /** @var ServerRequestInterface */ - $context = $context; - - /** @var ReflectionNamedType */ - $parameterType = $parameter->getType(); - - /** @var non-empty-list */ - $parameterRequestEntityAttributes = $parameter->getAttributes(RequestEntity::class); - - /** @var RequestEntity */ - $requestEntity = $parameterRequestEntityAttributes[0]->newInstance(); - - // if no request parameter key was assigned, the entity field name will be used... - $requestParameterKey = $requestEntity->paramKey ?? $requestEntity->findBy; - - /** @var string|null */ - $entityId = $context->getAttribute($requestParameterKey); - - if (!isset($entityId)) { - throw new MissingRequestParameterException(sprintf( - 'Missing the %s parameter in the request', - $requestParameterKey - )); - } - - $criteria = $requestEntity->criteria; - $criteria[$requestEntity->findBy] = $entityId; - - /** @var class-string */ - $entityName = $parameterType->getName(); - - $entity = $this->entityManagerRegistry - ->getManager($requestEntity->em) - ->getRepository($entityName) - ->findOneBy($criteria); - - if (isset($entity)) { - return $entity; - } - - if ($parameter->allowsNull()) { - return null; - } - - throw new EntityNotFoundException('Entity Not Found'); - } -} diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 070daab4..14be1470 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -1,4 +1,4 @@ -hydrator = $hydrator; $this->validator = $validator; } @@ -74,9 +61,9 @@ public function __construct( /** * {@inheritdoc} */ - public function supportsParameter(ReflectionParameter $parameter, $context): bool + public function supportsParameter(ReflectionParameter $parameter, $request): bool { - if (!($context instanceof ServerRequestInterface)) { + if (!($request instanceof ServerRequestInterface)) { return false; } @@ -88,7 +75,7 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo return false; } - if (8 === PHP_MAJOR_VERSION && $parameter->getAttributes(RequestQuery::class)) { + if (PHP_MAJOR_VERSION >= 8 && $parameter->getAttributes(RequestQuery::class)) { return true; } @@ -102,29 +89,22 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo /** * {@inheritdoc} * - * @throws InvalidRequestQueryException - * If the request query structure isn't valid. + * @throws UnhydrableObjectException + * If an object isn't valid. * * @throws UnprocessableRequestQueryException * If the request query data isn't valid. - * - * @throws UnhydrableObjectException - * If an object isn't valid. */ - public function resolveParameter(ReflectionParameter $parameter, $context) + public function resolveParameter(ReflectionParameter $parameter, $request) { - /** @var ServerRequestInterface */ - $context = $context; - - /** @var ReflectionNamedType */ - $parameterType = $parameter->getType(); + /** @var ServerRequestInterface $request */ try { - $object = $this->hydrator->hydrate($parameterType->getName(), $context->getQueryParams()); + $object = $this->hydrator->hydrate($parameter->getType()->getName(), $request->getQueryParams()); } catch (InvalidObjectException $e) { throw new UnhydrableObjectException($e->getMessage(), 0, $e); - } catch (InvalidValueException $e) { - throw new InvalidRequestQueryException($e->getMessage(), 0, $e); + } catch (InvalidDataException $e) { + throw new UnprocessableRequestQueryException($e->getViolations()); } if (isset($this->validator)) { diff --git a/src/ParameterResolver/RequestRouteParameterResolver.php b/src/ParameterResolver/RequestRouteParameterResolver.php index 3db1a9f9..b084b1f6 100644 --- a/src/ParameterResolver/RequestRouteParameterResolver.php +++ b/src/ParameterResolver/RequestRouteParameterResolver.php @@ -1,4 +1,4 @@ -getAttribute(RouteInterface::ATTR_ROUTE) instanceof RouteInterface)) { + if (!($request->getAttribute(RouteInterface::ATTR_ROUTE) instanceof RouteInterface)) { return false; } @@ -55,11 +53,10 @@ public function supportsParameter(ReflectionParameter $parameter, $context): boo /** * {@inheritdoc} */ - public function resolveParameter(ReflectionParameter $parameter, $context) + public function resolveParameter(ReflectionParameter $parameter, $request) { - /** @var ServerRequestInterface */ - $context = $context; + /** @var ServerRequestInterface $request */ - return $context->getAttribute(RouteInterface::ATTR_ROUTE); + return $request->getAttribute(RouteInterface::ATTR_ROUTE); } } diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index f76d2c0e..f9dc58b4 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -1,4 +1,4 @@ -parameterResolutioner, $this->responseResolutioner); + return new CallbackMiddleware($reference, $this->parameterResolutioner, $this->responseResolutioner); } if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { @@ -147,7 +137,7 @@ public function resolveMiddleware($reference): MiddlewareInterface $reference[0] = $this->classResolver->resolveClass($reference[0]); } - return new CallableMiddleware( + return new CallbackMiddleware( [$reference[0], $reference[1]], $this->parameterResolutioner, $this->responseResolutioner diff --git a/src/ReferenceResolverInterface.php b/src/ReferenceResolverInterface.php index a4f04b8a..deef0e97 100644 --- a/src/ReferenceResolverInterface.php +++ b/src/ReferenceResolverInterface.php @@ -1,4 +1,4 @@ -callback); } @@ -91,15 +86,13 @@ public function getReflection(): ReflectionFunctionAbstract public function handle(ServerRequestInterface $request): ResponseInterface { $arguments = $this->parameterResolutioner - ->withContext($request) - ->withPriorityResolver(new KnownTypedParameterResolver(ServerRequestInterface::class, $request)) + ->withRequest($request) + ->withPriorityResolver(new PresetTypedParameterResolver(ServerRequestInterface::class, $request)) ->resolveParameters(...$this->getReflection()->getParameters()); - /** @var mixed */ + /** @var mixed $response */ $response = ($this->callback)(...$arguments); - return $this->responseResolutioner - ->withContext($request) - ->resolveResponse($response); + return $this->responseResolutioner->withRequest($request)->resolveResponse($response); } } diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index 00282bff..4d9fab1e 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -1,4 +1,4 @@ - */ private SplQueue $queue; /** - * The request handler endpoint - * * @var RequestHandlerInterface */ private RequestHandlerInterface $endpoint; @@ -47,10 +42,7 @@ final class QueueableRequestHandler implements RequestHandlerInterface */ public function __construct(RequestHandlerInterface $endpoint) { - /** @var SplQueue */ - $queue = new SplQueue(); - - $this->queue = $queue; + $this->queue = new SplQueue(); $this->endpoint = $endpoint; } diff --git a/src/RequestHandler/UnsafeCallableRequestHandler.php b/src/RequestHandler/UnsafeCallableRequestHandler.php index 2c08f3be..22e4da2a 100644 --- a/src/RequestHandler/UnsafeCallableRequestHandler.php +++ b/src/RequestHandler/UnsafeCallableRequestHandler.php @@ -1,4 +1,4 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -namespace Sunrise\Http\Router; - -/** - * RequestQueryInterface - * - * @since 3.0.0 - */ -interface RequestQueryInterface -{ -} diff --git a/src/ResponseResolutioner.php b/src/ResponseResolutioner.php index 6422c26f..310f12fb 100644 --- a/src/ResponseResolutioner.php +++ b/src/ResponseResolutioner.php @@ -1,4 +1,4 @@ - */ private array $resolvers = []; @@ -48,10 +42,10 @@ final class ResponseResolutioner implements ResponseResolutionerInterface /** * {@inheritdoc} */ - public function withContext($context): ResponseResolutionerInterface + public function withRequest(RequestInterface $context): static { $clone = clone $this; - $clone->context = $context; + $clone->request = $context; return $clone; } @@ -76,28 +70,14 @@ public function resolveResponse($response): ResponseInterface } foreach ($this->resolvers as $resolver) { - if ($resolver->supportsResponse($response, $this->context)) { - return $resolver->resolveResponse($response, $this->context); + if ($resolver->supportsResponse($response, $this->request)) { + return $resolver->resolveResponse($response, $this->request); } } throw new ResolvingResponseException(sprintf( 'Unable to resolve the response {%s}', - $this->stringifyResponse($response) + get_debug_type($response), )); } - - /** - * Stringifies the given raw response - * - * @param mixed $response - * - * @return string - * - * @todo Think about how to display the responder... - */ - private function stringifyResponse($response): string - { - return get_debug_type($response); - } } diff --git a/src/ResponseResolutionerInterface.php b/src/ResponseResolutionerInterface.php index e56ced98..6818d72c 100644 --- a/src/ResponseResolutionerInterface.php +++ b/src/ResponseResolutionerInterface.php @@ -1,4 +1,4 @@ - + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ResponseResolver; + +use Psr\Http\Message\ResponseFactoryInterface; +use Psr\Http\Message\ResponseInterface; +use Sunrise\Http\Router\Annotation\ResponseBody; +use ReflectionClass; + +use function is_object; + +/** + * ObjectResponseResolver + * + * @since 3.0.0 + */ +final class ObjectResponseResolver implements ResponseResolverInterface +{ + public function __construct( + private ResponseFactoryInterface $responseFactory, + ) { + } + + /** + * {@inheritdoc} + */ + public function supportsResponse($response, $context): bool + { + if (!is_object($response)) { + return false; + } + + return true; + } + + /** + * {@inheritdoc} + */ + public function resolveResponse($response, $context): ResponseInterface + { + $attributes = (new ReflectionClass($response))->getAttributes(ResponseBody::class); + + return $this->responseFactory->createResponse(200); + } +} diff --git a/src/ResponseResolverInterface.php b/src/ResponseResolver/ResponseResolverInterface.php similarity index 79% rename from src/ResponseResolverInterface.php rename to src/ResponseResolver/ResponseResolverInterface.php index fa18d042..f332668e 100644 --- a/src/ResponseResolverInterface.php +++ b/src/ResponseResolver/ResponseResolverInterface.php @@ -1,4 +1,4 @@ -handle($context); } diff --git a/src/ResponseResolver/StatusCodeResponseResolver.php b/src/ResponseResolver/StatusCodeResponseResolver.php index 064f1e23..7eee9be1 100644 --- a/src/ResponseResolver/StatusCodeResponseResolver.php +++ b/src/ResponseResolver/StatusCodeResponseResolver.php @@ -1,4 +1,4 @@ - * * @since 2.9.0 @@ -55,36 +50,26 @@ class Router implements RequestHandlerInterface, RequestMethodInterface ]; /** - * The router's host table - * * @var HostTable */ private HostTable $hosts; /** - * The router's route collection - * * @var RouteCollectionInterface */ private RouteCollectionInterface $routes; /** - * The router's middlewares - * * @var list */ private array $middlewares = []; /** - * The router's event dispatcher - * * @var EventDispatcherInterface|null */ private ?EventDispatcherInterface $eventDispatcher = null; /** - * The router's matched route - * * @var RouteInterface|null */ private ?RouteInterface $matchedRoute = null; @@ -326,9 +311,9 @@ function (ServerRequestInterface $request): ResponseInterface { $this->matchedRoute = $this->match($request); if (isset($this->eventDispatcher)) { - $this->eventDispatcher->dispatch( - new RouteEvent($this->matchedRoute, $request) - ); + $event = new RouteEvent($this->matchedRoute, $request); + $this->eventDispatcher->dispatch($event); + $request = $event->getRequest(); } return $this->matchedRoute->handle($request); @@ -353,9 +338,9 @@ public function handle(ServerRequestInterface $request): ResponseInterface $this->matchedRoute = $this->match($request); if (isset($this->eventDispatcher)) { - $this->eventDispatcher->dispatch( - new RouteEvent($this->matchedRoute, $request) - ); + $event = new RouteEvent($this->matchedRoute, $request); + $this->eventDispatcher->dispatch($event); + $request = $event->getRequest(); } if (empty($this->middlewares)) { diff --git a/src/RouterBuilder.php b/src/RouterBuilder.php index 94edd9bb..4ac1e5cb 100644 --- a/src/RouterBuilder.php +++ b/src/RouterBuilder.php @@ -1,4 +1,4 @@ -request = $request; } /** - * Creates the class from the given request + * Creates the proxy from the given request * * @param ServerRequestInterface $request * @@ -76,7 +74,7 @@ public static function from(ServerRequestInterface $request): self public function isJson(): bool { return $this->clientProducesMediaType([ - 'application/json', + MediaType::APPLICATION_JSON, ]); } @@ -90,48 +88,52 @@ public function isJson(): bool public function isXml(): bool { return $this->clientProducesMediaType([ - 'application/xml', - 'text/xml', + MediaType::APPLICATION_XML, + MediaType::TEXT_XML, ]); } /** * Gets the client's IP address * - * @param array $proxyChain + * @param array $proxyChain * * @return IpAddress */ public function getClientIpAddress(array $proxyChain = []): IpAddress { - $env = $this->request->getServerParams(); + $serverParams = $this->request->getServerParams(); + + /** @var non-empty-string $clientAddress */ + $clientAddress = $serverParams['REMOTE_ADDR'] ?? '::1'; - /** @var string */ - $clientIp = $env['REMOTE_ADDR'] ?? '::1'; + /** @var list $proxyAddresses */ + $proxyAddresses = []; - while (isset($proxyChain[$clientIp])) { - $proxyHeader = $proxyChain[$clientIp]; - unset($proxyChain[$clientIp]); + while (isset($proxyChain[$clientAddress])) { + $proxyHeader = $proxyChain[$clientAddress]; + unset($proxyChain[$clientAddress]); $header = $this->request->getHeaderLine($proxyHeader); if ($header === '') { break; } - $proxiedClientIp = strstr($header, ',', true); - if ($proxiedClientIp === false) { - $proxiedClientIp = $header; + /** @var list $addresses */ + $addresses = preg_split('/\s*,\s*/', $header, -1, PREG_SPLIT_NO_EMPTY); + if ($addresses === []) { + break; } - $proxiedClientIp = trim($proxiedClientIp); - if ($proxiedClientIp === '') { - break; + $clientAddress = array_shift($addresses); + if ($addresses === []) { + continue; } - $clientIp = $proxiedClientIp; + $proxyAddresses = array_merge($proxyAddresses, $addresses); } - return new IpAddress($clientIp); + return new IpAddress($clientAddress, $proxyAddresses); } /** @@ -149,17 +151,17 @@ public function getClientProducedMediaType(): string return ''; } - $mediaType = strstr($header, ';', true); - if ($mediaType === false) { - $mediaType = $header; + $result = strstr($header, ';', true); + if ($result === false) { + $result = $header; } - $mediaType = trim($mediaType); - if ($mediaType === '') { + $result = trim($result); + if ($result === '') { return ''; } - return strtolower($mediaType); + return strtolower($result); } /** @@ -169,7 +171,7 @@ public function getClientProducedMediaType(): string * @link https://tools.ietf.org/html/rfc7231#section-3.1.1.1 * @link https://tools.ietf.org/html/rfc7231#section-5.3.2 * - * @return list + * @return array> */ public function getClientConsumedMediaTypes(): array { @@ -178,49 +180,79 @@ public function getClientConsumedMediaTypes(): array return []; } + $accepts = header_accept_like_parse($header); + if (empty($accepts)) { + return []; + } + $result = []; - $accepts = explode(',', $header); - foreach ($accepts as $accept) { - $mediaType = strstr($accept, ';', true); - if ($mediaType === false) { - $mediaType = $accept; - } + foreach ($accepts as $type => $params) { + $result[strtolower($type)] = $params; + } - $mediaType = trim($mediaType); - if ($mediaType === '') { - continue; - } + return $result; + } - if ($mediaType === '*/*') { - return []; - } + /** + * Gets the client's consumed encodings + * + * @return array> + */ + public function getClientConsumedEncodings(): array + { + $header = $this->request->getHeaderLine('Accept-Encoding'); + if ($header === '') { + return []; + } - $result[] = strtolower($mediaType); + $accepts = header_accept_like_parse($header); + if (empty($accepts)) { + return []; } - return $result; + return $accepts; + } + + /** + * Gets the client's consumed languages + * + * @return array> + */ + public function getClientConsumedLanguages(): array + { + $header = $this->request->getHeaderLine('Accept-Language'); + if ($header === '') { + return []; + } + + $accepts = header_accept_like_parse($header); + if (empty($accepts)) { + return []; + } + + return $accepts; } /** * Checks if the client produces one of the given media types * - * @param list $consumedMediaTypes + * @param list $consumes * * @return bool */ - public function clientProducesMediaType(array $consumedMediaTypes): bool + public function clientProducesMediaType(array $consumes): bool { - if ($consumedMediaTypes === []) { + if ($consumes === []) { return true; } - $producedMediaType = $this->getClientProducedMediaType(); - if ($producedMediaType === '') { + $produced = $this->getClientProducedMediaType(); + if ($produced === '') { return false; } - foreach ($consumedMediaTypes as $consumedMediaType) { - if ($this->equalsMediaTypes($consumedMediaType, $producedMediaType)) { + foreach ($consumes as $consumed) { + if (media_types_compare($consumed, $produced)) { return true; } } @@ -231,24 +263,28 @@ public function clientProducesMediaType(array $consumedMediaTypes): bool /** * Checks if the client consumes one of the given media types * - * @param list $producedMediaTypes + * @param list $produces * * @return bool */ - public function clientConsumesMediaType(array $producedMediaTypes): bool + public function clientConsumesMediaType(array $produces): bool { - if ($producedMediaTypes === []) { + if ($produces === []) { + return true; + } + + $consumes = $this->getClientConsumedMediaTypes(); + if ($consumes === []) { return true; } - $consumedMediaTypes = $this->getClientConsumedMediaTypes(); - if ($consumedMediaTypes === []) { + if (isset($consumes['*/*'])) { return true; } - foreach ($producedMediaTypes as $a) { - foreach ($consumedMediaTypes as $b) { - if ($this->equalsMediaTypes($a, $b)) { + foreach ($produces as $a) { + foreach ($consumes as $b => $_) { + if (media_types_compare($a, $b)) { return true; } } @@ -272,7 +308,7 @@ public function equalsMediaTypes(string $a, string $b): bool } $slash = strpos($a, '/'); - if ($slash === false) { + if ($slash === false || !isset($b[$slash]) || $b[$slash] !== '/') { return false; } @@ -299,7 +335,7 @@ public function getProtocolVersion(): string /** * {@inheritdoc} */ - public function withProtocolVersion($version) + public function withProtocolVersion($version): self { $clone = clone $this; $clone->request = $clone->request->withProtocolVersion($version); @@ -342,7 +378,7 @@ public function getHeaderLine($name): string /** * {@inheritdoc} */ - public function withHeader($name, $value) + public function withHeader($name, $value): self { $clone = clone $this; $clone->request = $clone->request->withHeader($name, $value); @@ -353,7 +389,7 @@ public function withHeader($name, $value) /** * {@inheritdoc} */ - public function withAddedHeader($name, $value) + public function withAddedHeader($name, $value): self { $clone = clone $this; $clone->request = $clone->request->withAddedHeader($name, $value); @@ -364,7 +400,7 @@ public function withAddedHeader($name, $value) /** * {@inheritdoc} */ - public function withoutHeader($name) + public function withoutHeader($name): self { $clone = clone $this; $clone->request = $clone->request->withoutHeader($name); @@ -375,7 +411,7 @@ public function withoutHeader($name) /** * {@inheritdoc} */ - public function getBody(): \Psr\Http\Message\StreamInterface + public function getBody(): StreamInterface { return $this->request->getBody(); } @@ -383,7 +419,7 @@ public function getBody(): \Psr\Http\Message\StreamInterface /** * {@inheritdoc} */ - public function withBody(\Psr\Http\Message\StreamInterface $body) + public function withBody(StreamInterface $body): self { $clone = clone $this; $clone->request = $clone->request->withBody($body); @@ -402,7 +438,7 @@ public function getMethod(): string /** * {@inheritdoc} */ - public function withMethod($method) + public function withMethod($method): self { $clone = clone $this; $clone->request = $clone->request->withMethod($method); @@ -413,7 +449,7 @@ public function withMethod($method) /** * {@inheritdoc} */ - public function getUri(): \Psr\Http\Message\UriInterface + public function getUri(): UriInterface { return $this->request->getUri(); } @@ -421,7 +457,7 @@ public function getUri(): \Psr\Http\Message\UriInterface /** * {@inheritdoc} */ - public function withUri(\Psr\Http\Message\UriInterface $uri, $preserveHost = false) + public function withUri(UriInterface $uri, $preserveHost = false): self { $clone = clone $this; $clone->request = $clone->request->withUri($uri, $preserveHost); @@ -440,7 +476,7 @@ public function getRequestTarget(): string /** * {@inheritdoc} */ - public function withRequestTarget($requestTarget) + public function withRequestTarget($requestTarget): self { $clone = clone $this; $clone->request = $clone->request->withRequestTarget($requestTarget); @@ -467,7 +503,7 @@ public function getQueryParams(): array /** * {@inheritdoc} */ - public function withQueryParams(array $query) + public function withQueryParams(array $query): self { $clone = clone $this; $clone->request = $clone->request->withQueryParams($query); @@ -486,7 +522,7 @@ public function getCookieParams(): array /** * {@inheritdoc} */ - public function withCookieParams(array $cookies) + public function withCookieParams(array $cookies): self { $clone = clone $this; $clone->request = $clone->request->withCookieParams($cookies); @@ -505,7 +541,7 @@ public function getUploadedFiles(): array /** * {@inheritdoc} */ - public function withUploadedFiles(array $uploadedFiles) + public function withUploadedFiles(array $uploadedFiles): self { $clone = clone $this; $clone->request = $clone->request->withUploadedFiles($uploadedFiles); @@ -516,7 +552,7 @@ public function withUploadedFiles(array $uploadedFiles) /** * {@inheritdoc} */ - public function getParsedBody() + public function getParsedBody(): mixed { return $this->request->getParsedBody(); } @@ -524,7 +560,7 @@ public function getParsedBody() /** * {@inheritdoc} */ - public function withParsedBody($data) + public function withParsedBody($data): self { $clone = clone $this; $clone->request = $clone->request->withParsedBody($data); @@ -543,7 +579,7 @@ public function getAttributes(): array /** * {@inheritdoc} */ - public function getAttribute($name, $default = null) + public function getAttribute($name, $default = null): mixed { return $this->request->getAttribute($name, $default); } @@ -551,7 +587,7 @@ public function getAttribute($name, $default = null) /** * {@inheritdoc} */ - public function withAttribute($name, $value) + public function withAttribute($name, $value): self { $clone = clone $this; $clone->request = $clone->request->withAttribute($name, $value); @@ -562,7 +598,7 @@ public function withAttribute($name, $value) /** * {@inheritdoc} */ - public function withoutAttribute($name) + public function withoutAttribute($name): self { $clone = clone $this; $clone->request = $clone->request->withoutAttribute($name); diff --git a/tests/Command/RouteListCommandTest.php b/tests/Command/RouteListCommandTest.php index deab9ebf..848b49a3 100644 --- a/tests/Command/RouteListCommandTest.php +++ b/tests/Command/RouteListCommandTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests\Command; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Command\RouteListCommand; use Sunrise\Http\Router\Router; diff --git a/tests/Exception/BadRequestExceptionTest.php b/tests/Exception/BadRequestExceptionTest.php index 1eb50213..2ab92b5d 100644 --- a/tests/Exception/BadRequestExceptionTest.php +++ b/tests/Exception/BadRequestExceptionTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests\Exception; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\Exception; use Sunrise\Http\Router\Exception\BadRequestException; diff --git a/tests/Exception/ExceptionTest.php b/tests/Exception/ExceptionTest.php index 38804ab2..98f513a3 100644 --- a/tests/Exception/ExceptionTest.php +++ b/tests/Exception/ExceptionTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests\Exception; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\Exception; use Sunrise\Http\Router\Exception\ExceptionInterface; diff --git a/tests/Exception/InvalidArgumentExceptionTest.php b/tests/Exception/InvalidArgumentExceptionTest.php index 900ff25c..cedf93ee 100644 --- a/tests/Exception/InvalidArgumentExceptionTest.php +++ b/tests/Exception/InvalidArgumentExceptionTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests\Exception; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\Exception; use Sunrise\Http\Router\Exception\InvalidArgumentException; diff --git a/tests/Exception/InvalidAttributeValueExceptionTest.php b/tests/Exception/InvalidAttributeValueExceptionTest.php index 93501e05..02bf80e2 100644 --- a/tests/Exception/InvalidAttributeValueExceptionTest.php +++ b/tests/Exception/InvalidAttributeValueExceptionTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests\Exception; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\Exception; use Sunrise\Http\Router\Exception\InvalidAttributeValueException; diff --git a/tests/Exception/InvalidLoaderResourceExceptionTest.php b/tests/Exception/InvalidLoaderResourceExceptionTest.php index 098d36dc..72b5e07a 100644 --- a/tests/Exception/InvalidLoaderResourceExceptionTest.php +++ b/tests/Exception/InvalidLoaderResourceExceptionTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests\Exception; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\Exception; use Sunrise\Http\Router\Exception\InvalidLoaderResourceException; diff --git a/tests/Exception/InvalidPathExceptionTest.php b/tests/Exception/InvalidPathExceptionTest.php index 4eb999ed..71bfbc73 100644 --- a/tests/Exception/InvalidPathExceptionTest.php +++ b/tests/Exception/InvalidPathExceptionTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests\Exception; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\Exception; use Sunrise\Http\Router\Exception\InvalidPathException; diff --git a/tests/Exception/MethodNotAllowedExceptionTest.php b/tests/Exception/MethodNotAllowedExceptionTest.php index dcc651e3..34930bba 100644 --- a/tests/Exception/MethodNotAllowedExceptionTest.php +++ b/tests/Exception/MethodNotAllowedExceptionTest.php @@ -2,16 +2,10 @@ namespace Sunrise\Http\Router\Tests\Exception; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\Exception; use Sunrise\Http\Router\Exception\MethodNotAllowedException; -/** - * Import functions - */ use function implode; /** diff --git a/tests/Exception/MissingAttributeValueExceptionTest.php b/tests/Exception/MissingAttributeValueExceptionTest.php index 57d1b7df..5380358b 100644 --- a/tests/Exception/MissingAttributeValueExceptionTest.php +++ b/tests/Exception/MissingAttributeValueExceptionTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests\Exception; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\Exception; use Sunrise\Http\Router\Exception\MissingAttributeValueException; diff --git a/tests/Exception/PageNotFoundExceptionTest.php b/tests/Exception/PageNotFoundExceptionTest.php index c824a541..7aed6f9e 100644 --- a/tests/Exception/PageNotFoundExceptionTest.php +++ b/tests/Exception/PageNotFoundExceptionTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests\Exception; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\PageNotFoundException; use Sunrise\Http\Router\Exception\RouteNotFoundException; diff --git a/tests/Exception/RouteNotFoundExceptionTest.php b/tests/Exception/RouteNotFoundExceptionTest.php index 04164112..1295debf 100644 --- a/tests/Exception/RouteNotFoundExceptionTest.php +++ b/tests/Exception/RouteNotFoundExceptionTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests\Exception; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\Exception; use Sunrise\Http\Router\Exception\RouteNotFoundException; diff --git a/tests/Exception/UnresolvableReferenceExceptionTest.php b/tests/Exception/UnresolvableReferenceExceptionTest.php index dd414b4d..c844afa5 100644 --- a/tests/Exception/UnresolvableReferenceExceptionTest.php +++ b/tests/Exception/UnresolvableReferenceExceptionTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests\Exception; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\Exception; use Sunrise\Http\Router\Exception\UnresolvableReferenceException; diff --git a/tests/Exception/UnsupportedMediaTypeExceptionTest.php b/tests/Exception/UnsupportedMediaTypeExceptionTest.php index c81ec6ef..375d8141 100644 --- a/tests/Exception/UnsupportedMediaTypeExceptionTest.php +++ b/tests/Exception/UnsupportedMediaTypeExceptionTest.php @@ -2,16 +2,10 @@ namespace Sunrise\Http\Router\Tests\Exception; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\Exception; use Sunrise\Http\Router\Exception\UnsupportedMediaTypeException; -/** - * Import functions - */ use function implode; /** diff --git a/tests/Functions/FunctionPathBuildTest.php b/tests/Functions/FunctionPathBuildTest.php index 7dfd1615..b2c4d303 100644 --- a/tests/Functions/FunctionPathBuildTest.php +++ b/tests/Functions/FunctionPathBuildTest.php @@ -2,16 +2,10 @@ namespace Sunrise\Http\Router\Tests\Functions; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\InvalidAttributeValueException; use Sunrise\Http\Router\Exception\MissingAttributeValueException; -/** - * Import functions - */ use function array_keys; use function Sunrise\Http\Router\path_build; diff --git a/tests/Functions/FunctionPathMatchTest.php b/tests/Functions/FunctionPathMatchTest.php index d5ec5763..bbff7847 100644 --- a/tests/Functions/FunctionPathMatchTest.php +++ b/tests/Functions/FunctionPathMatchTest.php @@ -2,14 +2,8 @@ namespace Sunrise\Http\Router\Tests\Functions; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; -/** - * Import functions - */ use function Sunrise\Http\Router\path_match; /** diff --git a/tests/Functions/FunctionPathParseTest.php b/tests/Functions/FunctionPathParseTest.php index 581c505d..bd24454e 100644 --- a/tests/Functions/FunctionPathParseTest.php +++ b/tests/Functions/FunctionPathParseTest.php @@ -2,16 +2,10 @@ namespace Sunrise\Http\Router\Tests\Functions; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\InvalidPathException; use Sunrise\Http\Router\Router; -/** - * Import functions - */ use function Sunrise\Http\Router\path_parse; use function chr; diff --git a/tests/Functions/FunctionPathPlainTest.php b/tests/Functions/FunctionPathPlainTest.php index 37228af8..7cd4e862 100644 --- a/tests/Functions/FunctionPathPlainTest.php +++ b/tests/Functions/FunctionPathPlainTest.php @@ -2,14 +2,8 @@ namespace Sunrise\Http\Router\Tests\Functions; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; -/** - * Import functions - */ use function Sunrise\Http\Router\path_plain; /** diff --git a/tests/Functions/FunctionPathRegexTest.php b/tests/Functions/FunctionPathRegexTest.php index a31c0fc3..b47e6dcd 100644 --- a/tests/Functions/FunctionPathRegexTest.php +++ b/tests/Functions/FunctionPathRegexTest.php @@ -2,14 +2,8 @@ namespace Sunrise\Http\Router\Tests\Functions; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; -/** - * Import functions - */ use function Sunrise\Http\Router\path_regex; /** diff --git a/tests/Loader/ConfigLoaderTest.php b/tests/Loader/ConfigLoaderTest.php index fa114f86..b3d44c9d 100644 --- a/tests/Loader/ConfigLoaderTest.php +++ b/tests/Loader/ConfigLoaderTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests\Loader; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\InvalidLoaderResourceException; use Sunrise\Http\Router\Loader\ConfigLoader; diff --git a/tests/Loader/DescriptorLoaderTest.php b/tests/Loader/DescriptorLoaderTest.php index 929e29f9..c897210a 100644 --- a/tests/Loader/DescriptorLoaderTest.php +++ b/tests/Loader/DescriptorLoaderTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests\Loader; -/** - * Import classes - */ use Doctrine\Common\Annotations\AnnotationRegistry; use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Annotation\Route; @@ -14,9 +11,6 @@ use Sunrise\Http\Router\Tests\Fixtures; use ReflectionClass; -/** - * Import functions - */ use function array_map; use function class_exists; @@ -33,16 +27,6 @@ class DescriptorLoaderTest extends TestCase use Fixtures\CacheAwareTrait; use Fixtures\ContainerAwareTrait; - /** - * {@inheritdoc} - */ - protected function setUp() : void - { - if (class_exists(AnnotationRegistry::class)) { - /** @scrutinizer ignore-deprecated */ AnnotationRegistry::registerLoader('class_exists'); - } - } - /** * @return void */ diff --git a/tests/Middleware/CallableMiddlewareTest.php b/tests/Middleware/CallableMiddlewareTest.php index f1e6b029..5f31f972 100644 --- a/tests/Middleware/CallableMiddlewareTest.php +++ b/tests/Middleware/CallableMiddlewareTest.php @@ -2,13 +2,10 @@ namespace Sunrise\Http\Router\Tests\Middleware; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; -use Sunrise\Http\Router\Middleware\CallableMiddleware; +use Sunrise\Http\Router\Middleware\CallbackMiddleware; use Sunrise\Http\Router\Tests\Fixtures; /** @@ -23,7 +20,7 @@ class CallableMiddlewareTest extends TestCase public function testContracts() : void { $callback = new Fixtures\Middlewares\BlankMiddleware(); - $middleware = new CallableMiddleware($callback); + $middleware = new CallbackMiddleware($callback); $this->assertInstanceOf(MiddlewareInterface::class, $middleware); } @@ -34,7 +31,7 @@ public function testContracts() : void public function testRun() : void { $callback = new Fixtures\Middlewares\BlankMiddleware(); - $middleware = new CallableMiddleware($callback); + $middleware = new CallbackMiddleware($callback); $this->assertSame($callback, $middleware->getCallback()); diff --git a/tests/Middleware/JsonPayloadDecodingMiddlewareTest.php b/tests/Middleware/JsonPayloadDecodingMiddlewareTest.php index 7d4fa750..d3e1e8cc 100644 --- a/tests/Middleware/JsonPayloadDecodingMiddlewareTest.php +++ b/tests/Middleware/JsonPayloadDecodingMiddlewareTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests\Middleware; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Psr\Http\Server\MiddlewareInterface; use Sunrise\Http\Router\Exception\UndecodablePayloadException; diff --git a/tests/ReferenceResolverTest.php b/tests/ReferenceResolverTest.php index e3d606de..50f9526a 100644 --- a/tests/ReferenceResolverTest.php +++ b/tests/ReferenceResolverTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\UnresolvableReferenceException; use Sunrise\Http\Router\ReferenceResolver; diff --git a/tests/RequestHandler/CallableRequestHandlerTest.php b/tests/RequestHandler/CallableRequestHandlerTest.php index 5ae1ac19..cfe1791e 100644 --- a/tests/RequestHandler/CallableRequestHandlerTest.php +++ b/tests/RequestHandler/CallableRequestHandlerTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests\RequestHandler; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; diff --git a/tests/RequestHandler/QueueableRequestHandlerTest.php b/tests/RequestHandler/QueueableRequestHandlerTest.php index 395e3f89..dddfbcb4 100644 --- a/tests/RequestHandler/QueueableRequestHandlerTest.php +++ b/tests/RequestHandler/QueueableRequestHandlerTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests\RequestHandler; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; diff --git a/tests/RouteCollectionFactoryTest.php b/tests/RouteCollectionFactoryTest.php index 780ed6be..f64349df 100644 --- a/tests/RouteCollectionFactoryTest.php +++ b/tests/RouteCollectionFactoryTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\RouteCollectionFactory; use Sunrise\Http\Router\RouteCollectionFactoryInterface; diff --git a/tests/RouteCollectionTest.php b/tests/RouteCollectionTest.php index 5b17b3c3..aa45725b 100644 --- a/tests/RouteCollectionTest.php +++ b/tests/RouteCollectionTest.php @@ -2,16 +2,10 @@ namespace Sunrise\Http\Router\Tests; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\RouteCollection; use Sunrise\Http\Router\RouteCollectionInterface; -/** - * Import functions - */ use function array_merge; /** diff --git a/tests/RouteCollectorTest.php b/tests/RouteCollectorTest.php index 5247b360..7fc18cbd 100644 --- a/tests/RouteCollectorTest.php +++ b/tests/RouteCollectorTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\RouteCollectionInterface; use Sunrise\Http\Router\RouteCollector; diff --git a/tests/RouteFactoryTest.php b/tests/RouteFactoryTest.php index 804940ef..48730cff 100644 --- a/tests/RouteFactoryTest.php +++ b/tests/RouteFactoryTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\RouteFactory; use Sunrise\Http\Router\RouteFactoryInterface; diff --git a/tests/RouteTest.php b/tests/RouteTest.php index e87dbabb..f5fdd706 100644 --- a/tests/RouteTest.php +++ b/tests/RouteTest.php @@ -2,18 +2,12 @@ namespace Sunrise\Http\Router\Tests; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use Sunrise\Http\Router\Route; use Sunrise\Http\Router\RouteInterface; use Sunrise\Http\ServerRequest\ServerRequestFactory; -/** - * Import functions - */ use function array_merge; /** diff --git a/tests/RouterBuilderTest.php b/tests/RouterBuilderTest.php index 953da79d..ef46f86e 100644 --- a/tests/RouterBuilderTest.php +++ b/tests/RouterBuilderTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\RouteNotFoundException; use Sunrise\Http\Router\Router; diff --git a/tests/RouterTest.php b/tests/RouterTest.php index 9870565c..8fa81167 100644 --- a/tests/RouterTest.php +++ b/tests/RouterTest.php @@ -2,9 +2,6 @@ namespace Sunrise\Http\Router\Tests; -/** - * Import classes - */ use PHPUnit\Framework\TestCase; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; @@ -13,7 +10,7 @@ use Sunrise\Http\Router\Exception\MethodNotAllowedException; use Sunrise\Http\Router\Exception\PageNotFoundException; use Sunrise\Http\Router\Exception\RouteNotFoundException; -use Sunrise\Http\Router\Middleware\CallableMiddleware; +use Sunrise\Http\Router\Middleware\CallbackMiddleware; use Sunrise\Http\Router\Loader\LoaderInterface; use Sunrise\Http\Router\Route; use Sunrise\Http\Router\RouteCollection; @@ -22,9 +19,6 @@ use Sunrise\Http\ServerRequest\ServerRequestFactory; use Symfony\Component\EventDispatcher\EventDispatcher; -/** - * Import functions - */ use function array_merge; use function array_unique; @@ -449,7 +443,7 @@ public function testRunWithUnallowedMethod() : void $router = new Router(); $router->addRoute(...$routes); - $router->addMiddleware(new CallableMiddleware(function ($request, $handler) { + $router->addMiddleware(new CallbackMiddleware(function ($request, $handler) { try { return $handler->handle($request); } catch (MethodNotAllowedException $e) { @@ -477,7 +471,7 @@ public function testRunWithUndefinedRoute() : void $router = new Router(); $router->addRoute(...$routes); - $router->addMiddleware(new CallableMiddleware(function ($request, $handler) { + $router->addMiddleware(new CallbackMiddleware(function ($request, $handler) { try { return $handler->handle($request); } catch (RouteNotFoundException $e) { From 8d44899fea536e821086efc5376fbf0a1e79be28 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Mon, 24 Jul 2023 05:18:56 +0200 Subject: [PATCH 073/180] v3 --- composer.json | 10 +- src/ClassResolver.php | 2 +- src/Command/RouteListCommand.php | 4 +- src/Exception/HttpException.php | 4 +- src/Loader/ConfigLoader.php | 6 +- src/Loader/DescriptorLoader.php | 6 +- src/Middleware/CallableMiddleware.php | 2 +- src/Middleware/CallbackMiddleware.php | 8 +- .../JsonPayloadDecodingMiddleware.php | 41 +++++--- .../SimdjsonPayloadDecodingMiddleware.php | 97 +++++++++++++++++++ src/ParameterResolutioner.php | 10 +- .../DependencyInjectionParameterResolver.php | 37 +++---- .../ParameterResolverInterface.php | 10 +- .../RequestBodyParameterResolver.php | 35 ++++--- .../RequestQueryParameterResolver.php | 59 +++++------ .../RequestRouteParameterResolver.php | 29 +++--- ...Resolver.php => TypeParameterResolver.php} | 47 ++++----- src/ReferenceResolver.php | 6 +- src/RequestHandler/CallableRequestHandler.php | 6 +- .../QueueableRequestHandler.php | 2 +- .../UnsafeCallableRequestHandler.php | 2 +- src/ResponseResolutioner.php | 6 +- .../ObjectResponseResolver.php | 4 +- .../RouteResponseResolver.php | 4 +- .../StatusCodeResponseResolver.php | 4 +- src/Route.php | 72 +++++++------- src/RouteCollection.php | 38 ++++---- src/RouteCollectionFactory.php | 2 +- src/RouteFactory.php | 2 +- src/Router.php | 2 +- src/ServerRequest.php | 60 ++++++------ 31 files changed, 358 insertions(+), 259 deletions(-) create mode 100644 src/Middleware/SimdjsonPayloadDecodingMiddleware.php rename src/ParameterResolver/{PresetTypedParameterResolver.php => TypeParameterResolver.php} (50%) diff --git a/composer.json b/composer.json index e9823858..36f25c53 100644 --- a/composer.json +++ b/composer.json @@ -34,16 +34,16 @@ "psr/http-message": "^1.0 || ^2.0", "psr/http-server-handler": "^1.0", "psr/http-server-middleware": "^1.0", - "psr/simple-cache": "^1.0 || ^2.0 || ^3.0" + "psr/simple-cache": "^1.0 || ^2.0 || ^3.0", + "sunrise/hydrator": "^3.0", + "symfony/validator": ">=6.0" }, "require-dev": { "phpunit/phpunit": "^9.6", + "vimeo/psalm": "^5.13", "sunrise/coding-standard": "^1.0", "sunrise/http-message": "^3.0", - "sunrise/hydrator": "^3.0", - "symfony/console": "^5.4", - "symfony/validator": "^5.4", - "vimeo/psalm": "^5.13" + "symfony/console": "^5.4" }, "autoload": { "files": [ diff --git a/src/ClassResolver.php b/src/ClassResolver.php index 24e45e30..96319547 100644 --- a/src/ClassResolver.php +++ b/src/ClassResolver.php @@ -53,7 +53,7 @@ public function __construct(ParameterResolutionerInterface $parameterResolutione } /** - * {@inheritdoc} + * @inheritDoc */ public function resolveClass(string $className): object { diff --git a/src/Command/RouteListCommand.php b/src/Command/RouteListCommand.php index 54135066..bc073ca5 100644 --- a/src/Command/RouteListCommand.php +++ b/src/Command/RouteListCommand.php @@ -68,7 +68,7 @@ protected function getRouter(): Router } /** - * {@inheritdoc} + * @inheritDoc */ protected function configure(): void { @@ -77,7 +77,7 @@ protected function configure(): void } /** - * {@inheritdoc} + * @inheritDoc */ final protected function execute(InputInterface $input, OutputInterface $output): int { diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index e5fb74e1..ced1091f 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -54,7 +54,7 @@ public function __construct(int $statusCode, string $message, int $code = 0, ?Th } /** - * {@inheritdoc} + * @inheritDoc */ final public function getStatusCode(): int { @@ -62,7 +62,7 @@ final public function getStatusCode(): int } /** - * {@inheritdoc} + * @inheritDoc */ final public function getHeaderFields(): array { diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index 5aef3a7f..69d0f9ae 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -175,7 +175,7 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo } /** - * {@inheritdoc} + * @inheritDoc * * @throws InvalidArgumentException * If the resource isn't valid. @@ -210,7 +210,7 @@ public function attach(mixed $resource): void } /** - * {@inheritdoc} + * @inheritDoc * * @throws InvalidArgumentException * If one of the given resources isn't valid. @@ -224,7 +224,7 @@ public function attachArray(array $resources): void } /** - * {@inheritdoc} + * @inheritDoc */ public function load(): RouteCollectionInterface { diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 00dcfdf0..183c2b3a 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -256,7 +256,7 @@ public function getCacheKey(): string } /** - * {@inheritdoc} + * @inheritDoc * * @throws InvalidArgumentException * If the resource isn't valid. @@ -281,7 +281,7 @@ public function attach(mixed $resource): void } /** - * {@inheritdoc} + * @inheritDoc * * @throws InvalidArgumentException * If one of the given resources isn't valid. @@ -295,7 +295,7 @@ public function attachArray(array $resources): void } /** - * {@inheritdoc} + * @inheritDoc */ public function load(): RouteCollectionInterface { diff --git a/src/Middleware/CallableMiddleware.php b/src/Middleware/CallableMiddleware.php index c42a2a38..b05f696c 100644 --- a/src/Middleware/CallableMiddleware.php +++ b/src/Middleware/CallableMiddleware.php @@ -46,7 +46,7 @@ public function __construct(callable $callback) } /** - * {@inheritdoc} + * @inheritDoc */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { diff --git a/src/Middleware/CallbackMiddleware.php b/src/Middleware/CallbackMiddleware.php index 77e10b43..963d286f 100644 --- a/src/Middleware/CallbackMiddleware.php +++ b/src/Middleware/CallbackMiddleware.php @@ -18,7 +18,7 @@ use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\ParameterResolutionerInterface; -use Sunrise\Http\Router\ParameterResolver\PresetTypedParameterResolver; +use Sunrise\Http\Router\ParameterResolver\TypeParameterResolver; use Sunrise\Http\Router\ResponseResolutionerInterface; use function Sunrise\Http\Router\reflect_callable; @@ -70,15 +70,15 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritDoc */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { $args = $this->parameterResolutioner ->withRequest($request) ->withPriorityResolver( - new PresetTypedParameterResolver(ServerRequestInterface::class, $request), - new PresetTypedParameterResolver(RequestHandlerInterface::class, $handler), + new TypeParameterResolver(ServerRequestInterface::class, $request), + new TypeParameterResolver(RequestHandlerInterface::class, $handler), ) ->resolveParameters(...reflect_callable($this->callback)->getParameters()); diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index b7eba786..8cf4c17a 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -13,14 +13,16 @@ namespace Sunrise\Http\Router\Middleware; -use JsonException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Exception\InvalidRequestPayloadException; +use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ServerRequest; +use JsonException; +use function extension_loaded; use function is_array; use function json_decode; use function sprintf; @@ -29,7 +31,7 @@ use const JSON_THROW_ON_ERROR; /** - * Middleware for JSON payload decoding + * Middleware for JSON payload decoding using the JSON extension * * @since 2.15.0 * @@ -39,13 +41,30 @@ final class JsonPayloadDecodingMiddleware implements MiddlewareInterface { /** - * {@inheritdoc} + * Constructor of the class + * + * @throws LogicException + * If the JSON extension isn't loaded. + */ + public function __construct() + { + if (!extension_loaded('json')) { + throw new LogicException( + 'The JSON extension is required, run the `pecl install json` command to resolve it.' + ); + } + } + + /** + * @inheritDoc */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { if (ServerRequest::from($request)->isJson()) { $request = $request->withParsedBody( - $this->decodeRequestPayload($request) + $this->decodeJsonPayload( + $request->getBody()->__toString() + ) ); } @@ -53,25 +72,25 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface } /** - * Tries to decode the given request's payload + * Tries to decode the given JSON payload * - * @param ServerRequestInterface $request + * @param string $json * * @return array * * @throws InvalidRequestPayloadException - * If the request's payload cannot be decoded. + * If the JSON payload cannot be decoded. */ - private function decodeRequestPayload(ServerRequestInterface $request): array + private function decodeJsonPayload(string $json): array { - $json = $request->getBody()->__toString(); - try { $data = json_decode($json, true, 512, JSON_BIGINT_AS_STRING | JSON_THROW_ON_ERROR); } catch (JsonException $e) { - throw new InvalidRequestPayloadException(sprintf('Invalid Payload: %s', $e->getMessage()), 0, $e); + throw new InvalidRequestPayloadException(sprintf('Invalid JSON: %s', $e->getMessage()), 0, $e); } + // According to PSR-7, the data must be an array because + // we're using the 'associative' option when decoding the JSON. if (!is_array($data)) { throw new InvalidRequestPayloadException('Unexpected JSON: Expects an array or object.'); } diff --git a/src/Middleware/SimdjsonPayloadDecodingMiddleware.php b/src/Middleware/SimdjsonPayloadDecodingMiddleware.php new file mode 100644 index 00000000..802ac74f --- /dev/null +++ b/src/Middleware/SimdjsonPayloadDecodingMiddleware.php @@ -0,0 +1,97 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Middleware; + +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\Exception\InvalidRequestPayloadException; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ServerRequest; +use RuntimeException; + +use function extension_loaded; +use function is_array; +use function simdjson_decode; +use function sprintf; + +/** + * Middleware for JSON payload decoding using the Simdjson extension + * + * @since 3.0.0 + * + * @link https://www.php.net/manual/en/book.simdjson.php + */ +final class SimdjsonPayloadDecodingMiddleware implements MiddlewareInterface +{ + + /** + * Constructor of the class + * + * @throws LogicException + * If the Simdjson extension isn't loaded. + */ + public function __construct() + { + if (!extension_loaded('simdjson')) { + throw new LogicException( + 'The Simdjson extension is required, run the `pecl install simdjson` command to resolve it.' + ); + } + } + + /** + * @inheritDoc + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + if (ServerRequest::from($request)->isJson()) { + $request = $request->withParsedBody( + $this->decodeJsonPayload( + $request->getBody()->__toString() + ) + ); + } + + return $handler->handle($request); + } + + /** + * Tries to decode the given JSON payload + * + * @param string $json + * + * @return array + * + * @throws InvalidRequestPayloadException + * If the JSON payload cannot be decoded. + */ + private function decodeJsonPayload(string $json): array + { + try { + $data = simdjson_decode($json, true, 512); + } catch (RuntimeException $e) { + throw new InvalidRequestPayloadException(sprintf('Invalid JSON: %s', $e->getMessage()), 0, $e); + } + + // According to PSR-7, the data must be an array because + // we're using the 'associative' option when decoding the JSON. + if (!is_array($data)) { + throw new InvalidRequestPayloadException('Unexpected JSON: Expects an array or object.'); + } + + return $data; + } +} diff --git a/src/ParameterResolutioner.php b/src/ParameterResolutioner.php index 4c0a3cd9..44842a30 100644 --- a/src/ParameterResolutioner.php +++ b/src/ParameterResolutioner.php @@ -40,7 +40,7 @@ final class ParameterResolutioner implements ParameterResolutionerInterface private array $resolvers = []; /** - * {@inheritdoc} + * @inheritDoc */ public function withRequest(RequestInterface $request): static { @@ -51,7 +51,7 @@ public function withRequest(RequestInterface $request): static } /** - * {@inheritdoc} + * @inheritDoc */ public function withPriorityResolver(ParameterResolverInterface ...$resolvers): static { @@ -70,7 +70,7 @@ public function withPriorityResolver(ParameterResolverInterface ...$resolvers): } /** - * {@inheritdoc} + * @inheritDoc */ public function addResolver(ParameterResolverInterface ...$resolvers): void { @@ -80,7 +80,7 @@ public function addResolver(ParameterResolverInterface ...$resolvers): void } /** - * {@inheritdoc} + * @inheritDoc */ public function resolveParameters(ReflectionParameter ...$parameters): array { @@ -103,7 +103,7 @@ public function resolveParameters(ReflectionParameter ...$parameters): array * @throws ResolvingParameterException * If the parameter cannot be resolved to an argument. */ - private function resolveParameter(ReflectionParameter $parameter) + private function resolveParameter(ReflectionParameter $parameter): mixed { foreach ($this->resolvers as $resolver) { if ($resolver->supportsParameter($parameter, $this->request)) { diff --git a/src/ParameterResolver/DependencyInjectionParameterResolver.php b/src/ParameterResolver/DependencyInjectionParameterResolver.php index 39aa2c2e..fbe69553 100644 --- a/src/ParameterResolver/DependencyInjectionParameterResolver.php +++ b/src/ParameterResolver/DependencyInjectionParameterResolver.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\ParameterResolver; use Psr\Container\ContainerInterface; -use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; @@ -27,43 +27,36 @@ final class DependencyInjectionParameterResolver implements ParameterResolverInt { /** - * @var ContainerInterface - */ - private ContainerInterface $container; - - /** + * Constructor of the class + * * @param ContainerInterface $container */ - public function __construct(ContainerInterface $container) + public function __construct(private ContainerInterface $container) { - $this->container = $container; } /** - * {@inheritdoc} + * @inheritDoc */ - public function supportsParameter(ReflectionParameter $parameter, RequestInterface $request): bool + public function supportsParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): bool { - if (!($parameter->getType() instanceof ReflectionNamedType)) { - return false; - } + $type = $parameter->getType(); - if ($parameter->getType()->isBuiltin()) { + if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { return false; } - if (!$this->container->has($parameter->getType()->getName())) { - return false; - } - - return true; + return $this->container->has($type->getName()); } /** - * {@inheritdoc} + * @inheritDoc */ - public function resolveParameter(ReflectionParameter $parameter, RequestInterface $request): mixed + public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): mixed { - return $this->container->get($parameter->getType()->getName()); + /** @var ReflectionNamedType $type */ + $type = $parameter->getType(); + + return $this->container->get($type->getName()); } } diff --git a/src/ParameterResolver/ParameterResolverInterface.php b/src/ParameterResolver/ParameterResolverInterface.php index 581631a0..39b1e0a4 100644 --- a/src/ParameterResolver/ParameterResolverInterface.php +++ b/src/ParameterResolver/ParameterResolverInterface.php @@ -13,7 +13,7 @@ namespace Sunrise\Http\Router\ParameterResolver; -use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ServerRequestInterface; use Sunrise\Http\Router\Exception\ResolvingParameterException; use ReflectionParameter; @@ -29,22 +29,22 @@ interface ParameterResolverInterface * Checks if the given parameter is supported * * @param ReflectionParameter $parameter - * @param RequestInterface $request + * @param ServerRequestInterface|null $request * * @return bool */ - public function supportsParameter(ReflectionParameter $parameter, RequestInterface $request): bool; + public function supportsParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): bool; /** * Resolves the given parameter to an argument * * @param ReflectionParameter $parameter - * @param RequestInterface $request + * @param ServerRequestInterface|null $request * * @return mixed * * @throws ResolvingParameterException * If the parameter cannot be resolved to an argument. */ - public function resolveParameter(ReflectionParameter $parameter, RequestInterface $request): mixed; + public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): mixed; } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index b5061a91..0e24286c 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -13,10 +13,7 @@ namespace Sunrise\Http\Router\ParameterResolver; -use Psr\Http\Message\RequestInterface; use Psr\Http\Message\ServerRequestInterface; -use ReflectionNamedType; -use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestBody; use Sunrise\Http\Router\Exception\UnhydrableObjectException; use Sunrise\Http\Router\Exception\UnprocessableRequestBodyException; @@ -24,6 +21,8 @@ use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; +use ReflectionNamedType; +use ReflectionParameter; /** * RequestBodyParameterResolver @@ -37,6 +36,8 @@ final class RequestBodyParameterResolver implements ParameterResolverInterface { /** + * Constructor of the class + * * @param HydratorInterface $hydrator * @param ValidatorInterface|null $validator */ @@ -45,44 +46,46 @@ public function __construct(private HydratorInterface $hydrator, private ?Valida } /** - * {@inheritdoc} + * @inheritDoc */ - public function supportsParameter(ReflectionParameter $parameter, RequestInterface $request): bool + public function supportsParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): bool { - if (!($parameter->getType() instanceof ReflectionNamedType)) { + if ($request === null) { return false; } - if ($parameter->getType()->isBuiltin()) { + $type = $parameter->getType(); + + if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { return false; } - if ($parameter->getAttributes(RequestBody::class)) { - return true; + if ($parameter->getAttributes(RequestBody::class) === []) { + return false; } - return false; + return true; } /** - * {@inheritdoc} + * @inheritDoc * * @throws UnhydrableObjectException * If an object isn't valid. * * @throws UnprocessableRequestBodyException - * If the request body data isn't valid. + * If the request's parsed body isn't valid. */ - public function resolveParameter(ReflectionParameter $parameter, RequestInterface $request): mixed + public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): mixed { /** @var ReflectionNamedType $type */ $type = $parameter->getType(); - /** @var class-string $typeName */ - $typeName = $type->getName(); + /** @var class-string $fqn */ + $fqn = $type->getName(); try { - $object = $this->hydrator->hydrate($typeName, (array) $request->getParsedBody()); + $object = $this->hydrator->hydrate($fqn, (array) $request?->getParsedBody()); } catch (InvalidObjectException $e) { throw new UnhydrableObjectException($e->getMessage(), 0, $e); } catch (InvalidDataException $e) { diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 14be1470..a36e1042 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -14,18 +14,15 @@ namespace Sunrise\Http\Router\ParameterResolver; use Psr\Http\Message\ServerRequestInterface; -use ReflectionNamedType; -use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestQuery; use Sunrise\Http\Router\Exception\UnhydrableObjectException; use Sunrise\Http\Router\Exception\UnprocessableRequestQueryException; -use Sunrise\Http\Router\RequestQueryInterface; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; -use function is_subclass_of; -use const PHP_MAJOR_VERSION; +use ReflectionNamedType; +use ReflectionParameter; /** * RequestQueryParameterResolver @@ -39,68 +36,56 @@ final class RequestQueryParameterResolver implements ParameterResolverInterface { /** - * @var HydratorInterface - */ - private HydratorInterface $hydrator; - - /** - * @var ValidatorInterface|null - */ - private ?ValidatorInterface $validator; - - /** + * Constructor of the class + * * @param HydratorInterface $hydrator * @param ValidatorInterface|null $validator */ - public function __construct(HydratorInterface $hydrator, ?ValidatorInterface $validator = null) + public function __construct(private HydratorInterface $hydrator, private ?ValidatorInterface $validator = null) { - $this->hydrator = $hydrator; - $this->validator = $validator; } /** - * {@inheritdoc} + * @inheritDoc */ - public function supportsParameter(ReflectionParameter $parameter, $request): bool + public function supportsParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): bool { - if (!($request instanceof ServerRequestInterface)) { + if ($request === null) { return false; } - if (!($parameter->getType() instanceof ReflectionNamedType)) { - return false; - } + $type = $parameter->getType(); - if ($parameter->getType()->isBuiltin()) { + if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { return false; } - if (PHP_MAJOR_VERSION >= 8 && $parameter->getAttributes(RequestQuery::class)) { - return true; - } - - if (is_subclass_of($parameter->getType()->getName(), RequestQueryInterface::class)) { - return true; + if ($parameter->getAttributes(RequestQuery::class) === []) { + return false; } - return false; + return true; } /** - * {@inheritdoc} + * @inheritDoc * * @throws UnhydrableObjectException * If an object isn't valid. * * @throws UnprocessableRequestQueryException - * If the request query data isn't valid. + * If the request's query parameters isn't valid. */ - public function resolveParameter(ReflectionParameter $parameter, $request) + public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): mixed { - /** @var ServerRequestInterface $request */ + /** @var ReflectionNamedType $type */ + $type = $parameter->getType(); + + /** @var class-string $fqn */ + $fqn = $type->getName(); try { - $object = $this->hydrator->hydrate($parameter->getType()->getName(), $request->getQueryParams()); + $object = $this->hydrator->hydrate($fqn, (array) $request?->getQueryParams()); } catch (InvalidObjectException $e) { throw new UnhydrableObjectException($e->getMessage(), 0, $e); } catch (InvalidDataException $e) { diff --git a/src/ParameterResolver/RequestRouteParameterResolver.php b/src/ParameterResolver/RequestRouteParameterResolver.php index b084b1f6..fe64e2ac 100644 --- a/src/ParameterResolver/RequestRouteParameterResolver.php +++ b/src/ParameterResolver/RequestRouteParameterResolver.php @@ -14,9 +14,9 @@ namespace Sunrise\Http\Router\ParameterResolver; use Psr\Http\Message\ServerRequestInterface; +use Sunrise\Http\Router\RouteInterface; use ReflectionNamedType; use ReflectionParameter; -use Sunrise\Http\Router\RouteInterface; /** * RequestRouteParameterResolver @@ -27,36 +27,35 @@ final class RequestRouteParameterResolver implements ParameterResolverInterface { /** - * {@inheritdoc} + * @inheritDoc */ - public function supportsParameter(ReflectionParameter $parameter, $request): bool + public function supportsParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): bool { - if (!($request instanceof ServerRequestInterface)) { + if ($request === null) { return false; } - if (!($parameter->getType() instanceof ReflectionNamedType)) { - return false; - } + $type = $parameter->getType(); - if (!($parameter->getType()->getName() === RouteInterface::class)) { + if (! $type instanceof ReflectionNamedType) { return false; } - if (!($request->getAttribute(RouteInterface::ATTR_ROUTE) instanceof RouteInterface)) { + if (! ($type->getName() === RouteInterface::class)) { return false; } - return true; + /** @var RouteInterface|null $route */ + $route = $request->getAttribute('@route'); + + return isset($route) || $type->allowsNull(); } /** - * {@inheritdoc} + * @inheritDoc */ - public function resolveParameter(ReflectionParameter $parameter, $request) + public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): mixed { - /** @var ServerRequestInterface $request */ - - return $request->getAttribute(RouteInterface::ATTR_ROUTE); + return $request?->getAttribute('@route'); } } diff --git a/src/ParameterResolver/PresetTypedParameterResolver.php b/src/ParameterResolver/TypeParameterResolver.php similarity index 50% rename from src/ParameterResolver/PresetTypedParameterResolver.php rename to src/ParameterResolver/TypeParameterResolver.php index 1188a2ea..9c4b3858 100644 --- a/src/ParameterResolver/PresetTypedParameterResolver.php +++ b/src/ParameterResolver/TypeParameterResolver.php @@ -13,56 +13,59 @@ namespace Sunrise\Http\Router\ParameterResolver; -use Psr\Http\Message\RequestInterface; +use Psr\Http\Message\ServerRequestInterface; +use Sunrise\Http\Router\Exception\LogicException; use ReflectionNamedType; use ReflectionParameter; +use function sprintf; + /** - * PresetTypedParameterResolver - * - * @template T of object + * TypeParameterResolver * * @since 3.0.0 */ -final class PresetTypedParameterResolver implements ParameterResolverInterface +final class TypeParameterResolver implements ParameterResolverInterface { /** - * @param class-string $type - * @param T $value + * Constructor of the class + * + * @param string $type + * @param object $value * - * @template T of object + * @throws LogicException + * If the value isn't an instance of the type. */ public function __construct(private string $type, private object $value) { + if (! $this->value instanceof $this->type) { + throw new LogicException(sprintf( + 'The %1$s value must be an instance of %2$s.', + $this->value::class, + $this->type, + )); + } } /** - * {@inheritdoc} + * @inheritDoc */ - public function supportsParameter(ReflectionParameter $parameter, RequestInterface $request): bool + public function supportsParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): bool { $type = $parameter->getType(); - if (!($type instanceof ReflectionNamedType)) { - return false; - } - - if ($type->isBuiltin()) { - return false; - } - - if (!($type->getName() === $this->type)) { + if (! $type instanceof ReflectionNamedType) { return false; } - return true; + return $type->getName() === $this->type; } /** - * {@inheritdoc} + * @inheritDoc */ - public function resolveParameter(ReflectionParameter $parameter, RequestInterface $request): mixed + public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): mixed { return $this->value; } diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index f9dc58b4..ca27e657 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -71,7 +71,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritDoc */ public function resolveRequestHandler($reference): RequestHandlerInterface { @@ -111,7 +111,7 @@ public function resolveRequestHandler($reference): RequestHandlerInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function resolveMiddleware($reference): MiddlewareInterface { @@ -151,7 +151,7 @@ public function resolveMiddleware($reference): MiddlewareInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function resolveMiddlewares(array $references): array { diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index e61e66f0..a958a179 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -16,7 +16,7 @@ use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\ParameterResolver\PresetTypedParameterResolver; +use Sunrise\Http\Router\ParameterResolver\TypeParameterResolver; use Sunrise\Http\Router\ParameterResolutionerInterface; use Sunrise\Http\Router\ResponseResolutionerInterface; use ReflectionFunction; @@ -81,13 +81,13 @@ public function getReflection(): ReflectionFunction|ReflectionMethod } /** - * {@inheritdoc} + * @inheritDoc */ public function handle(ServerRequestInterface $request): ResponseInterface { $arguments = $this->parameterResolutioner ->withRequest($request) - ->withPriorityResolver(new PresetTypedParameterResolver(ServerRequestInterface::class, $request)) + ->withPriorityResolver(new TypeParameterResolver(ServerRequestInterface::class, $request)) ->resolveParameters(...$this->getReflection()->getParameters()); /** @var mixed $response */ diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index 4d9fab1e..68c59ddf 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -61,7 +61,7 @@ public function add(MiddlewareInterface ...$middlewares): void } /** - * {@inheritdoc} + * @inheritDoc */ public function handle(ServerRequestInterface $request): ResponseInterface { diff --git a/src/RequestHandler/UnsafeCallableRequestHandler.php b/src/RequestHandler/UnsafeCallableRequestHandler.php index 22e4da2a..8e44a261 100644 --- a/src/RequestHandler/UnsafeCallableRequestHandler.php +++ b/src/RequestHandler/UnsafeCallableRequestHandler.php @@ -45,7 +45,7 @@ public function __construct(callable $callback) } /** - * {@inheritdoc} + * @inheritDoc */ public function handle(ServerRequestInterface $request): ResponseInterface { diff --git a/src/ResponseResolutioner.php b/src/ResponseResolutioner.php index 310f12fb..f3aac200 100644 --- a/src/ResponseResolutioner.php +++ b/src/ResponseResolutioner.php @@ -40,7 +40,7 @@ final class ResponseResolutioner implements ResponseResolutionerInterface private array $resolvers = []; /** - * {@inheritdoc} + * @inheritDoc */ public function withRequest(RequestInterface $context): static { @@ -51,7 +51,7 @@ public function withRequest(RequestInterface $context): static } /** - * {@inheritdoc} + * @inheritDoc */ public function addResolver(ResponseResolverInterface ...$resolvers): void { @@ -61,7 +61,7 @@ public function addResolver(ResponseResolverInterface ...$resolvers): void } /** - * {@inheritdoc} + * @inheritDoc */ public function resolveResponse($response): ResponseInterface { diff --git a/src/ResponseResolver/ObjectResponseResolver.php b/src/ResponseResolver/ObjectResponseResolver.php index d74bf244..bea2558b 100644 --- a/src/ResponseResolver/ObjectResponseResolver.php +++ b/src/ResponseResolver/ObjectResponseResolver.php @@ -33,7 +33,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritDoc */ public function supportsResponse($response, $context): bool { @@ -45,7 +45,7 @@ public function supportsResponse($response, $context): bool } /** - * {@inheritdoc} + * @inheritDoc */ public function resolveResponse($response, $context): ResponseInterface { diff --git a/src/ResponseResolver/RouteResponseResolver.php b/src/ResponseResolver/RouteResponseResolver.php index 8901e890..adc6bd7d 100644 --- a/src/ResponseResolver/RouteResponseResolver.php +++ b/src/ResponseResolver/RouteResponseResolver.php @@ -26,7 +26,7 @@ final class RouteResponseResolver implements ResponseResolverInterface { /** - * {@inheritdoc} + * @inheritDoc */ public function supportsResponse(mixed $response, mixed $context): bool { @@ -42,7 +42,7 @@ public function supportsResponse(mixed $response, mixed $context): bool } /** - * {@inheritdoc} + * @inheritDoc */ public function resolveResponse(mixed $response, mixed $context): ResponseInterface { diff --git a/src/ResponseResolver/StatusCodeResponseResolver.php b/src/ResponseResolver/StatusCodeResponseResolver.php index 7eee9be1..8f725123 100644 --- a/src/ResponseResolver/StatusCodeResponseResolver.php +++ b/src/ResponseResolver/StatusCodeResponseResolver.php @@ -39,7 +39,7 @@ public function __construct(ResponseFactoryInterface $responseFactory) } /** - * {@inheritdoc} + * @inheritDoc */ public function supportsResponse($response, $context): bool { @@ -47,7 +47,7 @@ public function supportsResponse($response, $context): bool } /** - * {@inheritdoc} + * @inheritDoc */ public function resolveResponse($response, $context): ResponseInterface { diff --git a/src/Route.php b/src/Route.php index ef869f15..388dcee4 100644 --- a/src/Route.php +++ b/src/Route.php @@ -144,7 +144,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritDoc */ public function getName(): string { @@ -152,7 +152,7 @@ public function getName(): string } /** - * {@inheritdoc} + * @inheritDoc */ public function getHost(): ?string { @@ -160,7 +160,7 @@ public function getHost(): ?string } /** - * {@inheritdoc} + * @inheritDoc */ public function getPath(): string { @@ -168,7 +168,7 @@ public function getPath(): string } /** - * {@inheritdoc} + * @inheritDoc */ public function getMethods(): array { @@ -176,7 +176,7 @@ public function getMethods(): array } /** - * {@inheritdoc} + * @inheritDoc */ public function getConsumedMediaTypes(): array { @@ -184,7 +184,7 @@ public function getConsumedMediaTypes(): array } /** - * {@inheritdoc} + * @inheritDoc */ public function getProducedMediaTypes(): array { @@ -192,7 +192,7 @@ public function getProducedMediaTypes(): array } /** - * {@inheritdoc} + * @inheritDoc */ public function getRequestHandler(): RequestHandlerInterface { @@ -200,7 +200,7 @@ public function getRequestHandler(): RequestHandlerInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function getMiddlewares(): array { @@ -208,7 +208,7 @@ public function getMiddlewares(): array } /** - * {@inheritdoc} + * @inheritDoc */ public function getAttributes(): array { @@ -216,7 +216,7 @@ public function getAttributes(): array } /** - * {@inheritdoc} + * @inheritDoc */ public function getSummary(): string { @@ -224,7 +224,7 @@ public function getSummary(): string } /** - * {@inheritdoc} + * @inheritDoc */ public function getDescription(): string { @@ -232,7 +232,7 @@ public function getDescription(): string } /** - * {@inheritdoc} + * @inheritDoc */ public function getTags(): array { @@ -240,7 +240,7 @@ public function getTags(): array } /** - * {@inheritdoc} + * @inheritDoc */ public function getHolder(): Reflector { @@ -252,7 +252,7 @@ public function getHolder(): Reflector } /** - * {@inheritdoc} + * @inheritDoc */ public function setName(string $name): RouteInterface { @@ -262,7 +262,7 @@ public function setName(string $name): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function setHost(?string $host): RouteInterface { @@ -272,7 +272,7 @@ public function setHost(?string $host): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function setPath(string $path): RouteInterface { @@ -282,7 +282,7 @@ public function setPath(string $path): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function setMethods(string ...$methods): RouteInterface { @@ -295,7 +295,7 @@ public function setMethods(string ...$methods): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function setConsumedMediaTypes(string ...$mediaTypes): RouteInterface { @@ -308,7 +308,7 @@ public function setConsumedMediaTypes(string ...$mediaTypes): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function setProducedMediaTypes(string ...$mediaTypes): RouteInterface { @@ -321,7 +321,7 @@ public function setProducedMediaTypes(string ...$mediaTypes): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function setRequestHandler(RequestHandlerInterface $requestHandler): RouteInterface { @@ -331,7 +331,7 @@ public function setRequestHandler(RequestHandlerInterface $requestHandler): Rout } /** - * {@inheritdoc} + * @inheritDoc */ public function setMiddlewares(MiddlewareInterface ...$middlewares): RouteInterface { @@ -344,7 +344,7 @@ public function setMiddlewares(MiddlewareInterface ...$middlewares): RouteInterf } /** - * {@inheritdoc} + * @inheritDoc */ public function setAttributes(array $attributes): RouteInterface { @@ -354,7 +354,7 @@ public function setAttributes(array $attributes): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function setAttribute(string $name, $value): RouteInterface { @@ -364,7 +364,7 @@ public function setAttribute(string $name, $value): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function setSummary(string $summary): RouteInterface { @@ -374,7 +374,7 @@ public function setSummary(string $summary): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function setDescription(string $description): RouteInterface { @@ -384,7 +384,7 @@ public function setDescription(string $description): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function setTags(string ...$tags): RouteInterface { @@ -397,7 +397,7 @@ public function setTags(string ...$tags): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function addPrefix(string $prefix): RouteInterface { @@ -410,7 +410,7 @@ public function addPrefix(string $prefix): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function addSuffix(string $suffix): RouteInterface { @@ -420,7 +420,7 @@ public function addSuffix(string $suffix): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function addMethod(string ...$methods): RouteInterface { @@ -432,7 +432,7 @@ public function addMethod(string ...$methods): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function addConsumedMediaType(string ...$mediaTypes): RouteInterface { @@ -444,7 +444,7 @@ public function addConsumedMediaType(string ...$mediaTypes): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function addProducedMediaType(string ...$mediaTypes): RouteInterface { @@ -456,7 +456,7 @@ public function addProducedMediaType(string ...$mediaTypes): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function addMiddleware(MiddlewareInterface ...$middlewares): RouteInterface { @@ -468,7 +468,7 @@ public function addMiddleware(MiddlewareInterface ...$middlewares): RouteInterfa } /** - * {@inheritdoc} + * @inheritDoc */ public function addPriorityMiddleware(MiddlewareInterface ...$middlewares): RouteInterface { @@ -488,7 +488,7 @@ public function addPriorityMiddleware(MiddlewareInterface ...$middlewares): Rout } /** - * {@inheritdoc} + * @inheritDoc */ public function addTag(string ...$tags): RouteInterface { @@ -500,7 +500,7 @@ public function addTag(string ...$tags): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function withAddedAttributes(array $attributes): RouteInterface { @@ -515,7 +515,7 @@ public function withAddedAttributes(array $attributes): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function handle(ServerRequestInterface $request): ResponseInterface { diff --git a/src/RouteCollection.php b/src/RouteCollection.php index f32e913c..730bd99c 100644 --- a/src/RouteCollection.php +++ b/src/RouteCollection.php @@ -55,7 +55,7 @@ public function __construct(RouteInterface ...$routes) } /** - * {@inheritdoc} + * @inheritDoc */ public function getIterator(): Iterator { @@ -65,7 +65,7 @@ public function getIterator(): Iterator } /** - * {@inheritdoc} + * @inheritDoc */ public function all(): Iterator { @@ -75,7 +75,7 @@ public function all(): Iterator } /** - * {@inheritdoc} + * @inheritDoc */ public function allOnHost(?string $host): Iterator { @@ -93,7 +93,7 @@ public function allOnHost(?string $host): Iterator } /** - * {@inheritdoc} + * @inheritDoc */ public function has(string $name): bool { @@ -101,7 +101,7 @@ public function has(string $name): bool } /** - * {@inheritdoc} + * @inheritDoc */ public function get(string $name): RouteInterface { @@ -116,7 +116,7 @@ public function get(string $name): RouteInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function add(RouteInterface ...$routes): RouteCollectionInterface { @@ -139,7 +139,7 @@ public function add(RouteInterface ...$routes): RouteCollectionInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function setHost(string $host): RouteCollectionInterface { @@ -151,7 +151,7 @@ public function setHost(string $host): RouteCollectionInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function setConsumedMediaTypes(string ...$mediaTypes): RouteCollectionInterface { @@ -163,7 +163,7 @@ public function setConsumedMediaTypes(string ...$mediaTypes): RouteCollectionInt } /** - * {@inheritdoc} + * @inheritDoc */ public function setProducedMediaTypes(string ...$mediaTypes): RouteCollectionInterface { @@ -175,7 +175,7 @@ public function setProducedMediaTypes(string ...$mediaTypes): RouteCollectionInt } /** - * {@inheritdoc} + * @inheritDoc */ public function setAttribute(string $name, $value): RouteCollectionInterface { @@ -187,7 +187,7 @@ public function setAttribute(string $name, $value): RouteCollectionInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function addPrefix(string $prefix): RouteCollectionInterface { @@ -199,7 +199,7 @@ public function addPrefix(string $prefix): RouteCollectionInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function addSuffix(string $suffix): RouteCollectionInterface { @@ -211,7 +211,7 @@ public function addSuffix(string $suffix): RouteCollectionInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function addMethod(string ...$methods): RouteCollectionInterface { @@ -223,7 +223,7 @@ public function addMethod(string ...$methods): RouteCollectionInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function addConsumedMediaType(string ...$mediaTypes): RouteCollectionInterface { @@ -235,7 +235,7 @@ public function addConsumedMediaType(string ...$mediaTypes): RouteCollectionInte } /** - * {@inheritdoc} + * @inheritDoc */ public function addProducedMediaType(string ...$mediaTypes): RouteCollectionInterface { @@ -247,7 +247,7 @@ public function addProducedMediaType(string ...$mediaTypes): RouteCollectionInte } /** - * {@inheritdoc} + * @inheritDoc */ public function addMiddleware(MiddlewareInterface ...$middlewares): RouteCollectionInterface { @@ -259,7 +259,7 @@ public function addMiddleware(MiddlewareInterface ...$middlewares): RouteCollect } /** - * {@inheritdoc} + * @inheritDoc */ public function addPriorityMiddleware(MiddlewareInterface ...$middlewares): RouteCollectionInterface { @@ -271,7 +271,7 @@ public function addPriorityMiddleware(MiddlewareInterface ...$middlewares): Rout } /** - * {@inheritdoc} + * @inheritDoc */ public function addTag(string ...$tags): RouteCollectionInterface { @@ -283,7 +283,7 @@ public function addTag(string ...$tags): RouteCollectionInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function count(): int { diff --git a/src/RouteCollectionFactory.php b/src/RouteCollectionFactory.php index c42a6019..3d596070 100644 --- a/src/RouteCollectionFactory.php +++ b/src/RouteCollectionFactory.php @@ -20,7 +20,7 @@ class RouteCollectionFactory implements RouteCollectionFactoryInterface { /** - * {@inheritdoc} + * @inheritDoc */ public function createCollection(RouteInterface ...$routes): RouteCollectionInterface { diff --git a/src/RouteFactory.php b/src/RouteFactory.php index b8a0ec5a..c7c8362b 100644 --- a/src/RouteFactory.php +++ b/src/RouteFactory.php @@ -22,7 +22,7 @@ class RouteFactory implements RouteFactoryInterface { /** - * {@inheritdoc} + * @inheritDoc */ public function createRoute( string $name, diff --git a/src/Router.php b/src/Router.php index 5d29bc27..1d7da240 100644 --- a/src/Router.php +++ b/src/Router.php @@ -331,7 +331,7 @@ function (ServerRequestInterface $request): ResponseInterface { } /** - * {@inheritdoc} + * @inheritDoc */ public function handle(ServerRequestInterface $request): ResponseInterface { diff --git a/src/ServerRequest.php b/src/ServerRequest.php index c4abff4e..afa4fcd1 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -325,7 +325,7 @@ public function equalsMediaTypes(string $a, string $b): bool } /** - * {@inheritdoc} + * @inheritDoc */ public function getProtocolVersion(): string { @@ -333,7 +333,7 @@ public function getProtocolVersion(): string } /** - * {@inheritdoc} + * @inheritDoc */ public function withProtocolVersion($version): self { @@ -344,7 +344,7 @@ public function withProtocolVersion($version): self } /** - * {@inheritdoc} + * @inheritDoc */ public function getHeaders(): array { @@ -352,7 +352,7 @@ public function getHeaders(): array } /** - * {@inheritdoc} + * @inheritDoc */ public function hasHeader($name): bool { @@ -360,7 +360,7 @@ public function hasHeader($name): bool } /** - * {@inheritdoc} + * @inheritDoc */ public function getHeader($name): array { @@ -368,7 +368,7 @@ public function getHeader($name): array } /** - * {@inheritdoc} + * @inheritDoc */ public function getHeaderLine($name): string { @@ -376,7 +376,7 @@ public function getHeaderLine($name): string } /** - * {@inheritdoc} + * @inheritDoc */ public function withHeader($name, $value): self { @@ -387,7 +387,7 @@ public function withHeader($name, $value): self } /** - * {@inheritdoc} + * @inheritDoc */ public function withAddedHeader($name, $value): self { @@ -398,7 +398,7 @@ public function withAddedHeader($name, $value): self } /** - * {@inheritdoc} + * @inheritDoc */ public function withoutHeader($name): self { @@ -409,7 +409,7 @@ public function withoutHeader($name): self } /** - * {@inheritdoc} + * @inheritDoc */ public function getBody(): StreamInterface { @@ -417,7 +417,7 @@ public function getBody(): StreamInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function withBody(StreamInterface $body): self { @@ -428,7 +428,7 @@ public function withBody(StreamInterface $body): self } /** - * {@inheritdoc} + * @inheritDoc */ public function getMethod(): string { @@ -436,7 +436,7 @@ public function getMethod(): string } /** - * {@inheritdoc} + * @inheritDoc */ public function withMethod($method): self { @@ -447,7 +447,7 @@ public function withMethod($method): self } /** - * {@inheritdoc} + * @inheritDoc */ public function getUri(): UriInterface { @@ -455,7 +455,7 @@ public function getUri(): UriInterface } /** - * {@inheritdoc} + * @inheritDoc */ public function withUri(UriInterface $uri, $preserveHost = false): self { @@ -466,7 +466,7 @@ public function withUri(UriInterface $uri, $preserveHost = false): self } /** - * {@inheritdoc} + * @inheritDoc */ public function getRequestTarget(): string { @@ -474,7 +474,7 @@ public function getRequestTarget(): string } /** - * {@inheritdoc} + * @inheritDoc */ public function withRequestTarget($requestTarget): self { @@ -485,7 +485,7 @@ public function withRequestTarget($requestTarget): self } /** - * {@inheritdoc} + * @inheritDoc */ public function getServerParams(): array { @@ -493,7 +493,7 @@ public function getServerParams(): array } /** - * {@inheritdoc} + * @inheritDoc */ public function getQueryParams(): array { @@ -501,7 +501,7 @@ public function getQueryParams(): array } /** - * {@inheritdoc} + * @inheritDoc */ public function withQueryParams(array $query): self { @@ -512,7 +512,7 @@ public function withQueryParams(array $query): self } /** - * {@inheritdoc} + * @inheritDoc */ public function getCookieParams(): array { @@ -520,7 +520,7 @@ public function getCookieParams(): array } /** - * {@inheritdoc} + * @inheritDoc */ public function withCookieParams(array $cookies): self { @@ -531,7 +531,7 @@ public function withCookieParams(array $cookies): self } /** - * {@inheritdoc} + * @inheritDoc */ public function getUploadedFiles(): array { @@ -539,7 +539,7 @@ public function getUploadedFiles(): array } /** - * {@inheritdoc} + * @inheritDoc */ public function withUploadedFiles(array $uploadedFiles): self { @@ -550,7 +550,7 @@ public function withUploadedFiles(array $uploadedFiles): self } /** - * {@inheritdoc} + * @inheritDoc */ public function getParsedBody(): mixed { @@ -558,7 +558,7 @@ public function getParsedBody(): mixed } /** - * {@inheritdoc} + * @inheritDoc */ public function withParsedBody($data): self { @@ -569,7 +569,7 @@ public function withParsedBody($data): self } /** - * {@inheritdoc} + * @inheritDoc */ public function getAttributes(): array { @@ -577,7 +577,7 @@ public function getAttributes(): array } /** - * {@inheritdoc} + * @inheritDoc */ public function getAttribute($name, $default = null): mixed { @@ -585,7 +585,7 @@ public function getAttribute($name, $default = null): mixed } /** - * {@inheritdoc} + * @inheritDoc */ public function withAttribute($name, $value): self { @@ -596,7 +596,7 @@ public function withAttribute($name, $value): self } /** - * {@inheritdoc} + * @inheritDoc */ public function withoutAttribute($name): self { From d8821df9ee83f7f8984d7cbd23a0cc0f3811f8c7 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Mon, 24 Jul 2023 05:19:25 +0200 Subject: [PATCH 074/180] v3 --- src/Annotation/RequestRouteAttribute.php | 33 ++++++++++ ...RequestRouteAttributeParameterResolver.php | 66 +++++++++++++++++++ 2 files changed, 99 insertions(+) create mode 100644 src/Annotation/RequestRouteAttribute.php create mode 100644 src/ParameterResolver/RequestRouteAttributeParameterResolver.php diff --git a/src/Annotation/RequestRouteAttribute.php b/src/Annotation/RequestRouteAttribute.php new file mode 100644 index 00000000..0a701a83 --- /dev/null +++ b/src/Annotation/RequestRouteAttribute.php @@ -0,0 +1,33 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_PARAMETER)] +final class RequestRouteAttribute +{ + + /** + * Constructor of the class + * + * @param non-empty-string|null $name + */ + public function __construct(public ?string $name = null) + { + } +} diff --git a/src/ParameterResolver/RequestRouteAttributeParameterResolver.php b/src/ParameterResolver/RequestRouteAttributeParameterResolver.php new file mode 100644 index 00000000..c4755cd2 --- /dev/null +++ b/src/ParameterResolver/RequestRouteAttributeParameterResolver.php @@ -0,0 +1,66 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ParameterResolver; + +use Psr\Http\Message\ServerRequestInterface; +use Sunrise\Http\Router\Annotation\RequestRouteAttribute; +use Sunrise\Http\Router\RouteInterface; +use ReflectionAttribute; +use ReflectionNamedType; +use ReflectionParameter; + +final class RequestRouteAttributeParameterResolver implements ParameterResolverInterface +{ + + /** + * @inheritDoc + */ + public function supportsParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): bool + { + if ($request === null) { + return false; + } + + $type = $parameter->getType(); + + if (! $type instanceof ReflectionNamedType || ! $type->isBuiltin()) { + return false; + } + + if ($parameter->getAttributes(RequestRouteAttribute::class) === []) { + return false; + } + + return true; + } + + /** + * @inheritDoc + */ + public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): mixed + { + /** @var non-empty-list> $annotations */ + $annotations = $parameter->getAttributes(RequestRouteAttribute::class); + + $key = $annotations[0]->newInstance()->name ?? $parameter->getName(); + + /** @var RouteInterface $route */ + $route = $request->getAttribute('@route'); + + /** @var mixed $value */ + $value = $route->getAttributes()[$key] ?? null; + + return $value; + } +} From d559726be833779a291dead75cab377f0bc0da9c Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 30 Jul 2023 10:49:06 +0200 Subject: [PATCH 075/180] v3 --- README.md | 4 +- composer.json | 3 +- functions/reflect_callable.php | 3 +- ...outeAttribute.php => RequestAttribute.php} | 6 +- src/Annotation/ResponseBody.php | 19 ++++ src/Entity/MediaType.php | 2 + src/Exception/ResolvingParameterException.php | 23 ---- src/Exception/ResolvingResponseException.php | 23 ---- src/Loader/ConfigLoader.php | 10 +- src/Loader/DescriptorLoader.php | 12 +-- src/Middleware/CallbackMiddleware.php | 28 +++-- .../JsonPayloadDecodingMiddleware.php | 18 ++-- ... => SimdJsonPayloadDecodingMiddleware.php} | 24 ++--- src/ParameterResolutioner.php | 42 ++++---- src/ParameterResolutionerInterface.php | 17 ++- .../DependencyInjectionParameterResolver.php | 21 ++-- .../DirectInjectionParameterResolver.php | 54 ++++++++++ .../ParameterResolverInterface.php | 24 +---- .../RequestAttributeParameterResolver.php | 56 ++++++++++ .../RequestBodyParameterResolver.php | 67 ++++++------ .../RequestQueryParameterResolver.php | 67 ++++++------ ...RequestRouteAttributeParameterResolver.php | 66 ------------ .../RequestRouteParameterResolver.php | 43 ++++---- .../TypeParameterResolver.php | 72 ------------- src/ReferenceResolver.php | 6 +- src/RequestHandler/CallableRequestHandler.php | 60 ++--------- src/RequestHandler/CallbackRequestHandler.php | 100 ++++++++++++++++++ .../QueueableRequestHandler.php | 28 +++-- .../UnsafeCallableRequestHandler.php | 54 ---------- src/ResponseResolutioner.php | 38 +++---- src/ResponseResolutionerInterface.php | 23 +--- src/ResponseResolver/NullResponseResolver.php | 47 ++++++++ .../ObjectResponseResolver.php | 56 ---------- .../ResponseBodyResponseResolver.php | 88 +++++++++++++++ .../ResponseResolverInterface.php | 22 +--- .../RouteResponseResolver.php | 29 +++-- .../StatusCodeResponseResolver.php | 27 ++--- src/ResponseResolver/UriResponseResolver.php | 49 +++++++++ src/Route.php | 4 +- src/Router.php | 4 +- .../CallableRequestHandlerTest.php | 6 +- tests/RouteTest.php | 6 +- 42 files changed, 671 insertions(+), 680 deletions(-) rename src/Annotation/{RequestRouteAttribute.php => RequestAttribute.php} (79%) delete mode 100644 src/Exception/ResolvingParameterException.php delete mode 100644 src/Exception/ResolvingResponseException.php rename src/Middleware/{SimdjsonPayloadDecodingMiddleware.php => SimdJsonPayloadDecodingMiddleware.php} (76%) create mode 100644 src/ParameterResolver/DirectInjectionParameterResolver.php create mode 100644 src/ParameterResolver/RequestAttributeParameterResolver.php delete mode 100644 src/ParameterResolver/RequestRouteAttributeParameterResolver.php delete mode 100644 src/ParameterResolver/TypeParameterResolver.php create mode 100644 src/RequestHandler/CallbackRequestHandler.php delete mode 100644 src/RequestHandler/UnsafeCallableRequestHandler.php create mode 100644 src/ResponseResolver/NullResponseResolver.php delete mode 100644 src/ResponseResolver/ObjectResponseResolver.php create mode 100644 src/ResponseResolver/ResponseBodyResponseResolver.php create mode 100644 src/ResponseResolver/UriResponseResolver.php diff --git a/README.md b/README.md index 8ac4eb00..b2207e5b 100644 --- a/README.md +++ b/README.md @@ -265,7 +265,7 @@ use Sunrise\Http\Message\ResponseFactory; use Sunrise\Http\Router\Exception\MethodNotAllowedException; use Sunrise\Http\Router\Exception\RouteNotFoundException; use Sunrise\Http\Router\Middleware\CallbackMiddleware; -use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; +use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; use Sunrise\Http\Router\RouteCollector; use Sunrise\Http\Router\Router; use Sunrise\Http\ServerRequest\ServerRequestFactory; @@ -274,7 +274,7 @@ use function Sunrise\Http\Router\emit; $collector = new RouteCollector(); -$collector->get('home', '/', new CallableRequestHandler(function ($request) { +$collector->get('home', '/', new CallbackRequestHandler(function ($request) { return (new ResponseFactory)->createJsonResponse(200); })); diff --git a/composer.json b/composer.json index 36f25c53..3b8c4b5e 100644 --- a/composer.json +++ b/composer.json @@ -36,6 +36,7 @@ "psr/http-server-middleware": "^1.0", "psr/simple-cache": "^1.0 || ^2.0 || ^3.0", "sunrise/hydrator": "^3.0", + "symfony/serializer": ">=6.0", "symfony/validator": ">=6.0" }, "require-dev": { @@ -43,7 +44,7 @@ "vimeo/psalm": "^5.13", "sunrise/coding-standard": "^1.0", "sunrise/http-message": "^3.0", - "symfony/console": "^5.4" + "symfony/console": "^6.0" }, "autoload": { "files": [ diff --git a/functions/reflect_callable.php b/functions/reflect_callable.php index 4751be85..e563cd43 100644 --- a/functions/reflect_callable.php +++ b/functions/reflect_callable.php @@ -15,7 +15,6 @@ use Closure; use InvalidArgumentException; -use ReflectionFunctionAbstract; use ReflectionFunction; use ReflectionMethod; @@ -38,7 +37,7 @@ * * @since 3.0.0 */ -function reflect_callable(callable $callback): ReflectionFunctionAbstract +function reflect_callable(callable $callback): ReflectionFunction|ReflectionMethod { if ($callback instanceof Closure) { return new ReflectionFunction($callback); diff --git a/src/Annotation/RequestRouteAttribute.php b/src/Annotation/RequestAttribute.php similarity index 79% rename from src/Annotation/RequestRouteAttribute.php rename to src/Annotation/RequestAttribute.php index 0a701a83..80a02a59 100644 --- a/src/Annotation/RequestRouteAttribute.php +++ b/src/Annotation/RequestAttribute.php @@ -19,15 +19,15 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_PARAMETER)] -final class RequestRouteAttribute +final class RequestAttribute { /** * Constructor of the class * - * @param non-empty-string|null $name + * @param non-empty-string|null $key */ - public function __construct(public ?string $name = null) + public function __construct(public ?string $key = null) { } } diff --git a/src/Annotation/ResponseBody.php b/src/Annotation/ResponseBody.php index dd699375..6b62561e 100644 --- a/src/Annotation/ResponseBody.php +++ b/src/Annotation/ResponseBody.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; +use Fig\Http\Message\StatusCodeInterface; /** * @since 3.0.0 @@ -21,4 +22,22 @@ #[Attribute(Attribute::TARGET_CLASS)] final class ResponseBody { + public const FORMAT_CSV = 'csv'; + public const FORMAT_JSON = 'json'; + public const FORMAT_XML = 'xml'; + public const FORMAT_YAML = 'yaml'; + + /** + * Constructor of the class + * + * @param int<100, 599> $statusCode + * @param array> $headers + * @param non-empty-string $format + */ + public function __construct( + public int $statusCode = StatusCodeInterface::STATUS_OK, + public array $headers = [], + public string $format = self::FORMAT_JSON, + ) { + } } diff --git a/src/Entity/MediaType.php b/src/Entity/MediaType.php index 87fea982..80e5a137 100644 --- a/src/Entity/MediaType.php +++ b/src/Entity/MediaType.php @@ -22,6 +22,8 @@ final class MediaType { public const APPLICATION_JSON = 'application/json'; public const APPLICATION_XML = 'application/xml'; + public const APPLICATION_YAML = 'application/yaml'; + public const TEXT_CSV = 'text/csv'; public const TEXT_XML = 'text/xml'; /** diff --git a/src/Exception/ResolvingParameterException.php b/src/Exception/ResolvingParameterException.php deleted file mode 100644 index 8054205e..00000000 --- a/src/Exception/ResolvingParameterException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -/** - * ResolvingParameterException - * - * @since 3.0.0 - */ -class ResolvingParameterException extends LogicException -{ -} diff --git a/src/Exception/ResolvingResponseException.php b/src/Exception/ResolvingResponseException.php deleted file mode 100644 index 67a6e0fb..00000000 --- a/src/Exception/ResolvingResponseException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -/** - * ResolvingResponseException - * - * @since 3.0.0 - */ -class ResolvingResponseException extends LogicException -{ -} diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index 69d0f9ae..b8ab7444 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -188,6 +188,11 @@ public function attach(mixed $resource): void ); } + if (is_file($resource)) { + $this->resources[] = $resource; + return; + } + if (is_dir($resource)) { $filenames = glob($resource . '/*.php'); foreach ($filenames as $filename) { @@ -197,11 +202,6 @@ public function attach(mixed $resource): void return; } - if (is_file($resource)) { - $this->resources[] = $resource; - return; - } - throw new InvalidArgumentException(sprintf( 'The config route loader only handles file or directory paths, ' . 'however the given resource "%s" is not one of them.', diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 183c2b3a..82a783d5 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -13,9 +13,15 @@ namespace Sunrise\Http\Router\Loader; +use FilesystemIterator; use Psr\Container\ContainerInterface; use Psr\Http\Server\RequestHandlerInterface; use Psr\SimpleCache\CacheInterface; +use RecursiveDirectoryIterator; +use RecursiveIteratorIterator; +use ReflectionClass; +use ReflectionMethod; +use RegexIterator; use Sunrise\Http\Router\Annotation\Consume; use Sunrise\Http\Router\Annotation\Description; use Sunrise\Http\Router\Annotation\Host; @@ -43,12 +49,6 @@ use Sunrise\Http\Router\RouteCollectionInterface; use Sunrise\Http\Router\RouteFactory; use Sunrise\Http\Router\RouteFactoryInterface; -use FilesystemIterator; -use RecursiveDirectoryIterator; -use RecursiveIteratorIterator; -use ReflectionClass; -use ReflectionMethod; -use RegexIterator; use function class_exists; use function get_declared_classes; diff --git a/src/Middleware/CallbackMiddleware.php b/src/Middleware/CallbackMiddleware.php index 963d286f..204433be 100644 --- a/src/Middleware/CallbackMiddleware.php +++ b/src/Middleware/CallbackMiddleware.php @@ -17,8 +17,10 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; +use ReflectionFunction; +use ReflectionMethod; use Sunrise\Http\Router\ParameterResolutionerInterface; -use Sunrise\Http\Router\ParameterResolver\TypeParameterResolver; +use Sunrise\Http\Router\ParameterResolver\DirectInjectionParameterResolver; use Sunrise\Http\Router\ResponseResolutionerInterface; use function Sunrise\Http\Router\reflect_callable; @@ -69,22 +71,32 @@ public function __construct( $this->responseResolutioner = $responseResolutioner; } + /** + * Gets the callback's reflection + * + * @return ReflectionFunction|ReflectionMethod + */ + public function getReflection(): ReflectionFunction|ReflectionMethod + { + return reflect_callable($this->callback); + } + /** * @inheritDoc */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - $args = $this->parameterResolutioner - ->withRequest($request) + $arguments = $this->parameterResolutioner + ->withContext($request) ->withPriorityResolver( - new TypeParameterResolver(ServerRequestInterface::class, $request), - new TypeParameterResolver(RequestHandlerInterface::class, $handler), + new DirectInjectionParameterResolver($request), + new DirectInjectionParameterResolver($handler), ) - ->resolveParameters(...reflect_callable($this->callback)->getParameters()); + ->resolveParameters(...$this->getReflection()->getParameters()); /** @var mixed $response */ - $response = ($this->callback)(...$args); + $response = ($this->callback)(...$arguments); - return $this->responseResolutioner->withRequest($request)->resolveResponse($response); + return $this->responseResolutioner->resolveResponse($response, $request); } } diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 8cf4c17a..db020f27 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -13,6 +13,7 @@ namespace Sunrise\Http\Router\Middleware; +use JsonException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; @@ -20,7 +21,6 @@ use Sunrise\Http\Router\Exception\InvalidRequestPayloadException; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ServerRequest; -use JsonException; use function extension_loaded; use function is_array; @@ -61,11 +61,7 @@ public function __construct() public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { if (ServerRequest::from($request)->isJson()) { - $request = $request->withParsedBody( - $this->decodeJsonPayload( - $request->getBody()->__toString() - ) - ); + $request = $request->withParsedBody($this->decodePayload($request->getBody()->__toString())); } return $handler->handle($request); @@ -74,23 +70,23 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface /** * Tries to decode the given JSON payload * - * @param string $json + * @param string $payload * * @return array * * @throws InvalidRequestPayloadException * If the JSON payload cannot be decoded. */ - private function decodeJsonPayload(string $json): array + private function decodePayload(string $payload): array { try { - $data = json_decode($json, true, 512, JSON_BIGINT_AS_STRING | JSON_THROW_ON_ERROR); + $data = json_decode($payload, true, 512, JSON_BIGINT_AS_STRING | JSON_THROW_ON_ERROR); } catch (JsonException $e) { throw new InvalidRequestPayloadException(sprintf('Invalid JSON: %s', $e->getMessage()), 0, $e); } - // According to PSR-7, the data must be an array because - // we're using the 'associative' option when decoding the JSON. + // According to PSR-7, the data must be an array + // because we're using the 'associative' option when decoding the JSON. if (!is_array($data)) { throw new InvalidRequestPayloadException('Unexpected JSON: Expects an array or object.'); } diff --git a/src/Middleware/SimdjsonPayloadDecodingMiddleware.php b/src/Middleware/SimdJsonPayloadDecodingMiddleware.php similarity index 76% rename from src/Middleware/SimdjsonPayloadDecodingMiddleware.php rename to src/Middleware/SimdJsonPayloadDecodingMiddleware.php index 802ac74f..168fd009 100644 --- a/src/Middleware/SimdjsonPayloadDecodingMiddleware.php +++ b/src/Middleware/SimdJsonPayloadDecodingMiddleware.php @@ -13,6 +13,7 @@ namespace Sunrise\Http\Router\Middleware; +use SimdJsonException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; @@ -20,7 +21,6 @@ use Sunrise\Http\Router\Exception\InvalidRequestPayloadException; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ServerRequest; -use RuntimeException; use function extension_loaded; use function is_array; @@ -34,7 +34,7 @@ * * @link https://www.php.net/manual/en/book.simdjson.php */ -final class SimdjsonPayloadDecodingMiddleware implements MiddlewareInterface +final class SimdJsonPayloadDecodingMiddleware implements MiddlewareInterface { /** @@ -47,7 +47,7 @@ public function __construct() { if (!extension_loaded('simdjson')) { throw new LogicException( - 'The Simdjson extension is required, run the `pecl install simdjson` command to resolve it.' + 'The SimdJson extension is required, run the `pecl install simdjson` command to resolve it.' ); } } @@ -58,11 +58,7 @@ public function __construct() public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { if (ServerRequest::from($request)->isJson()) { - $request = $request->withParsedBody( - $this->decodeJsonPayload( - $request->getBody()->__toString() - ) - ); + $request = $request->withParsedBody($this->decodePayload($request->getBody()->__toString())); } return $handler->handle($request); @@ -71,23 +67,23 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface /** * Tries to decode the given JSON payload * - * @param string $json + * @param string $payload * * @return array * * @throws InvalidRequestPayloadException * If the JSON payload cannot be decoded. */ - private function decodeJsonPayload(string $json): array + private function decodePayload(string $payload): array { try { - $data = simdjson_decode($json, true, 512); - } catch (RuntimeException $e) { + $data = simdjson_decode($payload, true, 512); + } catch (SimdJsonException $e) { throw new InvalidRequestPayloadException(sprintf('Invalid JSON: %s', $e->getMessage()), 0, $e); } - // According to PSR-7, the data must be an array because - // we're using the 'associative' option when decoding the JSON. + // According to PSR-7, the data must be an array + // because we're using the 'associative' option when decoding the JSON. if (!is_array($data)) { throw new InvalidRequestPayloadException('Unexpected JSON: Expects an array or object.'); } diff --git a/src/ParameterResolutioner.php b/src/ParameterResolutioner.php index 44842a30..431f1d27 100644 --- a/src/ParameterResolutioner.php +++ b/src/ParameterResolutioner.php @@ -13,10 +13,10 @@ namespace Sunrise\Http\Router; -use Psr\Http\Message\RequestInterface; +use Generator; use ReflectionMethod; use ReflectionParameter; -use Sunrise\Http\Router\Exception\ResolvingParameterException; +use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; use function sprintf; @@ -30,9 +30,9 @@ final class ParameterResolutioner implements ParameterResolutionerInterface { /** - * @var RequestInterface|null + * @var mixed */ - private ?RequestInterface $request = null; + private mixed $context = null; /** * @var list @@ -42,10 +42,10 @@ final class ParameterResolutioner implements ParameterResolutionerInterface /** * @inheritDoc */ - public function withRequest(RequestInterface $request): static + public function withContext(mixed $context): static { $clone = clone $this; - $clone->request = $request; + $clone->context = $context; return $clone; } @@ -81,42 +81,40 @@ public function addResolver(ParameterResolverInterface ...$resolvers): void /** * @inheritDoc + * + * @throws LogicException If one of the parameters cannot be resolved to an argument(s). */ - public function resolveParameters(ReflectionParameter ...$parameters): array + public function resolveParameters(ReflectionParameter ...$parameters): Generator { - $arguments = []; foreach ($parameters as $parameter) { - /** @var mixed */ - $arguments[] = $this->resolveParameter($parameter); + yield from $this->resolveParameter($parameter); } - - return $arguments; } /** - * Tries to resolve the given parameter to an argument + * Tries to resolve the given parameter to an argument(s) * * @param ReflectionParameter $parameter * - * @return mixed + * @return Generator * - * @throws ResolvingParameterException - * If the parameter cannot be resolved to an argument. + * @throws LogicException If the parameter cannot be resolved to an argument(s). */ - private function resolveParameter(ReflectionParameter $parameter): mixed + private function resolveParameter(ReflectionParameter $parameter): Generator { foreach ($this->resolvers as $resolver) { - if ($resolver->supportsParameter($parameter, $this->request)) { - return $resolver->resolveParameter($parameter, $this->request); + $arguments = $resolver->resolveParameter($parameter, $this->context); + if ($arguments->valid()) { + return yield from $arguments; } } if ($parameter->isDefaultValueAvailable()) { - return $parameter->getDefaultValue(); + return yield $parameter->getDefaultValue(); } - throw new ResolvingParameterException(sprintf( - 'Unable to resolve the parameter {%s}', + throw new LogicException(sprintf( + 'Unable to resolve the parameter {%s}.', $this->stringifyParameter($parameter) )); } diff --git a/src/ParameterResolutionerInterface.php b/src/ParameterResolutionerInterface.php index 255eca11..bfbd04ea 100644 --- a/src/ParameterResolutionerInterface.php +++ b/src/ParameterResolutionerInterface.php @@ -13,10 +13,9 @@ namespace Sunrise\Http\Router; -use Psr\Http\Message\RequestInterface; -use Sunrise\Http\Router\Exception\ResolvingParameterException; -use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; +use Generator; use ReflectionParameter; +use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; /** * ParameterResolutionerInterface @@ -27,15 +26,15 @@ interface ParameterResolutionerInterface { /** - * Creates a new instance of the resolutioner with the given current request + * Creates a new instance of the resolutioner with the given context * * Please note that this method MUST NOT change the object state. * - * @param RequestInterface $request + * @param mixed $context * * @return static */ - public function withRequest(RequestInterface $request): static; + public function withContext(mixed $context): static; /** * Creates a new instance of the resolutioner with the given priority parameter resolver(s) @@ -62,9 +61,7 @@ public function addResolver(ParameterResolverInterface ...$resolvers): void; * * @param ReflectionParameter ...$parameters * - * @return list List of ready-to-pass arguments. - * - * @throws ResolvingParameterException If one of the parameters cannot be resolved to an argument. + * @return Generator List of ready-to-pass arguments. */ - public function resolveParameters(ReflectionParameter ...$parameters): array; + public function resolveParameters(ReflectionParameter ...$parameters): Generator; } diff --git a/src/ParameterResolver/DependencyInjectionParameterResolver.php b/src/ParameterResolver/DependencyInjectionParameterResolver.php index fbe69553..ba6db34d 100644 --- a/src/ParameterResolver/DependencyInjectionParameterResolver.php +++ b/src/ParameterResolver/DependencyInjectionParameterResolver.php @@ -13,8 +13,8 @@ namespace Sunrise\Http\Router\ParameterResolver; +use Generator; use Psr\Container\ContainerInterface; -use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; @@ -38,25 +38,16 @@ public function __construct(private ContainerInterface $container) /** * @inheritDoc */ - public function supportsParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): bool + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { - return false; + return; } - return $this->container->has($type->getName()); - } - - /** - * @inheritDoc - */ - public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): mixed - { - /** @var ReflectionNamedType $type */ - $type = $parameter->getType(); - - return $this->container->get($type->getName()); + if ($this->container->has($type->getName())) { + yield $this->container->get($type->getName()); + } } } diff --git a/src/ParameterResolver/DirectInjectionParameterResolver.php b/src/ParameterResolver/DirectInjectionParameterResolver.php new file mode 100644 index 00000000..f285e48d --- /dev/null +++ b/src/ParameterResolver/DirectInjectionParameterResolver.php @@ -0,0 +1,54 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ParameterResolver; + +use Generator; +use ReflectionNamedType; +use ReflectionParameter; + +use function is_a; + +/** + * ObjectParameterResolver + * + * @since 3.0.0 + */ +final class DirectInjectionParameterResolver implements ParameterResolverInterface +{ + + /** + * Constructor of the class + * + * @param object $object + */ + public function __construct(private object $object) + { + } + + /** + * @inheritDoc + */ + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + { + $type = $parameter->getType(); + + if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { + return; + } + + if (is_a($this->object, $type->getName())) { + yield $this->object; + } + } +} diff --git a/src/ParameterResolver/ParameterResolverInterface.php b/src/ParameterResolver/ParameterResolverInterface.php index 39b1e0a4..6f29aaa7 100644 --- a/src/ParameterResolver/ParameterResolverInterface.php +++ b/src/ParameterResolver/ParameterResolverInterface.php @@ -13,8 +13,7 @@ namespace Sunrise\Http\Router\ParameterResolver; -use Psr\Http\Message\ServerRequestInterface; -use Sunrise\Http\Router\Exception\ResolvingParameterException; +use Generator; use ReflectionParameter; /** @@ -26,25 +25,12 @@ interface ParameterResolverInterface { /** - * Checks if the given parameter is supported + * Resolves the given parameter to an argument(s) * * @param ReflectionParameter $parameter - * @param ServerRequestInterface|null $request + * @param mixed $context * - * @return bool + * @return Generator */ - public function supportsParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): bool; - - /** - * Resolves the given parameter to an argument - * - * @param ReflectionParameter $parameter - * @param ServerRequestInterface|null $request - * - * @return mixed - * - * @throws ResolvingParameterException - * If the parameter cannot be resolved to an argument. - */ - public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): mixed; + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator; } diff --git a/src/ParameterResolver/RequestAttributeParameterResolver.php b/src/ParameterResolver/RequestAttributeParameterResolver.php new file mode 100644 index 00000000..5abf9040 --- /dev/null +++ b/src/ParameterResolver/RequestAttributeParameterResolver.php @@ -0,0 +1,56 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ParameterResolver; + +use Generator; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionParameter; +use Sunrise\Http\Router\Annotation\RequestAttribute; +use Sunrise\Http\Router\Exception\LogicException; + +/** + * RequestAttributeParameterResolver + * + * @since 3.0.0 + */ +final class RequestAttributeParameterResolver implements ParameterResolverInterface +{ + + /** + * @inheritDoc + */ + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + { + $attributes = $parameter->getAttributes(RequestAttribute::class); + if ($attributes === []) { + return; + } + + if (! $context instanceof ServerRequestInterface) { + throw new LogicException( + 'At this level of the application, any operations with the request are not possible.' + ); + } + + /** + * @var RequestAttribute $attribute + * @psalm-suppress UnnecessaryVarAnnotation + */ + $attribute = $attributes[0]->newInstance(); + + $value = $context->getAttribute($attribute->key); + + yield $value; + } +} diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 0e24286c..de28740a 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -13,16 +13,18 @@ namespace Sunrise\Http\Router\ParameterResolver; +use Generator; use Psr\Http\Message\ServerRequestInterface; +use ReflectionNamedType; +use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestBody; +use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\Exception\UnhydrableObjectException; use Sunrise\Http\Router\Exception\UnprocessableRequestBodyException; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; -use ReflectionNamedType; -use ReflectionParameter; /** * RequestBodyParameterResolver @@ -39,32 +41,10 @@ final class RequestBodyParameterResolver implements ParameterResolverInterface * Constructor of the class * * @param HydratorInterface $hydrator - * @param ValidatorInterface|null $validator - */ - public function __construct(private HydratorInterface $hydrator, private ?ValidatorInterface $validator = null) - { - } - - /** - * @inheritDoc + * @param ValidatorInterface $validator */ - public function supportsParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): bool + public function __construct(private HydratorInterface $hydrator, private ValidatorInterface $validator) { - if ($request === null) { - return false; - } - - $type = $parameter->getType(); - - if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { - return false; - } - - if ($parameter->getAttributes(RequestBody::class) === []) { - return false; - } - - return true; } /** @@ -75,30 +55,43 @@ public function supportsParameter(ReflectionParameter $parameter, ?ServerRequest * * @throws UnprocessableRequestBodyException * If the request's parsed body isn't valid. + * + * @throws LogicException + * If the resolver is used incorrectly. */ - public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): mixed + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - /** @var ReflectionNamedType $type */ + if ($parameter->getAttributes(RequestBody::class) === []) { + return; + } + $type = $parameter->getType(); - /** @var class-string $fqn */ - $fqn = $type->getName(); + if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { + throw new LogicException( + 'To use the #[RequestBody] attribute, the parameter must be typed with a DTO.' + ); + } + + if (! $context instanceof ServerRequestInterface) { + throw new LogicException( + 'At this level of the application, any operations with the request are not possible.' + ); + } try { - $object = $this->hydrator->hydrate($fqn, (array) $request?->getParsedBody()); + $object = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidObjectException $e) { throw new UnhydrableObjectException($e->getMessage(), 0, $e); } catch (InvalidDataException $e) { throw new UnprocessableRequestBodyException($e->getViolations()); } - if (isset($this->validator)) { - $violations = $this->validator->validate($object); - if ($violations->count() > 0) { - throw new UnprocessableRequestBodyException($violations); - } + $violations = $this->validator->validate($object); + if ($violations->count() > 0) { + throw new UnprocessableRequestBodyException($violations); } - return $object; + yield $object; } } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index a36e1042..50a2cfec 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -13,16 +13,18 @@ namespace Sunrise\Http\Router\ParameterResolver; +use Generator; use Psr\Http\Message\ServerRequestInterface; +use ReflectionNamedType; +use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestQuery; +use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\Exception\UnhydrableObjectException; use Sunrise\Http\Router\Exception\UnprocessableRequestQueryException; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; -use ReflectionNamedType; -use ReflectionParameter; /** * RequestQueryParameterResolver @@ -39,32 +41,10 @@ final class RequestQueryParameterResolver implements ParameterResolverInterface * Constructor of the class * * @param HydratorInterface $hydrator - * @param ValidatorInterface|null $validator - */ - public function __construct(private HydratorInterface $hydrator, private ?ValidatorInterface $validator = null) - { - } - - /** - * @inheritDoc + * @param ValidatorInterface $validator */ - public function supportsParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): bool + public function __construct(private HydratorInterface $hydrator, private ValidatorInterface $validator) { - if ($request === null) { - return false; - } - - $type = $parameter->getType(); - - if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { - return false; - } - - if ($parameter->getAttributes(RequestQuery::class) === []) { - return false; - } - - return true; } /** @@ -75,30 +55,43 @@ public function supportsParameter(ReflectionParameter $parameter, ?ServerRequest * * @throws UnprocessableRequestQueryException * If the request's query parameters isn't valid. + * + * @throws LogicException + * If the resolver is used incorrectly. */ - public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): mixed + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - /** @var ReflectionNamedType $type */ + if ($parameter->getAttributes(RequestQuery::class) === []) { + return; + } + $type = $parameter->getType(); - /** @var class-string $fqn */ - $fqn = $type->getName(); + if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { + throw new LogicException( + 'To use the #[RequestQuery] attribute, the parameter must be typed with a DTO.' + ); + } + + if (! $context instanceof ServerRequestInterface) { + throw new LogicException( + 'At this level of the application, any operations with the request are not possible.' + ); + } try { - $object = $this->hydrator->hydrate($fqn, (array) $request?->getQueryParams()); + $object = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidObjectException $e) { throw new UnhydrableObjectException($e->getMessage(), 0, $e); } catch (InvalidDataException $e) { throw new UnprocessableRequestQueryException($e->getViolations()); } - if (isset($this->validator)) { - $violations = $this->validator->validate($object); - if ($violations->count() > 0) { - throw new UnprocessableRequestQueryException($violations); - } + $violations = $this->validator->validate($object); + if ($violations->count() > 0) { + throw new UnprocessableRequestQueryException($violations); } - return $object; + yield $object; } } diff --git a/src/ParameterResolver/RequestRouteAttributeParameterResolver.php b/src/ParameterResolver/RequestRouteAttributeParameterResolver.php deleted file mode 100644 index c4755cd2..00000000 --- a/src/ParameterResolver/RequestRouteAttributeParameterResolver.php +++ /dev/null @@ -1,66 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ParameterResolver; - -use Psr\Http\Message\ServerRequestInterface; -use Sunrise\Http\Router\Annotation\RequestRouteAttribute; -use Sunrise\Http\Router\RouteInterface; -use ReflectionAttribute; -use ReflectionNamedType; -use ReflectionParameter; - -final class RequestRouteAttributeParameterResolver implements ParameterResolverInterface -{ - - /** - * @inheritDoc - */ - public function supportsParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): bool - { - if ($request === null) { - return false; - } - - $type = $parameter->getType(); - - if (! $type instanceof ReflectionNamedType || ! $type->isBuiltin()) { - return false; - } - - if ($parameter->getAttributes(RequestRouteAttribute::class) === []) { - return false; - } - - return true; - } - - /** - * @inheritDoc - */ - public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): mixed - { - /** @var non-empty-list> $annotations */ - $annotations = $parameter->getAttributes(RequestRouteAttribute::class); - - $key = $annotations[0]->newInstance()->name ?? $parameter->getName(); - - /** @var RouteInterface $route */ - $route = $request->getAttribute('@route'); - - /** @var mixed $value */ - $value = $route->getAttributes()[$key] ?? null; - - return $value; - } -} diff --git a/src/ParameterResolver/RequestRouteParameterResolver.php b/src/ParameterResolver/RequestRouteParameterResolver.php index fe64e2ac..5d1eb423 100644 --- a/src/ParameterResolver/RequestRouteParameterResolver.php +++ b/src/ParameterResolver/RequestRouteParameterResolver.php @@ -13,10 +13,12 @@ namespace Sunrise\Http\Router\ParameterResolver; +use Generator; use Psr\Http\Message\ServerRequestInterface; -use Sunrise\Http\Router\RouteInterface; use ReflectionNamedType; use ReflectionParameter; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\RouteInterface; /** * RequestRouteParameterResolver @@ -28,34 +30,37 @@ final class RequestRouteParameterResolver implements ParameterResolverInterface /** * @inheritDoc + * + * @throws LogicException + * If the resolver is used incorrectly. */ - public function supportsParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): bool + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - if ($request === null) { - return false; - } - $type = $parameter->getType(); - if (! $type instanceof ReflectionNamedType) { - return false; + if ( + ! ($type instanceof ReflectionNamedType) || + ! ($type->getName() === RouteInterface::class) + ) { + return; } - if (! ($type->getName() === RouteInterface::class)) { - return false; + if (! $context instanceof ServerRequestInterface) { + throw new LogicException( + 'At this level of the application, any operations with the request are not possible.' + ); } /** @var RouteInterface|null $route */ - $route = $request->getAttribute('@route'); + $route = $context->getAttribute('@route'); - return isset($route) || $type->allowsNull(); - } + if ($route === null && !$parameter->allowsNull()) { + throw new LogicException( + 'At this level of the application, the current request does not contain a route. ' . + 'To suppress this error, the parameter should be nullable.' + ); + } - /** - * @inheritDoc - */ - public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): mixed - { - return $request?->getAttribute('@route'); + yield $route; } } diff --git a/src/ParameterResolver/TypeParameterResolver.php b/src/ParameterResolver/TypeParameterResolver.php deleted file mode 100644 index 9c4b3858..00000000 --- a/src/ParameterResolver/TypeParameterResolver.php +++ /dev/null @@ -1,72 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ParameterResolver; - -use Psr\Http\Message\ServerRequestInterface; -use Sunrise\Http\Router\Exception\LogicException; -use ReflectionNamedType; -use ReflectionParameter; - -use function sprintf; - -/** - * TypeParameterResolver - * - * @since 3.0.0 - */ -final class TypeParameterResolver implements ParameterResolverInterface -{ - - /** - * Constructor of the class - * - * @param string $type - * @param object $value - * - * @throws LogicException - * If the value isn't an instance of the type. - */ - public function __construct(private string $type, private object $value) - { - if (! $this->value instanceof $this->type) { - throw new LogicException(sprintf( - 'The %1$s value must be an instance of %2$s.', - $this->value::class, - $this->type, - )); - } - } - - /** - * @inheritDoc - */ - public function supportsParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): bool - { - $type = $parameter->getType(); - - if (! $type instanceof ReflectionNamedType) { - return false; - } - - return $type->getName() === $this->type; - } - - /** - * @inheritDoc - */ - public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): mixed - { - return $this->value; - } -} diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index ca27e657..998ebfa7 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -17,7 +17,7 @@ use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Exception\ResolvingReferenceException; use Sunrise\Http\Router\Middleware\CallbackMiddleware; -use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; +use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; use Closure; use function get_debug_type; @@ -80,7 +80,7 @@ public function resolveRequestHandler($reference): RequestHandlerInterface } if ($reference instanceof Closure) { - return new CallableRequestHandler($reference, $this->parameterResolutioner, $this->responseResolutioner); + return new CallbackRequestHandler($reference, $this->parameterResolutioner, $this->responseResolutioner); } if (is_string($reference) && is_subclass_of($reference, RequestHandlerInterface::class)) { @@ -97,7 +97,7 @@ public function resolveRequestHandler($reference): RequestHandlerInterface $reference[0] = $this->classResolver->resolveClass($reference[0]); } - return new CallableRequestHandler( + return new CallbackRequestHandler( [$reference[0], $reference[1]], $this->parameterResolutioner, $this->responseResolutioner diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index a958a179..265a57a3 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -16,16 +16,11 @@ use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\ParameterResolver\TypeParameterResolver; -use Sunrise\Http\Router\ParameterResolutionerInterface; -use Sunrise\Http\Router\ResponseResolutionerInterface; -use ReflectionFunction; -use ReflectionMethod; - -use function Sunrise\Http\Router\reflect_callable; /** * CallableRequestHandler + * + * @template T as callable(ServerRequestInterface=): ResponseInterface */ final class CallableRequestHandler implements RequestHandlerInterface { @@ -33,51 +28,18 @@ final class CallableRequestHandler implements RequestHandlerInterface /** * The request handler's callback * - * @var callable + * @var T */ private $callback; - /** - * The callback's parameter resolutioner - * - * @var ParameterResolutionerInterface - */ - private ParameterResolutionerInterface $parameterResolutioner; - - /** - * The callback's response resolutioner - * - * @var ResponseResolutionerInterface - */ - private ResponseResolutionerInterface $responseResolutioner; - /** * Constructor of the class * - * @param callable $callback - * @param ParameterResolutionerInterface $parameterResolutioner - * @param ResponseResolutionerInterface $responseResolutioner + * @param T $callback */ - public function __construct( - callable $callback, - ParameterResolutionerInterface $parameterResolutioner, - ResponseResolutionerInterface $responseResolutioner - ) { - $this->callback = $callback; - $this->parameterResolutioner = $parameterResolutioner; - $this->responseResolutioner = $responseResolutioner; - } - - /** - * Gets the callback's reflection - * - * @return ReflectionFunction|ReflectionMethod - * - * @since 3.0.0 - */ - public function getReflection(): ReflectionFunction|ReflectionMethod + public function __construct(callable $callback) { - return reflect_callable($this->callback); + $this->callback = $callback; } /** @@ -85,14 +47,6 @@ public function getReflection(): ReflectionFunction|ReflectionMethod */ public function handle(ServerRequestInterface $request): ResponseInterface { - $arguments = $this->parameterResolutioner - ->withRequest($request) - ->withPriorityResolver(new TypeParameterResolver(ServerRequestInterface::class, $request)) - ->resolveParameters(...$this->getReflection()->getParameters()); - - /** @var mixed $response */ - $response = ($this->callback)(...$arguments); - - return $this->responseResolutioner->withRequest($request)->resolveResponse($response); + return ($this->callback)($request); } } diff --git a/src/RequestHandler/CallbackRequestHandler.php b/src/RequestHandler/CallbackRequestHandler.php new file mode 100644 index 00000000..ea009077 --- /dev/null +++ b/src/RequestHandler/CallbackRequestHandler.php @@ -0,0 +1,100 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\RequestHandler; + +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\RequestHandlerInterface; +use ReflectionFunction; +use ReflectionMethod; +use Sunrise\Http\Router\ParameterResolutionerInterface; +use Sunrise\Http\Router\ParameterResolver\DirectInjectionParameterResolver; +use Sunrise\Http\Router\ResponseResolutionerInterface; + +use function Sunrise\Http\Router\reflect_callable; + +/** + * CallbackRequestHandler + * + * @since 3.0.0 + */ +final class CallbackRequestHandler implements RequestHandlerInterface +{ + + /** + * The request handler's callback + * + * @var callable + */ + private $callback; + + /** + * The callback's parameter resolutioner + * + * @var ParameterResolutionerInterface + */ + private ParameterResolutionerInterface $parameterResolutioner; + + /** + * The callback's response resolutioner + * + * @var ResponseResolutionerInterface + */ + private ResponseResolutionerInterface $responseResolutioner; + + /** + * Constructor of the class + * + * @param callable $callback + * @param ParameterResolutionerInterface $parameterResolutioner + * @param ResponseResolutionerInterface $responseResolutioner + */ + public function __construct( + callable $callback, + ParameterResolutionerInterface $parameterResolutioner, + ResponseResolutionerInterface $responseResolutioner + ) { + $this->callback = $callback; + $this->parameterResolutioner = $parameterResolutioner; + $this->responseResolutioner = $responseResolutioner; + } + + /** + * Gets the callback's reflection + * + * @return ReflectionFunction|ReflectionMethod + */ + public function getReflection(): ReflectionFunction|ReflectionMethod + { + return reflect_callable($this->callback); + } + + /** + * @inheritDoc + */ + public function handle(ServerRequestInterface $request): ResponseInterface + { + $arguments = $this->parameterResolutioner + ->withContext($request) + ->withPriorityResolver( + new DirectInjectionParameterResolver($request), + ) + ->resolveParameters(...$this->getReflection()->getParameters()); + + /** @var mixed $response */ + $response = ($this->callback)(...$arguments); + + return $this->responseResolutioner->resolveResponse($response, $request); + } +} diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index 68c59ddf..3d036b60 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -26,28 +26,34 @@ final class QueueableRequestHandler implements RequestHandlerInterface { /** + * The request handler's middleware queue + * * @var SplQueue */ - private SplQueue $queue; + private SplQueue $middlewareQueue; /** + * The request handler's request handler + * * @var RequestHandlerInterface */ - private RequestHandlerInterface $endpoint; + private RequestHandlerInterface $requestHandler; /** * Constructor of the class * - * @param RequestHandlerInterface $endpoint + * @param RequestHandlerInterface $requestHandler */ - public function __construct(RequestHandlerInterface $endpoint) + public function __construct(RequestHandlerInterface $requestHandler) { - $this->queue = new SplQueue(); - $this->endpoint = $endpoint; + /** @var SplQueue */ + $this->middlewareQueue = new SplQueue(); + + $this->requestHandler = $requestHandler; } /** - * Adds the given middleware(s) to the request handler queue + * Adds the given middleware(s) to the request handler's middleware queue * * @param MiddlewareInterface ...$middlewares * @@ -56,7 +62,7 @@ public function __construct(RequestHandlerInterface $endpoint) public function add(MiddlewareInterface ...$middlewares): void { foreach ($middlewares as $middleware) { - $this->queue->enqueue($middleware); + $this->middlewareQueue->enqueue($middleware); } } @@ -65,10 +71,10 @@ public function add(MiddlewareInterface ...$middlewares): void */ public function handle(ServerRequestInterface $request): ResponseInterface { - if (!$this->queue->isEmpty()) { - return $this->queue->dequeue()->process($request, $this); + if (!$this->middlewareQueue->isEmpty()) { + return $this->middlewareQueue->dequeue()->process($request, $this); } - return $this->endpoint->handle($request); + return $this->requestHandler->handle($request); } } diff --git a/src/RequestHandler/UnsafeCallableRequestHandler.php b/src/RequestHandler/UnsafeCallableRequestHandler.php deleted file mode 100644 index 8e44a261..00000000 --- a/src/RequestHandler/UnsafeCallableRequestHandler.php +++ /dev/null @@ -1,54 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\RequestHandler; - -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\RequestHandlerInterface; - -/** - * UnsafeCallableRequestHandler - * - * @since 3.0.0 - * - * @template T as callable(ServerRequestInterface=): ResponseInterface - */ -final class UnsafeCallableRequestHandler implements RequestHandlerInterface -{ - - /** - * The request handler's callback - * - * @var T - */ - private $callback; - - /** - * Constructor of the class - * - * @param T $callback - */ - public function __construct(callable $callback) - { - $this->callback = $callback; - } - - /** - * @inheritDoc - */ - public function handle(ServerRequestInterface $request): ResponseInterface - { - return ($this->callback)($request); - } -} diff --git a/src/ResponseResolutioner.php b/src/ResponseResolutioner.php index f3aac200..7408518f 100644 --- a/src/ResponseResolutioner.php +++ b/src/ResponseResolutioner.php @@ -13,9 +13,8 @@ namespace Sunrise\Http\Router; -use Psr\Http\Message\RequestInterface; use Psr\Http\Message\ResponseInterface; -use Sunrise\Http\Router\Exception\ResolvingResponseException; +use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; use function get_debug_type; @@ -29,27 +28,11 @@ final class ResponseResolutioner implements ResponseResolutionerInterface { - /** - * @var RequestInterface|null - */ - private ?RequestInterface $request = null; - /** * @var list */ private array $resolvers = []; - /** - * @inheritDoc - */ - public function withRequest(RequestInterface $context): static - { - $clone = clone $this; - $clone->request = $context; - - return $clone; - } - /** * @inheritDoc */ @@ -62,22 +45,25 @@ public function addResolver(ResponseResolverInterface ...$resolvers): void /** * @inheritDoc + * + * @throws LogicException If the value cannot be resolved to PSR-7 response. */ - public function resolveResponse($response): ResponseInterface + public function resolveResponse(mixed $value, mixed $context): ResponseInterface { - if ($response instanceof ResponseInterface) { - return $response; + if ($value instanceof ResponseInterface) { + return $value; } foreach ($this->resolvers as $resolver) { - if ($resolver->supportsResponse($response, $this->request)) { - return $resolver->resolveResponse($response, $this->request); + $response = $resolver->resolveResponse($value, $context); + if ($response instanceof ResponseInterface) { + return $response; } } - throw new ResolvingResponseException(sprintf( - 'Unable to resolve the response {%s}', - get_debug_type($response), + throw new LogicException(sprintf( + 'Unable to resolve the value {%s} to PSR-7 response.', + get_debug_type($value), )); } } diff --git a/src/ResponseResolutionerInterface.php b/src/ResponseResolutionerInterface.php index 6818d72c..681967fb 100644 --- a/src/ResponseResolutionerInterface.php +++ b/src/ResponseResolutionerInterface.php @@ -13,9 +13,7 @@ namespace Sunrise\Http\Router; -use Psr\Http\Message\RequestInterface; use Psr\Http\Message\ResponseInterface; -use Sunrise\Http\Router\Exception\ResolvingResponseException; use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; /** @@ -26,17 +24,6 @@ interface ResponseResolutionerInterface { - /** - * Creates a new instance of the resolutioner with the given current context - * - * Please note that this method MUST NOT change the object state. - * - * @param RequestInterface $context - * - * @return static - */ - public function withRequest(RequestInterface $context): static; - /** * Adds the given response resolver(s) to the resolutioner * @@ -47,14 +34,12 @@ public function withRequest(RequestInterface $context): static; public function addResolver(ResponseResolverInterface ...$resolvers): void; /** - * Resolves the given raw response to the object + * Resolves the given value to PSR-7 response * - * @param mixed $response + * @param mixed $value + * @param mixed $context * * @return ResponseInterface - * - * @throws ResolvingResponseException - * If the raw response cannot be resolved to the object. */ - public function resolveResponse($response): ResponseInterface; + public function resolveResponse(mixed $value, mixed $context): ResponseInterface; } diff --git a/src/ResponseResolver/NullResponseResolver.php b/src/ResponseResolver/NullResponseResolver.php new file mode 100644 index 00000000..2332a0f3 --- /dev/null +++ b/src/ResponseResolver/NullResponseResolver.php @@ -0,0 +1,47 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ResponseResolver; + +use Psr\Http\Message\ResponseFactoryInterface; +use Psr\Http\Message\ResponseInterface; + +/** + * NullResponseResolver + * + * @since 3.0.0 + */ +final class NullResponseResolver implements ResponseResolverInterface +{ + + /** + * Constructor of the class + * + * @param ResponseFactoryInterface $responseFactory + */ + public function __construct(private ResponseFactoryInterface $responseFactory) + { + } + + /** + * @inheritDoc + */ + public function resolveResponse(mixed $value, mixed $context): ?ResponseInterface + { + if ($value === null) { + return $this->responseFactory->createResponse(204); + } + + return null; + } +} diff --git a/src/ResponseResolver/ObjectResponseResolver.php b/src/ResponseResolver/ObjectResponseResolver.php deleted file mode 100644 index bea2558b..00000000 --- a/src/ResponseResolver/ObjectResponseResolver.php +++ /dev/null @@ -1,56 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ResponseResolver; - -use Psr\Http\Message\ResponseFactoryInterface; -use Psr\Http\Message\ResponseInterface; -use Sunrise\Http\Router\Annotation\ResponseBody; -use ReflectionClass; - -use function is_object; - -/** - * ObjectResponseResolver - * - * @since 3.0.0 - */ -final class ObjectResponseResolver implements ResponseResolverInterface -{ - public function __construct( - private ResponseFactoryInterface $responseFactory, - ) { - } - - /** - * @inheritDoc - */ - public function supportsResponse($response, $context): bool - { - if (!is_object($response)) { - return false; - } - - return true; - } - - /** - * @inheritDoc - */ - public function resolveResponse($response, $context): ResponseInterface - { - $attributes = (new ReflectionClass($response))->getAttributes(ResponseBody::class); - - return $this->responseFactory->createResponse(200); - } -} diff --git a/src/ResponseResolver/ResponseBodyResponseResolver.php b/src/ResponseResolver/ResponseBodyResponseResolver.php new file mode 100644 index 00000000..ad751d92 --- /dev/null +++ b/src/ResponseResolver/ResponseBodyResponseResolver.php @@ -0,0 +1,88 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ResponseResolver; + +use Psr\Http\Message\ResponseFactoryInterface; +use Psr\Http\Message\ResponseInterface; +use ReflectionClass; +use Sunrise\Http\Router\Annotation\ResponseBody; +use Sunrise\Http\Router\Entity\MediaType; +use Symfony\Component\Serializer\SerializerInterface; + +use function is_object; + +/** + * ResponseBodyResponseResolver + * + * @since 3.0.0 + */ +final class ResponseBodyResponseResolver implements ResponseResolverInterface +{ + + /** + * Constructor of the class + * + * @param SerializerInterface $serializer + * @param ResponseFactoryInterface $responseFactory + */ + public function __construct( + private SerializerInterface $serializer, + private ResponseFactoryInterface $responseFactory, + ) { + } + + /** + * @inheritDoc + */ + public function resolveResponse(mixed $value, mixed $context): ?ResponseInterface + { + if (!is_object($value)) { + return null; + } + + $class = new ReflectionClass($value::class); + $attributes = $class->getAttributes(ResponseBody::class); + if ($attributes === []) { + return null; + } + + /** + * @var ResponseBody $responseBody + * @psalm-suppress UnnecessaryVarAnnotation + */ + $responseBody = $attributes[0]->newInstance(); + + $response = $this->responseFactory->createResponse($responseBody->statusCode); + + $mediaType = match ($responseBody->format) { + ResponseBody::FORMAT_CSV => MediaType::TEXT_CSV, + ResponseBody::FORMAT_JSON => MediaType::APPLICATION_JSON, + ResponseBody::FORMAT_XML => MediaType::APPLICATION_XML, + ResponseBody::FORMAT_YAML => MediaType::APPLICATION_YAML, + default => null, + }; + + if (isset($mediaType)) { + $response = $response->withHeader('Content-Type', $mediaType); + } + + foreach ($responseBody->headers as $name => $header) { + $response = $response->withHeader($name, $header); + } + + $response->getBody()->write($this->serializer->serialize($value, $responseBody->format)); + + return $response; + } +} diff --git a/src/ResponseResolver/ResponseResolverInterface.php b/src/ResponseResolver/ResponseResolverInterface.php index f332668e..49c32860 100644 --- a/src/ResponseResolver/ResponseResolverInterface.php +++ b/src/ResponseResolver/ResponseResolverInterface.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router\ResponseResolver; use Psr\Http\Message\ResponseInterface; -use Sunrise\Http\Router\Exception\ResolvingResponseException; /** * ResponseResolverInterface @@ -25,25 +24,12 @@ interface ResponseResolverInterface { /** - * Checks if the given raw response is supported + * Resolves the given value to PSR-7 response * - * @param mixed $response + * @param mixed $value * @param mixed $context * - * @return bool + * @return ResponseInterface|null */ - public function supportsResponse(mixed $response, mixed $context): bool; - - /** - * Resolves the given raw response to the object - * - * @param mixed $response - * @param mixed $context - * - * @return ResponseInterface - * - * @throws ResolvingResponseException - * If the raw response cannot be resolved to the object. - */ - public function resolveResponse(mixed $response, mixed $context): ResponseInterface; + public function resolveResponse(mixed $value, mixed $context): ?ResponseInterface; } diff --git a/src/ResponseResolver/RouteResponseResolver.php b/src/ResponseResolver/RouteResponseResolver.php index adc6bd7d..ca38ee0e 100644 --- a/src/ResponseResolver/RouteResponseResolver.php +++ b/src/ResponseResolver/RouteResponseResolver.php @@ -15,6 +15,7 @@ use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; +use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\RouteInterface; /** @@ -27,28 +28,22 @@ final class RouteResponseResolver implements ResponseResolverInterface /** * @inheritDoc + * + * @throws LogicException + * If the resolver is used incorrectly. */ - public function supportsResponse(mixed $response, mixed $context): bool + public function resolveResponse(mixed $value, mixed $context): ?ResponseInterface { - if (!($context instanceof ServerRequestInterface)) { - return false; + if (! $value instanceof RouteInterface) { + return null; } - if (!($response instanceof RouteInterface)) { - return false; + if (! $context instanceof ServerRequestInterface) { + throw new LogicException( + 'At this level of the application, any operations with the request are not possible.' + ); } - return true; - } - - /** - * @inheritDoc - */ - public function resolveResponse(mixed $response, mixed $context): ResponseInterface - { - /** @var RouteInterface $response */ - /** @var ServerRequestInterface $context */ - - return $response->handle($context); + return $value->handle($context); } } diff --git a/src/ResponseResolver/StatusCodeResponseResolver.php b/src/ResponseResolver/StatusCodeResponseResolver.php index 8f725123..24e6f66a 100644 --- a/src/ResponseResolver/StatusCodeResponseResolver.php +++ b/src/ResponseResolver/StatusCodeResponseResolver.php @@ -15,6 +15,7 @@ use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; + use function is_int; /** @@ -26,33 +27,23 @@ final class StatusCodeResponseResolver implements ResponseResolverInterface { /** - * @var ResponseFactoryInterface - */ - private ResponseFactoryInterface $responseFactory; - - /** + * Constructor of the class + * * @param ResponseFactoryInterface $responseFactory */ - public function __construct(ResponseFactoryInterface $responseFactory) - { - $this->responseFactory = $responseFactory; - } - - /** - * @inheritDoc - */ - public function supportsResponse($response, $context): bool + public function __construct(private ResponseFactoryInterface $responseFactory) { - return is_int($response) && $response >= 100 && $response <= 599; } /** * @inheritDoc */ - public function resolveResponse($response, $context): ResponseInterface + public function resolveResponse(mixed $value, mixed $context): ?ResponseInterface { - /** @var int<100, 599> $response */ + if (is_int($value) && $value >= 100 && $value <= 599) { + return $this->responseFactory->createResponse($value); + } - return $this->responseFactory->createResponse($response); + return null; } } diff --git a/src/ResponseResolver/UriResponseResolver.php b/src/ResponseResolver/UriResponseResolver.php new file mode 100644 index 00000000..5638a5f7 --- /dev/null +++ b/src/ResponseResolver/UriResponseResolver.php @@ -0,0 +1,49 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ResponseResolver; + +use Psr\Http\Message\ResponseFactoryInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\UriInterface; + +/** + * UriResponseResolver + * + * @since 3.0.0 + */ +final class UriResponseResolver implements ResponseResolverInterface +{ + + /** + * Constructor of the class + * + * @param ResponseFactoryInterface $responseFactory + */ + public function __construct(private ResponseFactoryInterface $responseFactory) + { + } + + /** + * @inheritDoc + */ + public function resolveResponse(mixed $value, mixed $context): ?ResponseInterface + { + if (! $value instanceof UriInterface) { + return null; + } + + return $this->responseFactory->createResponse(302) + ->withHeader('Location', $value->__toString()); + } +} diff --git a/src/Route.php b/src/Route.php index 388dcee4..af224fa5 100644 --- a/src/Route.php +++ b/src/Route.php @@ -17,7 +17,7 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; +use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; use ReflectionClass; use Reflector; @@ -244,7 +244,7 @@ public function getTags(): array */ public function getHolder(): Reflector { - if ($this->requestHandler instanceof CallableRequestHandler) { + if ($this->requestHandler instanceof CallbackRequestHandler) { return $this->requestHandler->getReflection(); } diff --git a/src/Router.php b/src/Router.php index 1d7da240..540fe8a2 100644 --- a/src/Router.php +++ b/src/Router.php @@ -27,7 +27,7 @@ use Sunrise\Http\Router\Exception\PageNotFoundException; use Sunrise\Http\Router\Loader\LoaderInterface; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; -use Sunrise\Http\Router\RequestHandler\UnsafeCallableRequestHandler; +use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use function array_keys; use function Sunrise\Http\Router\path_build; @@ -306,7 +306,7 @@ public function match(ServerRequestInterface $request): RouteInterface public function run(ServerRequestInterface $request): ResponseInterface { // lazy resolving of the given request... - $routing = new UnsafeCallableRequestHandler( + $routing = new CallableRequestHandler( function (ServerRequestInterface $request): ResponseInterface { $this->matchedRoute = $this->match($request); diff --git a/tests/RequestHandler/CallableRequestHandlerTest.php b/tests/RequestHandler/CallableRequestHandlerTest.php index cfe1791e..9cbdba6f 100644 --- a/tests/RequestHandler/CallableRequestHandlerTest.php +++ b/tests/RequestHandler/CallableRequestHandlerTest.php @@ -5,7 +5,7 @@ use PHPUnit\Framework\TestCase; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; +use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; use Sunrise\Http\Router\Tests\Fixtures; /** @@ -20,7 +20,7 @@ class CallableRequestHandlerTest extends TestCase public function testContracts() : void { $callback = new Fixtures\Controllers\BlankController(); - $requestHandler = new CallableRequestHandler($callback); + $requestHandler = new CallbackRequestHandler($callback); $this->assertInstanceOf(RequestHandlerInterface::class, $requestHandler); } @@ -31,7 +31,7 @@ public function testContracts() : void public function testRun() : void { $callback = new Fixtures\Controllers\BlankController(); - $requestHandler = new CallableRequestHandler($callback); + $requestHandler = new CallbackRequestHandler($callback); $this->assertSame($callback, $requestHandler->getCallback()); diff --git a/tests/RouteTest.php b/tests/RouteTest.php index f5fdd706..20fe0a05 100644 --- a/tests/RouteTest.php +++ b/tests/RouteTest.php @@ -3,7 +3,7 @@ namespace Sunrise\Http\Router\Tests; use PHPUnit\Framework\TestCase; -use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; +use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; use Sunrise\Http\Router\Route; use Sunrise\Http\Router\RouteInterface; use Sunrise\Http\ServerRequest\ServerRequestFactory; @@ -383,7 +383,7 @@ public function testGetClosureHolder() : void $callback = function () { }; - $route = new Route('foo', '/foo', [], new CallableRequestHandler($callback)); + $route = new Route('foo', '/foo', [], new CallbackRequestHandler($callback)); $holder = $route->getHolder(); $this->assertInstanceOf(\ReflectionFunction::class, $holder); @@ -398,7 +398,7 @@ public function testGetMethodHolder() : void $class = new Fixtures\Controllers\BlankController(); $method = '__invoke'; - $route = new Route('foo', '/foo', [], new CallableRequestHandler([$class, $method])); + $route = new Route('foo', '/foo', [], new CallbackRequestHandler([$class, $method])); $holder = $route->getHolder(); $this->assertInstanceOf(\ReflectionMethod::class, $holder); From 181775f8d094d4786f65c0ae90aba7dc08d728ea Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Wed, 2 Aug 2023 03:32:03 +0200 Subject: [PATCH 076/180] v3 --- composer.json | 2 +- ...ike_header.php => parse_accept_header.php} | 0 src/Annotation/ResponseBody.php | 21 +--- src/Annotation/ResponseHeader.php | 34 ++++++ ...equestAttribute.php => ResponseStatus.php} | 9 +- src/Command/RouteListCommand.php | 3 +- src/Entity/MediaType.php | 2 + src/Loader/ConfigLoader.php | 6 +- src/Loader/DescriptorLoader.php | 8 +- src/Middleware/CallbackMiddleware.php | 12 +- .../JsonPayloadDecodingMiddleware.php | 12 +- .../SimdJsonPayloadDecodingMiddleware.php | 12 +- src/ParameterResolutioner.php | 6 +- ...p => ObjectInjectionParameterResolver.php} | 4 +- .../RequestAttributeParameterResolver.php | 56 --------- .../RequestBodyParameterResolver.php | 21 ++-- .../RequestQueryParameterResolver.php | 21 ++-- .../RequestRouteParameterResolver.php | 15 ++- src/ReferenceResolver.php | 37 +++--- src/ReferenceResolverInterface.php | 19 +--- src/RequestHandler/CallbackRequestHandler.php | 10 +- .../QueueableRequestHandler.php | 1 - src/ResponseResolutioner.php | 84 ++++++++++++-- src/ResponseResolutionerInterface.php | 16 ++- ...Resolver.php => EmptyResponseResolver.php} | 16 ++- .../ResponseBodyResponseResolver.php | 106 ++++++++++++------ .../ResponseResolverInterface.php | 16 ++- .../RouteResponseResolver.php | 25 ++--- ...esolver.php => StreamResponseResolver.php} | 22 ++-- src/ResponseResolver/UriResponseResolver.php | 18 ++- src/Route.php | 4 +- src/RouteCollector.php | 5 +- src/RouteInterface.php | 2 +- src/ServerRequest.php | 2 +- 34 files changed, 364 insertions(+), 263 deletions(-) rename functions/{parse_accept_like_header.php => parse_accept_header.php} (100%) create mode 100644 src/Annotation/ResponseHeader.php rename src/Annotation/{RequestAttribute.php => ResponseStatus.php} (65%) rename src/ParameterResolver/{DirectInjectionParameterResolver.php => ObjectInjectionParameterResolver.php} (91%) delete mode 100644 src/ParameterResolver/RequestAttributeParameterResolver.php rename src/ResponseResolver/{NullResponseResolver.php => EmptyResponseResolver.php} (67%) rename src/ResponseResolver/{StatusCodeResponseResolver.php => StreamResponseResolver.php} (58%) diff --git a/composer.json b/composer.json index 3b8c4b5e..736e4d2c 100644 --- a/composer.json +++ b/composer.json @@ -41,7 +41,7 @@ }, "require-dev": { "phpunit/phpunit": "^9.6", - "vimeo/psalm": "^5.13", + "vimeo/psalm": "^5.14", "sunrise/coding-standard": "^1.0", "sunrise/http-message": "^3.0", "symfony/console": "^6.0" diff --git a/functions/parse_accept_like_header.php b/functions/parse_accept_header.php similarity index 100% rename from functions/parse_accept_like_header.php rename to functions/parse_accept_header.php diff --git a/src/Annotation/ResponseBody.php b/src/Annotation/ResponseBody.php index 6b62561e..bc866170 100644 --- a/src/Annotation/ResponseBody.php +++ b/src/Annotation/ResponseBody.php @@ -14,30 +14,11 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Fig\Http\Message\StatusCodeInterface; /** * @since 3.0.0 */ -#[Attribute(Attribute::TARGET_CLASS)] +#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] final class ResponseBody { - public const FORMAT_CSV = 'csv'; - public const FORMAT_JSON = 'json'; - public const FORMAT_XML = 'xml'; - public const FORMAT_YAML = 'yaml'; - - /** - * Constructor of the class - * - * @param int<100, 599> $statusCode - * @param array> $headers - * @param non-empty-string $format - */ - public function __construct( - public int $statusCode = StatusCodeInterface::STATUS_OK, - public array $headers = [], - public string $format = self::FORMAT_JSON, - ) { - } } diff --git a/src/Annotation/ResponseHeader.php b/src/Annotation/ResponseHeader.php new file mode 100644 index 00000000..b640211b --- /dev/null +++ b/src/Annotation/ResponseHeader.php @@ -0,0 +1,34 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION | Attribute::IS_REPEATABLE)] +final class ResponseHeader +{ + + /** + * Constructor of the class + * + * @param non-empty-string $name + * @param string $value + */ + public function __construct(public string $name, public string $value) + { + } +} diff --git a/src/Annotation/RequestAttribute.php b/src/Annotation/ResponseStatus.php similarity index 65% rename from src/Annotation/RequestAttribute.php rename to src/Annotation/ResponseStatus.php index 80a02a59..09c57642 100644 --- a/src/Annotation/RequestAttribute.php +++ b/src/Annotation/ResponseStatus.php @@ -14,20 +14,21 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; +use Fig\Http\Message\StatusCodeInterface; /** * @since 3.0.0 */ -#[Attribute(Attribute::TARGET_PARAMETER)] -final class RequestAttribute +#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] +final class ResponseStatus implements StatusCodeInterface { /** * Constructor of the class * - * @param non-empty-string|null $key + * @param int<100, 599> $code */ - public function __construct(public ?string $key = null) + public function __construct(public int $code) { } } diff --git a/src/Command/RouteListCommand.php b/src/Command/RouteListCommand.php index bc073ca5..fb4b9a63 100644 --- a/src/Command/RouteListCommand.php +++ b/src/Command/RouteListCommand.php @@ -48,8 +48,7 @@ public function __construct(private ?Router $router = null) * * @return Router * - * @throws LogicException - * If the command doesn't contain the router instance. + * @throws LogicException If the command doesn't contain the router instance. * * @since 2.11.0 */ diff --git a/src/Entity/MediaType.php b/src/Entity/MediaType.php index 80e5a137..289b1440 100644 --- a/src/Entity/MediaType.php +++ b/src/Entity/MediaType.php @@ -24,6 +24,8 @@ final class MediaType public const APPLICATION_XML = 'application/xml'; public const APPLICATION_YAML = 'application/yaml'; public const TEXT_CSV = 'text/csv'; + public const TEXT_HTML = 'text/html'; + public const TEXT_PLAIN = 'text/plain'; public const TEXT_XML = 'text/xml'; /** diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index b8ab7444..85677f98 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -177,8 +177,7 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo /** * @inheritDoc * - * @throws InvalidArgumentException - * If the resource isn't valid. + * @throws InvalidArgumentException If the resource isn't valid. */ public function attach(mixed $resource): void { @@ -212,8 +211,7 @@ public function attach(mixed $resource): void /** * @inheritDoc * - * @throws InvalidArgumentException - * If one of the given resources isn't valid. + * @throws InvalidArgumentException If one of the given resources isn't valid. */ public function attachArray(array $resources): void { diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 82a783d5..0354769a 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -258,8 +258,7 @@ public function getCacheKey(): string /** * @inheritDoc * - * @throws InvalidArgumentException - * If the resource isn't valid. + * @throws InvalidArgumentException If the resource isn't valid. */ public function attach(mixed $resource): void { @@ -283,8 +282,7 @@ public function attach(mixed $resource): void /** * @inheritDoc * - * @throws InvalidArgumentException - * If one of the given resources isn't valid. + * @throws InvalidArgumentException If one of the given resources isn't valid. */ public function attachArray(array $resources): void { @@ -307,7 +305,7 @@ public function load(): RouteCollectionInterface $descriptor->path, $descriptor->methods, $this->referenceResolver->resolveRequestHandler($descriptor->holder), - $this->referenceResolver->resolveMiddlewares($descriptor->middlewares), + [...$this->referenceResolver->resolveMiddlewares($descriptor->middlewares)], $descriptor->attributes, ); diff --git a/src/Middleware/CallbackMiddleware.php b/src/Middleware/CallbackMiddleware.php index 204433be..d68d1b58 100644 --- a/src/Middleware/CallbackMiddleware.php +++ b/src/Middleware/CallbackMiddleware.php @@ -20,7 +20,7 @@ use ReflectionFunction; use ReflectionMethod; use Sunrise\Http\Router\ParameterResolutionerInterface; -use Sunrise\Http\Router\ParameterResolver\DirectInjectionParameterResolver; +use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; use Sunrise\Http\Router\ResponseResolutionerInterface; use function Sunrise\Http\Router\reflect_callable; @@ -86,17 +86,19 @@ public function getReflection(): ReflectionFunction|ReflectionMethod */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { + $source = $this->getReflection(); + $arguments = $this->parameterResolutioner ->withContext($request) ->withPriorityResolver( - new DirectInjectionParameterResolver($request), - new DirectInjectionParameterResolver($handler), + new ObjectInjectionParameterResolver($request), + new ObjectInjectionParameterResolver($handler), ) - ->resolveParameters(...$this->getReflection()->getParameters()); + ->resolveParameters(...$source->getParameters()); /** @var mixed $response */ $response = ($this->callback)(...$arguments); - return $this->responseResolutioner->resolveResponse($response, $request); + return $this->responseResolutioner->resolveResponse($response, $request, $source); } } diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index db020f27..3d1d362d 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -43,8 +43,7 @@ final class JsonPayloadDecodingMiddleware implements MiddlewareInterface /** * Constructor of the class * - * @throws LogicException - * If the JSON extension isn't loaded. + * @throws LogicException If the JSON extension isn't loaded. */ public function __construct() { @@ -61,7 +60,11 @@ public function __construct() public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { if (ServerRequest::from($request)->isJson()) { - $request = $request->withParsedBody($this->decodePayload($request->getBody()->__toString())); + $request = $request->withParsedBody( + $this->decodePayload( + $request->getBody()->__toString() + ) + ); } return $handler->handle($request); @@ -74,8 +77,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface * * @return array * - * @throws InvalidRequestPayloadException - * If the JSON payload cannot be decoded. + * @throws InvalidRequestPayloadException If the JSON payload cannot be decoded. */ private function decodePayload(string $payload): array { diff --git a/src/Middleware/SimdJsonPayloadDecodingMiddleware.php b/src/Middleware/SimdJsonPayloadDecodingMiddleware.php index 168fd009..a24da152 100644 --- a/src/Middleware/SimdJsonPayloadDecodingMiddleware.php +++ b/src/Middleware/SimdJsonPayloadDecodingMiddleware.php @@ -40,8 +40,7 @@ final class SimdJsonPayloadDecodingMiddleware implements MiddlewareInterface /** * Constructor of the class * - * @throws LogicException - * If the Simdjson extension isn't loaded. + * @throws LogicException If the Simdjson extension isn't loaded. */ public function __construct() { @@ -58,7 +57,11 @@ public function __construct() public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { if (ServerRequest::from($request)->isJson()) { - $request = $request->withParsedBody($this->decodePayload($request->getBody()->__toString())); + $request = $request->withParsedBody( + $this->decodePayload( + $request->getBody()->__toString() + ) + ); } return $handler->handle($request); @@ -71,8 +74,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface * * @return array * - * @throws InvalidRequestPayloadException - * If the JSON payload cannot be decoded. + * @throws InvalidRequestPayloadException If the JSON payload cannot be decoded. */ private function decodePayload(string $payload): array { diff --git a/src/ParameterResolutioner.php b/src/ParameterResolutioner.php index 431f1d27..87148307 100644 --- a/src/ParameterResolutioner.php +++ b/src/ParameterResolutioner.php @@ -115,7 +115,7 @@ private function resolveParameter(ReflectionParameter $parameter): Generator throw new LogicException(sprintf( 'Unable to resolve the parameter {%s}.', - $this->stringifyParameter($parameter) + self::stringifyParameter($parameter) )); } @@ -124,9 +124,9 @@ private function resolveParameter(ReflectionParameter $parameter): Generator * * @param ReflectionParameter $parameter * - * @return string + * @return non-empty-string */ - private function stringifyParameter(ReflectionParameter $parameter): string + public static function stringifyParameter(ReflectionParameter $parameter): string { if ($parameter->getDeclaringFunction() instanceof ReflectionMethod) { return sprintf( diff --git a/src/ParameterResolver/DirectInjectionParameterResolver.php b/src/ParameterResolver/ObjectInjectionParameterResolver.php similarity index 91% rename from src/ParameterResolver/DirectInjectionParameterResolver.php rename to src/ParameterResolver/ObjectInjectionParameterResolver.php index f285e48d..dd3087e9 100644 --- a/src/ParameterResolver/DirectInjectionParameterResolver.php +++ b/src/ParameterResolver/ObjectInjectionParameterResolver.php @@ -20,11 +20,11 @@ use function is_a; /** - * ObjectParameterResolver + * ObjectInjectionParameterResolver * * @since 3.0.0 */ -final class DirectInjectionParameterResolver implements ParameterResolverInterface +final class ObjectInjectionParameterResolver implements ParameterResolverInterface { /** diff --git a/src/ParameterResolver/RequestAttributeParameterResolver.php b/src/ParameterResolver/RequestAttributeParameterResolver.php deleted file mode 100644 index 5abf9040..00000000 --- a/src/ParameterResolver/RequestAttributeParameterResolver.php +++ /dev/null @@ -1,56 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ParameterResolver; - -use Generator; -use Psr\Http\Message\ServerRequestInterface; -use ReflectionParameter; -use Sunrise\Http\Router\Annotation\RequestAttribute; -use Sunrise\Http\Router\Exception\LogicException; - -/** - * RequestAttributeParameterResolver - * - * @since 3.0.0 - */ -final class RequestAttributeParameterResolver implements ParameterResolverInterface -{ - - /** - * @inheritDoc - */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator - { - $attributes = $parameter->getAttributes(RequestAttribute::class); - if ($attributes === []) { - return; - } - - if (! $context instanceof ServerRequestInterface) { - throw new LogicException( - 'At this level of the application, any operations with the request are not possible.' - ); - } - - /** - * @var RequestAttribute $attribute - * @psalm-suppress UnnecessaryVarAnnotation - */ - $attribute = $attributes[0]->newInstance(); - - $value = $context->getAttribute($attribute->key); - - yield $value; - } -} diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index de28740a..78081a2c 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -21,11 +21,14 @@ use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\Exception\UnhydrableObjectException; use Sunrise\Http\Router\Exception\UnprocessableRequestBodyException; +use Sunrise\Http\Router\ParameterResolutioner; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; +use function sprintf; + /** * RequestBodyParameterResolver * @@ -50,14 +53,9 @@ public function __construct(private HydratorInterface $hydrator, private Validat /** * @inheritDoc * - * @throws UnhydrableObjectException - * If an object isn't valid. - * - * @throws UnprocessableRequestBodyException - * If the request's parsed body isn't valid. - * - * @throws LogicException - * If the resolver is used incorrectly. + * @throws UnhydrableObjectException If an object isn't valid. + * @throws UnprocessableRequestBodyException If the request's parsed body isn't valid. + * @throws LogicException If the resolver is used incorrectly. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -68,9 +66,10 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { - throw new LogicException( - 'To use the #[RequestBody] attribute, the parameter must be typed with a DTO.' - ); + throw new LogicException(sprintf( + 'To use the #[RequestBody] attribute, the parameter {%s} must be typed with an object.', + ParameterResolutioner::stringifyParameter($parameter), + )); } if (! $context instanceof ServerRequestInterface) { diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 50a2cfec..9aea6c02 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -21,11 +21,14 @@ use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\Exception\UnhydrableObjectException; use Sunrise\Http\Router\Exception\UnprocessableRequestQueryException; +use Sunrise\Http\Router\ParameterResolutioner; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; +use function sprintf; + /** * RequestQueryParameterResolver * @@ -50,14 +53,9 @@ public function __construct(private HydratorInterface $hydrator, private Validat /** * @inheritDoc * - * @throws UnhydrableObjectException - * If an object isn't valid. - * - * @throws UnprocessableRequestQueryException - * If the request's query parameters isn't valid. - * - * @throws LogicException - * If the resolver is used incorrectly. + * @throws UnhydrableObjectException If an object isn't valid. + * @throws UnprocessableRequestQueryException If the request's query parameters isn't valid. + * @throws LogicException If the resolver is used incorrectly. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -68,9 +66,10 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { - throw new LogicException( - 'To use the #[RequestQuery] attribute, the parameter must be typed with a DTO.' - ); + throw new LogicException(sprintf( + 'To use the #[RequestQuery] attribute, the parameter {%s} must be typed with an object.', + ParameterResolutioner::stringifyParameter($parameter), + )); } if (! $context instanceof ServerRequestInterface) { diff --git a/src/ParameterResolver/RequestRouteParameterResolver.php b/src/ParameterResolver/RequestRouteParameterResolver.php index 5d1eb423..df975527 100644 --- a/src/ParameterResolver/RequestRouteParameterResolver.php +++ b/src/ParameterResolver/RequestRouteParameterResolver.php @@ -18,8 +18,11 @@ use ReflectionNamedType; use ReflectionParameter; use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ParameterResolutioner; use Sunrise\Http\Router\RouteInterface; +use function sprintf; + /** * RequestRouteParameterResolver * @@ -31,8 +34,7 @@ final class RequestRouteParameterResolver implements ParameterResolverInterface /** * @inheritDoc * - * @throws LogicException - * If the resolver is used incorrectly. + * @throws LogicException If the resolver is used incorrectly. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -54,11 +56,12 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) /** @var RouteInterface|null $route */ $route = $context->getAttribute('@route'); - if ($route === null && !$parameter->allowsNull()) { - throw new LogicException( + if (! $route instanceof RouteInterface && !$parameter->allowsNull()) { + throw new LogicException(sprintf( 'At this level of the application, the current request does not contain a route. ' . - 'To suppress this error, the parameter should be nullable.' - ); + 'To suppress this error, the parameter {%s} should be nullable.', + ParameterResolutioner::stringifyParameter($parameter), + )); } yield $route; diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index 998ebfa7..373fed5b 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -13,6 +13,7 @@ namespace Sunrise\Http\Router; +use Generator; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Exception\ResolvingReferenceException; @@ -20,6 +21,7 @@ use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; use Closure; +use function class_exists; use function get_debug_type; use function is_array; use function is_callable; @@ -73,7 +75,7 @@ public function __construct( /** * @inheritDoc */ - public function resolveRequestHandler($reference): RequestHandlerInterface + public function resolveRequestHandler(mixed $reference): RequestHandlerInterface { if ($reference instanceof RequestHandlerInterface) { return $reference; @@ -83,9 +85,19 @@ public function resolveRequestHandler($reference): RequestHandlerInterface return new CallbackRequestHandler($reference, $this->parameterResolutioner, $this->responseResolutioner); } - if (is_string($reference) && is_subclass_of($reference, RequestHandlerInterface::class)) { - /** @var RequestHandlerInterface */ - return $this->classResolver->resolveClass($reference); + if (is_string($reference) && class_exists($reference)) { + if (is_subclass_of($reference, RequestHandlerInterface::class)) { + /** @var RequestHandlerInterface */ + return $this->classResolver->resolveClass($reference); + } + + if (method_exists($reference, '__invoke')) { + return new CallbackRequestHandler( + $this->classResolver->resolveClass($reference), + $this->parameterResolutioner, + $this->responseResolutioner + ); + } } // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 @@ -105,15 +117,15 @@ public function resolveRequestHandler($reference): RequestHandlerInterface } throw new ResolvingReferenceException(sprintf( - 'Unable to resolve the reference {%s}', - $this->stringifyReference($reference) + 'Unable to resolve the reference {%s}.', + self::stringifyReference($reference) )); } /** * @inheritDoc */ - public function resolveMiddleware($reference): MiddlewareInterface + public function resolveMiddleware(mixed $reference): MiddlewareInterface { if ($reference instanceof MiddlewareInterface) { return $reference; @@ -146,22 +158,19 @@ public function resolveMiddleware($reference): MiddlewareInterface throw new ResolvingReferenceException(sprintf( 'Unable to resolve the reference {%s}', - $this->stringifyReference($reference) + self::stringifyReference($reference) )); } /** * @inheritDoc */ - public function resolveMiddlewares(array $references): array + public function resolveMiddlewares(array $references): Generator { - $middlewares = []; /** @psalm-suppress MixedAssignment */ foreach ($references as $reference) { - $middlewares[] = $this->resolveMiddleware($reference); + yield $this->resolveMiddleware($reference); } - - return $middlewares; } /** @@ -171,7 +180,7 @@ public function resolveMiddlewares(array $references): array * * @return string */ - private function stringifyReference($reference): string + public static function stringifyReference(mixed $reference): string { if (is_array($reference) && is_callable($reference, true, $stringReference)) { return $stringReference; diff --git a/src/ReferenceResolverInterface.php b/src/ReferenceResolverInterface.php index deef0e97..904b1423 100644 --- a/src/ReferenceResolverInterface.php +++ b/src/ReferenceResolverInterface.php @@ -13,9 +13,9 @@ namespace Sunrise\Http\Router; +use Generator; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\ResolvingReferenceException; /** * ReferenceResolverInterface @@ -32,12 +32,9 @@ interface ReferenceResolverInterface * * @return RequestHandlerInterface * - * @throws ResolvingReferenceException - * If the reference cannot be resolved to a request handler. - * * @since 3.0.0 */ - public function resolveRequestHandler($reference): RequestHandlerInterface; + public function resolveRequestHandler(mixed $reference): RequestHandlerInterface; /** * Resolves the given reference to a middleware @@ -46,24 +43,18 @@ public function resolveRequestHandler($reference): RequestHandlerInterface; * * @return MiddlewareInterface * - * @throws ResolvingReferenceException - * If the reference cannot be resolved to a middleware. - * * @since 3.0.0 */ - public function resolveMiddleware($reference): MiddlewareInterface; + public function resolveMiddleware(mixed $reference): MiddlewareInterface; /** * Resolves the given references to middlewares * * @param array $references * - * @return list - * - * @throws ResolvingReferenceException - * If one of the references cannot be resolved to a middleware. + * @return Generator * * @since 3.0.0 */ - public function resolveMiddlewares(array $references): array; + public function resolveMiddlewares(array $references): Generator; } diff --git a/src/RequestHandler/CallbackRequestHandler.php b/src/RequestHandler/CallbackRequestHandler.php index ea009077..c6ecf8e7 100644 --- a/src/RequestHandler/CallbackRequestHandler.php +++ b/src/RequestHandler/CallbackRequestHandler.php @@ -19,7 +19,7 @@ use ReflectionFunction; use ReflectionMethod; use Sunrise\Http\Router\ParameterResolutionerInterface; -use Sunrise\Http\Router\ParameterResolver\DirectInjectionParameterResolver; +use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; use Sunrise\Http\Router\ResponseResolutionerInterface; use function Sunrise\Http\Router\reflect_callable; @@ -85,16 +85,18 @@ public function getReflection(): ReflectionFunction|ReflectionMethod */ public function handle(ServerRequestInterface $request): ResponseInterface { + $source = $this->getReflection(); + $arguments = $this->parameterResolutioner ->withContext($request) ->withPriorityResolver( - new DirectInjectionParameterResolver($request), + new ObjectInjectionParameterResolver($request), ) - ->resolveParameters(...$this->getReflection()->getParameters()); + ->resolveParameters(...$source->getParameters()); /** @var mixed $response */ $response = ($this->callback)(...$arguments); - return $this->responseResolutioner->resolveResponse($response, $request); + return $this->responseResolutioner->resolveResponse($response, $request, $source); } } diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index 3d036b60..476dde45 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -48,7 +48,6 @@ public function __construct(RequestHandlerInterface $requestHandler) { /** @var SplQueue */ $this->middlewareQueue = new SplQueue(); - $this->requestHandler = $requestHandler; } diff --git a/src/ResponseResolutioner.php b/src/ResponseResolutioner.php index 7408518f..f5c3b8c6 100644 --- a/src/ResponseResolutioner.php +++ b/src/ResponseResolutioner.php @@ -14,6 +14,12 @@ namespace Sunrise\Http\Router; use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionAttribute; +use ReflectionFunction; +use ReflectionMethod; +use Sunrise\Http\Router\Annotation\ResponseHeader; +use Sunrise\Http\Router\Annotation\ResponseStatus; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; @@ -46,24 +52,82 @@ public function addResolver(ResponseResolverInterface ...$resolvers): void /** * @inheritDoc * - * @throws LogicException If the value cannot be resolved to PSR-7 response. + * @throws LogicException If the response cannot be resolved to PSR-7 response. */ - public function resolveResponse(mixed $value, mixed $context): ResponseInterface - { - if ($value instanceof ResponseInterface) { - return $value; + public function resolveResponse( + mixed $response, + ServerRequestInterface $request, + ReflectionFunction|ReflectionMethod $source, + ) : ResponseInterface { + if ($response instanceof ResponseInterface) { + return $response; } foreach ($this->resolvers as $resolver) { - $response = $resolver->resolveResponse($value, $context); - if ($response instanceof ResponseInterface) { - return $response; + $result = $resolver->resolveResponse($response, $request, $source); + if ($result instanceof ResponseInterface) { + return $this->handleResponse($result, $source); } } throw new LogicException(sprintf( - 'Unable to resolve the value {%s} to PSR-7 response.', - get_debug_type($value), + 'Unable to resolve the response {%s} to PSR-7 response.', + self::stringifyResponse($response, $source), )); } + + /** + * Handles the given response + * + * @param ResponseInterface $response + * @param ReflectionFunction|ReflectionMethod $source + * + * @return ResponseInterface + */ + private function handleResponse( + ResponseInterface $response, + ReflectionFunction|ReflectionMethod $source, + ) : ResponseInterface { + /** @var list> $attributes */ + $attributes = $source->getAttributes(ResponseStatus::class); + if (isset($attributes[0])) { + $status = $attributes[0]->newInstance(); + $response = $response->withStatus($status->code); + } + + /** @var list> $attributes */ + $attributes = $source->getAttributes(ResponseHeader::class); + foreach ($attributes as $attribute) { + $header = $attribute->newInstance(); + $response = $response->withHeader($header->name, $header->value); + } + + return $response; + } + + /** + * Stringifies the given raw response + * + * @param mixed $response + * @param ReflectionFunction|ReflectionMethod $source + * + * @return non-empty-string + */ + public static function stringifyResponse(mixed $response, ReflectionFunction|ReflectionMethod $source): string + { + if ($source instanceof ReflectionMethod) { + return sprintf( + '%s::%s():$%s', + $source->getDeclaringClass()->getName(), + $source->getName(), + get_debug_type($response), + ); + } + + return sprintf( + '%s():$%s', + $source->getName(), + get_debug_type($response), + ); + } } diff --git a/src/ResponseResolutionerInterface.php b/src/ResponseResolutionerInterface.php index 681967fb..78baeb1f 100644 --- a/src/ResponseResolutionerInterface.php +++ b/src/ResponseResolutionerInterface.php @@ -14,6 +14,9 @@ namespace Sunrise\Http\Router; use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionFunction; +use ReflectionMethod; use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; /** @@ -34,12 +37,17 @@ interface ResponseResolutionerInterface public function addResolver(ResponseResolverInterface ...$resolvers): void; /** - * Resolves the given value to PSR-7 response + * Resolves the given response to PSR-7 response * - * @param mixed $value - * @param mixed $context + * @param mixed $response + * @param ServerRequestInterface $request + * @param ReflectionFunction|ReflectionMethod $source * * @return ResponseInterface */ - public function resolveResponse(mixed $value, mixed $context): ResponseInterface; + public function resolveResponse( + mixed $response, + ServerRequestInterface $request, + ReflectionFunction|ReflectionMethod $source, + ) : ResponseInterface; } diff --git a/src/ResponseResolver/NullResponseResolver.php b/src/ResponseResolver/EmptyResponseResolver.php similarity index 67% rename from src/ResponseResolver/NullResponseResolver.php rename to src/ResponseResolver/EmptyResponseResolver.php index 2332a0f3..cd193807 100644 --- a/src/ResponseResolver/NullResponseResolver.php +++ b/src/ResponseResolver/EmptyResponseResolver.php @@ -15,13 +15,16 @@ use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionFunction; +use ReflectionMethod; /** - * NullResponseResolver + * EmptyResponseResolver * * @since 3.0.0 */ -final class NullResponseResolver implements ResponseResolverInterface +final class EmptyResponseResolver implements ResponseResolverInterface { /** @@ -36,9 +39,12 @@ public function __construct(private ResponseFactoryInterface $responseFactory) /** * @inheritDoc */ - public function resolveResponse(mixed $value, mixed $context): ?ResponseInterface - { - if ($value === null) { + public function resolveResponse( + mixed $response, + ServerRequestInterface $request, + ReflectionFunction|ReflectionMethod $source, + ) : ?ResponseInterface { + if ($response === null) { return $this->responseFactory->createResponse(204); } diff --git a/src/ResponseResolver/ResponseBodyResponseResolver.php b/src/ResponseResolver/ResponseBodyResponseResolver.php index ad751d92..f47e2750 100644 --- a/src/ResponseResolver/ResponseBodyResponseResolver.php +++ b/src/ResponseResolver/ResponseBodyResponseResolver.php @@ -15,12 +15,20 @@ use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; -use ReflectionClass; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionFunction; +use ReflectionMethod; use Sunrise\Http\Router\Annotation\ResponseBody; use Sunrise\Http\Router\Entity\MediaType; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ResponseResolutioner; +use Sunrise\Http\Router\RouteInterface; +use Sunrise\Http\Router\ServerRequest; use Symfony\Component\Serializer\SerializerInterface; -use function is_object; +use function next; +use function reset; +use function sprintf; /** * ResponseBodyResponseResolver @@ -30,59 +38,91 @@ final class ResponseBodyResponseResolver implements ResponseResolverInterface { + /** + * @var array + */ + public const MEDIA_TYPE_FORMATS = [ + MediaType::APPLICATION_JSON => 'json', + MediaType::APPLICATION_XML => 'xml', + MediaType::APPLICATION_YAML => 'yaml', + ]; + /** * Constructor of the class * - * @param SerializerInterface $serializer * @param ResponseFactoryInterface $responseFactory + * @param SerializerInterface $serializer + * @param non-empty-string $defaultMediaType + * @param array $mediaTypeFormats + * @param array $serializationContext */ public function __construct( - private SerializerInterface $serializer, private ResponseFactoryInterface $responseFactory, + private SerializerInterface $serializer, + private string $defaultMediaType = MediaType::APPLICATION_JSON, + private array $mediaTypeFormats = self::MEDIA_TYPE_FORMATS, + private array $serializationContext = [], ) { } /** * @inheritDoc + * + * @throws LogicException If the resolver is used incorrectly. */ - public function resolveResponse(mixed $value, mixed $context): ?ResponseInterface - { - if (!is_object($value)) { + public function resolveResponse( + mixed $response, + ServerRequestInterface $request, + ReflectionFunction|ReflectionMethod $source, + ) : ?ResponseInterface { + if ($source->getAttributes(ResponseBody::class) === []) { return null; } - $class = new ReflectionClass($value::class); - $attributes = $class->getAttributes(ResponseBody::class); - if ($attributes === []) { - return null; + $mediaType = $this->defaultMediaType; + + /** @var RouteInterface|null $route */ + $route = $request->getAttribute('@route'); + if ($route instanceof RouteInterface) { + $producedMediaTypes = $route->getProducedMediaTypes(); + if (!empty($producedMediaTypes)) { + /** @var non-empty-string $mediaType */ + $mediaType = reset($producedMediaTypes); + $requestProxy = ServerRequest::from($request); + $consumedMediaTypes = $requestProxy->getClientConsumedMediaTypes(); + while ($producedMediaType = next($producedMediaTypes)) { + if (isset($consumedMediaTypes[$producedMediaType])) { + /** @var non-empty-string $mediaType */ + $mediaType = $consumedMediaTypes[$producedMediaType]; + break; + } + } + } } - /** - * @var ResponseBody $responseBody - * @psalm-suppress UnnecessaryVarAnnotation - */ - $responseBody = $attributes[0]->newInstance(); - - $response = $this->responseFactory->createResponse($responseBody->statusCode); + if (!isset($this->mediaTypeFormats[$mediaType])) { + throw new LogicException(sprintf( + 'The response {%s} cannot be serialized. ' . + 'Make sure that the resolver %s is configured correctly, ' . + 'and also ensure that the current route provides media types known to the resolver.', + ResponseResolutioner::stringifyResponse($response, $source), + ResponseBodyResponseResolver::class, + )); + } - $mediaType = match ($responseBody->format) { - ResponseBody::FORMAT_CSV => MediaType::TEXT_CSV, - ResponseBody::FORMAT_JSON => MediaType::APPLICATION_JSON, - ResponseBody::FORMAT_XML => MediaType::APPLICATION_XML, - ResponseBody::FORMAT_YAML => MediaType::APPLICATION_YAML, - default => null, - }; + $payload = $this->serializer->serialize( + $response, + $this->mediaTypeFormats[$mediaType], + $this->serializationContext, + ); - if (isset($mediaType)) { - $response = $response->withHeader('Content-Type', $mediaType); - } + $contentType = sprintf('%s; charset=UTF-8', $mediaType); - foreach ($responseBody->headers as $name => $header) { - $response = $response->withHeader($name, $header); - } + $result = $this->responseFactory->createResponse(200) + ->withHeader('Content-Type', $contentType); - $response->getBody()->write($this->serializer->serialize($value, $responseBody->format)); + $result->getBody()->write($payload); - return $response; + return $result; } } diff --git a/src/ResponseResolver/ResponseResolverInterface.php b/src/ResponseResolver/ResponseResolverInterface.php index 49c32860..e6d28126 100644 --- a/src/ResponseResolver/ResponseResolverInterface.php +++ b/src/ResponseResolver/ResponseResolverInterface.php @@ -14,6 +14,9 @@ namespace Sunrise\Http\Router\ResponseResolver; use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionFunction; +use ReflectionMethod; /** * ResponseResolverInterface @@ -24,12 +27,17 @@ interface ResponseResolverInterface { /** - * Resolves the given value to PSR-7 response + * Resolves the given response to PSR-7 response * - * @param mixed $value - * @param mixed $context + * @param mixed $response + * @param ServerRequestInterface $request + * @param ReflectionFunction|ReflectionMethod $source * * @return ResponseInterface|null */ - public function resolveResponse(mixed $value, mixed $context): ?ResponseInterface; + public function resolveResponse( + mixed $response, + ServerRequestInterface $request, + ReflectionFunction|ReflectionMethod $source, + ) : ?ResponseInterface; } diff --git a/src/ResponseResolver/RouteResponseResolver.php b/src/ResponseResolver/RouteResponseResolver.php index ca38ee0e..a0e4d0b3 100644 --- a/src/ResponseResolver/RouteResponseResolver.php +++ b/src/ResponseResolver/RouteResponseResolver.php @@ -15,7 +15,8 @@ use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; -use Sunrise\Http\Router\Exception\LogicException; +use ReflectionFunction; +use ReflectionMethod; use Sunrise\Http\Router\RouteInterface; /** @@ -28,22 +29,16 @@ final class RouteResponseResolver implements ResponseResolverInterface /** * @inheritDoc - * - * @throws LogicException - * If the resolver is used incorrectly. */ - public function resolveResponse(mixed $value, mixed $context): ?ResponseInterface - { - if (! $value instanceof RouteInterface) { - return null; + public function resolveResponse( + mixed $response, + ServerRequestInterface $request, + ReflectionFunction|ReflectionMethod $source, + ) : ?ResponseInterface { + if ($response instanceof RouteInterface) { + return $response->handle($request); } - if (! $context instanceof ServerRequestInterface) { - throw new LogicException( - 'At this level of the application, any operations with the request are not possible.' - ); - } - - return $value->handle($context); + return null; } } diff --git a/src/ResponseResolver/StatusCodeResponseResolver.php b/src/ResponseResolver/StreamResponseResolver.php similarity index 58% rename from src/ResponseResolver/StatusCodeResponseResolver.php rename to src/ResponseResolver/StreamResponseResolver.php index 24e6f66a..b06d7a2a 100644 --- a/src/ResponseResolver/StatusCodeResponseResolver.php +++ b/src/ResponseResolver/StreamResponseResolver.php @@ -15,15 +15,17 @@ use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; - -use function is_int; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Message\StreamInterface; +use ReflectionFunction; +use ReflectionMethod; /** - * StatusCodeResponseResolver + * StreamResponseResolver * * @since 3.0.0 */ -final class StatusCodeResponseResolver implements ResponseResolverInterface +final class StreamResponseResolver implements ResponseResolverInterface { /** @@ -38,10 +40,14 @@ public function __construct(private ResponseFactoryInterface $responseFactory) /** * @inheritDoc */ - public function resolveResponse(mixed $value, mixed $context): ?ResponseInterface - { - if (is_int($value) && $value >= 100 && $value <= 599) { - return $this->responseFactory->createResponse($value); + public function resolveResponse( + mixed $response, + ServerRequestInterface $request, + ReflectionFunction|ReflectionMethod $source, + ) : ?ResponseInterface { + if ($response instanceof StreamInterface) { + return $this->responseFactory->createResponse(200) + ->withBody($response); } return null; diff --git a/src/ResponseResolver/UriResponseResolver.php b/src/ResponseResolver/UriResponseResolver.php index 5638a5f7..b21ad271 100644 --- a/src/ResponseResolver/UriResponseResolver.php +++ b/src/ResponseResolver/UriResponseResolver.php @@ -15,7 +15,10 @@ use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\UriInterface; +use ReflectionFunction; +use ReflectionMethod; /** * UriResponseResolver @@ -37,13 +40,16 @@ public function __construct(private ResponseFactoryInterface $responseFactory) /** * @inheritDoc */ - public function resolveResponse(mixed $value, mixed $context): ?ResponseInterface - { - if (! $value instanceof UriInterface) { - return null; + public function resolveResponse( + mixed $response, + ServerRequestInterface $request, + ReflectionFunction|ReflectionMethod $source, + ) : ?ResponseInterface { + if ($response instanceof UriInterface) { + return $this->responseFactory->createResponse(302) + ->withHeader('Location', $response->__toString()); } - return $this->responseFactory->createResponse(302) - ->withHeader('Location', $value->__toString()); + return null; } } diff --git a/src/Route.php b/src/Route.php index af224fa5..376e34f0 100644 --- a/src/Route.php +++ b/src/Route.php @@ -17,6 +17,8 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; +use ReflectionFunction; +use ReflectionMethod; use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; use ReflectionClass; @@ -242,7 +244,7 @@ public function getTags(): array /** * @inheritDoc */ - public function getHolder(): Reflector + public function getHolder(): ReflectionClass|ReflectionMethod|ReflectionFunction { if ($this->requestHandler instanceof CallbackRequestHandler) { return $this->requestHandler->getReflection(); diff --git a/src/RouteCollector.php b/src/RouteCollector.php index 64012cb7..2b77f784 100644 --- a/src/RouteCollector.php +++ b/src/RouteCollector.php @@ -13,6 +13,7 @@ namespace Sunrise\Http\Router; +use Fig\Http\Message\RequestMethodInterface; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; @@ -167,7 +168,7 @@ public function route( $path, $methods, $this->referenceResolver->resolveRequestHandler($requestHandler), - $this->referenceResolver->resolveMiddlewares($middlewares), + [...$this->referenceResolver->resolveMiddlewares($middlewares)], $attributes ); @@ -365,7 +366,7 @@ public function purge( return $this->route( $name, $path, - [RouteInterface::METHOD_PURGE], + [RequestMethodInterface::METHOD_PURGE], $requestHandler, $middlewares, $attributes diff --git a/src/RouteInterface.php b/src/RouteInterface.php index 7833a663..a1e32cd9 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -139,7 +139,7 @@ public function getTags(): array; * * @since 2.14.0 */ - public function getHolder(): Reflector; + public function getHolder(): ReflectionClass|ReflectionMethod|ReflectionFunction; /** * Sets the given name to the route diff --git a/src/ServerRequest.php b/src/ServerRequest.php index afa4fcd1..0e754838 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -180,7 +180,7 @@ public function getClientConsumedMediaTypes(): array return []; } - $accepts = header_accept_like_parse($header); + $accepts = parse_accept_header($header); if (empty($accepts)) { return []; } From f09d6a1c38df2e177c9d80666c3ade8ab8128879 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Wed, 2 Aug 2023 12:40:32 +0200 Subject: [PATCH 077/180] v3 --- src/Annotation/Middleware.php | 5 +- src/Annotation/Route.php | 29 ++++---- src/ClassResolver.php | 30 +++++---- src/ClassResolverInterface.php | 13 +--- src/ReferenceResolver.php | 119 ++++++++++++++++++++------------- 5 files changed, 108 insertions(+), 88 deletions(-) diff --git a/src/Annotation/Middleware.php b/src/Annotation/Middleware.php index 980dc8ff..19dd49ed 100644 --- a/src/Annotation/Middleware.php +++ b/src/Annotation/Middleware.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Psr\Http\Server\MiddlewareInterface; /** * @since 2.11.0 @@ -26,9 +25,9 @@ final class Middleware /** * Constructor of the class * - * @param class-string $value + * @param mixed $value */ - public function __construct(public string $value) + public function __construct(public mixed $value) { } } diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index 43408464..5b6ea783 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -15,7 +15,6 @@ use Attribute; use Fig\Http\Message\RequestMethodInterface; -use Psr\Http\Server\MiddlewareInterface; #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] final class Route implements RequestMethodInterface @@ -24,6 +23,8 @@ final class Route implements RequestMethodInterface /** * The annotation's holder * + * @var mixed + * * @internal */ public mixed $holder = null; @@ -31,19 +32,19 @@ final class Route implements RequestMethodInterface /** * Constructor of the class * - * @param non-empty-string $name The route's name - * @param non-empty-string|null $host The route's host - * @param non-empty-string $path The route's path - * @param non-empty-string|null $method The route's method - * @param list $methods The route's methods - * @param list $consumes The route's consumed media types - * @param list $produces The route's produced media types - * @param list> $middlewares The route's middlewares - * @param array $attributes The route's attributes - * @param string $summary The route's summary - * @param string $description The route's description - * @param list $tags The route's tags - * @param int $priority The route's priority (default 0) + * @param non-empty-string $name The route's name + * @param non-empty-string|null $host The route's host + * @param non-empty-string $path The route's path + * @param non-empty-string|null $method The route's method + * @param list $methods The route's methods + * @param list $consumes The route's consumed media types + * @param list $produces The route's produced media types + * @param list $middlewares The route's middlewares + * @param array $attributes The route's attributes + * @param string $summary The route's summary + * @param string $description The route's description + * @param list $tags The route's tags + * @param int $priority The route's priority (default 0) */ public function __construct( public string $name, diff --git a/src/ClassResolver.php b/src/ClassResolver.php index 96319547..d457a173 100644 --- a/src/ClassResolver.php +++ b/src/ClassResolver.php @@ -18,6 +18,7 @@ use ReflectionClass; use function class_exists; +use function is_object; use function sprintf; /** @@ -54,39 +55,44 @@ public function __construct(ParameterResolutionerInterface $parameterResolutione /** * @inheritDoc + * + * @throws InvalidArgumentException If the class doesn't exist. + * @throws LogicException If the class cannot be resolved. */ - public function resolveClass(string $className): object + public function resolveClass(string $fqn): object { - if (isset($this->resolvedClasses[$className])) { - return $this->resolvedClasses[$className]; + if (isset($this->resolvedClasses[$fqn])) { + return $this->resolvedClasses[$fqn]; } - if (!class_exists($className)) { + if (!class_exists($fqn)) { throw new InvalidArgumentException(sprintf( 'Class %s does not exist', - $className + $fqn )); } - $reflection = new ReflectionClass($className); - if (!$reflection->isInstantiable()) { + $class = new ReflectionClass($fqn); + if (!$class->isInstantiable()) { throw new LogicException(sprintf( 'Class %s cannot be initialized', - $className + $fqn )); } $arguments = []; - $constructor = $reflection->getConstructor(); + $constructor = $class->getConstructor(); if (isset($constructor) && $constructor->getNumberOfParameters() > 0) { $arguments = $this->parameterResolutioner->resolveParameters( ...$constructor->getParameters() ); } - /** @var T */ - $this->resolvedClasses[$className] = $reflection->newInstance(...$arguments); + /** @var T $instance */ + $instance = new $class(...$arguments); + + $this->resolvedClasses[$fqn] = $instance; - return $this->resolvedClasses[$className]; + return $this->resolvedClasses[$fqn]; } } diff --git a/src/ClassResolverInterface.php b/src/ClassResolverInterface.php index 164b08d6..c20ef413 100644 --- a/src/ClassResolverInterface.php +++ b/src/ClassResolverInterface.php @@ -13,9 +13,6 @@ namespace Sunrise\Http\Router; -use Sunrise\Http\Router\Exception\InvalidArgumentException; -use Sunrise\Http\Router\Exception\LogicException; - /** * ClassResolverInterface * @@ -29,15 +26,9 @@ interface ClassResolverInterface /** * Resolves the given named class * - * @param class-string $className + * @param class-string $fqn * * @return T - * - * @throws InvalidArgumentException - * If the class doesn't exist. - * - * @throws LogicException - * If the class cannot be resolved. */ - public function resolveClass(string $className): object; + public function resolveClass(string $fqn): object; } diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index 373fed5b..073a8319 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -13,13 +13,13 @@ namespace Sunrise\Http\Router; +use Closure; use Generator; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\ResolvingReferenceException; +use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\Middleware\CallbackMiddleware; use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; -use Closure; use function class_exists; use function get_debug_type; @@ -38,11 +38,6 @@ final class ReferenceResolver implements ReferenceResolverInterface { - /** - * @var ClassResolverInterface - */ - private ClassResolverInterface $classResolver; - /** * @var ParameterResolutionerInterface */ @@ -53,6 +48,11 @@ final class ReferenceResolver implements ReferenceResolverInterface */ private ResponseResolutionerInterface $responseResolutioner; + /** + * @var ClassResolverInterface + */ + private ClassResolverInterface $classResolver; + /** * Constructor of the class * @@ -67,13 +67,15 @@ public function __construct( ) { $classResolver ??= new ClassResolver($parameterResolutioner); - $this->classResolver = $classResolver; $this->parameterResolutioner = $parameterResolutioner; $this->responseResolutioner = $responseResolutioner; + $this->classResolver = $classResolver; } /** * @inheritDoc + * + * @throws LogicException If the reference cannot be resolved. */ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface { @@ -82,7 +84,28 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface } if ($reference instanceof Closure) { - return new CallbackRequestHandler($reference, $this->parameterResolutioner, $this->responseResolutioner); + return new CallbackRequestHandler( + $reference, + $this->parameterResolutioner, + $this->responseResolutioner, + ); + } + + // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 + if (is_array($reference) && is_callable($reference, true)) { + /** @var array{0: class-string|object, 1: non-empty-string} $reference */ + + if (is_string($reference[0])) { + $reference[0] = $this->classResolver->resolveClass($reference[0]); + } + + if (is_callable($reference)) { + return new CallbackRequestHandler( + $reference, + $this->parameterResolutioner, + $this->responseResolutioner, + ); + } } if (is_string($reference) && class_exists($reference)) { @@ -95,35 +118,21 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface return new CallbackRequestHandler( $this->classResolver->resolveClass($reference), $this->parameterResolutioner, - $this->responseResolutioner + $this->responseResolutioner, ); } } - // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 - /** @psalm-suppress MixedArgument */ - if (is_array($reference) && is_callable($reference, true) && method_exists($reference[0], $reference[1])) { - /** @var array{0: class-string|object, 1: non-empty-string} $reference */ - - if (is_string($reference[0])) { - $reference[0] = $this->classResolver->resolveClass($reference[0]); - } - - return new CallbackRequestHandler( - [$reference[0], $reference[1]], - $this->parameterResolutioner, - $this->responseResolutioner - ); - } - - throw new ResolvingReferenceException(sprintf( + throw new LogicException(sprintf( 'Unable to resolve the reference {%s}.', - self::stringifyReference($reference) + self::stringifyReference($reference), )); } /** * @inheritDoc + * + * @throws LogicException If the reference cannot be resolved. */ public function resolveMiddleware(mixed $reference): MiddlewareInterface { @@ -132,38 +141,55 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface } if ($reference instanceof Closure) { - return new CallbackMiddleware($reference, $this->parameterResolutioner, $this->responseResolutioner); + return new CallbackMiddleware( + $reference, + $this->parameterResolutioner, + $this->responseResolutioner, + ); } - if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { - /** @var MiddlewareInterface */ - return $this->classResolver->resolveClass($reference); + if (is_string($reference) && class_exists($reference)) { + if (is_subclass_of($reference, MiddlewareInterface::class)) { + /** @var MiddlewareInterface */ + return $this->classResolver->resolveClass($reference); + } + + if (method_exists($reference, '__invoke')) { + return new CallbackMiddleware( + $this->classResolver->resolveClass($reference), + $this->parameterResolutioner, + $this->responseResolutioner, + ); + } } // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 - /** @psalm-suppress MixedArgument */ - if (is_array($reference) && is_callable($reference, true) && method_exists($reference[0], $reference[1])) { + if (is_array($reference) && is_callable($reference, true)) { /** @var array{0: class-string|object, 1: non-empty-string} $reference */ if (is_string($reference[0])) { $reference[0] = $this->classResolver->resolveClass($reference[0]); } - return new CallbackMiddleware( - [$reference[0], $reference[1]], - $this->parameterResolutioner, - $this->responseResolutioner - ); + if (is_callable($reference)) { + return new CallbackMiddleware( + $reference, + $this->parameterResolutioner, + $this->responseResolutioner, + ); + } } - throw new ResolvingReferenceException(sprintf( - 'Unable to resolve the reference {%s}', - self::stringifyReference($reference) + throw new LogicException(sprintf( + 'Unable to resolve the reference {%s}.', + self::stringifyReference($reference), )); } /** * @inheritDoc + * + * @throws LogicException If one of the references cannot be resolved. */ public function resolveMiddlewares(array $references): Generator { @@ -182,12 +208,9 @@ public function resolveMiddlewares(array $references): Generator */ public static function stringifyReference(mixed $reference): string { - if (is_array($reference) && is_callable($reference, true, $stringReference)) { - return $stringReference; - } - - if (is_string($reference)) { - return $reference; + // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 + if (is_callable($reference, true, $result)) { + return $result; } return get_debug_type($reference); From ee61aa946514f913a8ba0587a3255610fdd92476 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Wed, 2 Aug 2023 12:59:51 +0200 Subject: [PATCH 078/180] v3 --- src/ResponseResolver/ResponseBodyResponseResolver.php | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/src/ResponseResolver/ResponseBodyResponseResolver.php b/src/ResponseResolver/ResponseBodyResponseResolver.php index f47e2750..b4b04305 100644 --- a/src/ResponseResolver/ResponseBodyResponseResolver.php +++ b/src/ResponseResolver/ResponseBodyResponseResolver.php @@ -86,14 +86,11 @@ public function resolveResponse( if ($route instanceof RouteInterface) { $producedMediaTypes = $route->getProducedMediaTypes(); if (!empty($producedMediaTypes)) { - /** @var non-empty-string $mediaType */ $mediaType = reset($producedMediaTypes); - $requestProxy = ServerRequest::from($request); - $consumedMediaTypes = $requestProxy->getClientConsumedMediaTypes(); + $consumedMediaTypes = ServerRequest::from($request)->getClientConsumedMediaTypes(); while ($producedMediaType = next($producedMediaTypes)) { if (isset($consumedMediaTypes[$producedMediaType])) { - /** @var non-empty-string $mediaType */ - $mediaType = $consumedMediaTypes[$producedMediaType]; + $mediaType = $producedMediaType; break; } } From ca227476ba82495e37043e2b9582fbf67fab5060 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 6 Aug 2023 09:09:45 +0200 Subject: [PATCH 079/180] v3 --- composer.json | 7 +- functions/emit.php | 8 +- functions/parse_accept_header.php | 198 -------------- functions/parse_header.php | 178 +++++++++++++ functions/parse_header_with_media_type.php | 91 +++++++ ...lect_callable.php => reflect_callback.php} | 5 +- src/Annotation/Consume.php | 5 +- src/Annotation/Produce.php | 5 +- src/Annotation/ProxyChain.php | 36 +++ src/Annotation/Route.php | 19 +- src/ClassResolver.php | 13 +- src/Dictionary/Charset.php | 72 ++++++ ...{IpAddress.php => ClientRemoteAddress.php} | 22 +- src/Entity/MediaType.php | 85 +++++- src/Loader/DescriptorLoader.php | 40 ++- src/Middleware/CallbackMiddleware.php | 4 +- .../JsonPayloadDecodingMiddleware.php | 20 +- .../SimdJsonPayloadDecodingMiddleware.php | 20 +- src/ParameterResolutioner.php | 4 +- .../ClientRemoteAddressParameterResolver.php | 75 ++++++ .../RequestRouteParameterResolver.php | 6 +- src/ReferenceResolver.php | 4 +- src/RequestHandler/CallbackRequestHandler.php | 4 +- src/ResponseResolutioner.php | 2 +- .../ResponseBodyResponseResolver.php | 59 ++--- src/Route.php | 42 +-- src/RouteCollection.php | 17 +- src/RouteCollectionInterface.php | 25 +- src/RouteInterface.php | 38 +-- src/Router.php | 7 +- src/ServerRequest.php | 241 +++++------------- 31 files changed, 781 insertions(+), 571 deletions(-) delete mode 100644 functions/parse_accept_header.php create mode 100644 functions/parse_header.php create mode 100644 functions/parse_header_with_media_type.php rename functions/{reflect_callable.php => reflect_callback.php} (90%) create mode 100644 src/Annotation/ProxyChain.php create mode 100644 src/Dictionary/Charset.php rename src/Entity/{IpAddress.php => ClientRemoteAddress.php} (70%) create mode 100644 src/ParameterResolver/ClientRemoteAddressParameterResolver.php diff --git a/composer.json b/composer.json index 736e4d2c..bab7bb85 100644 --- a/composer.json +++ b/composer.json @@ -44,17 +44,20 @@ "vimeo/psalm": "^5.14", "sunrise/coding-standard": "^1.0", "sunrise/http-message": "^3.0", - "symfony/console": "^6.0" + "symfony/console": "^6.0", + "symfony/http-foundation": "^6.3" }, "autoload": { "files": [ "functions/emit.php", + "functions/parse_header.php", + "functions/parse_header_with_media_type.php", "functions/path_build.php", "functions/path_match.php", "functions/path_parse.php", "functions/path_plain.php", "functions/path_regex.php", - "functions/reflect_callable.php" + "functions/reflect_callback.php" ], "psr-4": { "Sunrise\\Http\\Router\\": "src/" diff --git a/functions/emit.php b/functions/emit.php index 50bf35c6..643229f9 100644 --- a/functions/emit.php +++ b/functions/emit.php @@ -32,15 +32,11 @@ function emit(ResponseInterface $response): void $response->getProtocolVersion(), $response->getStatusCode(), $response->getReasonPhrase() - ), true); + )); foreach ($response->getHeaders() as $name => $values) { foreach ($values as $value) { - header(sprintf( - '%s: %s', - $name, - $value - ), false); + header(sprintf('%s: %s', $name, $value), replace: false); } } diff --git a/functions/parse_accept_header.php b/functions/parse_accept_header.php deleted file mode 100644 index c8b41ee9..00000000 --- a/functions/parse_accept_header.php +++ /dev/null @@ -1,198 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-message/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-message - */ - -namespace Sunrise\Http\Message; - -use function uasort; - -/** - * Parses the given accept-like header - * - * Returns null if the header isn't valid. - * - * @param string $header - * - * @return ?array> - */ -function parse_accept_header(string $header): ?array -{ - // OWS according to RFC-7230 - static $ows = [ - "\x09" => 1, "\x20" => 1, - ]; - - // token according to RFC-7230 - static $token = [ - "\x21" => 1, "\x23" => 1, "\x24" => 1, "\x25" => 1, "\x26" => 1, "\x27" => 1, "\x2a" => 1, "\x2b" => 1, - "\x2d" => 1, "\x2e" => 1, "\x30" => 1, "\x31" => 1, "\x32" => 1, "\x33" => 1, "\x34" => 1, "\x35" => 1, - "\x36" => 1, "\x37" => 1, "\x38" => 1, "\x39" => 1, "\x41" => 1, "\x42" => 1, "\x43" => 1, "\x44" => 1, - "\x45" => 1, "\x46" => 1, "\x47" => 1, "\x48" => 1, "\x49" => 1, "\x4a" => 1, "\x4b" => 1, "\x4c" => 1, - "\x4d" => 1, "\x4e" => 1, "\x4f" => 1, "\x50" => 1, "\x51" => 1, "\x52" => 1, "\x53" => 1, "\x54" => 1, - "\x55" => 1, "\x56" => 1, "\x57" => 1, "\x58" => 1, "\x59" => 1, "\x5a" => 1, "\x5e" => 1, "\x5f" => 1, - "\x60" => 1, "\x61" => 1, "\x62" => 1, "\x63" => 1, "\x64" => 1, "\x65" => 1, "\x66" => 1, "\x67" => 1, - "\x68" => 1, "\x69" => 1, "\x6a" => 1, "\x6b" => 1, "\x6c" => 1, "\x6d" => 1, "\x6e" => 1, "\x6f" => 1, - "\x70" => 1, "\x71" => 1, "\x72" => 1, "\x73" => 1, "\x74" => 1, "\x75" => 1, "\x76" => 1, "\x77" => 1, - "\x78" => 1, "\x79" => 1, "\x7a" => 1, "\x7c" => 1, "\x7e" => 1, - ]; - - // quoted-string according to RFC-7230 - static $quotedString = [ - "\x09" => 1, "\x20" => 1, "\x21" => 1, "\x23" => 1, "\x24" => 1, "\x25" => 1, "\x26" => 1, "\x27" => 1, - "\x28" => 1, "\x29" => 1, "\x2a" => 1, "\x2b" => 1, "\x2c" => 1, "\x2d" => 1, "\x2e" => 1, "\x2f" => 1, - "\x30" => 1, "\x31" => 1, "\x32" => 1, "\x33" => 1, "\x34" => 1, "\x35" => 1, "\x36" => 1, "\x37" => 1, - "\x38" => 1, "\x39" => 1, "\x3a" => 1, "\x3b" => 1, "\x3c" => 1, "\x3d" => 1, "\x3e" => 1, "\x3f" => 1, - "\x40" => 1, "\x41" => 1, "\x42" => 1, "\x43" => 1, "\x44" => 1, "\x45" => 1, "\x46" => 1, "\x47" => 1, - "\x48" => 1, "\x49" => 1, "\x4a" => 1, "\x4b" => 1, "\x4c" => 1, "\x4d" => 1, "\x4e" => 1, "\x4f" => 1, - "\x50" => 1, "\x51" => 1, "\x52" => 1, "\x53" => 1, "\x54" => 1, "\x55" => 1, "\x56" => 1, "\x57" => 1, - "\x58" => 1, "\x59" => 1, "\x5a" => 1, "\x5b" => 1, "\x5d" => 1, "\x5e" => 1, "\x5f" => 1, "\x60" => 1, - "\x61" => 1, "\x62" => 1, "\x63" => 1, "\x64" => 1, "\x65" => 1, "\x66" => 1, "\x67" => 1, "\x68" => 1, - "\x69" => 1, "\x6a" => 1, "\x6b" => 1, "\x6c" => 1, "\x6d" => 1, "\x6e" => 1, "\x6f" => 1, "\x70" => 1, - "\x71" => 1, "\x72" => 1, "\x73" => 1, "\x74" => 1, "\x75" => 1, "\x76" => 1, "\x77" => 1, "\x78" => 1, - "\x79" => 1, "\x7a" => 1, "\x7b" => 1, "\x7c" => 1, "\x7d" => 1, "\x7e" => 1, "\x80" => 1, "\x81" => 1, - "\x82" => 1, "\x83" => 1, "\x84" => 1, "\x85" => 1, "\x86" => 1, "\x87" => 1, "\x88" => 1, "\x89" => 1, - "\x8a" => 1, "\x8b" => 1, "\x8c" => 1, "\x8d" => 1, "\x8e" => 1, "\x8f" => 1, "\x90" => 1, "\x91" => 1, - "\x92" => 1, "\x93" => 1, "\x94" => 1, "\x95" => 1, "\x96" => 1, "\x97" => 1, "\x98" => 1, "\x99" => 1, - "\x9a" => 1, "\x9b" => 1, "\x9c" => 1, "\x9d" => 1, "\x9e" => 1, "\x9f" => 1, "\xa0" => 1, "\xa1" => 1, - "\xa2" => 1, "\xa3" => 1, "\xa4" => 1, "\xa5" => 1, "\xa6" => 1, "\xa7" => 1, "\xa8" => 1, "\xa9" => 1, - "\xaa" => 1, "\xab" => 1, "\xac" => 1, "\xad" => 1, "\xae" => 1, "\xaf" => 1, "\xb0" => 1, "\xb1" => 1, - "\xb2" => 1, "\xb3" => 1, "\xb4" => 1, "\xb5" => 1, "\xb6" => 1, "\xb7" => 1, "\xb8" => 1, "\xb9" => 1, - "\xba" => 1, "\xbb" => 1, "\xbc" => 1, "\xbd" => 1, "\xbe" => 1, "\xbf" => 1, "\xc0" => 1, "\xc1" => 1, - "\xc2" => 1, "\xc3" => 1, "\xc4" => 1, "\xc5" => 1, "\xc6" => 1, "\xc7" => 1, "\xc8" => 1, "\xc9" => 1, - "\xca" => 1, "\xcb" => 1, "\xcc" => 1, "\xcd" => 1, "\xce" => 1, "\xcf" => 1, "\xd0" => 1, "\xd1" => 1, - "\xd2" => 1, "\xd3" => 1, "\xd4" => 1, "\xd5" => 1, "\xd6" => 1, "\xd7" => 1, "\xd8" => 1, "\xd9" => 1, - "\xda" => 1, "\xdb" => 1, "\xdc" => 1, "\xdd" => 1, "\xde" => 1, "\xdf" => 1, "\xe0" => 1, "\xe1" => 1, - "\xe2" => 1, "\xe3" => 1, "\xe4" => 1, "\xe5" => 1, "\xe6" => 1, "\xe7" => 1, "\xe8" => 1, "\xe9" => 1, - "\xea" => 1, "\xeb" => 1, "\xec" => 1, "\xed" => 1, "\xee" => 1, "\xef" => 1, "\xf0" => 1, "\xf1" => 1, - "\xf2" => 1, "\xf3" => 1, "\xf4" => 1, "\xf5" => 1, "\xf6" => 1, "\xf7" => 1, "\xf8" => 1, "\xf9" => 1, - "\xfa" => 1, "\xfb" => 1, "\xfc" => 1, "\xfd" => 1, "\xfe" => 1, "\xff" => 1, - ]; - - $offset = -1; - - $inToken = true; - $inParamName = false; - $inParamValue = false; - $inQuotes = false; - - $data = []; - - $i = 0; - $p = 0; - - while (true) { - $char = $header[++$offset] ?? null; - - if (!isset($char)) { - break; - } - - $prev = $header[$offset-1] ?? null; - $next = $header[$offset+1] ?? null; - - if ($char === ',' && !$inQuotes) { - $inToken = true; - $inParamName = false; - $inParamValue = false; - $i++; - $p = 0; - continue; - } - if ($char === ';' && !$inQuotes) { - $inToken = false; - $inParamName = true; - $inParamValue = false; - $p++; - continue; - } - if ($char === '=' && !$inQuotes) { - $inToken = false; - $inParamName = false; - $inParamValue = true; - continue; - } - - // ignoring whitespaces around tokens... - if (isset($ows[$char]) && !$inQuotes) { - // en-GB[ ], ... - // ~~~~~~^~~~~~~ - if ($inToken && isset($data[$i][0])) { - $inToken = false; - } - // en-GB; q[ ]= 0.8, ... - // ~~~~~~~~~^~~~~~~~~~~~ - if ($inParamName && isset($data[$i][1][$p][0])) { - $inParamName = false; - } - // en-GB; q = 0.8[ ], ... - // ~~~~~~~~~~~~~~~^~~~~~~ - if ($inParamValue && isset($data[$i][1][$p][1])) { - $inParamValue = false; - } - - continue; - } - - // ignoring backslashes before double quotes in the quoted parameter value... - if ($char === '\\' && $next === '"' && $inQuotes) { - continue; - } - - if ($char === '"' && $inParamValue && !$inQuotes && !isset($data[$i][1][$p][1])) { - $inQuotes = true; - continue; - } - if ($char === '"' && $prev !== '\\' && $inQuotes) { - $inParamValue = false; - $inQuotes = false; - continue; - } - - // [en-GB]; q=0.8, ... - // ~^^^^^~~~~~~~~~~~~~ - if ($inToken && (isset($token[$char]) || $char === '/')) { - $data[$i][0] ??= ''; - $data[$i][0] .= $char; - continue; - } - // en-GB; [q]=0.8, ... - // ~~~~~~~~^~~~~~~~~~~ - if ($inParamName && isset($token[$char]) && isset($data[$i][0])) { - $data[$i][1][$p][0] ??= ''; - $data[$i][1][$p][0] .= $char; - continue; - } - // en-GB; q=[0.8], ... - // ~~~~~~~~~~^^^~~~~~~ - // phpcs:ignore Generic.Files.LineLength - if ($inParamValue && (isset($token[$char]) || ($inQuotes && (isset($quotedString[$char]) || ($prev . $char) === '\"'))) && isset($data[$i][1][$p][0])) { - $data[$i][1][$p][1] ??= ''; - $data[$i][1][$p][1] .= $char; - continue; - } - - // the header is invalid... - return null; - } - - $result = []; - foreach ($data as $item) { - $result[$item[0]] = []; - if (isset($item[1])) { - foreach ($item[1] as $param) { - $result[$item[0]][$param[0]] = $param[1] ?? ''; - } - } - } - - uasort($result, static fn(array $a, array $b): int => ($b['q'] ?? 1) <=> ($a['q'] ?? 1)); - - return $result; -} diff --git a/functions/parse_header.php b/functions/parse_header.php new file mode 100644 index 00000000..50fe3335 --- /dev/null +++ b/functions/parse_header.php @@ -0,0 +1,178 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router; + +use Sunrise\Http\Router\Dictionary\Charset; +use Sunrise\Http\Router\Exception\InvalidArgumentException; + +use function sprintf; + +/** + * Parses the given header + * + * @param string $header + * + * @return T + * + * @throws InvalidArgumentException If the given header is invalid. + * + * @template T as list}> + * + * @since 3.0.0 + */ +function parse_header(string $header): array +{ + /** @var list}> $matches */ + $matches = []; + + $offset = -1; + $inToken = true; + $inParamName = false; + $inParamValue = false; + $inQuotedString = false; + $isQuotedChar = false; + + $tokenIndex = 0; + $paramIndex = 0; + + while (true) { + $offset++; + + $char = $header[$offset] ?? null; + if ($char === null) { + break; + } + + // en-GB; q=0.8[,] ... + // ~~~~~~~~~~~~~^~~~~~ + if (!$inQuotedString && $char === ',') { + $inToken = true; + $inParamName = false; + $inParamValue = false; + $tokenIndex++; + $paramIndex = 0; + continue; + } + // en-GB[;] q=0.8, ... + // ~~~~~~^~~~~~~~~~~~~ + if (!$inQuotedString && $char === ';') { + $inToken = false; + $inParamName = true; + $inParamValue = false; + $paramIndex++; + continue; + } + // en-GB; q[=]0.8, ... + // ~~~~~~~~~^~~~~~~~~~ + if (!$inQuotedString && $char === '=') { + $inToken = false; + $inParamName = false; + $inParamValue = true; + continue; + } + + // en-GB[ ]; q=0.8, ... + // ~~~~~~^~~~~~~~~~~~~~ + if (!$inQuotedString && $inToken && isset(Charset::RFC7230_OWS[$char]) && isset($matches[$tokenIndex][0][0])) { + // The cursor is no longer inside the token, as it cannot contain OWS characters... + $inToken = false; + continue; + } + // en-GB; q[ ]=0.8, ... + // ~~~~~~~~~^~~~~~~~~~~ + // phpcs:ignore Generic.Files.LineLength + if (!$inQuotedString && $inParamName && isset(Charset::RFC7230_OWS[$char]) && isset($matches[$tokenIndex][1][$paramIndex][0][0])) { + // The cursor is no longer inside the parameter name, as it cannot contain OWS characters... + $inParamName = false; + continue; + } + // en-GB; q=0.8[ ], ... + // ~~~~~~~~~~~~~^~~~~~~ + // phpcs:ignore Generic.Files.LineLength + if (!$inQuotedString && $inParamValue && isset(Charset::RFC7230_OWS[$char]) && isset($matches[$tokenIndex][1][$paramIndex][1][0])) { + // The cursor is no longer inside the parameter value, as it cannot contain OWS characters... + $inParamValue = false; + continue; + } + + // Ignore any OWS characters outside the quoted string... + if (!$inQuotedString && isset(Charset::RFC7230_OWS[$char])) { + continue; + } + + // en-GB; q=["]0.8", ... + // ~~~~~~~~~~^~~~~~~~~~~ + if (!$inQuotedString && $inParamValue && $char === '"' && !isset($matches[$tokenIndex][1][$paramIndex][1][0])) { + $inQuotedString = true; + continue; + } + // en-GB; q="0.8["], ... + // ~~~~~~~~~~~~~~^~~~~~~ + if ($inQuotedString && $inParamValue && !$isQuotedChar && $char === '"') { + $inParamValue = false; + $inQuotedString = false; + continue; + } + + // en-GB; param="foo [\]"bar[\]" [\]\0", ... + // ~~~~~~~~~~~~~~~~~~~^~~~~~^~~~~~^~~~~~~~~~ + if ($inQuotedString && !$isQuotedChar && $char === '\\') { + $nextChar = $header[$offset + 1] ?? null; + // phpcs:ignore Generic.Files.LineLength + if (isset($nextChar) && ($nextChar === '\\' || $nextChar === '"' || isset(Charset::RFC7230_QUOTED_STRING[$nextChar]))) { + $isQuotedChar = true; + continue; + } + } + + // [en-GB]; q=0.8, ... + // ~^^^^^~~~~~~~~~~~~~ + if ($inToken) { // AS IS + $matches[$tokenIndex][0] ??= ''; + $matches[$tokenIndex][0] .= $char; + continue; + } + // en-GB; [q]=0.8, ... + // ~~~~~~~~^~~~~~~~~~~ + if ($inParamName && isset(Charset::RFC7230_TOKEN[$char]) && isset($matches[$tokenIndex][0][0])) { + $matches[$tokenIndex][1][$paramIndex][0] ??= ''; + $matches[$tokenIndex][1][$paramIndex][0] .= $char; + continue; + } + // en-GB; q=[0.8], ... + // ~~~~~~~~~~^^^~~~~~~ + // phpcs:ignore Generic.Files.LineLength + if ($inParamValue && (isset(Charset::RFC7230_TOKEN[$char]) || ($inQuotedString && isset(Charset::RFC7230_QUOTED_STRING[$char])) || $isQuotedChar) && isset($matches[$tokenIndex][1][$paramIndex][0][0])) { + $matches[$tokenIndex][1][$paramIndex][1] ??= ''; + $matches[$tokenIndex][1][$paramIndex][1] .= $char; + $isQuotedChar = false; + continue; + } + + throw new InvalidArgumentException(sprintf('Unexpected character at position %d', $offset)); + } + + $result = []; + foreach ($matches as $index => $match) { + $result[$index] = [$match[0], []]; + if (isset($match[1])) { + foreach ($match[1] as $param) { + $result[$index][1][$param[0]] = $param[1] ?? null; + } + } + } + + /** @var T */ + return $result; +} diff --git a/functions/parse_header_with_media_type.php b/functions/parse_header_with_media_type.php new file mode 100644 index 00000000..fbdb526a --- /dev/null +++ b/functions/parse_header_with_media_type.php @@ -0,0 +1,91 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router; + +use Generator; +use Sunrise\Http\Router\Dictionary\Charset; +use Sunrise\Http\Router\Entity\MediaType; +use Sunrise\Http\Router\Exception\InvalidArgumentException; + +use function sprintf; +use function strtolower; + +/** + * Parses the given header that contains media types + * + * @param string $header + * + * @return Generator, MediaType> + * + * @throws InvalidArgumentException If one of the media types is invalid. + * + * @since 3.0.0 + */ +function parse_header_with_media_type(string $header): Generator +{ + $matches = parse_header($header); + if ($matches === []) { + return; + } + + foreach ($matches as $index => [$token, $parameters]) { + $offset = -1; + + $inType = true; + $inSubtype = false; + + $type = null; + $subtype = null; + + while (true) { + $offset++; + + $char = $token[$offset] ?? null; + if ($char === null) { + break; + } + + if ($char === '/' && $inSubtype === false) { + $inType = false; + $inSubtype = true; + continue; + } + + if ($inType && isset(Charset::RFC7230_TOKEN[$char])) { + $type .= $char; + continue; + } + + if ($inSubtype && isset(Charset::RFC7230_TOKEN[$char])) { + $subtype .= $char; + continue; + } + + throw new InvalidArgumentException(sprintf( + 'Unexpected character at position %d inside media type with index %d.', + $offset, + $index, + )); + } + + if ($subtype === null) { + throw new InvalidArgumentException(sprintf( + 'Missing subtype for media type with index %d.', + $index, + )); + } + + yield $index => new MediaType(strtolower($type), strtolower($subtype), $parameters); + } +} diff --git a/functions/reflect_callable.php b/functions/reflect_callback.php similarity index 90% rename from functions/reflect_callable.php rename to functions/reflect_callback.php index e563cd43..be81733b 100644 --- a/functions/reflect_callable.php +++ b/functions/reflect_callback.php @@ -32,12 +32,11 @@ * * @return ReflectionFunction|ReflectionMethod * - * @throws InvalidArgumentException - * If the given callback cannot be reflected. + * @throws InvalidArgumentException If the given callback cannot be reflected. * * @since 3.0.0 */ -function reflect_callable(callable $callback): ReflectionFunction|ReflectionMethod +function reflect_callback(callable $callback): ReflectionFunction|ReflectionMethod { if ($callback instanceof Closure) { return new ReflectionFunction($callback); diff --git a/src/Annotation/Consume.php b/src/Annotation/Consume.php index 8eaf7d85..bcbf45a4 100644 --- a/src/Annotation/Consume.php +++ b/src/Annotation/Consume.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; +use Sunrise\Http\Router\Entity\MediaType; /** * @since 3.0.0 @@ -25,9 +26,9 @@ final class Consume /** * Constructor of the class * - * @param non-empty-string $value + * @param MediaType|non-empty-string $value */ - public function __construct(public string $value) + public function __construct(public MediaType|string $value) { } } diff --git a/src/Annotation/Produce.php b/src/Annotation/Produce.php index ccac05ce..407b911e 100644 --- a/src/Annotation/Produce.php +++ b/src/Annotation/Produce.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; +use Sunrise\Http\Router\Entity\MediaType; /** * @since 3.0.0 @@ -25,9 +26,9 @@ final class Produce /** * Constructor of the class * - * @param non-empty-string $value + * @param MediaType|non-empty-string $value */ - public function __construct(public string $value) + public function __construct(public MediaType|string $value) { } } diff --git a/src/Annotation/ProxyChain.php b/src/Annotation/ProxyChain.php new file mode 100644 index 00000000..ff449937 --- /dev/null +++ b/src/Annotation/ProxyChain.php @@ -0,0 +1,36 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_PARAMETER)] +final class ProxyChain +{ + + /** + * Constructor of the class + * + * @param array $value + * + * @template TKey as non-empty-string Proxy address + * @template TValue as non-empty-string Trusted header + */ + public function __construct(public array $value) + { + } +} diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index 5b6ea783..4bb47742 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -15,6 +15,7 @@ use Attribute; use Fig\Http\Message\RequestMethodInterface; +use Sunrise\Http\Router\Entity\MediaType; #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] final class Route implements RequestMethodInterface @@ -29,6 +30,20 @@ final class Route implements RequestMethodInterface */ public mixed $holder = null; + /** + * The route's consumes media types + * + * @var list + */ + public array $consumes = []; + + /** + * The route's produces media types + * + * @var list + */ + public array $produces = []; + /** * Constructor of the class * @@ -37,8 +52,6 @@ final class Route implements RequestMethodInterface * @param non-empty-string $path The route's path * @param non-empty-string|null $method The route's method * @param list $methods The route's methods - * @param list $consumes The route's consumed media types - * @param list $produces The route's produced media types * @param list $middlewares The route's middlewares * @param array $attributes The route's attributes * @param string $summary The route's summary @@ -52,8 +65,6 @@ public function __construct( public string $path = '/', ?string $method = null, public array $methods = [], - public array $consumes = [], - public array $produces = [], public array $middlewares = [], public array $attributes = [], public string $summary = '', diff --git a/src/ClassResolver.php b/src/ClassResolver.php index d457a173..88522cd1 100644 --- a/src/ClassResolver.php +++ b/src/ClassResolver.php @@ -13,12 +13,11 @@ namespace Sunrise\Http\Router; +use ReflectionClass; use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Exception\LogicException; -use ReflectionClass; use function class_exists; -use function is_object; use function sprintf; /** @@ -66,18 +65,12 @@ public function resolveClass(string $fqn): object } if (!class_exists($fqn)) { - throw new InvalidArgumentException(sprintf( - 'Class %s does not exist', - $fqn - )); + throw new InvalidArgumentException(sprintf('The class %s does not exist', $fqn)); } $class = new ReflectionClass($fqn); if (!$class->isInstantiable()) { - throw new LogicException(sprintf( - 'Class %s cannot be initialized', - $fqn - )); + throw new LogicException(sprintf('The class %s cannot be initialized', $fqn)); } $arguments = []; diff --git a/src/Dictionary/Charset.php b/src/Dictionary/Charset.php new file mode 100644 index 00000000..05e975e9 --- /dev/null +++ b/src/Dictionary/Charset.php @@ -0,0 +1,72 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Dictionary; + +/** + * Charset + * + * @since 3.0.0 + */ +final class Charset +{ + public const WILDCARD = '*'; + + public const RFC7230_OWS = [ + "\x09" => 1, "\x20" => 1, + ]; + + public const RFC7230_TOKEN = [ + "\x21" => 1, "\x23" => 1, "\x24" => 1, "\x25" => 1, "\x26" => 1, "\x27" => 1, "\x2a" => 1, "\x2b" => 1, + "\x2d" => 1, "\x2e" => 1, "\x5e" => 1, "\x5f" => 1, "\x60" => 1, "\x7c" => 1, "\x7e" => 1, "\x30" => 1, + "\x31" => 1, "\x32" => 1, "\x33" => 1, "\x34" => 1, "\x35" => 1, "\x36" => 1, "\x37" => 1, "\x38" => 1, + "\x39" => 1, "\x41" => 1, "\x42" => 1, "\x43" => 1, "\x44" => 1, "\x45" => 1, "\x46" => 1, "\x47" => 1, + "\x48" => 1, "\x49" => 1, "\x4a" => 1, "\x4b" => 1, "\x4c" => 1, "\x4d" => 1, "\x4e" => 1, "\x4f" => 1, + "\x50" => 1, "\x51" => 1, "\x52" => 1, "\x53" => 1, "\x54" => 1, "\x55" => 1, "\x56" => 1, "\x57" => 1, + "\x58" => 1, "\x59" => 1, "\x5a" => 1, "\x61" => 1, "\x62" => 1, "\x63" => 1, "\x64" => 1, "\x65" => 1, + "\x66" => 1, "\x67" => 1, "\x68" => 1, "\x69" => 1, "\x6a" => 1, "\x6b" => 1, "\x6c" => 1, "\x6d" => 1, + "\x6e" => 1, "\x6f" => 1, "\x70" => 1, "\x71" => 1, "\x72" => 1, "\x73" => 1, "\x74" => 1, "\x75" => 1, + "\x76" => 1, "\x77" => 1, "\x78" => 1, "\x79" => 1, "\x7a" => 1, + ]; + + public const RFC7230_QUOTED_STRING = [ + "\x09" => 1, "\x20" => 1, "\x21" => 1, "\x23" => 1, "\x24" => 1, "\x25" => 1, "\x26" => 1, "\x27" => 1, + "\x28" => 1, "\x29" => 1, "\x2a" => 1, "\x2b" => 1, "\x2c" => 1, "\x2d" => 1, "\x2e" => 1, "\x2f" => 1, + "\x30" => 1, "\x31" => 1, "\x32" => 1, "\x33" => 1, "\x34" => 1, "\x35" => 1, "\x36" => 1, "\x37" => 1, + "\x38" => 1, "\x39" => 1, "\x3a" => 1, "\x3b" => 1, "\x3c" => 1, "\x3d" => 1, "\x3e" => 1, "\x3f" => 1, + "\x40" => 1, "\x41" => 1, "\x42" => 1, "\x43" => 1, "\x44" => 1, "\x45" => 1, "\x46" => 1, "\x47" => 1, + "\x48" => 1, "\x49" => 1, "\x4a" => 1, "\x4b" => 1, "\x4c" => 1, "\x4d" => 1, "\x4e" => 1, "\x4f" => 1, + "\x50" => 1, "\x51" => 1, "\x52" => 1, "\x53" => 1, "\x54" => 1, "\x55" => 1, "\x56" => 1, "\x57" => 1, + "\x58" => 1, "\x59" => 1, "\x5a" => 1, "\x5b" => 1, "\x5d" => 1, "\x5e" => 1, "\x5f" => 1, "\x60" => 1, + "\x61" => 1, "\x62" => 1, "\x63" => 1, "\x64" => 1, "\x65" => 1, "\x66" => 1, "\x67" => 1, "\x68" => 1, + "\x69" => 1, "\x6a" => 1, "\x6b" => 1, "\x6c" => 1, "\x6d" => 1, "\x6e" => 1, "\x6f" => 1, "\x70" => 1, + "\x71" => 1, "\x72" => 1, "\x73" => 1, "\x74" => 1, "\x75" => 1, "\x76" => 1, "\x77" => 1, "\x78" => 1, + "\x79" => 1, "\x7a" => 1, "\x7b" => 1, "\x7c" => 1, "\x7d" => 1, "\x7e" => 1, "\x80" => 1, "\x81" => 1, + "\x82" => 1, "\x83" => 1, "\x84" => 1, "\x85" => 1, "\x86" => 1, "\x87" => 1, "\x88" => 1, "\x89" => 1, + "\x8a" => 1, "\x8b" => 1, "\x8c" => 1, "\x8d" => 1, "\x8e" => 1, "\x8f" => 1, "\x90" => 1, "\x91" => 1, + "\x92" => 1, "\x93" => 1, "\x94" => 1, "\x95" => 1, "\x96" => 1, "\x97" => 1, "\x98" => 1, "\x99" => 1, + "\x9a" => 1, "\x9b" => 1, "\x9c" => 1, "\x9d" => 1, "\x9e" => 1, "\x9f" => 1, "\xa0" => 1, "\xa1" => 1, + "\xa2" => 1, "\xa3" => 1, "\xa4" => 1, "\xa5" => 1, "\xa6" => 1, "\xa7" => 1, "\xa8" => 1, "\xa9" => 1, + "\xaa" => 1, "\xab" => 1, "\xac" => 1, "\xad" => 1, "\xae" => 1, "\xaf" => 1, "\xb0" => 1, "\xb1" => 1, + "\xb2" => 1, "\xb3" => 1, "\xb4" => 1, "\xb5" => 1, "\xb6" => 1, "\xb7" => 1, "\xb8" => 1, "\xb9" => 1, + "\xba" => 1, "\xbb" => 1, "\xbc" => 1, "\xbd" => 1, "\xbe" => 1, "\xbf" => 1, "\xc0" => 1, "\xc1" => 1, + "\xc2" => 1, "\xc3" => 1, "\xc4" => 1, "\xc5" => 1, "\xc6" => 1, "\xc7" => 1, "\xc8" => 1, "\xc9" => 1, + "\xca" => 1, "\xcb" => 1, "\xcc" => 1, "\xcd" => 1, "\xce" => 1, "\xcf" => 1, "\xd0" => 1, "\xd1" => 1, + "\xd2" => 1, "\xd3" => 1, "\xd4" => 1, "\xd5" => 1, "\xd6" => 1, "\xd7" => 1, "\xd8" => 1, "\xd9" => 1, + "\xda" => 1, "\xdb" => 1, "\xdc" => 1, "\xdd" => 1, "\xde" => 1, "\xdf" => 1, "\xe0" => 1, "\xe1" => 1, + "\xe2" => 1, "\xe3" => 1, "\xe4" => 1, "\xe5" => 1, "\xe6" => 1, "\xe7" => 1, "\xe8" => 1, "\xe9" => 1, + "\xea" => 1, "\xeb" => 1, "\xec" => 1, "\xed" => 1, "\xee" => 1, "\xef" => 1, "\xf0" => 1, "\xf1" => 1, + "\xf2" => 1, "\xf3" => 1, "\xf4" => 1, "\xf5" => 1, "\xf6" => 1, "\xf7" => 1, "\xf8" => 1, "\xf9" => 1, + "\xfa" => 1, "\xfb" => 1, "\xfc" => 1, "\xfd" => 1, "\xfe" => 1, "\xff" => 1, + ]; +} diff --git a/src/Entity/IpAddress.php b/src/Entity/ClientRemoteAddress.php similarity index 70% rename from src/Entity/IpAddress.php rename to src/Entity/ClientRemoteAddress.php index 4e5477a8..2d67b9dc 100644 --- a/src/Entity/IpAddress.php +++ b/src/Entity/ClientRemoteAddress.php @@ -13,26 +13,28 @@ namespace Sunrise\Http\Router\Entity; +use Stringable; + /** - * IP address + * Client remote address * * @since 3.0.0 */ -final class IpAddress +final class ClientRemoteAddress implements Stringable { /** * Constructor of the class * - * @param non-empty-string $value The IP address value - * @param list $proxies The list of proxies in front of this IP address + * @param non-empty-string $value The address value + * @param list $proxies The list of proxies in front of this address */ public function __construct(private string $value, private array $proxies = []) { } /** - * Gets the IP address value + * Gets the address value * * @return non-empty-string */ @@ -42,7 +44,7 @@ public function getValue(): string } /** - * Gets the list of proxies in front of this IP address + * Gets the list of proxies in front of this address * * @return list */ @@ -50,4 +52,12 @@ public function getProxies(): array { return $this->proxies; } + + /** + * @inheritDoc + */ + public function __toString(): string + { + return $this->value; + } } diff --git a/src/Entity/MediaType.php b/src/Entity/MediaType.php index 289b1440..2ed04d60 100644 --- a/src/Entity/MediaType.php +++ b/src/Entity/MediaType.php @@ -13,6 +13,8 @@ namespace Sunrise\Http\Router\Entity; +use Sunrise\Http\Router\Dictionary\Charset; + /** * Media type * @@ -20,36 +22,40 @@ */ final class MediaType { - public const APPLICATION_JSON = 'application/json'; - public const APPLICATION_XML = 'application/xml'; - public const APPLICATION_YAML = 'application/yaml'; - public const TEXT_CSV = 'text/csv'; - public const TEXT_HTML = 'text/html'; - public const TEXT_PLAIN = 'text/plain'; - public const TEXT_XML = 'text/xml'; /** * Constructor of the class * - * @param non-empty-string $value + * @param non-empty-string $type + * @param non-empty-string $subtype * @param array $parameters */ - public function __construct(private string $value, private array $parameters = []) + public function __construct(private string $type, private string $subtype, private array $parameters = []) + { + } + + /** + * Gets the type of the media type + * + * @return non-empty-string + */ + public function getType(): string { + return $this->type; } /** - * Gets the media type value + * Gets the subtype of the media type * * @return non-empty-string */ - public function getValue(): string + public function getSubtype(): string { - return $this->value; + return $this->subtype; } /** - * Gets the media type parameters + * Gets the parameters of the media type * * @return array */ @@ -57,4 +63,57 @@ public function getParameters(): array { return $this->parameters; } + + /** + * Gets the media range of the media type + * + * @return non-empty-string + */ + public function getMediaRange(): string + { + return $this->type . '/' . $this->subtype; + } + + /** + * Gets the quality factor of the media type + * + * @return float + */ + public function getQualityFactor(): float + { + return (float) ($this->parameters['q'] ?? 1.); + } + + /** + * Checks if the type of the media type is wildcard + * + * @return bool + */ + public function isWildcardType(): bool + { + return $this->type === Charset::WILDCARD; + } + + /** + * Checks if the subtype of the media type is wildcard + * + * @return bool + */ + public function isWildcardSubtype(): bool + { + return $this->subtype === Charset::WILDCARD; + } + + /** + * Checks if this media type equals to the given media type + * + * @param MediaType $other + * + * @return bool + */ + public function equals(MediaType $other): bool + { + return ($this->isWildcardType() || $other->isWildcardType() || $this->getType() === $other->getType()) + && ($this->isWildcardSubtype() || $other->isWildcardSubtype() || $this->getType() === $other->getSubtype()); + } } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 0354769a..e823f85d 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router\Loader; use FilesystemIterator; +use Generator; use Psr\Container\ContainerInterface; use Psr\Http\Server\RequestHandlerInterface; use Psr\SimpleCache\CacheInterface; @@ -33,6 +34,7 @@ use Sunrise\Http\Router\Annotation\Route; use Sunrise\Http\Router\Annotation\Summary; use Sunrise\Http\Router\Annotation\Tag; +use Sunrise\Http\Router\Entity\MediaType; use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ParameterResolutioner; @@ -59,6 +61,8 @@ use function sprintf; use function usort; +use function Sunrise\Http\Router\parse_header_with_media_type; + /** * DescriptorLoader */ @@ -310,8 +314,8 @@ public function load(): RouteCollectionInterface ); $route->setHost($descriptor->host); - $route->setConsumedMediaTypes(...$descriptor->consumes); - $route->setProducedMediaTypes(...$descriptor->produces); + $route->setConsumesMediaTypes(...$descriptor->consumes); + $route->setProducesMediaTypes(...$descriptor->produces); $route->setSummary($descriptor->summary); $route->setDescription($descriptor->description); $route->setTags(...$descriptor->tags); @@ -360,9 +364,9 @@ private function getDescriptors(): array * * @param string $resource * - * @return iterable + * @return Generator */ - private function getResourceDescriptors(string $resource): iterable + private function getResourceDescriptors(string $resource): Generator { if (class_exists($resource)) { yield from $this->getClassDescriptors(new ReflectionClass($resource)); @@ -380,9 +384,9 @@ private function getResourceDescriptors(string $resource): iterable * * @param ReflectionClass $class * - * @return iterable + * @return Generator */ - private function getClassDescriptors(ReflectionClass $class): iterable + private function getClassDescriptors(ReflectionClass $class): Generator { if (!$class->isInstantiable()) { return; @@ -447,12 +451,28 @@ private function supplementDescriptor(Route $descriptor, ReflectionClass|Reflect $annotations = $this->getAnnotations(Consume::class, $holder); foreach ($annotations as $annotation) { - $descriptor->consumes[] = $annotation->value; + if ($annotation->value instanceof MediaType) { + $descriptor->consumes[] = $annotation->value; + continue; + } + + $consumes = parse_header_with_media_type($annotation->value); + foreach ($consumes as $consume) { + $descriptor->consumes[] = $consume; + } } $annotations = $this->getAnnotations(Produce::class, $holder); foreach ($annotations as $annotation) { - $descriptor->produces[] = $annotation->value; + if ($annotation->value instanceof MediaType) { + $descriptor->produces[] = $annotation->value; + continue; + } + + $produces = parse_header_with_media_type($annotation->value); + foreach ($produces as $produce) { + $descriptor->produces[] = $produce; + } } $annotations = $this->getAnnotations(Middleware::class, $holder); @@ -502,9 +522,9 @@ private function getAnnotations(string $name, ReflectionClass|ReflectionMethod $ * * @param string $dirname * - * @return iterable + * @return Generator */ - private function getDirectoryClasses(string $dirname): iterable + private function getDirectoryClasses(string $dirname): Generator { /** @var array $filenames */ $filenames = iterator_to_array( diff --git a/src/Middleware/CallbackMiddleware.php b/src/Middleware/CallbackMiddleware.php index d68d1b58..8fad2684 100644 --- a/src/Middleware/CallbackMiddleware.php +++ b/src/Middleware/CallbackMiddleware.php @@ -23,7 +23,7 @@ use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; use Sunrise\Http\Router\ResponseResolutionerInterface; -use function Sunrise\Http\Router\reflect_callable; +use function Sunrise\Http\Router\reflect_callback; /** * CallbackMiddleware @@ -78,7 +78,7 @@ public function __construct( */ public function getReflection(): ReflectionFunction|ReflectionMethod { - return reflect_callable($this->callback); + return reflect_callback($this->callback); } /** diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 3d1d362d..f249fb98 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -18,6 +18,7 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\Entity\MediaType; use Sunrise\Http\Router\Exception\InvalidRequestPayloadException; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ServerRequest; @@ -59,12 +60,17 @@ public function __construct() */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if (ServerRequest::from($request)->isJson()) { - $request = $request->withParsedBody( - $this->decodePayload( - $request->getBody()->__toString() - ) - ); + $requestProxy = ServerRequest::from($request); + $clientProducedMediaType = $requestProxy->getClientProducedMediaType(); + if (isset($clientProducedMediaType)) { + $serverConsumesMediaType = new MediaType('application', 'json'); + if ($serverConsumesMediaType->equals($clientProducedMediaType)) { + $request = $request->withParsedBody( + $this->decodePayload( + $request->getBody()->__toString() + ) + ); + } } return $handler->handle($request); @@ -84,7 +90,7 @@ private function decodePayload(string $payload): array try { $data = json_decode($payload, true, 512, JSON_BIGINT_AS_STRING | JSON_THROW_ON_ERROR); } catch (JsonException $e) { - throw new InvalidRequestPayloadException(sprintf('Invalid JSON: %s', $e->getMessage()), 0, $e); + throw new InvalidRequestPayloadException(sprintf('Invalid JSON payload: %s', $e->getMessage()), 0, $e); } // According to PSR-7, the data must be an array diff --git a/src/Middleware/SimdJsonPayloadDecodingMiddleware.php b/src/Middleware/SimdJsonPayloadDecodingMiddleware.php index a24da152..7309ff99 100644 --- a/src/Middleware/SimdJsonPayloadDecodingMiddleware.php +++ b/src/Middleware/SimdJsonPayloadDecodingMiddleware.php @@ -18,6 +18,7 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\Entity\MediaType; use Sunrise\Http\Router\Exception\InvalidRequestPayloadException; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ServerRequest; @@ -56,12 +57,17 @@ public function __construct() */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if (ServerRequest::from($request)->isJson()) { - $request = $request->withParsedBody( - $this->decodePayload( - $request->getBody()->__toString() - ) - ); + $requestProxy = ServerRequest::from($request); + $clientProducedMediaType = $requestProxy->getClientProducedMediaType(); + if (isset($clientProducedMediaType)) { + $serverConsumesMediaType = new MediaType('application', 'json'); + if ($serverConsumesMediaType->equals($clientProducedMediaType)) { + $request = $request->withParsedBody( + $this->decodePayload( + $request->getBody()->__toString() + ) + ); + } } return $handler->handle($request); @@ -81,7 +87,7 @@ private function decodePayload(string $payload): array try { $data = simdjson_decode($payload, true, 512); } catch (SimdJsonException $e) { - throw new InvalidRequestPayloadException(sprintf('Invalid JSON: %s', $e->getMessage()), 0, $e); + throw new InvalidRequestPayloadException(sprintf('Invalid JSON payload: %s', $e->getMessage()), 0, $e); } // According to PSR-7, the data must be an array diff --git a/src/ParameterResolutioner.php b/src/ParameterResolutioner.php index 87148307..3d9ed969 100644 --- a/src/ParameterResolutioner.php +++ b/src/ParameterResolutioner.php @@ -110,11 +110,11 @@ private function resolveParameter(ReflectionParameter $parameter): Generator } if ($parameter->isDefaultValueAvailable()) { - return yield $parameter->getDefaultValue(); + return yield $parameter->getDefaultValue(); } throw new LogicException(sprintf( - 'Unable to resolve the parameter {%s}.', + 'Unable to resolve the parameter {%s}', self::stringifyParameter($parameter) )); } diff --git a/src/ParameterResolver/ClientRemoteAddressParameterResolver.php b/src/ParameterResolver/ClientRemoteAddressParameterResolver.php new file mode 100644 index 00000000..27bd8ebc --- /dev/null +++ b/src/ParameterResolver/ClientRemoteAddressParameterResolver.php @@ -0,0 +1,75 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ParameterResolver; + +use Generator; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionAttribute; +use ReflectionNamedType; +use ReflectionParameter; +use Sunrise\Http\Router\Annotation\ProxyChain; +use Sunrise\Http\Router\Entity\ClientRemoteAddress; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ServerRequest; + +/** + * ClientRemoteAddressParameterResolver + * + * @since 3.0.0 + */ +final class ClientRemoteAddressParameterResolver implements ParameterResolverInterface +{ + + /** + * Constructor of th class + * + * @param array $proxyChain + * + * @template TKey as non-empty-string Proxy address + * @template TValue as non-empty-string Trusted header + */ + public function __construct(private array $proxyChain = []) + { + } + + /** + * @inheritDoc + * + * @throws LogicException If the resolver is used incorrectly. + */ + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + { + $type = $parameter->getType(); + + if (! ($type instanceof ReflectionNamedType) || + ! ($type->getName() === ClientRemoteAddress::class)) { + return; + } + + if (! $context instanceof ServerRequestInterface) { + throw new LogicException( + 'At this level of the application, any operations with the request are not possible.' + ); + } + + $proxyChain = $this->proxyChain; + /** @var list> $attributes */ + $attributes = $parameter->getAttributes(ProxyChain::class); + if (isset($attributes[0])) { + $proxyChain = $attributes[0]->newInstance()->value; + } + + yield ServerRequest::from($context)->getClientRemoteAddress($proxyChain); + } +} diff --git a/src/ParameterResolver/RequestRouteParameterResolver.php b/src/ParameterResolver/RequestRouteParameterResolver.php index df975527..0d919b51 100644 --- a/src/ParameterResolver/RequestRouteParameterResolver.php +++ b/src/ParameterResolver/RequestRouteParameterResolver.php @@ -40,10 +40,8 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) { $type = $parameter->getType(); - if ( - ! ($type instanceof ReflectionNamedType) || - ! ($type->getName() === RouteInterface::class) - ) { + if (! ($type instanceof ReflectionNamedType) || + ! ($type->getName() === RouteInterface::class)) { return; } diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index 073a8319..954e391a 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -124,7 +124,7 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface } throw new LogicException(sprintf( - 'Unable to resolve the reference {%s}.', + 'Unable to resolve the reference {%s}', self::stringifyReference($reference), )); } @@ -181,7 +181,7 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface } throw new LogicException(sprintf( - 'Unable to resolve the reference {%s}.', + 'Unable to resolve the reference {%s}', self::stringifyReference($reference), )); } diff --git a/src/RequestHandler/CallbackRequestHandler.php b/src/RequestHandler/CallbackRequestHandler.php index c6ecf8e7..572c3458 100644 --- a/src/RequestHandler/CallbackRequestHandler.php +++ b/src/RequestHandler/CallbackRequestHandler.php @@ -22,7 +22,7 @@ use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; use Sunrise\Http\Router\ResponseResolutionerInterface; -use function Sunrise\Http\Router\reflect_callable; +use function Sunrise\Http\Router\reflect_callback; /** * CallbackRequestHandler @@ -77,7 +77,7 @@ public function __construct( */ public function getReflection(): ReflectionFunction|ReflectionMethod { - return reflect_callable($this->callback); + return reflect_callback($this->callback); } /** diff --git a/src/ResponseResolutioner.php b/src/ResponseResolutioner.php index f5c3b8c6..b3d81403 100644 --- a/src/ResponseResolutioner.php +++ b/src/ResponseResolutioner.php @@ -71,7 +71,7 @@ public function resolveResponse( } throw new LogicException(sprintf( - 'Unable to resolve the response {%s} to PSR-7 response.', + 'Unable to resolve the response {%s} to PSR-7 response', self::stringifyResponse($response, $source), )); } diff --git a/src/ResponseResolver/ResponseBodyResponseResolver.php b/src/ResponseResolver/ResponseBodyResponseResolver.php index b4b04305..fd6ad771 100644 --- a/src/ResponseResolver/ResponseBodyResponseResolver.php +++ b/src/ResponseResolver/ResponseBodyResponseResolver.php @@ -26,7 +26,7 @@ use Sunrise\Http\Router\ServerRequest; use Symfony\Component\Serializer\SerializerInterface; -use function next; +use function in_array; use function reset; use function sprintf; @@ -38,30 +38,21 @@ final class ResponseBodyResponseResolver implements ResponseResolverInterface { - /** - * @var array - */ - public const MEDIA_TYPE_FORMATS = [ - MediaType::APPLICATION_JSON => 'json', - MediaType::APPLICATION_XML => 'xml', - MediaType::APPLICATION_YAML => 'yaml', - ]; - /** * Constructor of the class * * @param ResponseFactoryInterface $responseFactory * @param SerializerInterface $serializer - * @param non-empty-string $defaultMediaType - * @param array $mediaTypeFormats + * @param non-empty-string $defaultFormat + * @param array $formats * @param array $serializationContext */ public function __construct( private ResponseFactoryInterface $responseFactory, - private SerializerInterface $serializer, - private string $defaultMediaType = MediaType::APPLICATION_JSON, - private array $mediaTypeFormats = self::MEDIA_TYPE_FORMATS, - private array $serializationContext = [], + private SerializerInterface $serializer, + private string $defaultFormat = 'json', + private array $formats = self::MEDIA_FORMATS, + private array $serializationContext = [], ) { } @@ -79,41 +70,23 @@ public function resolveResponse( return null; } - $mediaType = $this->defaultMediaType; + $format = $this->defaultFormat; /** @var RouteInterface|null $route */ $route = $request->getAttribute('@route'); if ($route instanceof RouteInterface) { - $producedMediaTypes = $route->getProducedMediaTypes(); - if (!empty($producedMediaTypes)) { - $mediaType = reset($producedMediaTypes); - $consumedMediaTypes = ServerRequest::from($request)->getClientConsumedMediaTypes(); - while ($producedMediaType = next($producedMediaTypes)) { - if (isset($consumedMediaTypes[$producedMediaType])) { - $mediaType = $producedMediaType; - break; - } - } - } - } + $mediaRange = ServerRequest::from($request) + ->getClientPreferredMediaType(...$route->getProducesMediaTypes()) + ?->getMediaRange(); - if (!isset($this->mediaTypeFormats[$mediaType])) { - throw new LogicException(sprintf( - 'The response {%s} cannot be serialized. ' . - 'Make sure that the resolver %s is configured correctly, ' . - 'and also ensure that the current route provides media types known to the resolver.', - ResponseResolutioner::stringifyResponse($response, $source), - ResponseBodyResponseResolver::class, - )); + if (isset($mediaRange) && isset($this->formats[$mediaRange])) { + $format = $this->formats[$mediaRange]; + } } - $payload = $this->serializer->serialize( - $response, - $this->mediaTypeFormats[$mediaType], - $this->serializationContext, - ); + $payload = $this->serializer->serialize($response, $format, $this->serializationContext); - $contentType = sprintf('%s; charset=UTF-8', $mediaType); + $contentType = sprintf('%s; charset=UTF-8', $mediaType->getMediaRange()); $result = $this->responseFactory->createResponse(200) ->withHeader('Content-Type', $contentType); diff --git a/src/Route.php b/src/Route.php index 376e34f0..4cf4dcb3 100644 --- a/src/Route.php +++ b/src/Route.php @@ -19,10 +19,10 @@ use Psr\Http\Server\RequestHandlerInterface; use ReflectionFunction; use ReflectionMethod; +use Sunrise\Http\Router\Entity\MediaType; use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; use ReflectionClass; -use Reflector; use function rtrim; use function strtoupper; @@ -64,18 +64,18 @@ class Route implements RouteInterface private array $methods = []; /** - * The route's consumed media types + * The route's consumes media types * - * @var list + * @var list */ - private array $consumedMediaTypes = []; + private array $consumesMediaTypes = []; /** - * The route's produced media types + * The route's produces media types * - * @var list + * @var list */ - private array $producedMediaTypes = []; + private array $producesMediaTypes = []; /** * The route request handler @@ -180,17 +180,17 @@ public function getMethods(): array /** * @inheritDoc */ - public function getConsumedMediaTypes(): array + public function getConsumesMediaTypes(): array { - return $this->consumedMediaTypes; + return $this->consumesMediaTypes; } /** * @inheritDoc */ - public function getProducedMediaTypes(): array + public function getProducesMediaTypes(): array { - return $this->producedMediaTypes; + return $this->producesMediaTypes; } /** @@ -299,11 +299,11 @@ public function setMethods(string ...$methods): RouteInterface /** * @inheritDoc */ - public function setConsumedMediaTypes(string ...$mediaTypes): RouteInterface + public function setConsumesMediaTypes(MediaType ...$mediaTypes): RouteInterface { - $this->consumedMediaTypes = []; + $this->consumesMediaTypes = []; foreach ($mediaTypes as $mediaType) { - $this->consumedMediaTypes[] = $mediaType; + $this->consumesMediaTypes[] = $mediaType; } return $this; @@ -312,11 +312,11 @@ public function setConsumedMediaTypes(string ...$mediaTypes): RouteInterface /** * @inheritDoc */ - public function setProducedMediaTypes(string ...$mediaTypes): RouteInterface + public function setProducesMediaTypes(MediaType ...$mediaTypes): RouteInterface { - $this->producedMediaTypes = []; + $this->producesMediaTypes = []; foreach ($mediaTypes as $mediaType) { - $this->producedMediaTypes[] = $mediaType; + $this->producesMediaTypes[] = $mediaType; } return $this; @@ -436,10 +436,10 @@ public function addMethod(string ...$methods): RouteInterface /** * @inheritDoc */ - public function addConsumedMediaType(string ...$mediaTypes): RouteInterface + public function addConsumesMediaType(MediaType ...$mediaTypes): RouteInterface { foreach ($mediaTypes as $mediaType) { - $this->consumedMediaTypes[] = $mediaType; + $this->consumesMediaTypes[] = $mediaType; } return $this; @@ -448,10 +448,10 @@ public function addConsumedMediaType(string ...$mediaTypes): RouteInterface /** * @inheritDoc */ - public function addProducedMediaType(string ...$mediaTypes): RouteInterface + public function addProducesMediaType(MediaType ...$mediaTypes): RouteInterface { foreach ($mediaTypes as $mediaType) { - $this->producedMediaTypes[] = $mediaType; + $this->producesMediaTypes[] = $mediaType; } return $this; diff --git a/src/RouteCollection.php b/src/RouteCollection.php index 730bd99c..11ac5830 100644 --- a/src/RouteCollection.php +++ b/src/RouteCollection.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router; use Psr\Http\Server\MiddlewareInterface; +use Sunrise\Http\Router\Entity\MediaType; use Sunrise\Http\Router\Exception\RouteAlreadyExistsException; use Sunrise\Http\Router\Exception\RouteNotFoundException; use Iterator; @@ -153,10 +154,10 @@ public function setHost(string $host): RouteCollectionInterface /** * @inheritDoc */ - public function setConsumedMediaTypes(string ...$mediaTypes): RouteCollectionInterface + public function setConsumesMediaTypes(MediaType ...$mediaTypes): RouteCollectionInterface { foreach ($this->routes as $route) { - $route->setConsumedMediaTypes(...$mediaTypes); + $route->setConsumesMediaTypes(...$mediaTypes); } return $this; @@ -165,10 +166,10 @@ public function setConsumedMediaTypes(string ...$mediaTypes): RouteCollectionInt /** * @inheritDoc */ - public function setProducedMediaTypes(string ...$mediaTypes): RouteCollectionInterface + public function setProducesMediaTypes(MediaType ...$mediaTypes): RouteCollectionInterface { foreach ($this->routes as $route) { - $route->setProducedMediaTypes(...$mediaTypes); + $route->setProducesMediaTypes(...$mediaTypes); } return $this; @@ -225,10 +226,10 @@ public function addMethod(string ...$methods): RouteCollectionInterface /** * @inheritDoc */ - public function addConsumedMediaType(string ...$mediaTypes): RouteCollectionInterface + public function addConsumesMediaType(MediaType ...$mediaTypes): RouteCollectionInterface { foreach ($this->routes as $route) { - $route->addConsumedMediaType(...$mediaTypes); + $route->addConsumesMediaType(...$mediaTypes); } return $this; @@ -237,10 +238,10 @@ public function addConsumedMediaType(string ...$mediaTypes): RouteCollectionInte /** * @inheritDoc */ - public function addProducedMediaType(string ...$mediaTypes): RouteCollectionInterface + public function addProducesMediaType(MediaType ...$mediaTypes): RouteCollectionInterface { foreach ($this->routes as $route) { - $route->addProducedMediaType(...$mediaTypes); + $route->addProducesMediaType(...$mediaTypes); } return $this; diff --git a/src/RouteCollectionInterface.php b/src/RouteCollectionInterface.php index 51a88cf4..2ae51da0 100644 --- a/src/RouteCollectionInterface.php +++ b/src/RouteCollectionInterface.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router; use Psr\Http\Server\MiddlewareInterface; +use Sunrise\Http\Router\Entity\MediaType; use Sunrise\Http\Router\Exception\RouteAlreadyExistsException; use Sunrise\Http\Router\Exception\RouteNotFoundException; use Countable; @@ -98,26 +99,26 @@ public function add(RouteInterface ...$routes): RouteCollectionInterface; public function setHost(string $host): RouteCollectionInterface; /** - * Sets the given consumed media type(s) to all routes in the collection + * Sets the given consumes media type(s) to all routes in the collection * - * @param string ...$mediaTypes + * @param MediaType ...$mediaTypes * * @return RouteCollectionInterface * * @since 3.0.0 */ - public function setConsumedMediaTypes(string ...$mediaTypes): RouteCollectionInterface; + public function setConsumesMediaTypes(MediaType ...$mediaTypes): RouteCollectionInterface; /** - * Sets the given produced media type(s) to all routes in the collection + * Sets the given produces media type(s) to all routes in the collection * - * @param string ...$mediaTypes + * @param MediaType ...$mediaTypes * * @return RouteCollectionInterface * * @since 3.0.0 */ - public function setProducedMediaTypes(string ...$mediaTypes): RouteCollectionInterface; + public function setProducesMediaTypes(MediaType ...$mediaTypes): RouteCollectionInterface; /** * Sets the given attribute to all routes in the collection @@ -165,26 +166,26 @@ public function addSuffix(string $suffix): RouteCollectionInterface; public function addMethod(string ...$methods): RouteCollectionInterface; /** - * Adds the given consumed media type(s) to all routes in the collection + * Adds the given consumes media type(s) to all routes in the collection * - * @param string ...$mediaTypes + * @param MediaType ...$mediaTypes * * @return RouteCollectionInterface * * @since 3.0.0 */ - public function addConsumedMediaType(string ...$mediaTypes): RouteCollectionInterface; + public function addConsumesMediaType(MediaType ...$mediaTypes): RouteCollectionInterface; /** - * Adds the given produced media type(s) to all routes in the collection + * Adds the given produces media type(s) to all routes in the collection * - * @param string ...$mediaTypes + * @param MediaType ...$mediaTypes * * @return RouteCollectionInterface * * @since 3.0.0 */ - public function addProducedMediaType(string ...$mediaTypes): RouteCollectionInterface; + public function addProducesMediaType(MediaType ...$mediaTypes): RouteCollectionInterface; /** * Adds the given middleware(s) to all routes in the collection diff --git a/src/RouteInterface.php b/src/RouteInterface.php index a1e32cd9..83d8c861 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -19,7 +19,7 @@ use ReflectionClass; use ReflectionMethod; use ReflectionFunction; -use Reflector; +use Sunrise\Http\Router\Entity\MediaType; /** * RouteInterface @@ -67,22 +67,22 @@ public function getPath(): string; public function getMethods(): array; /** - * Gets the route's consumed media types + * Gets the route's consumes media types * - * @return list + * @return list * * @since 3.0.0 */ - public function getConsumedMediaTypes(): array; + public function getConsumesMediaTypes(): array; /** - * Gets the route's produced media types + * Gets the route's produces media types * - * @return list + * @return list * * @since 3.0.0 */ - public function getProducedMediaTypes(): array; + public function getProducesMediaTypes(): array; /** * Gets the route request handler @@ -180,26 +180,26 @@ public function setPath(string $path): RouteInterface; public function setMethods(string ...$methods): RouteInterface; /** - * Sets the given consumed media type(s) to the route + * Sets the given consumes media type(s) to the route * - * @param string ...$mediaTypes + * @param MediaType ...$mediaTypes * * @return RouteInterface * * @since 3.0.0 */ - public function setConsumedMediaTypes(string ...$mediaTypes): RouteInterface; + public function setConsumesMediaTypes(MediaType ...$mediaTypes): RouteInterface; /** - * Sets the given produced media type(s) to the route + * Sets the given produces media type(s) to the route * - * @param string ...$mediaTypes + * @param MediaType ...$mediaTypes * * @return RouteInterface * * @since 3.0.0 */ - public function setProducedMediaTypes(string ...$mediaTypes): RouteInterface; + public function setProducesMediaTypes(MediaType ...$mediaTypes): RouteInterface; /** * Sets the given request handler to the route @@ -301,26 +301,26 @@ public function addSuffix(string $suffix): RouteInterface; public function addMethod(string ...$methods): RouteInterface; /** - * Adds the given consumed media type(s) to the route + * Adds the given consumes media type(s) to the route * - * @param string ...$mediaTypes + * @param MediaType ...$mediaTypes * * @return RouteInterface * * @since 3.0.0 */ - public function addConsumedMediaType(string ...$mediaTypes): RouteInterface; + public function addConsumesMediaType(MediaType ...$mediaTypes): RouteInterface; /** - * Adds the given produced media type(s) to the route + * Adds the given produces media type(s) to the route * - * @param string ...$mediaTypes + * @param MediaType ...$mediaTypes * * @return RouteInterface * * @since 3.0.0 */ - public function addProducedMediaType(string ...$mediaTypes): RouteInterface; + public function addProducesMediaType(MediaType ...$mediaTypes): RouteInterface; /** * Adds the given middleware(s) to the route diff --git a/src/Router.php b/src/Router.php index 540fe8a2..4d3919e5 100644 --- a/src/Router.php +++ b/src/Router.php @@ -270,16 +270,11 @@ public function match(ServerRequestInterface $request): RouteInterface continue; } - $routeConsumes = $route->getConsumedMediaTypes(); + $routeConsumes = $route->getConsumesMediaTypes(); if (!empty($routeConsumes) && !$request->clientProducesMediaType($routeConsumes)) { throw new ClientNotProducedMediaTypeException($routeConsumes); } - $routeProduces = $route->getProducedMediaTypes(); - if (!empty($routeProduces) && !$request->clientConsumesMediaType($routeProduces)) { - throw new ClientNotConsumedMediaTypeException($routeProduces); - } - /** @var array $attributes */ return $route->withAddedAttributes($attributes); diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 0e754838..14c2e001 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -14,22 +14,25 @@ namespace Sunrise\Http\Router; use Fig\Http\Message\RequestMethodInterface; +use Generator; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\StreamInterface; use Psr\Http\Message\UriInterface; -use Sunrise\Http\Router\Entity\IpAddress; - +use Sunrise\Http\Router\Entity\ClientRemoteAddress; use Sunrise\Http\Router\Entity\MediaType; -use function array_merge; +use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; +use Sunrise\Http\Router\Exception\InvalidArgumentException; + +use Throwable; +use function current; use function explode; use function key; use function preg_split; -use function reset; +use function sprintf; use function strncmp; use function strpos; -use function strstr; use function strtolower; -use function trim; +use function usort; /** * ServerRequest @@ -65,178 +68,122 @@ public static function from(ServerRequestInterface $request): self } /** - * Checks if the request is JSON + * Gets the client's remote address * - * @link https://tools.ietf.org/html/rfc4627 + * @param array $proxyChain * - * @return bool - */ - public function isJson(): bool - { - return $this->clientProducesMediaType([ - MediaType::APPLICATION_JSON, - ]); - } - - /** - * Checks if the request is XML + * @return ClientRemoteAddress * - * @link https://tools.ietf.org/html/rfc2376 + * @template TKey as non-empty-string Proxy address; e.g., 127.0.0.1 + * @template TValue as non-empty-string Trusted header; e.g., X-Forwarded-For * - * @return bool + * @link https://www.rfc-editor.org/rfc/rfc7239.html#section-5.2 */ - public function isXml(): bool - { - return $this->clientProducesMediaType([ - MediaType::APPLICATION_XML, - MediaType::TEXT_XML, - ]); - } - - /** - * Gets the client's IP address - * - * @param array $proxyChain - * - * @return IpAddress - */ - public function getClientIpAddress(array $proxyChain = []): IpAddress + public function getClientRemoteAddress(array $proxyChain = []): ClientRemoteAddress { $serverParams = $this->request->getServerParams(); - /** @var non-empty-string $clientAddress */ $clientAddress = $serverParams['REMOTE_ADDR'] ?? '::1'; - /** @var list $proxyAddresses */ $proxyAddresses = []; while (isset($proxyChain[$clientAddress])) { - $proxyHeader = $proxyChain[$clientAddress]; + $trustedHeader = $proxyChain[$clientAddress]; unset($proxyChain[$clientAddress]); - $header = $this->request->getHeaderLine($proxyHeader); + $header = $this->request->getHeaderLine($trustedHeader); if ($header === '') { break; } /** @var list $addresses */ $addresses = preg_split('/\s*,\s*/', $header, -1, PREG_SPLIT_NO_EMPTY); - if ($addresses === []) { + if (empty($addresses)) { break; } - $clientAddress = array_shift($addresses); - if ($addresses === []) { - continue; - } + $clientAddress = $addresses[0]; + unset($addresses[0]); - $proxyAddresses = array_merge($proxyAddresses, $addresses); + foreach ($addresses as $address) { + $proxyAddresses[] = $address; + } } - return new IpAddress($clientAddress, $proxyAddresses); + return new ClientRemoteAddress($clientAddress, $proxyAddresses); } /** - * Gets the client's produced media type - * - * @link https://tools.ietf.org/html/rfc7231#section-3.1.1.1 - * @link https://tools.ietf.org/html/rfc7231#section-3.1.1.5 + * Gets the media type that the client produced * - * @return string + * @return MediaType|null */ - public function getClientProducedMediaType(): string + public function getClientProducedMediaType(): ?MediaType { $header = $this->request->getHeaderLine('Content-Type'); - if ($header === '') { - return ''; - } - - $result = strstr($header, ';', true); - if ($result === false) { - $result = $header; - } - $result = trim($result); - if ($result === '') { - return ''; + try { + return parse_header_with_media_type($header)->current(); + } catch (InvalidArgumentException $e) { + throw new HttpBadRequestException(sprintf('The Content-Type header is invalid: %s', $e->getMessage())); } - - return strtolower($result); } /** - * Gets the client's consumed media types - * - * @link https://tools.ietf.org/html/rfc7231#section-1.2 - * @link https://tools.ietf.org/html/rfc7231#section-3.1.1.1 - * @link https://tools.ietf.org/html/rfc7231#section-5.3.2 + * Gets the media types that the client consumes * - * @return array> + * @return Generator, MediaType> */ - public function getClientConsumedMediaTypes(): array + public function getClientConsumesMediaTypes(): Generator { $header = $this->request->getHeaderLine('Accept'); - if ($header === '') { - return []; - } - $accepts = parse_accept_header($header); - if (empty($accepts)) { - return []; + try { + yield from parse_header_with_media_type($header); + } catch (InvalidArgumentException $e) { + throw new HttpBadRequestException(sprintf('The Accept header is invalid: %s', $e->getMessage())); } - - $result = []; - foreach ($accepts as $type => $params) { - $result[strtolower($type)] = $params; - } - - return $result; } /** - * Gets the client's consumed encodings + * Gets the client's preferred media type * - * @return array> + * @param MediaType ...$serverProducesMediaTypes + * + * @return MediaType|null */ - public function getClientConsumedEncodings(): array + public function getClientPreferredMediaType(MediaType ...$serverProducesMediaTypes): ?MediaType { - $header = $this->request->getHeaderLine('Accept-Encoding'); - if ($header === '') { - return []; + if ($serverProducesMediaTypes === []) { + return null; } - $accepts = header_accept_like_parse($header); - if (empty($accepts)) { - return []; - } + /** @var list $clientConsumesMediaTypes */ + $clientConsumesMediaTypes = [...$this->getClientConsumesMediaTypes()]; - return $accepts; - } - - /** - * Gets the client's consumed languages - * - * @return array> - */ - public function getClientConsumedLanguages(): array - { - $header = $this->request->getHeaderLine('Accept-Language'); - if ($header === '') { - return []; + if ($clientConsumesMediaTypes === []) { + return current($serverProducesMediaTypes); } - $accepts = header_accept_like_parse($header); - if (empty($accepts)) { - return []; + usort($clientConsumesMediaTypes, static fn (MediaType $a, MediaType $b): int => ( + $b->getQualityFactor() <=> $a->getQualityFactor() + )); + + foreach ($clientConsumesMediaTypes as $clientConsumesMediaType) { + foreach ($serverProducesMediaTypes as $serverProducesMediaType) { + if ($serverProducesMediaType->equals($clientConsumesMediaType)) { + return $serverProducesMediaType; + } + } } - return $accepts; + return current($serverProducesMediaTypes); } /** * Checks if the client produces one of the given media types * - * @param list $consumes + * @param MediaType ...$consumes * * @return bool */ @@ -260,70 +207,6 @@ public function clientProducesMediaType(array $consumes): bool return false; } - /** - * Checks if the client consumes one of the given media types - * - * @param list $produces - * - * @return bool - */ - public function clientConsumesMediaType(array $produces): bool - { - if ($produces === []) { - return true; - } - - $consumes = $this->getClientConsumedMediaTypes(); - if ($consumes === []) { - return true; - } - - if (isset($consumes['*/*'])) { - return true; - } - - foreach ($produces as $a) { - foreach ($consumes as $b => $_) { - if (media_types_compare($a, $b)) { - return true; - } - } - } - - return false; - } - - /** - * Checks if the given media types are equal - * - * @param string $a - * @param string $b - * - * @return bool - */ - public function equalsMediaTypes(string $a, string $b): bool - { - if ($a === $b) { - return true; - } - - $slash = strpos($a, '/'); - if ($slash === false || !isset($b[$slash]) || $b[$slash] !== '/') { - return false; - } - - $star = $slash + 1; - if (!isset($a[$star], $b[$star])) { - return false; - } - - if (!($a[$star] === '*' || $b[$star] === '*')) { - return false; - } - - return strncmp($a, $b, $star) === 0; - } - /** * @inheritDoc */ From 3eb6a530a177292179adf0245e8cf646bf26b69f Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 20 Aug 2023 08:04:28 +0200 Subject: [PATCH 080/180] v3 --- composer.json | 7 +- functions/parse_header.php | 19 +-- functions/parse_header_with_media_type.php | 26 +++- src/Annotation/{Version.php => Consumes.php} | 4 +- .../{Produce.php => JsonResponseBody.php} | 10 +- src/Annotation/{Consume.php => Produces.php} | 7 +- src/Annotation/RequestEntity.php | 40 ++++++ .../{ResponseBody.php => RequestHeader.php} | 4 +- ...ProxyChain.php => RequestPathVariable.php} | 14 +- src/Annotation/ResponseHeader.php | 2 +- src/ClassResolver.php | 3 +- src/Dictionary/Charset.php | 2 - src/Entity/ClientRemoteAddress.php | 16 +-- src/Entity/MediaType.php | 91 +++++++----- src/Loader/DescriptorLoader.php | 108 ++++++-------- src/Middleware/CallbackMiddleware.php | 6 +- .../JsonPayloadDecodingMiddleware.php | 16 +-- .../SimdJsonPayloadDecodingMiddleware.php | 101 -------------- .../ClientRemoteAddressParameterResolver.php | 15 +- ....php => PresetObjectParameterResolver.php} | 10 +- .../RequestEntityParameterResolver.php | 132 ++++++++++++++++++ .../RequestHeaderParameterResolver.php | 37 +++++ .../RequestPathVariableParameterResolver.php | 37 +++++ src/RequestHandler/CallbackRequestHandler.php | 6 +- .../QueueableRequestHandler.php | 39 +----- src/ResponseResolutioner.php | 29 ++-- .../EmptyResponseResolver.php | 3 +- .../ExceptionResponseResolver.php | 96 +++++++++++++ .../JsonResponseBodyResponseResolver.php | 106 ++++++++++++++ .../ResponseBodyResponseResolver.php | 98 ------------- .../StreamResponseResolver.php | 3 +- src/ResponseResolver/UriResponseResolver.php | 3 +- src/Route.php | 5 +- src/Router.php | 17 +-- src/ServerRequest.php | 99 ++++++------- 35 files changed, 700 insertions(+), 511 deletions(-) rename src/Annotation/{Version.php => Consumes.php} (83%) rename src/Annotation/{Produce.php => JsonResponseBody.php} (62%) rename src/Annotation/{Consume.php => Produces.php} (76%) create mode 100644 src/Annotation/RequestEntity.php rename src/Annotation/{ResponseBody.php => RequestHeader.php} (81%) rename src/Annotation/{ProxyChain.php => RequestPathVariable.php} (60%) delete mode 100644 src/Middleware/SimdJsonPayloadDecodingMiddleware.php rename src/ParameterResolver/{ObjectInjectionParameterResolver.php => PresetObjectParameterResolver.php} (81%) create mode 100644 src/ParameterResolver/RequestEntityParameterResolver.php create mode 100644 src/ParameterResolver/RequestHeaderParameterResolver.php create mode 100644 src/ParameterResolver/RequestPathVariableParameterResolver.php create mode 100644 src/ResponseResolver/ExceptionResponseResolver.php create mode 100644 src/ResponseResolver/JsonResponseBodyResponseResolver.php delete mode 100644 src/ResponseResolver/ResponseBodyResponseResolver.php diff --git a/composer.json b/composer.json index bab7bb85..2e51a6c9 100644 --- a/composer.json +++ b/composer.json @@ -45,7 +45,9 @@ "sunrise/coding-standard": "^1.0", "sunrise/http-message": "^3.0", "symfony/console": "^6.0", - "symfony/http-foundation": "^6.3" + "symfony/http-foundation": "^6.3", + "doctrine/orm": "^2.16", + "filp/whoops": "^2.15" }, "autoload": { "files": [ @@ -60,7 +62,8 @@ "functions/reflect_callback.php" ], "psr-4": { - "Sunrise\\Http\\Router\\": "src/" + "Sunrise\\Http\\Router\\": "src/", + "App\\": "example/" } }, "autoload-dev": { diff --git a/functions/parse_header.php b/functions/parse_header.php index 50fe3335..7d91e500 100644 --- a/functions/parse_header.php +++ b/functions/parse_header.php @@ -27,13 +27,13 @@ * * @throws InvalidArgumentException If the given header is invalid. * - * @template T as list}> + * @template T as list}> * * @since 3.0.0 */ function parse_header(string $header): array { - /** @var list}> $matches */ + /** @var T $matches */ $matches = []; $offset = -1; @@ -160,19 +160,8 @@ function parse_header(string $header): array continue; } - throw new InvalidArgumentException(sprintf('Unexpected character at position %d', $offset)); + throw new InvalidArgumentException(sprintf('Unexpected character at position %d.', $offset)); } - $result = []; - foreach ($matches as $index => $match) { - $result[$index] = [$match[0], []]; - if (isset($match[1])) { - foreach ($match[1] as $param) { - $result[$index][1][$param[0]] = $param[1] ?? null; - } - } - } - - /** @var T */ - return $result; + return $matches; } diff --git a/functions/parse_header_with_media_type.php b/functions/parse_header_with_media_type.php index fbdb526a..cd87f751 100644 --- a/functions/parse_header_with_media_type.php +++ b/functions/parse_header_with_media_type.php @@ -19,14 +19,13 @@ use Sunrise\Http\Router\Exception\InvalidArgumentException; use function sprintf; -use function strtolower; /** * Parses the given header that contains media types * * @param string $header * - * @return Generator, MediaType> + * @return Generator * * @throws InvalidArgumentException If one of the media types is invalid. * @@ -39,7 +38,7 @@ function parse_header_with_media_type(string $header): Generator return; } - foreach ($matches as $index => [$token, $parameters]) { + foreach ($matches as $index => $match) { $offset = -1; $inType = true; @@ -51,12 +50,12 @@ function parse_header_with_media_type(string $header): Generator while (true) { $offset++; - $char = $token[$offset] ?? null; + $char = $match[0][$offset] ?? null; if ($char === null) { break; } - if ($char === '/' && $inSubtype === false) { + if ($inType && $char === '/') { $inType = false; $inSubtype = true; continue; @@ -66,7 +65,6 @@ function parse_header_with_media_type(string $header): Generator $type .= $char; continue; } - if ($inSubtype && isset(Charset::RFC7230_TOKEN[$char])) { $subtype .= $char; continue; @@ -86,6 +84,20 @@ function parse_header_with_media_type(string $header): Generator )); } - yield $index => new MediaType(strtolower($type), strtolower($subtype), $parameters); + if ($type === '*' && $subtype !== '*') { + throw new InvalidArgumentException(sprintf( + 'Subtype "*" expected for media type with index %d.', + $index, + )); + } + + $parameters = []; + if (isset($match[1])) { + foreach ($match[1] as $param) { + $parameters[$param[0]] = $param[1] ?? null; + } + } + + yield new MediaType($type, $subtype, $parameters); } } diff --git a/src/Annotation/Version.php b/src/Annotation/Consumes.php similarity index 83% rename from src/Annotation/Version.php rename to src/Annotation/Consumes.php index 8d018ab9..6cd0a05b 100644 --- a/src/Annotation/Version.php +++ b/src/Annotation/Consumes.php @@ -18,8 +18,8 @@ /** * @since 3.0.0 */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] -final class Version +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class Consumes { /** diff --git a/src/Annotation/Produce.php b/src/Annotation/JsonResponseBody.php similarity index 62% rename from src/Annotation/Produce.php rename to src/Annotation/JsonResponseBody.php index 407b911e..ee1c32ed 100644 --- a/src/Annotation/Produce.php +++ b/src/Annotation/JsonResponseBody.php @@ -14,21 +14,21 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType; /** * @since 3.0.0 */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Produce +#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] +final class JsonResponseBody { /** * Constructor of the class * - * @param MediaType|non-empty-string $value + * @param int|null $jsonEncodingFlags + * @param int|null $jsonEncodingDepth */ - public function __construct(public MediaType|string $value) + public function __construct(public ?int $jsonEncodingFlags = null, public ?int $jsonEncodingDepth = null) { } } diff --git a/src/Annotation/Consume.php b/src/Annotation/Produces.php similarity index 76% rename from src/Annotation/Consume.php rename to src/Annotation/Produces.php index bcbf45a4..5b467587 100644 --- a/src/Annotation/Consume.php +++ b/src/Annotation/Produces.php @@ -14,21 +14,20 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Consume +final class Produces { /** * Constructor of the class * - * @param MediaType|non-empty-string $value + * @param non-empty-string $value */ - public function __construct(public MediaType|string $value) + public function __construct(public string $value) { } } diff --git a/src/Annotation/RequestEntity.php b/src/Annotation/RequestEntity.php new file mode 100644 index 00000000..2b6313a9 --- /dev/null +++ b/src/Annotation/RequestEntity.php @@ -0,0 +1,40 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_PARAMETER)] +final class RequestEntity +{ + + /** + * Constructor of the class + * + * @param non-empty-string|null $em + * @param non-empty-string|null $findBy + * @param non-empty-string|null $valueKey + * @param array $criteria An entity's additional search criteria + */ + public function __construct( + public string|null $em = null, + public string|null $findBy = null, + public string|null $valueKey = null, + public array $criteria = [], + ) { + } +} diff --git a/src/Annotation/ResponseBody.php b/src/Annotation/RequestHeader.php similarity index 81% rename from src/Annotation/ResponseBody.php rename to src/Annotation/RequestHeader.php index bc866170..3703e1e8 100644 --- a/src/Annotation/ResponseBody.php +++ b/src/Annotation/RequestHeader.php @@ -18,7 +18,7 @@ /** * @since 3.0.0 */ -#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] -final class ResponseBody +#[Attribute(Attribute::TARGET_PARAMETER)] +final class RequestHeader { } diff --git a/src/Annotation/ProxyChain.php b/src/Annotation/RequestPathVariable.php similarity index 60% rename from src/Annotation/ProxyChain.php rename to src/Annotation/RequestPathVariable.php index ff449937..9938a654 100644 --- a/src/Annotation/ProxyChain.php +++ b/src/Annotation/RequestPathVariable.php @@ -19,18 +19,6 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_PARAMETER)] -final class ProxyChain +final class RequestPathVariable { - - /** - * Constructor of the class - * - * @param array $value - * - * @template TKey as non-empty-string Proxy address - * @template TValue as non-empty-string Trusted header - */ - public function __construct(public array $value) - { - } } diff --git a/src/Annotation/ResponseHeader.php b/src/Annotation/ResponseHeader.php index b640211b..0e5d020b 100644 --- a/src/Annotation/ResponseHeader.php +++ b/src/Annotation/ResponseHeader.php @@ -26,7 +26,7 @@ final class ResponseHeader * Constructor of the class * * @param non-empty-string $name - * @param string $value + * @param non-empty-string $value */ public function __construct(public string $name, public string $value) { diff --git a/src/ClassResolver.php b/src/ClassResolver.php index 88522cd1..daf676c3 100644 --- a/src/ClassResolver.php +++ b/src/ClassResolver.php @@ -19,6 +19,7 @@ use function class_exists; use function sprintf; +use function var_dump; /** * ClassResolver @@ -82,7 +83,7 @@ public function resolveClass(string $fqn): object } /** @var T $instance */ - $instance = new $class(...$arguments); + $instance = new $fqn(...$arguments); $this->resolvedClasses[$fqn] = $instance; diff --git a/src/Dictionary/Charset.php b/src/Dictionary/Charset.php index 05e975e9..720e0c9c 100644 --- a/src/Dictionary/Charset.php +++ b/src/Dictionary/Charset.php @@ -20,8 +20,6 @@ */ final class Charset { - public const WILDCARD = '*'; - public const RFC7230_OWS = [ "\x09" => 1, "\x20" => 1, ]; diff --git a/src/Entity/ClientRemoteAddress.php b/src/Entity/ClientRemoteAddress.php index 2d67b9dc..691f33af 100644 --- a/src/Entity/ClientRemoteAddress.php +++ b/src/Entity/ClientRemoteAddress.php @@ -16,7 +16,7 @@ use Stringable; /** - * Client remote address + * Client Remote Address * * @since 3.0.0 */ @@ -26,21 +26,21 @@ final class ClientRemoteAddress implements Stringable /** * Constructor of the class * - * @param non-empty-string $value The address value - * @param list $proxies The list of proxies in front of this address + * @param non-empty-string $address + * @param list $proxies */ - public function __construct(private string $value, private array $proxies = []) + public function __construct(private string $address, private array $proxies = []) { } /** - * Gets the address value + * Gets the client's remote address * * @return non-empty-string */ - public function getValue(): string + public function getAddress(): string { - return $this->value; + return $this->address; } /** @@ -58,6 +58,6 @@ public function getProxies(): array */ public function __toString(): string { - return $this->value; + return $this->address; } } diff --git a/src/Entity/MediaType.php b/src/Entity/MediaType.php index 2ed04d60..b2ce333c 100644 --- a/src/Entity/MediaType.php +++ b/src/Entity/MediaType.php @@ -13,14 +13,16 @@ namespace Sunrise\Http\Router\Entity; -use Sunrise\Http\Router\Dictionary\Charset; +use Stringable; + +use function sprintf; /** - * Media type + * Media Type * * @since 3.0.0 */ -final class MediaType +final class MediaType implements Stringable { /** @@ -28,80 +30,88 @@ final class MediaType * * @param non-empty-string $type * @param non-empty-string $subtype - * @param array $parameters + * @param array $parameters */ public function __construct(private string $type, private string $subtype, private array $parameters = []) { } /** - * Gets the type of the media type + * Creates the json media type * - * @return non-empty-string + * @param array $parameters + * + * @return self */ - public function getType(): string + public static function json(array $parameters = []): self { - return $this->type; + return new self('application', 'json', $parameters); } /** - * Gets the subtype of the media type + * Creates the xml media type * - * @return non-empty-string + * @param array $parameters + * + * @return self */ - public function getSubtype(): string + public static function xml(array $parameters = []): self { - return $this->subtype; + return new self('application', 'xml', $parameters); } /** - * Gets the parameters of the media type + * Creates the yaml media type + * + * @param array $parameters * - * @return array + * @return self */ - public function getParameters(): array + public static function yaml(array $parameters = []): self { - return $this->parameters; + return new self('application', 'yaml', $parameters); } /** - * Gets the media range of the media type + * Creates the html media type * - * @return non-empty-string + * @param array $parameters + * + * @return self */ - public function getMediaRange(): string + public static function html(array $parameters = []): self { - return $this->type . '/' . $this->subtype; + return new self('text', 'html', $parameters); } /** - * Gets the quality factor of the media type + * Gets the media range type * - * @return float + * @return non-empty-string */ - public function getQualityFactor(): float + public function getType(): string { - return (float) ($this->parameters['q'] ?? 1.); + return $this->type; } /** - * Checks if the type of the media type is wildcard + * Gets the media range subtype * - * @return bool + * @return non-empty-string */ - public function isWildcardType(): bool + public function getSubtype(): string { - return $this->type === Charset::WILDCARD; + return $this->subtype; } /** - * Checks if the subtype of the media type is wildcard + * Gets the media range parameters * - * @return bool + * @return array */ - public function isWildcardSubtype(): bool + public function getParameters(): array { - return $this->subtype === Charset::WILDCARD; + return $this->parameters; } /** @@ -113,7 +123,20 @@ public function isWildcardSubtype(): bool */ public function equals(MediaType $other): bool { - return ($this->isWildcardType() || $other->isWildcardType() || $this->getType() === $other->getType()) - && ($this->isWildcardSubtype() || $other->isWildcardSubtype() || $this->getType() === $other->getSubtype()); + return ($this->type === '*' || $other->type === '*' || $this->type === $other->type) + && ($this->subtype === '*' || $other->subtype === '*' || $this->subtype === $other->subtype); + } + + /** + * @inheritDoc + */ + public function __toString(): string + { + $result = sprintf('%s/%s', $this->type, $this->subtype); + foreach ($this->parameters as $name => $value) { + $result .= sprintf('; %s="%s"', $name, $value); + } + + return $result; } } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index e823f85d..7f716f36 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -23,18 +23,17 @@ use ReflectionClass; use ReflectionMethod; use RegexIterator; -use Sunrise\Http\Router\Annotation\Consume; +use Sunrise\Http\Router\Annotation\Consumes; use Sunrise\Http\Router\Annotation\Description; use Sunrise\Http\Router\Annotation\Host; use Sunrise\Http\Router\Annotation\Method; use Sunrise\Http\Router\Annotation\Middleware; use Sunrise\Http\Router\Annotation\Postfix; use Sunrise\Http\Router\Annotation\Prefix; -use Sunrise\Http\Router\Annotation\Produce; +use Sunrise\Http\Router\Annotation\Produces; use Sunrise\Http\Router\Annotation\Route; use Sunrise\Http\Router\Annotation\Summary; use Sunrise\Http\Router\Annotation\Tag; -use Sunrise\Http\Router\Entity\MediaType; use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ParameterResolutioner; @@ -57,12 +56,9 @@ use function hash; use function is_dir; use function is_string; -use function iterator_to_array; use function sprintf; use function usort; -use function Sunrise\Http\Router\parse_header_with_media_type; - /** * DescriptorLoader */ @@ -394,8 +390,8 @@ private function getClassDescriptors(ReflectionClass $class): Generator if ($class->isSubclassOf(RequestHandlerInterface::class)) { $annotations = $this->getAnnotations(Route::class, $class); - if (isset($annotations[0])) { - $descriptor = $annotations[0]; + if ($annotations->valid()) { + $descriptor = $annotations->current(); $descriptor->holder = $class->getName(); $this->supplementDescriptor($descriptor, $class); yield $descriptor; @@ -409,8 +405,8 @@ private function getClassDescriptors(ReflectionClass $class): Generator } $annotations = $this->getAnnotations(Route::class, $method); - if (isset($annotations[0])) { - $descriptor = $annotations[0]; + if ($annotations->valid()) { + $descriptor = $annotations->current(); $descriptor->holder = [$class->getName(), $method->getName()]; $this->supplementDescriptor($descriptor, $class); $this->supplementDescriptor($descriptor, $method); @@ -430,18 +426,18 @@ private function getClassDescriptors(ReflectionClass $class): Generator private function supplementDescriptor(Route $descriptor, ReflectionClass|ReflectionMethod $holder): void { $annotations = $this->getAnnotations(Host::class, $holder); - if (isset($annotations[0])) { - $descriptor->host = $annotations[0]->value; + if ($annotations->valid()) { + $descriptor->host = $annotations->current()->value; } $annotations = $this->getAnnotations(Prefix::class, $holder); - if (isset($annotations[0])) { - $descriptor->path = $annotations[0]->value . $descriptor->path; + if ($annotations->valid()) { + $descriptor->path = $annotations->current()->value . $descriptor->path; } $annotations = $this->getAnnotations(Postfix::class, $holder); - if (isset($annotations[0])) { - $descriptor->path .= $annotations[0]->value; + if ($annotations->valid()) { + $descriptor->path .= $annotations->current()->value; } $annotations = $this->getAnnotations(Method::class, $holder); @@ -449,29 +445,19 @@ private function supplementDescriptor(Route $descriptor, ReflectionClass|Reflect $descriptor->methods[] = $annotation->value; } - $annotations = $this->getAnnotations(Consume::class, $holder); + $annotations = $this->getAnnotations(Consumes::class, $holder); foreach ($annotations as $annotation) { - if ($annotation->value instanceof MediaType) { - $descriptor->consumes[] = $annotation->value; - continue; - } - - $consumes = parse_header_with_media_type($annotation->value); - foreach ($consumes as $consume) { - $descriptor->consumes[] = $consume; + $consumesMediaTypes = \Sunrise\Http\Router\parse_header_with_media_type($annotation->value); + foreach ($consumesMediaTypes as $consumesMediaType) { + $descriptor->consumes[] = $consumesMediaType; } } - $annotations = $this->getAnnotations(Produce::class, $holder); + $annotations = $this->getAnnotations(Produces::class, $holder); foreach ($annotations as $annotation) { - if ($annotation->value instanceof MediaType) { - $descriptor->produces[] = $annotation->value; - continue; - } - - $produces = parse_header_with_media_type($annotation->value); - foreach ($produces as $produce) { - $descriptor->produces[] = $produce; + $producesMediaTypes = \Sunrise\Http\Router\parse_header_with_media_type($annotation->value); + foreach ($producesMediaTypes as $producesMediaType) { + $descriptor->produces[] = $producesMediaType; } } @@ -496,27 +482,6 @@ private function supplementDescriptor(Route $descriptor, ReflectionClass|Reflect } } - /** - * Gets the named annotations from the given class or method - * - * @param class-string $name - * @param ReflectionClass|ReflectionMethod $source - * - * @return list - * - * @template T of object - */ - private function getAnnotations(string $name, ReflectionClass|ReflectionMethod $source): array - { - $result = []; - $attributes = $source->getAttributes($name); - foreach ($attributes as $attribute) { - $result[] = $attribute->newInstance(); - } - - return $result; - } - /** * Scans the given directory and returns the found classes * @@ -527,7 +492,7 @@ private function getAnnotations(string $name, ReflectionClass|ReflectionMethod $ private function getDirectoryClasses(string $dirname): Generator { /** @var array $filenames */ - $filenames = iterator_to_array( + $filenames = [...( new RegexIterator( new RecursiveIteratorIterator( new RecursiveDirectoryIterator( @@ -535,9 +500,9 @@ private function getDirectoryClasses(string $dirname): Generator FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_PATHNAME, ) ), - '/\.php$/', + pattern: '/\.php$/', ) - ); + )]; foreach ($filenames as $filename) { (static function (string $filename): void { @@ -546,12 +511,29 @@ private function getDirectoryClasses(string $dirname): Generator })($filename); } - foreach (get_declared_classes() as $fqn) { - $class = new ReflectionClass($fqn); - $filename = $class->getFileName(); - if (isset($filenames[$filename])) { - yield $class; + foreach (get_declared_classes() as $className) { + $classReflection = new ReflectionClass($className); + if (isset($filenames[$classReflection->getFileName()])) { + yield $classReflection; } } } + + /** + * Gets the named annotations from the given class or method + * + * @param class-string $name + * @param ReflectionClass|ReflectionMethod $source + * + * @return Generator + * + * @template T of object + */ + private function getAnnotations(string $name, ReflectionClass|ReflectionMethod $source): Generator + { + $attributes = $source->getAttributes($name); + foreach ($attributes as $attribute) { + yield $attribute->newInstance(); + } + } } diff --git a/src/Middleware/CallbackMiddleware.php b/src/Middleware/CallbackMiddleware.php index 8fad2684..64d83c57 100644 --- a/src/Middleware/CallbackMiddleware.php +++ b/src/Middleware/CallbackMiddleware.php @@ -20,7 +20,7 @@ use ReflectionFunction; use ReflectionMethod; use Sunrise\Http\Router\ParameterResolutionerInterface; -use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; +use Sunrise\Http\Router\ParameterResolver\PresetObjectParameterResolver; use Sunrise\Http\Router\ResponseResolutionerInterface; use function Sunrise\Http\Router\reflect_callback; @@ -91,8 +91,8 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface $arguments = $this->parameterResolutioner ->withContext($request) ->withPriorityResolver( - new ObjectInjectionParameterResolver($request), - new ObjectInjectionParameterResolver($handler), + new PresetObjectParameterResolver($request), + new PresetObjectParameterResolver($handler), ) ->resolveParameters(...$source->getParameters()); diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index f249fb98..6dbd6d97 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -60,17 +60,8 @@ public function __construct() */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - $requestProxy = ServerRequest::from($request); - $clientProducedMediaType = $requestProxy->getClientProducedMediaType(); - if (isset($clientProducedMediaType)) { - $serverConsumesMediaType = new MediaType('application', 'json'); - if ($serverConsumesMediaType->equals($clientProducedMediaType)) { - $request = $request->withParsedBody( - $this->decodePayload( - $request->getBody()->__toString() - ) - ); - } + if (ServerRequest::from($request)->clientProducesMediaType(MediaType::json())) { + $request = $request->withParsedBody($this->decodePayload($request->getBody()->__toString())); } return $handler->handle($request); @@ -93,8 +84,7 @@ private function decodePayload(string $payload): array throw new InvalidRequestPayloadException(sprintf('Invalid JSON payload: %s', $e->getMessage()), 0, $e); } - // According to PSR-7, the data must be an array - // because we're using the 'associative' option when decoding the JSON. + // According to PSR-7, the data must be an array... if (!is_array($data)) { throw new InvalidRequestPayloadException('Unexpected JSON: Expects an array or object.'); } diff --git a/src/Middleware/SimdJsonPayloadDecodingMiddleware.php b/src/Middleware/SimdJsonPayloadDecodingMiddleware.php deleted file mode 100644 index 7309ff99..00000000 --- a/src/Middleware/SimdJsonPayloadDecodingMiddleware.php +++ /dev/null @@ -1,101 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Middleware; - -use SimdJsonException; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Exception\InvalidRequestPayloadException; -use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ServerRequest; - -use function extension_loaded; -use function is_array; -use function simdjson_decode; -use function sprintf; - -/** - * Middleware for JSON payload decoding using the Simdjson extension - * - * @since 3.0.0 - * - * @link https://www.php.net/manual/en/book.simdjson.php - */ -final class SimdJsonPayloadDecodingMiddleware implements MiddlewareInterface -{ - - /** - * Constructor of the class - * - * @throws LogicException If the Simdjson extension isn't loaded. - */ - public function __construct() - { - if (!extension_loaded('simdjson')) { - throw new LogicException( - 'The SimdJson extension is required, run the `pecl install simdjson` command to resolve it.' - ); - } - } - - /** - * @inheritDoc - */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface - { - $requestProxy = ServerRequest::from($request); - $clientProducedMediaType = $requestProxy->getClientProducedMediaType(); - if (isset($clientProducedMediaType)) { - $serverConsumesMediaType = new MediaType('application', 'json'); - if ($serverConsumesMediaType->equals($clientProducedMediaType)) { - $request = $request->withParsedBody( - $this->decodePayload( - $request->getBody()->__toString() - ) - ); - } - } - - return $handler->handle($request); - } - - /** - * Tries to decode the given JSON payload - * - * @param string $payload - * - * @return array - * - * @throws InvalidRequestPayloadException If the JSON payload cannot be decoded. - */ - private function decodePayload(string $payload): array - { - try { - $data = simdjson_decode($payload, true, 512); - } catch (SimdJsonException $e) { - throw new InvalidRequestPayloadException(sprintf('Invalid JSON payload: %s', $e->getMessage()), 0, $e); - } - - // According to PSR-7, the data must be an array - // because we're using the 'associative' option when decoding the JSON. - if (!is_array($data)) { - throw new InvalidRequestPayloadException('Unexpected JSON: Expects an array or object.'); - } - - return $data; - } -} diff --git a/src/ParameterResolver/ClientRemoteAddressParameterResolver.php b/src/ParameterResolver/ClientRemoteAddressParameterResolver.php index 27bd8ebc..e1e00e80 100644 --- a/src/ParameterResolver/ClientRemoteAddressParameterResolver.php +++ b/src/ParameterResolver/ClientRemoteAddressParameterResolver.php @@ -15,10 +15,8 @@ use Generator; use Psr\Http\Message\ServerRequestInterface; -use ReflectionAttribute; use ReflectionNamedType; use ReflectionParameter; -use Sunrise\Http\Router\Annotation\ProxyChain; use Sunrise\Http\Router\Entity\ClientRemoteAddress; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ServerRequest; @@ -36,8 +34,8 @@ final class ClientRemoteAddressParameterResolver implements ParameterResolverInt * * @param array $proxyChain * - * @template TKey as non-empty-string Proxy address - * @template TValue as non-empty-string Trusted header + * @template TKey as non-empty-string Proxy address; e.g., 127.0.0.1 + * @template TValue as non-empty-string Trusted header; e.g., X-Forwarded-For, X-Real-IP, etc. */ public function __construct(private array $proxyChain = []) { @@ -63,13 +61,6 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } - $proxyChain = $this->proxyChain; - /** @var list> $attributes */ - $attributes = $parameter->getAttributes(ProxyChain::class); - if (isset($attributes[0])) { - $proxyChain = $attributes[0]->newInstance()->value; - } - - yield ServerRequest::from($context)->getClientRemoteAddress($proxyChain); + yield ServerRequest::from($context)->getClientRemoteAddress($this->proxyChain); } } diff --git a/src/ParameterResolver/ObjectInjectionParameterResolver.php b/src/ParameterResolver/PresetObjectParameterResolver.php similarity index 81% rename from src/ParameterResolver/ObjectInjectionParameterResolver.php rename to src/ParameterResolver/PresetObjectParameterResolver.php index dd3087e9..91e16fd7 100644 --- a/src/ParameterResolver/ObjectInjectionParameterResolver.php +++ b/src/ParameterResolver/PresetObjectParameterResolver.php @@ -20,11 +20,11 @@ use function is_a; /** - * ObjectInjectionParameterResolver + * PresetObjectParameterResolver * * @since 3.0.0 */ -final class ObjectInjectionParameterResolver implements ParameterResolverInterface +final class PresetObjectParameterResolver implements ParameterResolverInterface { /** @@ -47,8 +47,10 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return; } - if (is_a($this->object, $type->getName())) { - yield $this->object; + if (! is_a($this->object, $type->getName())) { + return; } + + yield $this->object; } } diff --git a/src/ParameterResolver/RequestEntityParameterResolver.php b/src/ParameterResolver/RequestEntityParameterResolver.php new file mode 100644 index 00000000..ed844278 --- /dev/null +++ b/src/ParameterResolver/RequestEntityParameterResolver.php @@ -0,0 +1,132 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ParameterResolver; + +use Doctrine\Persistence\ManagerRegistry as EntityManagerRegistryInterface; +use Generator; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionAttribute; +use ReflectionNamedType; +use ReflectionParameter; +use Sunrise\Http\Router\Annotation\RequestEntity; +use Sunrise\Http\Router\Exception\EntityNotFoundException; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ParameterResolutioner; + +use function count; +use function current; +use function sprintf; + +/** + * RequestEntityParameterResolver + * + * @since 3.0.0 + */ +final class RequestEntityParameterResolver implements ParameterResolverInterface +{ + + /** + * Constructor of the class + * + * @param EntityManagerRegistryInterface $entityManagerRegistry + * @param non-empty-string|null $defaultEntityManagerName + */ + public function __construct( + private EntityManagerRegistryInterface $entityManagerRegistry, + private string|null $defaultEntityManagerName = null, + ) { + } + + /** + * @inheritDoc + * + * @throws EntityNotFoundException If an entity wasn't found. + * @throws LogicException If the resolver is used incorrectly. + */ + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + { + /** @var list> $attributes */ + $attributes = $parameter->getAttributes(RequestEntity::class); + if ($attributes === []) { + return; + } + + $type = $parameter->getType(); + + if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { + throw new LogicException(sprintf( + 'To use the #[RequestEntity] attribute, the parameter {%s} must be typed with an entity.', + ParameterResolutioner::stringifyParameter($parameter), + )); + } + + if (! $context instanceof ServerRequestInterface) { + throw new LogicException( + 'At this level of the application, any operations with the request are not possible.' + ); + } + + $requestEntity = $attributes[0]->newInstance(); + + $entityManagerName = $requestEntity->em ?? $this->defaultEntityManagerName; + $entityManager = $this->entityManagerRegistry->getManager($entityManagerName); + + $entityIdentificationFieldName = $requestEntity->findBy; + if ($entityIdentificationFieldName === null) { + $entityMetadata = $entityManager->getClassMetadata($type->getName()); + $entityIdentificationFieldNames = $entityMetadata->getIdentifier(); + if (empty($entityIdentificationFieldNames) || + count($entityIdentificationFieldNames) > 1) { + throw new LogicException(sprintf( + 'To use the #[RequestEntity] attribute with the parameter {%s}, ' . + 'it is necessary to explicitly set the "findBy" parameter within it, ' . + 'as the entity {%s} either has a composite identifier or does not have one at all.', + ParameterResolutioner::stringifyParameter($parameter), + $type->getName(), + )); + } + + $entityIdentificationFieldName = current($entityIdentificationFieldNames); + } + + $requestParameterName = $requestEntity->valueKey ?? $entityIdentificationFieldName; + $entityIdentificationFieldValue = $context->getAttribute($requestParameterName); + if ($entityIdentificationFieldValue === null) { + throw new LogicException(sprintf( + 'To use the #[RequestEntity] attribute with the parameter {%s}, ' . + 'it might be necessary to explicitly set the "valueKey" parameter within it, ' . + 'as the attribute with the name "%s" was not found in the current request.', + ParameterResolutioner::stringifyParameter($parameter), + $requestParameterName, + )); + } + + $entity = $entityManager->getRepository($type->getName())->findOneBy([ + $entityIdentificationFieldName => $entityIdentificationFieldValue, + ...$requestEntity->criteria, + ]); + + if (isset($entity)) { + yield $entity; + return; + } + + if ($parameter->allowsNull()) { + yield null; + return; + } + + throw new EntityNotFoundException(); + } +} diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php new file mode 100644 index 00000000..014c4f31 --- /dev/null +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -0,0 +1,37 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ParameterResolver; + +use Generator; +use ReflectionAttribute; +use ReflectionParameter; +use Sunrise\Http\Router\Annotation\RequestHeader; + +final class RequestHeaderParameterResolver implements ParameterResolverInterface +{ + + /** + * @inheritDoc + */ + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + { + /** @var list> $attributes */ + $attributes = $parameter->getAttributes(RequestHeader::class); + if ($attributes === []) { + return; + } + + // TODO: Implement the method... + } +} diff --git a/src/ParameterResolver/RequestPathVariableParameterResolver.php b/src/ParameterResolver/RequestPathVariableParameterResolver.php new file mode 100644 index 00000000..4db162e1 --- /dev/null +++ b/src/ParameterResolver/RequestPathVariableParameterResolver.php @@ -0,0 +1,37 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ParameterResolver; + +use Generator; +use ReflectionAttribute; +use ReflectionParameter; +use Sunrise\Http\Router\Annotation\RequestPathVariable; + +final class RequestPathVariableParameterResolver implements ParameterResolverInterface +{ + + /** + * @inheritDoc + */ + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + { + /** @var list> $attributes */ + $attributes = $parameter->getAttributes(RequestPathVariable::class); + if ($attributes === []) { + return; + } + + // TODO: Implement the method... + } +} diff --git a/src/RequestHandler/CallbackRequestHandler.php b/src/RequestHandler/CallbackRequestHandler.php index 572c3458..3b52a405 100644 --- a/src/RequestHandler/CallbackRequestHandler.php +++ b/src/RequestHandler/CallbackRequestHandler.php @@ -19,7 +19,7 @@ use ReflectionFunction; use ReflectionMethod; use Sunrise\Http\Router\ParameterResolutionerInterface; -use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; +use Sunrise\Http\Router\ParameterResolver\PresetObjectParameterResolver; use Sunrise\Http\Router\ResponseResolutionerInterface; use function Sunrise\Http\Router\reflect_callback; @@ -63,7 +63,7 @@ final class CallbackRequestHandler implements RequestHandlerInterface public function __construct( callable $callback, ParameterResolutionerInterface $parameterResolutioner, - ResponseResolutionerInterface $responseResolutioner + ResponseResolutionerInterface $responseResolutioner, ) { $this->callback = $callback; $this->parameterResolutioner = $parameterResolutioner; @@ -90,7 +90,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface $arguments = $this->parameterResolutioner ->withContext($request) ->withPriorityResolver( - new ObjectInjectionParameterResolver($request), + new PresetObjectParameterResolver($request), ) ->resolveParameters(...$source->getParameters()); diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index 476dde45..83079a32 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -21,47 +21,22 @@ /** * QueueableRequestHandler + * + * @extends SplQueue */ -final class QueueableRequestHandler implements RequestHandlerInterface +final class QueueableRequestHandler extends SplQueue implements RequestHandlerInterface { - /** - * The request handler's middleware queue - * - * @var SplQueue - */ - private SplQueue $middlewareQueue; - - /** - * The request handler's request handler - * - * @var RequestHandlerInterface - */ - private RequestHandlerInterface $requestHandler; - /** * Constructor of the class * * @param RequestHandlerInterface $requestHandler - */ - public function __construct(RequestHandlerInterface $requestHandler) - { - /** @var SplQueue */ - $this->middlewareQueue = new SplQueue(); - $this->requestHandler = $requestHandler; - } - - /** - * Adds the given middleware(s) to the request handler's middleware queue - * * @param MiddlewareInterface ...$middlewares - * - * @return void */ - public function add(MiddlewareInterface ...$middlewares): void + public function __construct(private RequestHandlerInterface $requestHandler, MiddlewareInterface ...$middlewares) { foreach ($middlewares as $middleware) { - $this->middlewareQueue->enqueue($middleware); + $this->enqueue($middleware); } } @@ -70,8 +45,8 @@ public function add(MiddlewareInterface ...$middlewares): void */ public function handle(ServerRequestInterface $request): ResponseInterface { - if (!$this->middlewareQueue->isEmpty()) { - return $this->middlewareQueue->dequeue()->process($request, $this); + if (! $this->isEmpty()) { + return ($clone = clone $this)->dequeue()->process($request, $clone); } return $this->requestHandler->handle($request); diff --git a/src/ResponseResolutioner.php b/src/ResponseResolutioner.php index b3d81403..6313adb0 100644 --- a/src/ResponseResolutioner.php +++ b/src/ResponseResolutioner.php @@ -66,25 +66,26 @@ public function resolveResponse( foreach ($this->resolvers as $resolver) { $result = $resolver->resolveResponse($response, $request, $source); if ($result instanceof ResponseInterface) { - return $this->handleResponse($result, $source); + return $this->supplementResponse($result, $source); } } throw new LogicException(sprintf( - 'Unable to resolve the response {%s} to PSR-7 response', - self::stringifyResponse($response, $source), + 'Unable to resolve the response {%s->%s} to PSR-7 response', + self::stringifySource($source), + get_debug_type($response), )); } /** - * Handles the given response + * Supplements the given response * * @param ResponseInterface $response * @param ReflectionFunction|ReflectionMethod $source * * @return ResponseInterface */ - private function handleResponse( + private function supplementResponse( ResponseInterface $response, ReflectionFunction|ReflectionMethod $source, ) : ResponseInterface { @@ -106,28 +107,18 @@ private function handleResponse( } /** - * Stringifies the given raw response + * Stringifies the given source of a response * - * @param mixed $response * @param ReflectionFunction|ReflectionMethod $source * * @return non-empty-string */ - public static function stringifyResponse(mixed $response, ReflectionFunction|ReflectionMethod $source): string + public static function stringifySource(ReflectionFunction|ReflectionMethod $source): string { if ($source instanceof ReflectionMethod) { - return sprintf( - '%s::%s():$%s', - $source->getDeclaringClass()->getName(), - $source->getName(), - get_debug_type($response), - ); + return sprintf('%s::%s()', $source->getDeclaringClass()->getName(), $source->getName()); } - return sprintf( - '%s():$%s', - $source->getName(), - get_debug_type($response), - ); + return sprintf('%s()', $source->getName()); } } diff --git a/src/ResponseResolver/EmptyResponseResolver.php b/src/ResponseResolver/EmptyResponseResolver.php index cd193807..595c8e60 100644 --- a/src/ResponseResolver/EmptyResponseResolver.php +++ b/src/ResponseResolver/EmptyResponseResolver.php @@ -13,6 +13,7 @@ namespace Sunrise\Http\Router\ResponseResolver; +use Fig\Http\Message\StatusCodeInterface; use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; @@ -45,7 +46,7 @@ public function resolveResponse( ReflectionFunction|ReflectionMethod $source, ) : ?ResponseInterface { if ($response === null) { - return $this->responseFactory->createResponse(204); + return $this->responseFactory->createResponse(StatusCodeInterface::STATUS_NO_CONTENT); } return null; diff --git a/src/ResponseResolver/ExceptionResponseResolver.php b/src/ResponseResolver/ExceptionResponseResolver.php new file mode 100644 index 00000000..bead398f --- /dev/null +++ b/src/ResponseResolver/ExceptionResponseResolver.php @@ -0,0 +1,96 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ResponseResolver; + +use Psr\Http\Message\ResponseFactoryInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionFunction; +use ReflectionMethod; +use Sunrise\Http\Router\Entity\MediaType; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ServerRequest; +use Throwable; +use Whoops\Run as Whoops; + +use function class_exists; + +/** + * ExceptionResponseResolver + * + * @since 3.0.0 + * + * @link https://github.com/filp/whoops + */ +final class ExceptionResponseResolver implements ResponseResolverInterface +{ + + /** + * Constructor of the class + * + * @param ResponseFactoryInterface $responseFactory + * @param int<100, 599> $defaultResponseStatusCode + * + * @throws LogicException If the whoops package isn't installed. + */ + public function __construct( + private ResponseFactoryInterface $responseFactory, + private int $defaultResponseStatusCode = 500, + ) { + if (!class_exists(Whoops::class)) { + throw new LogicException( + 'The whoops package is required, run the `composer require filp/whoops` command to resolve it.' + ); + } + } + + /** + * @inheritDoc + */ + public function resolveResponse( + mixed $response, + ServerRequestInterface $request, + ReflectionMethod|ReflectionFunction $source, + ): ?ResponseInterface { + if (! $response instanceof Throwable) { + return null; + } + + $whoops = new Whoops(); + $whoops->allowQuit(false); + $whoops->writeToOutput(false); + + $clientPreferredMediaType = ServerRequest::from($request) + ->getClientPreferredMediaType( + MediaType::html(), + MediaType::json(), + MediaType::xml(), + ); + + if ($clientPreferredMediaType->equals(MediaType::html())) { + $whoops->pushHandler(new \Whoops\Handler\PrettyPageHandler()); + } elseif ($clientPreferredMediaType->equals(MediaType::json())) { + $whoops->pushHandler(new \Whoops\Handler\JsonResponseHandler()); + } elseif ($clientPreferredMediaType->equals(MediaType::xml())) { + $whoops->pushHandler(new \Whoops\Handler\XmlResponseHandler()); + } + + $result = $this->responseFactory->createResponse($this->defaultResponseStatusCode) + ->withHeader('Content-Type', $clientPreferredMediaType->__toString()); + + $result->getBody()->write($whoops->handleException($response)); + + return $result; + } +} diff --git a/src/ResponseResolver/JsonResponseBodyResponseResolver.php b/src/ResponseResolver/JsonResponseBodyResponseResolver.php new file mode 100644 index 00000000..a0144b91 --- /dev/null +++ b/src/ResponseResolver/JsonResponseBodyResponseResolver.php @@ -0,0 +1,106 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ResponseResolver; + +use Fig\Http\Message\StatusCodeInterface; +use JsonException; +use Psr\Http\Message\ResponseFactoryInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionAttribute; +use ReflectionFunction; +use ReflectionMethod; +use Sunrise\Http\Router\Annotation\JsonResponseBody; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ResponseResolutioner; + +use function extension_loaded; +use function json_encode; +use function sprintf; + +use const JSON_PRESERVE_ZERO_FRACTION; +use const JSON_THROW_ON_ERROR; +use const JSON_UNESCAPED_SLASHES; +use const JSON_UNESCAPED_UNICODE; + +/** + * JsonResponseBodyResponseResolver + * + * @since 3.0.0 + * + * @link https://www.php.net/manual/en/book.json.php + */ +final class JsonResponseBodyResponseResolver implements ResponseResolverInterface +{ + public const DEFAULT_JSON_ENCODING_FLAGS = JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION; + public const DEFAULT_JSON_ENCODING_DEPTH = 512; + + /** + * Constructor of the class + * + * @param ResponseFactoryInterface $responseFactory + * @param int|null $jsonEncodingFlags + * @param int|null $jsonEncodingDepth + */ + public function __construct( + private ResponseFactoryInterface $responseFactory, + private ?int $jsonEncodingFlags = null, + private ?int $jsonEncodingDepth = null, + ) { + if (!extension_loaded('json')) { + throw new LogicException( + 'The JSON extension is required, run the `pecl install json` command to resolve it.' + ); + } + } + + /** + * @inheritDoc + * + * @throws LogicException If the resolver is used incorrectly. + */ + public function resolveResponse( + mixed $response, + ServerRequestInterface $request, + ReflectionFunction|ReflectionMethod $source, + ) : ?ResponseInterface { + /** @var list> $attributes */ + $attributes = $source->getAttributes(JsonResponseBody::class); + if ($attributes === []) { + return null; + } + + $jsonResponseBody = $attributes[0]->newInstance(); + + $jsonEncodingFlags = $jsonResponseBody->jsonEncodingFlags ?? $this->jsonEncodingFlags ?? self::DEFAULT_JSON_ENCODING_FLAGS; + $jsonEncodingDepth = $jsonResponseBody->jsonEncodingDepth ?? $this->jsonEncodingDepth ?? self::DEFAULT_JSON_ENCODING_DEPTH; + + try { + $payload = json_encode($response, $jsonEncodingFlags | JSON_THROW_ON_ERROR, $jsonEncodingDepth); + } catch (JsonException $e) { + throw new LogicException(sprintf( + 'Unable to encode a response from the source {%s} due to: %s', + ResponseResolutioner::stringifySource($source), + $e->getMessage(), + ), 0, $e); + } + + $result = $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK) + ->withHeader('Content-Type', 'application/json; charset=UTF-8'); + + $result->getBody()->write($payload); + + return $result; + } +} diff --git a/src/ResponseResolver/ResponseBodyResponseResolver.php b/src/ResponseResolver/ResponseBodyResponseResolver.php deleted file mode 100644 index fd6ad771..00000000 --- a/src/ResponseResolver/ResponseBodyResponseResolver.php +++ /dev/null @@ -1,98 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ResponseResolver; - -use Psr\Http\Message\ResponseFactoryInterface; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use ReflectionFunction; -use ReflectionMethod; -use Sunrise\Http\Router\Annotation\ResponseBody; -use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ResponseResolutioner; -use Sunrise\Http\Router\RouteInterface; -use Sunrise\Http\Router\ServerRequest; -use Symfony\Component\Serializer\SerializerInterface; - -use function in_array; -use function reset; -use function sprintf; - -/** - * ResponseBodyResponseResolver - * - * @since 3.0.0 - */ -final class ResponseBodyResponseResolver implements ResponseResolverInterface -{ - - /** - * Constructor of the class - * - * @param ResponseFactoryInterface $responseFactory - * @param SerializerInterface $serializer - * @param non-empty-string $defaultFormat - * @param array $formats - * @param array $serializationContext - */ - public function __construct( - private ResponseFactoryInterface $responseFactory, - private SerializerInterface $serializer, - private string $defaultFormat = 'json', - private array $formats = self::MEDIA_FORMATS, - private array $serializationContext = [], - ) { - } - - /** - * @inheritDoc - * - * @throws LogicException If the resolver is used incorrectly. - */ - public function resolveResponse( - mixed $response, - ServerRequestInterface $request, - ReflectionFunction|ReflectionMethod $source, - ) : ?ResponseInterface { - if ($source->getAttributes(ResponseBody::class) === []) { - return null; - } - - $format = $this->defaultFormat; - - /** @var RouteInterface|null $route */ - $route = $request->getAttribute('@route'); - if ($route instanceof RouteInterface) { - $mediaRange = ServerRequest::from($request) - ->getClientPreferredMediaType(...$route->getProducesMediaTypes()) - ?->getMediaRange(); - - if (isset($mediaRange) && isset($this->formats[$mediaRange])) { - $format = $this->formats[$mediaRange]; - } - } - - $payload = $this->serializer->serialize($response, $format, $this->serializationContext); - - $contentType = sprintf('%s; charset=UTF-8', $mediaType->getMediaRange()); - - $result = $this->responseFactory->createResponse(200) - ->withHeader('Content-Type', $contentType); - - $result->getBody()->write($payload); - - return $result; - } -} diff --git a/src/ResponseResolver/StreamResponseResolver.php b/src/ResponseResolver/StreamResponseResolver.php index b06d7a2a..a014f6b3 100644 --- a/src/ResponseResolver/StreamResponseResolver.php +++ b/src/ResponseResolver/StreamResponseResolver.php @@ -13,6 +13,7 @@ namespace Sunrise\Http\Router\ResponseResolver; +use Fig\Http\Message\StatusCodeInterface; use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; @@ -46,7 +47,7 @@ public function resolveResponse( ReflectionFunction|ReflectionMethod $source, ) : ?ResponseInterface { if ($response instanceof StreamInterface) { - return $this->responseFactory->createResponse(200) + return $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK) ->withBody($response); } diff --git a/src/ResponseResolver/UriResponseResolver.php b/src/ResponseResolver/UriResponseResolver.php index b21ad271..9f553445 100644 --- a/src/ResponseResolver/UriResponseResolver.php +++ b/src/ResponseResolver/UriResponseResolver.php @@ -13,6 +13,7 @@ namespace Sunrise\Http\Router\ResponseResolver; +use Fig\Http\Message\StatusCodeInterface; use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; @@ -46,7 +47,7 @@ public function resolveResponse( ReflectionFunction|ReflectionMethod $source, ) : ?ResponseInterface { if ($response instanceof UriInterface) { - return $this->responseFactory->createResponse(302) + return $this->responseFactory->createResponse(StatusCodeInterface::STATUS_FOUND) ->withHeader('Location', $response->__toString()); } diff --git a/src/Route.php b/src/Route.php index 4cf4dcb3..434be829 100644 --- a/src/Route.php +++ b/src/Route.php @@ -532,9 +532,6 @@ public function handle(ServerRequestInterface $request): ResponseInterface return $this->requestHandler->handle($request); } - $handler = new QueueableRequestHandler($this->requestHandler); - $handler->add(...$this->middlewares); - - return $handler->handle($request); + return (new QueueableRequestHandler($this->requestHandler, ...$this->middlewares))->handle($request); } } diff --git a/src/Router.php b/src/Router.php index 4d3919e5..318fe458 100644 --- a/src/Router.php +++ b/src/Router.php @@ -243,6 +243,7 @@ public function generateUri(string $name, array $attributes = [], bool $strict = */ public function match(ServerRequestInterface $request): RouteInterface { + $request = ServerRequest::from($request); $requestUri = $request->getUri(); $requestHost = $requestUri->getHost(); $requestPath = $requestUri->getPath(); @@ -251,7 +252,6 @@ public function match(ServerRequestInterface $request): RouteInterface $host = $this->hosts->resolve($requestHost); $routes = $this->routes->allOnHost($host); - $request = ServerRequest::from($request); foreach ($routes as $route) { // https://github.com/sunrise-php/http-router/issues/50 @@ -270,9 +270,8 @@ public function match(ServerRequestInterface $request): RouteInterface continue; } - $routeConsumes = $route->getConsumesMediaTypes(); - if (!empty($routeConsumes) && !$request->clientProducesMediaType($routeConsumes)) { - throw new ClientNotProducedMediaTypeException($routeConsumes); + if (!$request->clientProducesMediaType(...$route->getConsumesMediaTypes())) { + throw new ClientNotProducedMediaTypeException($route->getConsumesMediaTypes()); } /** @var array $attributes */ @@ -319,10 +318,7 @@ function (ServerRequestInterface $request): ResponseInterface { return $routing->handle($request); } - $handler = new QueueableRequestHandler($routing); - $handler->add(...$this->middlewares); - - return $handler->handle($request); + return (new QueueableRequestHandler($routing, ...$this->middlewares))->handle($request); } /** @@ -342,9 +338,6 @@ public function handle(ServerRequestInterface $request): ResponseInterface return $this->matchedRoute->handle($request); } - $handler = new QueueableRequestHandler($this->matchedRoute); - $handler->add(...$this->middlewares); - - return $handler->handle($request); + return (new QueueableRequestHandler($this->matchedRoute, ...$this->middlewares))->handle($request); } } diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 14c2e001..e4b81617 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -13,7 +13,6 @@ namespace Sunrise\Http\Router; -use Fig\Http\Message\RequestMethodInterface; use Generator; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\StreamInterface; @@ -22,16 +21,11 @@ use Sunrise\Http\Router\Entity\MediaType; use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; use Sunrise\Http\Router\Exception\InvalidArgumentException; +use Sunrise\Http\Router\Exception\LogicException; -use Throwable; -use function current; -use function explode; -use function key; use function preg_split; +use function reset; use function sprintf; -use function strncmp; -use function strpos; -use function strtolower; use function usort; /** @@ -39,7 +33,7 @@ * * @since 3.0.0 */ -final class ServerRequest implements ServerRequestInterface, RequestMethodInterface +final class ServerRequest implements ServerRequestInterface { /** @@ -67,6 +61,16 @@ public static function from(ServerRequestInterface $request): self return new self($request); } + /** + * Gets the original request + * + * @return ServerRequestInterface + */ + public function getOriginalRequest(): ServerRequestInterface + { + return $this->request; + } + /** * Gets the client's remote address * @@ -75,46 +79,41 @@ public static function from(ServerRequestInterface $request): self * @return ClientRemoteAddress * * @template TKey as non-empty-string Proxy address; e.g., 127.0.0.1 - * @template TValue as non-empty-string Trusted header; e.g., X-Forwarded-For + * @template TValue as non-empty-string Trusted header; e.g., X-Forwarded-For, X-Real-IP, etc. * + * @link https://www.rfc-editor.org/rfc/rfc3875#section-4.1.8 * @link https://www.rfc-editor.org/rfc/rfc7239.html#section-5.2 */ public function getClientRemoteAddress(array $proxyChain = []): ClientRemoteAddress { $serverParams = $this->request->getServerParams(); - /** @var non-empty-string $clientAddress */ - $clientAddress = $serverParams['REMOTE_ADDR'] ?? '::1'; - /** @var list $proxyAddresses */ - $proxyAddresses = []; + $clientRemoteAddress = $serverParams['REMOTE_ADDR'] ?? '::1'; + $clientRemoteAddressChain = [$clientRemoteAddress]; - while (isset($proxyChain[$clientAddress])) { - $trustedHeader = $proxyChain[$clientAddress]; - unset($proxyChain[$clientAddress]); + while (isset($proxyChain[$clientRemoteAddressChain[0]])) { + $trustedHeader = $proxyChain[$clientRemoteAddressChain[0]]; + unset($proxyChain[$clientRemoteAddressChain[0]]); $header = $this->request->getHeaderLine($trustedHeader); - if ($header === '') { + $addresses = preg_split('/\s*,\s*/', $header, flags: \PREG_SPLIT_NO_EMPTY); + if ($addresses === []) { break; } - /** @var list $addresses */ - $addresses = preg_split('/\s*,\s*/', $header, -1, PREG_SPLIT_NO_EMPTY); - if (empty($addresses)) { - break; - } + $clientRemoteAddressChain = [...$addresses, ...$clientRemoteAddressChain]; + } - $clientAddress = $addresses[0]; - unset($addresses[0]); + $address = $clientRemoteAddressChain[0]; + unset($clientRemoteAddressChain[0]); - foreach ($addresses as $address) { - $proxyAddresses[] = $address; - } - } + /** @var list $proxies */ + $proxies = [...$clientRemoteAddressChain]; - return new ClientRemoteAddress($clientAddress, $proxyAddresses); + return new ClientRemoteAddress($address, $proxies); } /** - * Gets the media type that the client produced + * Gets a media type that the client produced * * @return MediaType|null */ @@ -130,9 +129,9 @@ public function getClientProducedMediaType(): ?MediaType } /** - * Gets the media types that the client consumes + * Gets media types that the client consumes * - * @return Generator, MediaType> + * @return Generator */ public function getClientConsumesMediaTypes(): Generator { @@ -150,23 +149,27 @@ public function getClientConsumesMediaTypes(): Generator * * @param MediaType ...$serverProducesMediaTypes * - * @return MediaType|null + * @return MediaType + * + * @throws LogicException If the list of produces media types is empty. */ - public function getClientPreferredMediaType(MediaType ...$serverProducesMediaTypes): ?MediaType + public function getClientPreferredMediaType(MediaType ...$serverProducesMediaTypes): MediaType { if ($serverProducesMediaTypes === []) { - return null; + throw new LogicException( + 'The list of media types produced by the server is empty, ' . + 'making it impossible to determine the preferred media type for the client.' + ); } /** @var list $clientConsumesMediaTypes */ $clientConsumesMediaTypes = [...$this->getClientConsumesMediaTypes()]; - if ($clientConsumesMediaTypes === []) { - return current($serverProducesMediaTypes); + return reset($serverProducesMediaTypes); } - usort($clientConsumesMediaTypes, static fn (MediaType $a, MediaType $b): int => ( - $b->getQualityFactor() <=> $a->getQualityFactor() + usort($clientConsumesMediaTypes, static fn(MediaType $a, MediaType $b): int => ( + ($b->getParameters()['q'] ?? 1.) <=> ($a->getParameters()['q'] ?? 1.) )); foreach ($clientConsumesMediaTypes as $clientConsumesMediaType) { @@ -177,29 +180,29 @@ public function getClientPreferredMediaType(MediaType ...$serverProducesMediaTyp } } - return current($serverProducesMediaTypes); + return reset($serverProducesMediaTypes); } /** * Checks if the client produces one of the given media types * - * @param MediaType ...$consumes + * @param MediaType ...$serverConsumesMediaTypes * * @return bool */ - public function clientProducesMediaType(array $consumes): bool + public function clientProducesMediaType(MediaType ...$serverConsumesMediaTypes): bool { - if ($consumes === []) { + if ($serverConsumesMediaTypes === []) { return true; } - $produced = $this->getClientProducedMediaType(); - if ($produced === '') { + $clientProducedMediaType = $this->getClientProducedMediaType(); + if ($clientProducedMediaType === null) { return false; } - foreach ($consumes as $consumed) { - if (media_types_compare($consumed, $produced)) { + foreach ($serverConsumesMediaTypes as $serverConsumesMediaType) { + if ($clientProducedMediaType->equals($serverConsumesMediaType)) { return true; } } From 0f8015fc33a3ab554622c1bf3902858bc826b591 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 26 Aug 2023 09:43:10 +0200 Subject: [PATCH 081/180] v3 --- composer.json | 14 +- functions/parse_header_with_media_type.php | 2 +- resources/views/error.phtml | 85 +++++++++ src/Annotation/Consumes.php | 5 +- src/Annotation/JsonResponseBody.php | 5 +- ...questPathVariable.php => PathVariable.php} | 11 +- src/Annotation/Produces.php | 6 +- src/Annotation/RequestEntity.php | 40 ---- src/Annotation/RequestHeader.php | 9 + src/Annotation/Route.php | 4 + src/ClassResolver.php | 11 +- .../ErrorDto.php} | 18 +- src/Dto/ViolationDto.php | 62 ++++++ src/Entity/ClientRemoteAddress.php | 63 ------- src/Entity/MediaType.php | 28 ++- src/Event/ErrorEvent.php | 75 ++++++++ .../ClientNotConsumedMediaTypeException.php | 25 --- .../ClientNotProducedMediaTypeException.php | 25 --- .../Http/HttpBadRequestException.php | 6 +- src/Exception/Http/HttpConflictException.php | 6 +- .../Http/HttpExpectationFailedException.php | 42 ----- .../Http/HttpFailedDependencyException.php | 6 +- src/Exception/Http/HttpForbiddenException.php | 6 +- src/Exception/Http/HttpGoneException.php | 6 +- ...p => HttpInternalServerErrorException.php} | 14 +- .../Http/HttpLengthRequiredException.php | 42 ----- src/Exception/Http/HttpLockedException.php | 8 +- .../Http/HttpMethodNotAllowedException.php | 44 +---- .../Http/HttpMisdirectedRequestException.php | 40 ---- .../Http/HttpNotAcceptableException.php | 66 ------- src/Exception/Http/HttpNotFoundException.php | 6 +- .../Http/HttpPayloadTooLargeException.php | 6 +- .../Http/HttpPaymentRequiredException.php | 42 ----- .../Http/HttpPreconditionFailedException.php | 42 ----- ...tpProxyAuthenticationRequiredException.php | 42 ----- .../Http/HttpRangeNotSatisfiableException.php | 42 ----- ...tpRequestHeaderFieldsTooLargeException.php | 42 ----- .../Http/HttpRequestTimeoutException.php | 42 ----- .../Http/HttpServiceUnavailableException.php | 7 +- src/Exception/Http/HttpTooEarlyException.php | 42 ----- .../Http/HttpTooManyRequestsException.php | 6 +- .../Http/HttpUnauthorizedException.php | 6 +- ...ttpUnavailableForLegalReasonsException.php | 6 +- .../Http/HttpUnprocessableEntityException.php | 6 +- .../HttpUnsupportedMediaTypeException.php | 45 ++--- .../Http/HttpUpgradeRequiredException.php | 42 ----- .../Http/HttpUriTooLongException.php | 42 ----- src/Exception/HttpException.php | 155 +++++++++++++-- src/Exception/HttpExceptionInterface.php | 30 ++- .../InvalidRequestPayloadException.php | 25 --- src/Exception/MethodNotAllowedException.php | 23 --- .../MissingRequestParameterException.php | 25 --- src/Exception/PageNotFoundException.php | 25 --- src/Exception/ResolvingReferenceException.php | 23 --- src/Exception/UnhydrableObjectException.php | 23 --- .../UnprocessableEntityException.php | 53 ------ .../UnprocessableRequestBodyException.php | 23 --- .../UnprocessableRequestQueryException.php | 23 --- src/Loader/ConfigLoader.php | 14 +- src/Loader/DescriptorLoader.php | 94 ++++++---- src/Middleware/CallbackMiddleware.php | 10 +- src/Middleware/ErrorHandlingMiddleware.php | 177 ++++++++++++++++++ .../JsonPayloadDecodingMiddleware.php | 32 +--- .../ClientRemoteAddressParameterResolver.php | 66 ------- .../RequestEntityParameterResolver.php | 132 ------------- .../RequestHeaderParameterResolver.php | 37 ---- .../RequestPathVariableParameterResolver.php | 37 ---- .../ParameterResolutioner.php | 12 +- .../ParameterResolutionerInterface.php | 6 +- .../DependencyInjectionParameterResolver.php | 2 +- .../ObjectInjectionParameterResolver.php} | 8 +- .../ParameterResolverInterface.php | 4 +- .../PathVariableParameterResolver.php | 117 ++++++++++++ .../RequestBodyParameterResolver.php | 29 +-- .../RequestHeaderParameterResolver.php | 100 ++++++++++ .../RequestQueryParameterResolver.php | 29 +-- .../RequestRouteParameterResolver.php | 4 +- src/ReferenceResolver.php | 8 +- src/RequestHandler/CallbackRequestHandler.php | 8 +- .../QueueableRequestHandler.php | 6 +- .../ExceptionResponseResolver.php | 96 ---------- .../ResponseResolutioner.php | 8 +- .../ResponseResolutionerInterface.php | 4 +- .../EmptyResponseResolver.php | 5 +- .../JsonResponseBodyResponseResolver.php | 33 +--- .../ResponseResolverInterface.php | 2 +- .../RouteResponseResolver.php | 2 +- .../StreamResponseResolver.php | 5 +- .../ResponseResolver/UriResponseResolver.php | 5 +- src/Route.php | 8 + src/RouteCollector.php | 12 +- src/RouteInterface.php | 10 + src/Router.php | 33 ++-- src/ServerRequest.php | 104 +++------- src/TypeConversion/TypeConversioner.php | 64 +++++++ .../TypeConversionerInterface.php | 46 +++++ .../TypeConverter/BackedEnumTypeConverter.php | 122 ++++++++++++ .../TypeConverter/BoolTypeConverter.php | 65 +++++++ .../TypeConverter/DateTimeTypeConverter.php | 83 ++++++++ .../TypeConverter/FloatTypeConverter.php | 70 +++++++ .../TypeConverter/IntTypeConverter.php | 66 +++++++ .../TypeConverter/StringTypeConverter.php | 46 +++++ .../TypeConverter/TypeConverterInterface.php | 37 ++++ 103 files changed, 1785 insertions(+), 1741 deletions(-) create mode 100644 resources/views/error.phtml rename src/Annotation/{RequestPathVariable.php => PathVariable.php} (70%) delete mode 100644 src/Annotation/RequestEntity.php rename src/{Exception/EntityNotFoundException.php => Dto/ErrorDto.php} (55%) create mode 100644 src/Dto/ViolationDto.php delete mode 100644 src/Entity/ClientRemoteAddress.php create mode 100644 src/Event/ErrorEvent.php delete mode 100644 src/Exception/ClientNotConsumedMediaTypeException.php delete mode 100644 src/Exception/ClientNotProducedMediaTypeException.php delete mode 100644 src/Exception/Http/HttpExpectationFailedException.php rename src/Exception/Http/{HttpPreconditionRequiredException.php => HttpInternalServerErrorException.php} (67%) delete mode 100644 src/Exception/Http/HttpLengthRequiredException.php delete mode 100644 src/Exception/Http/HttpMisdirectedRequestException.php delete mode 100644 src/Exception/Http/HttpNotAcceptableException.php delete mode 100644 src/Exception/Http/HttpPaymentRequiredException.php delete mode 100644 src/Exception/Http/HttpPreconditionFailedException.php delete mode 100644 src/Exception/Http/HttpProxyAuthenticationRequiredException.php delete mode 100644 src/Exception/Http/HttpRangeNotSatisfiableException.php delete mode 100644 src/Exception/Http/HttpRequestHeaderFieldsTooLargeException.php delete mode 100644 src/Exception/Http/HttpRequestTimeoutException.php delete mode 100644 src/Exception/Http/HttpTooEarlyException.php delete mode 100644 src/Exception/Http/HttpUpgradeRequiredException.php delete mode 100644 src/Exception/Http/HttpUriTooLongException.php delete mode 100644 src/Exception/InvalidRequestPayloadException.php delete mode 100644 src/Exception/MethodNotAllowedException.php delete mode 100644 src/Exception/MissingRequestParameterException.php delete mode 100644 src/Exception/PageNotFoundException.php delete mode 100644 src/Exception/ResolvingReferenceException.php delete mode 100644 src/Exception/UnhydrableObjectException.php delete mode 100644 src/Exception/UnprocessableEntityException.php delete mode 100644 src/Exception/UnprocessableRequestBodyException.php delete mode 100644 src/Exception/UnprocessableRequestQueryException.php create mode 100644 src/Middleware/ErrorHandlingMiddleware.php delete mode 100644 src/ParameterResolver/ClientRemoteAddressParameterResolver.php delete mode 100644 src/ParameterResolver/RequestEntityParameterResolver.php delete mode 100644 src/ParameterResolver/RequestHeaderParameterResolver.php delete mode 100644 src/ParameterResolver/RequestPathVariableParameterResolver.php rename src/{ => ParameterResolving}/ParameterResolutioner.php (89%) rename src/{ => ParameterResolving}/ParameterResolutionerInterface.php (88%) rename src/{ => ParameterResolving}/ParameterResolver/DependencyInjectionParameterResolver.php (94%) rename src/{ParameterResolver/PresetObjectParameterResolver.php => ParameterResolving/ParameterResolver/ObjectInjectionParameterResolver.php} (79%) rename src/{ => ParameterResolving}/ParameterResolver/ParameterResolverInterface.php (87%) create mode 100644 src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php rename src/{ => ParameterResolving}/ParameterResolver/RequestBodyParameterResolver.php (73%) create mode 100644 src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php rename src/{ => ParameterResolving}/ParameterResolver/RequestQueryParameterResolver.php (72%) rename src/{ => ParameterResolving}/ParameterResolver/RequestRouteParameterResolver.php (93%) delete mode 100644 src/ResponseResolver/ExceptionResponseResolver.php rename src/{ => ResponseResolving}/ResponseResolutioner.php (93%) rename src/{ => ResponseResolving}/ResponseResolutionerInterface.php (90%) rename src/{ => ResponseResolving}/ResponseResolver/EmptyResponseResolver.php (85%) rename src/{ => ResponseResolving}/ResponseResolver/JsonResponseBodyResponseResolver.php (60%) rename src/{ => ResponseResolving}/ResponseResolver/ResponseResolverInterface.php (93%) rename src/{ => ResponseResolving}/ResponseResolver/RouteResponseResolver.php (93%) rename src/{ => ResponseResolving}/ResponseResolver/StreamResponseResolver.php (87%) rename src/{ => ResponseResolving}/ResponseResolver/UriResponseResolver.php (87%) create mode 100644 src/TypeConversion/TypeConversioner.php create mode 100644 src/TypeConversion/TypeConversionerInterface.php create mode 100644 src/TypeConversion/TypeConverter/BackedEnumTypeConverter.php create mode 100644 src/TypeConversion/TypeConverter/BoolTypeConverter.php create mode 100644 src/TypeConversion/TypeConverter/DateTimeTypeConverter.php create mode 100644 src/TypeConversion/TypeConverter/FloatTypeConverter.php create mode 100644 src/TypeConversion/TypeConverter/IntTypeConverter.php create mode 100644 src/TypeConversion/TypeConverter/StringTypeConverter.php create mode 100644 src/TypeConversion/TypeConverter/TypeConverterInterface.php diff --git a/composer.json b/composer.json index 2e51a6c9..b03dee91 100644 --- a/composer.json +++ b/composer.json @@ -34,20 +34,18 @@ "psr/http-message": "^1.0 || ^2.0", "psr/http-server-handler": "^1.0", "psr/http-server-middleware": "^1.0", - "psr/simple-cache": "^1.0 || ^2.0 || ^3.0", - "sunrise/hydrator": "^3.0", - "symfony/serializer": ">=6.0", - "symfony/validator": ">=6.0" + "psr/log": "^1.0 || ^2.0 || ^3.0", + "psr/simple-cache": "^1.0 || ^2.0 || ^3.0" }, "require-dev": { "phpunit/phpunit": "^9.6", - "vimeo/psalm": "^5.14", + "vimeo/psalm": "^5.15", "sunrise/coding-standard": "^1.0", "sunrise/http-message": "^3.0", + "sunrise/hydrator": "^3.0", "symfony/console": "^6.0", - "symfony/http-foundation": "^6.3", - "doctrine/orm": "^2.16", - "filp/whoops": "^2.15" + "symfony/validator": "^6.0", + "monolog/monolog": "^3.4" }, "autoload": { "files": [ diff --git a/functions/parse_header_with_media_type.php b/functions/parse_header_with_media_type.php index cd87f751..c53587fd 100644 --- a/functions/parse_header_with_media_type.php +++ b/functions/parse_header_with_media_type.php @@ -25,7 +25,7 @@ * * @param string $header * - * @return Generator + * @return Generator * * @throws InvalidArgumentException If one of the media types is invalid. * diff --git a/resources/views/error.phtml b/resources/views/error.phtml new file mode 100644 index 00000000..9e604094 --- /dev/null +++ b/resources/views/error.phtml @@ -0,0 +1,85 @@ + + + + + + + <?= sprintf('%d | %s', $this->getStatusCode(), $this->getReasonPhrase()) ?> + + + +
+

getReasonPhrase() ?>

+

getMessage() ?>

+
+ getViolations() as $violation): ?> +

source ?> message ?>

+ +
+
+

+ Home + Back +

+
+
+ + diff --git a/src/Annotation/Consumes.php b/src/Annotation/Consumes.php index 6cd0a05b..c2f4905a 100644 --- a/src/Annotation/Consumes.php +++ b/src/Annotation/Consumes.php @@ -25,9 +25,10 @@ final class Consumes /** * Constructor of the class * - * @param non-empty-string $value + * @param non-empty-string $type + * @param non-empty-string $subtype */ - public function __construct(public string $value) + public function __construct(public string $type, public string $subtype) { } } diff --git a/src/Annotation/JsonResponseBody.php b/src/Annotation/JsonResponseBody.php index ee1c32ed..86dc0857 100644 --- a/src/Annotation/JsonResponseBody.php +++ b/src/Annotation/JsonResponseBody.php @@ -25,10 +25,9 @@ final class JsonResponseBody /** * Constructor of the class * - * @param int|null $jsonEncodingFlags - * @param int|null $jsonEncodingDepth + * @param int $options */ - public function __construct(public ?int $jsonEncodingFlags = null, public ?int $jsonEncodingDepth = null) + public function __construct(public int $options = 0) { } } diff --git a/src/Annotation/RequestPathVariable.php b/src/Annotation/PathVariable.php similarity index 70% rename from src/Annotation/RequestPathVariable.php rename to src/Annotation/PathVariable.php index 9938a654..9f180e4a 100644 --- a/src/Annotation/RequestPathVariable.php +++ b/src/Annotation/PathVariable.php @@ -19,6 +19,15 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_PARAMETER)] -final class RequestPathVariable +final class PathVariable { + + /** + * Constructor of the class + * + * @param non-empty-string|null $name + */ + public function __construct(public ?string $name = null) + { + } } diff --git a/src/Annotation/Produces.php b/src/Annotation/Produces.php index 5b467587..a121a4ed 100644 --- a/src/Annotation/Produces.php +++ b/src/Annotation/Produces.php @@ -25,9 +25,11 @@ final class Produces /** * Constructor of the class * - * @param non-empty-string $value + * @param non-empty-string $type + * @param non-empty-string $subtype + * @param array $parameters */ - public function __construct(public string $value) + public function __construct(public string $type, public string $subtype, public array $parameters = []) { } } diff --git a/src/Annotation/RequestEntity.php b/src/Annotation/RequestEntity.php deleted file mode 100644 index 2b6313a9..00000000 --- a/src/Annotation/RequestEntity.php +++ /dev/null @@ -1,40 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation; - -use Attribute; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_PARAMETER)] -final class RequestEntity -{ - - /** - * Constructor of the class - * - * @param non-empty-string|null $em - * @param non-empty-string|null $findBy - * @param non-empty-string|null $valueKey - * @param array $criteria An entity's additional search criteria - */ - public function __construct( - public string|null $em = null, - public string|null $findBy = null, - public string|null $valueKey = null, - public array $criteria = [], - ) { - } -} diff --git a/src/Annotation/RequestHeader.php b/src/Annotation/RequestHeader.php index 3703e1e8..1dd0bb43 100644 --- a/src/Annotation/RequestHeader.php +++ b/src/Annotation/RequestHeader.php @@ -21,4 +21,13 @@ #[Attribute(Attribute::TARGET_PARAMETER)] final class RequestHeader { + + /** + * Constructor of the class + * + * @param non-empty-string $name + */ + public function __construct(public string $name) + { + } } diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index 4bb47742..9bec9b38 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -34,6 +34,8 @@ final class Route implements RequestMethodInterface * The route's consumes media types * * @var list + * + * @internal */ public array $consumes = []; @@ -41,6 +43,8 @@ final class Route implements RequestMethodInterface * The route's produces media types * * @var list + * + * @internal */ public array $produces = []; diff --git a/src/ClassResolver.php b/src/ClassResolver.php index daf676c3..111dcbca 100644 --- a/src/ClassResolver.php +++ b/src/ClassResolver.php @@ -16,10 +16,10 @@ use ReflectionClass; use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; use function class_exists; use function sprintf; -use function var_dump; /** * ClassResolver @@ -57,7 +57,8 @@ public function __construct(ParameterResolutionerInterface $parameterResolutione * @inheritDoc * * @throws InvalidArgumentException If the class doesn't exist. - * @throws LogicException If the class cannot be resolved. + * + * @throws LogicException If the class couldn't be resolved. */ public function resolveClass(string $fqn): object { @@ -66,12 +67,12 @@ public function resolveClass(string $fqn): object } if (!class_exists($fqn)) { - throw new InvalidArgumentException(sprintf('The class %s does not exist', $fqn)); + throw new InvalidArgumentException(sprintf('The class %s does not exist.', $fqn)); } $class = new ReflectionClass($fqn); if (!$class->isInstantiable()) { - throw new LogicException(sprintf('The class %s cannot be initialized', $fqn)); + throw new LogicException(sprintf('The class %s cannot be initialized.', $fqn)); } $arguments = []; @@ -83,7 +84,7 @@ public function resolveClass(string $fqn): object } /** @var T $instance */ - $instance = new $fqn(...$arguments); + $instance = $class->newInstance(...$arguments); $this->resolvedClasses[$fqn] = $instance; diff --git a/src/Exception/EntityNotFoundException.php b/src/Dto/ErrorDto.php similarity index 55% rename from src/Exception/EntityNotFoundException.php rename to src/Dto/ErrorDto.php index e5f490b0..33135fa5 100644 --- a/src/Exception/EntityNotFoundException.php +++ b/src/Dto/ErrorDto.php @@ -11,15 +11,21 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Exception; - -use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; +namespace Sunrise\Http\Router\Dto; /** - * EntityNotFoundException - * * @since 3.0.0 */ -class EntityNotFoundException extends HttpNotFoundException +final class ErrorDto { + + /** + * Constructor of the class + * + * @param non-empty-string $message + * @param list $violations + */ + public function __construct(public string $message, public array $violations = []) + { + } } diff --git a/src/Dto/ViolationDto.php b/src/Dto/ViolationDto.php new file mode 100644 index 00000000..fa4e71c8 --- /dev/null +++ b/src/Dto/ViolationDto.php @@ -0,0 +1,62 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Dto; + +use Sunrise\Hydrator\Exception\InvalidValueException; +use Symfony\Component\Validator\ConstraintViolationInterface; + +/** + * @since 3.0.0 + */ +final class ViolationDto +{ + public function __construct( + public string $message, + public string $source, + public string $code, + ) { + } + + /** + * Creates the violation from the given hydrator violation + * + * @param InvalidValueException $violation + * + * @return self + */ + public static function fromHydratorViolation(InvalidValueException $violation): self + { + return new self( + $violation->getMessage(), + $violation->getPropertyPath(), + $violation->getErrorCode(), + ); + } + + /** + * Creates the violation from the given validator violation + * + * @param ConstraintViolationInterface $violation + * + * @return self + */ + public static function fromValidatorViolation(ConstraintViolationInterface $violation): self + { + return new self( + (string) $violation->getMessage(), + $violation->getPropertyPath(), + $violation->getCode() ?? '00000000-0000-0000-0000-000000000000', + ); + } +} diff --git a/src/Entity/ClientRemoteAddress.php b/src/Entity/ClientRemoteAddress.php deleted file mode 100644 index 691f33af..00000000 --- a/src/Entity/ClientRemoteAddress.php +++ /dev/null @@ -1,63 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Entity; - -use Stringable; - -/** - * Client Remote Address - * - * @since 3.0.0 - */ -final class ClientRemoteAddress implements Stringable -{ - - /** - * Constructor of the class - * - * @param non-empty-string $address - * @param list $proxies - */ - public function __construct(private string $address, private array $proxies = []) - { - } - - /** - * Gets the client's remote address - * - * @return non-empty-string - */ - public function getAddress(): string - { - return $this->address; - } - - /** - * Gets the list of proxies in front of this address - * - * @return list - */ - public function getProxies(): array - { - return $this->proxies; - } - - /** - * @inheritDoc - */ - public function __toString(): string - { - return $this->address; - } -} diff --git a/src/Entity/MediaType.php b/src/Entity/MediaType.php index b2ce333c..419aac47 100644 --- a/src/Entity/MediaType.php +++ b/src/Entity/MediaType.php @@ -84,6 +84,30 @@ public static function html(array $parameters = []): self return new self('text', 'html', $parameters); } + /** + * Creates the text media type + * + * @param array $parameters + * + * @return self + */ + public static function text(array $parameters = []): self + { + return new self('text', 'plain', $parameters); + } + + /** + * Creates the image media range + * + * @param array $parameters + * + * @return self + */ + public static function image(array $parameters = []): self + { + return new self('image', '*', $parameters); + } + /** * Gets the media range type * @@ -105,7 +129,7 @@ public function getSubtype(): string } /** - * Gets the media range parameters + * Gets the media type parameters * * @return array */ @@ -134,7 +158,7 @@ public function __toString(): string { $result = sprintf('%s/%s', $this->type, $this->subtype); foreach ($this->parameters as $name => $value) { - $result .= sprintf('; %s="%s"', $name, $value); + $result .= sprintf('; %s="%s"', $name, (string) $value); } return $result; diff --git a/src/Event/ErrorEvent.php b/src/Event/ErrorEvent.php new file mode 100644 index 00000000..cbd9a478 --- /dev/null +++ b/src/Event/ErrorEvent.php @@ -0,0 +1,75 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Event; + +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Throwable; + +/** + * ErrorEvent + * + * @since 3.0.0 + */ +final class ErrorEvent +{ + + /** + * Constructor of the class + * + * @param Throwable $error + * @param ServerRequestInterface $request + * @param ResponseInterface $response + */ + public function __construct( + private Throwable $error, + private ServerRequestInterface $request, + private ResponseInterface $response, + ) { + } + + /** + * @return Throwable + */ + public function getError(): Throwable + { + return $this->error; + } + + /** + * @return ServerRequestInterface + */ + public function getRequest(): ServerRequestInterface + { + return $this->request; + } + + /** + * @return ResponseInterface + */ + public function getResponse(): ResponseInterface + { + return $this->response; + } + + /** + * @param ResponseInterface $response + * + * @return void + */ + public function setResponse(ResponseInterface $response): void + { + $this->response = $response; + } +} diff --git a/src/Exception/ClientNotConsumedMediaTypeException.php b/src/Exception/ClientNotConsumedMediaTypeException.php deleted file mode 100644 index ab2f8af9..00000000 --- a/src/Exception/ClientNotConsumedMediaTypeException.php +++ /dev/null @@ -1,25 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use Sunrise\Http\Router\Exception\Http\HttpNotAcceptableException; - -/** - * ClientNotConsumedMediaTypeException - * - * @since 3.0.0 - */ -class ClientNotConsumedMediaTypeException extends HttpNotAcceptableException -{ -} diff --git a/src/Exception/ClientNotProducedMediaTypeException.php b/src/Exception/ClientNotProducedMediaTypeException.php deleted file mode 100644 index c6c746d2..00000000 --- a/src/Exception/ClientNotProducedMediaTypeException.php +++ /dev/null @@ -1,25 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use Sunrise\Http\Router\Exception\Http\HttpUnsupportedMediaTypeException; - -/** - * ClientNotProducedMediaTypeException - * - * @since 3.0.0 - */ -class ClientNotProducedMediaTypeException extends HttpUnsupportedMediaTypeException -{ -} diff --git a/src/Exception/Http/HttpBadRequestException.php b/src/Exception/Http/HttpBadRequestException.php index 9dc1dfef..e9e74862 100644 --- a/src/Exception/Http/HttpBadRequestException.php +++ b/src/Exception/Http/HttpBadRequestException.php @@ -29,14 +29,16 @@ class HttpBadRequestException extends HttpException /** * Constructor of the class * - * @param string|null $message + * @param non-empty-string|null $message * @param int $code * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'Bad Request'; + $message ??= 'The request couldn‘t be processed due to malformed syntax or invalid parameters.'; parent::__construct(self::STATUS_BAD_REQUEST, $message, $code, $previous); + + $this->setReasonPhrase('Bad Request'); } } diff --git a/src/Exception/Http/HttpConflictException.php b/src/Exception/Http/HttpConflictException.php index b657b250..885fe754 100644 --- a/src/Exception/Http/HttpConflictException.php +++ b/src/Exception/Http/HttpConflictException.php @@ -29,14 +29,16 @@ class HttpConflictException extends HttpException /** * Constructor of the class * - * @param string|null $message + * @param non-empty-string|null $message * @param int $code * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'Conflict'; + $message ??= 'The request couldn‘t be processed due to conflicts with the resource‘s current state.'; parent::__construct(self::STATUS_CONFLICT, $message, $code, $previous); + + $this->setReasonPhrase('Conflict'); } } diff --git a/src/Exception/Http/HttpExpectationFailedException.php b/src/Exception/Http/HttpExpectationFailedException.php deleted file mode 100644 index 08cab2ca..00000000 --- a/src/Exception/Http/HttpExpectationFailedException.php +++ /dev/null @@ -1,42 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Expectation Failed Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/417 - * - * @since 3.0.0 - */ -class HttpExpectationFailedException extends HttpException -{ - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - $message ??= 'Expectation Failed'; - - parent::__construct(self::STATUS_EXPECTATION_FAILED, $message, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpFailedDependencyException.php b/src/Exception/Http/HttpFailedDependencyException.php index e107c724..65f57092 100644 --- a/src/Exception/Http/HttpFailedDependencyException.php +++ b/src/Exception/Http/HttpFailedDependencyException.php @@ -29,14 +29,16 @@ class HttpFailedDependencyException extends HttpException /** * Constructor of the class * - * @param string|null $message + * @param non-empty-string|null $message * @param int $code * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'Failed Dependency'; + $message ??= 'The request couldn‘t be processed due to failures with the resource‘s dependencies.'; parent::__construct(self::STATUS_FAILED_DEPENDENCY, $message, $code, $previous); + + $this->setReasonPhrase('Failed Dependency'); } } diff --git a/src/Exception/Http/HttpForbiddenException.php b/src/Exception/Http/HttpForbiddenException.php index 3103c39a..2b5bc2cd 100644 --- a/src/Exception/Http/HttpForbiddenException.php +++ b/src/Exception/Http/HttpForbiddenException.php @@ -29,14 +29,16 @@ class HttpForbiddenException extends HttpException /** * Constructor of the class * - * @param string|null $message + * @param non-empty-string|null $message * @param int $code * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'Forbidden'; + $message ??= 'The request couldn‘t be processed due to insufficient permissions for the resource.'; parent::__construct(self::STATUS_FORBIDDEN, $message, $code, $previous); + + $this->setReasonPhrase('Forbidden'); } } diff --git a/src/Exception/Http/HttpGoneException.php b/src/Exception/Http/HttpGoneException.php index 91ef1e0d..503799cf 100644 --- a/src/Exception/Http/HttpGoneException.php +++ b/src/Exception/Http/HttpGoneException.php @@ -29,14 +29,16 @@ class HttpGoneException extends HttpException /** * Constructor of the class * - * @param string|null $message + * @param non-empty-string|null $message * @param int $code * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'Gone'; + $message ??= 'The resource is no longer available.'; parent::__construct(self::STATUS_GONE, $message, $code, $previous); + + $this->setReasonPhrase('Gone'); } } diff --git a/src/Exception/Http/HttpPreconditionRequiredException.php b/src/Exception/Http/HttpInternalServerErrorException.php similarity index 67% rename from src/Exception/Http/HttpPreconditionRequiredException.php rename to src/Exception/Http/HttpInternalServerErrorException.php index 026df707..0bc04a19 100644 --- a/src/Exception/Http/HttpPreconditionRequiredException.php +++ b/src/Exception/Http/HttpInternalServerErrorException.php @@ -17,26 +17,28 @@ use Throwable; /** - * HTTP Precondition Required Exception + * HTTP Internal Server Error Exception * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/428 + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500 * * @since 3.0.0 */ -class HttpPreconditionRequiredException extends HttpException +class HttpInternalServerErrorException extends HttpException { /** * Constructor of the class * - * @param string|null $message + * @param non-empty-string|null $message * @param int $code * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'Precondition Required'; + $message ??= 'The server encountered an unexpected condition that prevented it from fulfilling the request.'; - parent::__construct(self::STATUS_PRECONDITION_REQUIRED, $message, $code, $previous); + parent::__construct(self::STATUS_INTERNAL_SERVER_ERROR, $message, $code, $previous); + + $this->setReasonPhrase('Internal Server Error'); } } diff --git a/src/Exception/Http/HttpLengthRequiredException.php b/src/Exception/Http/HttpLengthRequiredException.php deleted file mode 100644 index 96c826fd..00000000 --- a/src/Exception/Http/HttpLengthRequiredException.php +++ /dev/null @@ -1,42 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Length Required Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/411 - * - * @since 3.0.0 - */ -class HttpLengthRequiredException extends HttpException -{ - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - $message ??= 'Length Required'; - - parent::__construct(self::STATUS_LENGTH_REQUIRED, $message, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpLockedException.php b/src/Exception/Http/HttpLockedException.php index 030170cd..afb842e4 100644 --- a/src/Exception/Http/HttpLockedException.php +++ b/src/Exception/Http/HttpLockedException.php @@ -19,6 +19,8 @@ /** * HTTP Locked Exception * + * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/423 + * * @since 3.0.0 */ class HttpLockedException extends HttpException @@ -27,14 +29,16 @@ class HttpLockedException extends HttpException /** * Constructor of the class * - * @param string|null $message + * @param non-empty-string|null $message * @param int $code * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'Locked'; + $message ??= 'The request couldn‘t be processed due to the resource‘s temporary lock and inaccessibility.'; parent::__construct(self::STATUS_LOCKED, $message, $code, $previous); + + $this->setReasonPhrase('Locked'); } } diff --git a/src/Exception/Http/HttpMethodNotAllowedException.php b/src/Exception/Http/HttpMethodNotAllowedException.php index 13b5d681..a9ba4440 100644 --- a/src/Exception/Http/HttpMethodNotAllowedException.php +++ b/src/Exception/Http/HttpMethodNotAllowedException.php @@ -16,8 +16,6 @@ use Sunrise\Http\Router\Exception\HttpException; use Throwable; -use function join; - /** * HTTP Method Not Allowed Exception * @@ -28,53 +26,31 @@ class HttpMethodNotAllowedException extends HttpException { - /** - * Allowed HTTP methods - * - * @var list - */ - private array $allowedMethods; - /** * Constructor of the class * - * @param list $allowedMethods - * @param string|null $message + * @param list $allowedMethods + * @param non-empty-string|null $message * @param int $code * @param Throwable|null $previous */ - public function __construct( - array $allowedMethods, - ?string $message = null, - int $code = 0, - ?Throwable $previous = null - ) { - $message ??= 'Method Not Allowed'; + // phpcs:ignore Generic.Files.LineLength + public function __construct(private array $allowedMethods, ?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'The request couldn‘t be processed using the requested HTTP method for the resource.'; parent::__construct(self::STATUS_METHOD_NOT_ALLOWED, $message, $code, $previous); - $this->allowedMethods = $allowedMethods; + $this->setReasonPhrase('Method Not Allowed'); - $this->addHeaderField('Allow', $this->getJoinedAllowedMethods()); + $this->addHeader('Allow', ...$allowedMethods); } /** - * Gets allowed HTTP methods - * - * @return list + * @return list */ - final public function getAllowedMethods(): array + public function getAllowedMethods(): array { return $this->allowedMethods; } - - /** - * Gets joined allowed HTTP methods - * - * @return string - */ - final public function getJoinedAllowedMethods(): string - { - return join(',', $this->allowedMethods); - } } diff --git a/src/Exception/Http/HttpMisdirectedRequestException.php b/src/Exception/Http/HttpMisdirectedRequestException.php deleted file mode 100644 index 4987747f..00000000 --- a/src/Exception/Http/HttpMisdirectedRequestException.php +++ /dev/null @@ -1,40 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Misdirected Request Exception - * - * @since 3.0.0 - */ -class HttpMisdirectedRequestException extends HttpException -{ - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - $message ??= 'Misdirected Request'; - - parent::__construct(self::STATUS_MISDIRECTED_REQUEST, $message, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpNotAcceptableException.php b/src/Exception/Http/HttpNotAcceptableException.php deleted file mode 100644 index 5204ff13..00000000 --- a/src/Exception/Http/HttpNotAcceptableException.php +++ /dev/null @@ -1,66 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Not Acceptable Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/406 - * - * @since 3.0.0 - */ -class HttpNotAcceptableException extends HttpException -{ - - /** - * Supported media types - * - * @var list - */ - private array $supportedMediaTypes = []; - - /** - * Constructor of the class - * - * @param list $supportedMediaTypes - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct( - array $supportedMediaTypes, - ?string $message = null, - int $code = 0, - ?Throwable $previous = null - ) { - $message ??= 'Not Acceptable'; - - parent::__construct(self::STATUS_NOT_ACCEPTABLE, $message, $code, $previous); - - $this->supportedMediaTypes = $supportedMediaTypes; - } - - /** - * Gets supported media types - * - * @return list - */ - final public function getSupportedTypes(): array - { - return $this->supportedMediaTypes; - } -} diff --git a/src/Exception/Http/HttpNotFoundException.php b/src/Exception/Http/HttpNotFoundException.php index 4b2c300e..d8e98fcd 100644 --- a/src/Exception/Http/HttpNotFoundException.php +++ b/src/Exception/Http/HttpNotFoundException.php @@ -29,14 +29,16 @@ class HttpNotFoundException extends HttpException /** * Constructor of the class * - * @param string|null $message + * @param non-empty-string|null $message * @param int $code * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'Not Found'; + $message ??= 'The requested page or resource could not be found.'; parent::__construct(self::STATUS_NOT_FOUND, $message, $code, $previous); + + $this->setReasonPhrase('Not Found'); } } diff --git a/src/Exception/Http/HttpPayloadTooLargeException.php b/src/Exception/Http/HttpPayloadTooLargeException.php index 46556afc..26e9d184 100644 --- a/src/Exception/Http/HttpPayloadTooLargeException.php +++ b/src/Exception/Http/HttpPayloadTooLargeException.php @@ -29,14 +29,16 @@ class HttpPayloadTooLargeException extends HttpException /** * Constructor of the class * - * @param string|null $message + * @param non-empty-string|null $message * @param int $code * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'Payload Too Large'; + $message ??= 'The request couldn‘t be processed due to the payload size exceeding limits.'; parent::__construct(self::STATUS_PAYLOAD_TOO_LARGE, $message, $code, $previous); + + $this->setReasonPhrase('Payload Too Large'); } } diff --git a/src/Exception/Http/HttpPaymentRequiredException.php b/src/Exception/Http/HttpPaymentRequiredException.php deleted file mode 100644 index 523de368..00000000 --- a/src/Exception/Http/HttpPaymentRequiredException.php +++ /dev/null @@ -1,42 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Payment Required Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402 - * - * @since 3.0.0 - */ -class HttpPaymentRequiredException extends HttpException -{ - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - $message ??= 'Payment Required'; - - parent::__construct(self::STATUS_PAYMENT_REQUIRED, $message, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpPreconditionFailedException.php b/src/Exception/Http/HttpPreconditionFailedException.php deleted file mode 100644 index d5c631cd..00000000 --- a/src/Exception/Http/HttpPreconditionFailedException.php +++ /dev/null @@ -1,42 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Precondition Failed Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/412 - * - * @since 3.0.0 - */ -class HttpPreconditionFailedException extends HttpException -{ - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - $message ??= 'Precondition Failed'; - - parent::__construct(self::STATUS_PRECONDITION_FAILED, $message, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpProxyAuthenticationRequiredException.php b/src/Exception/Http/HttpProxyAuthenticationRequiredException.php deleted file mode 100644 index 78e216e5..00000000 --- a/src/Exception/Http/HttpProxyAuthenticationRequiredException.php +++ /dev/null @@ -1,42 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Proxy Authentication Required Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/407 - * - * @since 3.0.0 - */ -class HttpProxyAuthenticationRequiredException extends HttpException -{ - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - $message ??= 'Proxy Authentication Required'; - - parent::__construct(self::STATUS_PROXY_AUTHENTICATION_REQUIRED, $message, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpRangeNotSatisfiableException.php b/src/Exception/Http/HttpRangeNotSatisfiableException.php deleted file mode 100644 index 9a495c79..00000000 --- a/src/Exception/Http/HttpRangeNotSatisfiableException.php +++ /dev/null @@ -1,42 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Range Not Satisfiable Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/416 - * - * @since 3.0.0 - */ -class HttpRangeNotSatisfiableException extends HttpException -{ - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - $message ??= 'Range Not Satisfiable'; - - parent::__construct(self::STATUS_RANGE_NOT_SATISFIABLE, $message, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpRequestHeaderFieldsTooLargeException.php b/src/Exception/Http/HttpRequestHeaderFieldsTooLargeException.php deleted file mode 100644 index 095dbbbe..00000000 --- a/src/Exception/Http/HttpRequestHeaderFieldsTooLargeException.php +++ /dev/null @@ -1,42 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Request Header Fields Too Large Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/431 - * - * @since 3.0.0 - */ -class HttpRequestHeaderFieldsTooLargeException extends HttpException -{ - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - $message ??= 'Request Header Fields Too Large'; - - parent::__construct(self::STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE, $message, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpRequestTimeoutException.php b/src/Exception/Http/HttpRequestTimeoutException.php deleted file mode 100644 index 48a39295..00000000 --- a/src/Exception/Http/HttpRequestTimeoutException.php +++ /dev/null @@ -1,42 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Request Timeout Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408 - * - * @since 3.0.0 - */ -class HttpRequestTimeoutException extends HttpException -{ - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - $message ??= 'Request Timeout'; - - parent::__construct(self::STATUS_REQUEST_TIMEOUT, $message, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpServiceUnavailableException.php b/src/Exception/Http/HttpServiceUnavailableException.php index f30b1822..ff7986db 100644 --- a/src/Exception/Http/HttpServiceUnavailableException.php +++ b/src/Exception/Http/HttpServiceUnavailableException.php @@ -29,14 +29,17 @@ class HttpServiceUnavailableException extends HttpException /** * Constructor of the class * - * @param string|null $message + * @param non-empty-string|null $message * @param int $code * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'Service Unavailable'; + // phpcs:ignore Generic.Files.LineLength + $message ??= 'The server is currently unable to handle the request due to temporary overloading or maintenance.'; parent::__construct(self::STATUS_SERVICE_UNAVAILABLE, $message, $code, $previous); + + $this->setReasonPhrase('Service Unavailable'); } } diff --git a/src/Exception/Http/HttpTooEarlyException.php b/src/Exception/Http/HttpTooEarlyException.php deleted file mode 100644 index 3652bebf..00000000 --- a/src/Exception/Http/HttpTooEarlyException.php +++ /dev/null @@ -1,42 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Too Early Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/425 - * - * @since 3.0.0 - */ -class HttpTooEarlyException extends HttpException -{ - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - $message ??= 'Too Early'; - - parent::__construct(self::STATUS_TOO_EARLY, $message, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpTooManyRequestsException.php b/src/Exception/Http/HttpTooManyRequestsException.php index cbf9c022..4e81b91a 100644 --- a/src/Exception/Http/HttpTooManyRequestsException.php +++ b/src/Exception/Http/HttpTooManyRequestsException.php @@ -29,14 +29,16 @@ class HttpTooManyRequestsException extends HttpException /** * Constructor of the class * - * @param string|null $message + * @param non-empty-string|null $message * @param int $code * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'Too Many Requests'; + $message ??= 'The request couldn‘t be processed due to exceeding rate-limiting thresholds.'; parent::__construct(self::STATUS_TOO_MANY_REQUESTS, $message, $code, $previous); + + $this->setReasonPhrase('Too Many Requests'); } } diff --git a/src/Exception/Http/HttpUnauthorizedException.php b/src/Exception/Http/HttpUnauthorizedException.php index d496e992..d90910db 100644 --- a/src/Exception/Http/HttpUnauthorizedException.php +++ b/src/Exception/Http/HttpUnauthorizedException.php @@ -29,14 +29,16 @@ class HttpUnauthorizedException extends HttpException /** * Constructor of the class * - * @param string|null $message + * @param non-empty-string|null $message * @param int $code * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'Unauthorized'; + $message ??= 'The request couldn‘t processed due to insufficient or invalid authentication credentials.'; parent::__construct(self::STATUS_UNAUTHORIZED, $message, $code, $previous); + + $this->setReasonPhrase('Unauthorized'); } } diff --git a/src/Exception/Http/HttpUnavailableForLegalReasonsException.php b/src/Exception/Http/HttpUnavailableForLegalReasonsException.php index fcdd1550..a7cbb14f 100644 --- a/src/Exception/Http/HttpUnavailableForLegalReasonsException.php +++ b/src/Exception/Http/HttpUnavailableForLegalReasonsException.php @@ -29,14 +29,16 @@ class HttpUnavailableForLegalReasonsException extends HttpException /** * Constructor of the class * - * @param string|null $message + * @param non-empty-string|null $message * @param int $code * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'Unavailable For Legal Reasons'; + $message ??= 'The request couldn‘t be processed due to legal restrictions on the resource.'; parent::__construct(self::STATUS_UNAVAILABLE_FOR_LEGAL_REASONS, $message, $code, $previous); + + $this->setReasonPhrase('Unavailable For Legal Reasons'); } } diff --git a/src/Exception/Http/HttpUnprocessableEntityException.php b/src/Exception/Http/HttpUnprocessableEntityException.php index ba950687..b26c9ebf 100644 --- a/src/Exception/Http/HttpUnprocessableEntityException.php +++ b/src/Exception/Http/HttpUnprocessableEntityException.php @@ -29,14 +29,16 @@ class HttpUnprocessableEntityException extends HttpException /** * Constructor of the class * - * @param string|null $message + * @param non-empty-string|null $message * @param int $code * @param Throwable|null $previous */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'Unprocessable Entity'; + $message ??= 'The request couldn‘t be processed due to semantic violations.'; parent::__construct(self::STATUS_UNPROCESSABLE_ENTITY, $message, $code, $previous); + + $this->setReasonPhrase('Unprocessable Entity'); } } diff --git a/src/Exception/Http/HttpUnsupportedMediaTypeException.php b/src/Exception/Http/HttpUnsupportedMediaTypeException.php index 449ce440..bf046b8e 100644 --- a/src/Exception/Http/HttpUnsupportedMediaTypeException.php +++ b/src/Exception/Http/HttpUnsupportedMediaTypeException.php @@ -13,11 +13,10 @@ namespace Sunrise\Http\Router\Exception\Http; +use Sunrise\Http\Router\Entity\MediaType; use Sunrise\Http\Router\Exception\HttpException; use Throwable; -use function join; - /** * HTTP Unsupported Media Type Exception * @@ -28,53 +27,31 @@ class HttpUnsupportedMediaTypeException extends HttpException { - /** - * Supported media types - * - * @var list - */ - private array $supportedMediaTypes = []; - /** * Constructor of the class * - * @param list $supportedMediaTypes - * @param string|null $message + * @param list $supportedMediaTypes + * @param non-empty-string|null $message * @param int $code * @param Throwable|null $previous */ - public function __construct( - array $supportedMediaTypes, - ?string $message = null, - int $code = 0, - ?Throwable $previous = null - ) { - $message ??= 'Unsupported Media Type'; + // phpcs:ignore Generic.Files.LineLength + public function __construct(private array $supportedMediaTypes, ?string $message = null, int $code = 0, ?Throwable $previous = null) + { + $message ??= 'The request couldn‘t be processed due to an unsupported format of the request payload.'; parent::__construct(self::STATUS_UNSUPPORTED_MEDIA_TYPE, $message, $code, $previous); - $this->supportedMediaTypes = $supportedMediaTypes; + $this->setReasonPhrase('Unsupported Media Type'); - $this->addHeaderField('Accept', $this->getJoinedSupportedTypes()); + $this->addHeader('Accept', ...$supportedMediaTypes); } /** - * Gets supported media types - * - * @return list + * @return list */ - final public function getSupportedTypes(): array + public function getSupportedMediaTypes(): array { return $this->supportedMediaTypes; } - - /** - * Gets joined supported media types - * - * @return string - */ - final public function getJoinedSupportedTypes(): string - { - return join(',', $this->supportedMediaTypes); - } } diff --git a/src/Exception/Http/HttpUpgradeRequiredException.php b/src/Exception/Http/HttpUpgradeRequiredException.php deleted file mode 100644 index f2b56bb5..00000000 --- a/src/Exception/Http/HttpUpgradeRequiredException.php +++ /dev/null @@ -1,42 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Upgrade Required Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/426 - * - * @since 3.0.0 - */ -class HttpUpgradeRequiredException extends HttpException -{ - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - $message ??= 'Upgrade Required'; - - parent::__construct(self::STATUS_UPGRADE_REQUIRED, $message, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpUriTooLongException.php b/src/Exception/Http/HttpUriTooLongException.php deleted file mode 100644 index 81691ca5..00000000 --- a/src/Exception/Http/HttpUriTooLongException.php +++ /dev/null @@ -1,42 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP URI Too Long Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/414 - * - * @since 3.0.0 - */ -class HttpUriTooLongException extends HttpException -{ - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - $message ??= 'URI Too Long'; - - parent::__construct(self::STATUS_URI_TOO_LONG, $message, $code, $previous); - } -} diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index ced1091f..11add4f8 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -14,8 +14,14 @@ namespace Sunrise\Http\Router\Exception; use RuntimeException; +use Stringable; +use Sunrise\Http\Router\Dto\ViolationDto; +use Sunrise\Hydrator\Exception\InvalidValueException; +use Symfony\Component\Validator\ConstraintViolationInterface; use Throwable; +use function join; + /** * Base HTTP exception * @@ -25,18 +31,32 @@ class HttpException extends RuntimeException implements HttpExceptionInterface { /** - * HTTP status code + * The error's reason phrase + * + * @var non-empty-string + */ + private string $reasonPhrase = 'Something went wrong'; + + /** + * HTTP status code that will be sent to the client * * @var int<100, 599> */ private int $statusCode; /** - * HTTP header fields + * HTTP header fields that will be sent to the client * - * @var list + * @var list */ - private array $headerFields = []; + private array $headers = []; + + /** + * The list of violations associated with the error + * + * @var list + */ + private array $violations = []; /** * Constructor of the class @@ -53,6 +73,14 @@ public function __construct(int $statusCode, string $message, int $code = 0, ?Th $this->statusCode = $statusCode; } + /** + * @inheritDoc + */ + final public function getReasonPhrase(): string + { + return $this->reasonPhrase; + } + /** * @inheritDoc */ @@ -64,21 +92,124 @@ final public function getStatusCode(): int /** * @inheritDoc */ - final public function getHeaderFields(): array + final public function getHeaders(): array { - return $this->headerFields; + return $this->headers; } /** - * Adds the given header field to the exception + * @inheritDoc + */ + final public function getViolations(): array + { + return $this->violations; + } + + /** + * Sets the given message to the error + * + * @param non-empty-string $message + * + * @return static + */ + final public function setMessage(string $message): static + { + $this->message = $message; + + return $this; + } + + /** + * Sets the given reason phrase to the error * - * @param string $fieldName - * @param string $fieldValue + * @param non-empty-string $reasonPhrase * - * @return void + * @return static */ - final public function addHeaderField(string $fieldName, string $fieldValue): void + final public function setReasonPhrase(string $reasonPhrase): static { - $this->headerFields[] = [$fieldName, $fieldValue]; + $this->reasonPhrase = $reasonPhrase; + + return $this; + } + + /** + * Sets the given HTTP status code that will be sent to the client + * + * @param int<100, 599> $statusCode + * + * @return static + */ + final public function setStatusCode(int $statusCode): static + { + $this->statusCode = $statusCode; + + return $this; + } + + /** + * Adds the given HTTP header field that will be sent to the client + * + * @param non-empty-string $fieldName + * @param Stringable|non-empty-string ...$fieldValues + * + * @return static + */ + final public function addHeader(string $fieldName, Stringable|string ...$fieldValues): static + { + /** @var non-empty-string $fieldValue */ + $fieldValue = join(', ', $fieldValues); + + $this->headers[] = [$fieldName, $fieldValue]; + + return $this; + } + + /** + * Adds the given violation(s) associated with the error + * + * @param ViolationDto ...$violations + * + * @return static + */ + final public function addViolation(ViolationDto ...$violations): static + { + foreach ($violations as $violation) { + $this->violations[] = $violation; + } + + return $this; + } + + /** + * Adds the given hydrator violation(s) associated with the error + * + * @param InvalidValueException ...$violations + * + * @return static + */ + final public function addHydratorViolation(InvalidValueException ...$violations): static + { + foreach ($violations as $violation) { + $this->violations[] = ViolationDto::fromHydratorViolation($violation); + } + + return $this; + } + + /** + * Adds the given validator violation(s) associated with the error + * + * @param ConstraintViolationInterface ...$violations + * + * @return static + */ + final public function addValidatorViolation(ConstraintViolationInterface ...$violations): static + { + foreach ($violations as $violation) { + $this->violations[] = ViolationDto::fromValidatorViolation($violation); + } + + return $this; } } diff --git a/src/Exception/HttpExceptionInterface.php b/src/Exception/HttpExceptionInterface.php index 903c93b7..70a5e7c0 100644 --- a/src/Exception/HttpExceptionInterface.php +++ b/src/Exception/HttpExceptionInterface.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router\Exception; use Fig\Http\Message\StatusCodeInterface; +use Sunrise\Http\Router\Dto\ViolationDto; /** * Base HTTP exception interface @@ -24,16 +25,37 @@ interface HttpExceptionInterface extends ExceptionInterface, StatusCodeInterface { /** - * Gets HTTP status code + * {@inheritDoc} + * + * @return non-empty-string + */ + public function getMessage(): string; + + /** + * Gets the error's reason phrase + * + * @return non-empty-string + */ + public function getReasonPhrase(): string; + + /** + * Gets HTTP status code that will be sent to the client * * @return int<100, 599> */ public function getStatusCode(): int; /** - * Gets HTTP header fields + * Gets HTTP header fields that will be sent to the client + * + * @return list + */ + public function getHeaders(): array; + + /** + * Gets the list of violations associated with the error * - * @return list + * @return list */ - public function getHeaderFields(): array; + public function getViolations(): array; } diff --git a/src/Exception/InvalidRequestPayloadException.php b/src/Exception/InvalidRequestPayloadException.php deleted file mode 100644 index 4e6c96c9..00000000 --- a/src/Exception/InvalidRequestPayloadException.php +++ /dev/null @@ -1,25 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; - -/** - * InvalidRequestPayloadException - * - * @since 3.0.0 - */ -class InvalidRequestPayloadException extends HttpBadRequestException -{ -} diff --git a/src/Exception/MethodNotAllowedException.php b/src/Exception/MethodNotAllowedException.php deleted file mode 100644 index 8d15989e..00000000 --- a/src/Exception/MethodNotAllowedException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use Sunrise\Http\Router\Exception\Http\HttpMethodNotAllowedException; - -/** - * MethodNotAllowedException - */ -class MethodNotAllowedException extends HttpMethodNotAllowedException -{ -} diff --git a/src/Exception/MissingRequestParameterException.php b/src/Exception/MissingRequestParameterException.php deleted file mode 100644 index ebdb33de..00000000 --- a/src/Exception/MissingRequestParameterException.php +++ /dev/null @@ -1,25 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; - -/** - * MissingRequestParameterException - * - * @since 3.0.0 - */ -class MissingRequestParameterException extends HttpBadRequestException -{ -} diff --git a/src/Exception/PageNotFoundException.php b/src/Exception/PageNotFoundException.php deleted file mode 100644 index 744e661f..00000000 --- a/src/Exception/PageNotFoundException.php +++ /dev/null @@ -1,25 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; - -/** - * PageNotFoundException - * - * @since 2.4.2 - */ -class PageNotFoundException extends HttpNotFoundException -{ -} diff --git a/src/Exception/ResolvingReferenceException.php b/src/Exception/ResolvingReferenceException.php deleted file mode 100644 index 2b21ef63..00000000 --- a/src/Exception/ResolvingReferenceException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -/** - * ResolvingReferenceException - * - * @since 3.0.0 - */ -class ResolvingReferenceException extends LogicException -{ -} diff --git a/src/Exception/UnhydrableObjectException.php b/src/Exception/UnhydrableObjectException.php deleted file mode 100644 index d35f2b71..00000000 --- a/src/Exception/UnhydrableObjectException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -/** - * UnhydrableObjectException - * - * @since 3.0.0 - */ -class UnhydrableObjectException extends LogicException -{ -} diff --git a/src/Exception/UnprocessableEntityException.php b/src/Exception/UnprocessableEntityException.php deleted file mode 100644 index 345a2bee..00000000 --- a/src/Exception/UnprocessableEntityException.php +++ /dev/null @@ -1,53 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; -use Symfony\Component\Validator\ConstraintViolationListInterface; - -/** - * UnprocessableEntityException - * - * @since 3.0.0 - */ -class UnprocessableEntityException extends HttpUnprocessableEntityException -{ - - /** - * @var ConstraintViolationListInterface - */ - private ConstraintViolationListInterface $violations; - - /** - * Constructor of the class - * - * @param ConstraintViolationListInterface $violations - */ - public function __construct(ConstraintViolationListInterface $violations) - { - parent::__construct(); - - $this->violations = $violations; - } - - /** - * Gets the violations list - * - * @return ConstraintViolationListInterface - */ - final public function getViolations(): ConstraintViolationListInterface - { - return $this->violations; - } -} diff --git a/src/Exception/UnprocessableRequestBodyException.php b/src/Exception/UnprocessableRequestBodyException.php deleted file mode 100644 index 3ba6a2dd..00000000 --- a/src/Exception/UnprocessableRequestBodyException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -/** - * UnprocessableRequestBodyException - * - * @since 3.0.0 - */ -class UnprocessableRequestBodyException extends UnprocessableEntityException -{ -} diff --git a/src/Exception/UnprocessableRequestQueryException.php b/src/Exception/UnprocessableRequestQueryException.php deleted file mode 100644 index 403ed813..00000000 --- a/src/Exception/UnprocessableRequestQueryException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -/** - * UnprocessableRequestQueryException - * - * @since 3.0.0 - */ -class UnprocessableRequestQueryException extends UnprocessableEntityException -{ -} diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index 85677f98..b06b980e 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -16,15 +16,15 @@ use Psr\Container\ContainerInterface; use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ParameterResolutioner; -use Sunrise\Http\Router\ParameterResolutionerInterface; -use Sunrise\Http\Router\ParameterResolver\DependencyInjectionParameterResolver; -use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; +use Sunrise\Http\Router\ParameterResolving\ParameterResolver\DependencyInjectionParameterResolver; +use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ParameterResolverInterface; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; -use Sunrise\Http\Router\ResponseResolutioner; -use Sunrise\Http\Router\ResponseResolutionerInterface; -use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; +use Sunrise\Http\Router\ResponseResolving\ResponseResolutioner; +use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; +use Sunrise\Http\Router\ResponseResolving\ResponseResolver\ResponseResolverInterface; use Sunrise\Http\Router\RouteCollectionFactory; use Sunrise\Http\Router\RouteCollectionFactoryInterface; use Sunrise\Http\Router\RouteCollectionInterface; diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 7f716f36..0d65c2c3 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -34,17 +34,18 @@ use Sunrise\Http\Router\Annotation\Route; use Sunrise\Http\Router\Annotation\Summary; use Sunrise\Http\Router\Annotation\Tag; +use Sunrise\Http\Router\Entity\MediaType; use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ParameterResolutioner; -use Sunrise\Http\Router\ParameterResolutionerInterface; -use Sunrise\Http\Router\ParameterResolver\DependencyInjectionParameterResolver; -use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; +use Sunrise\Http\Router\ParameterResolving\ParameterResolver\DependencyInjectionParameterResolver; +use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ParameterResolverInterface; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; -use Sunrise\Http\Router\ResponseResolutioner; -use Sunrise\Http\Router\ResponseResolutionerInterface; -use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; +use Sunrise\Http\Router\ResponseResolving\ResponseResolutioner; +use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; +use Sunrise\Http\Router\ResponseResolving\ResponseResolver\ResponseResolverInterface; use Sunrise\Http\Router\RouteCollectionFactory; use Sunrise\Http\Router\RouteCollectionFactoryInterface; use Sunrise\Http\Router\RouteCollectionInterface; @@ -56,6 +57,7 @@ use function hash; use function is_dir; use function is_string; +use function iterator_to_array; use function sprintf; use function usort; @@ -252,7 +254,7 @@ public function setCacheKey(?string $cacheKey): void */ public function getCacheKey(): string { - return $this->cacheKey ??= hash('md5', __METHOD__); + return $this->cacheKey ??= hash('md5', $this::class); } /** @@ -360,7 +362,7 @@ private function getDescriptors(): array * * @param string $resource * - * @return Generator + * @return Generator */ private function getResourceDescriptors(string $resource): Generator { @@ -380,7 +382,7 @@ private function getResourceDescriptors(string $resource): Generator * * @param ReflectionClass $class * - * @return Generator + * @return Generator */ private function getClassDescriptors(ReflectionClass $class): Generator { @@ -393,7 +395,8 @@ private function getClassDescriptors(ReflectionClass $class): Generator if ($annotations->valid()) { $descriptor = $annotations->current(); $descriptor->holder = $class->getName(); - $this->supplementDescriptor($descriptor, $class); + $this->supplementDescriptorFromParentClasses($descriptor, $class); + $this->supplementDescriptorFromClassOrMethod($descriptor, $class); yield $descriptor; } } @@ -408,13 +411,29 @@ private function getClassDescriptors(ReflectionClass $class): Generator if ($annotations->valid()) { $descriptor = $annotations->current(); $descriptor->holder = [$class->getName(), $method->getName()]; - $this->supplementDescriptor($descriptor, $class); - $this->supplementDescriptor($descriptor, $method); + $this->supplementDescriptorFromParentClasses($descriptor, $class); + $this->supplementDescriptorFromClassOrMethod($descriptor, $class); + $this->supplementDescriptorFromClassOrMethod($descriptor, $method); yield $descriptor; } } } + /** + * Supplements the given descriptor from parent classes of the given class + * + * @param Route $descriptor + * @param ReflectionClass $holder + * + * @return void + */ + private function supplementDescriptorFromParentClasses(Route $descriptor, ReflectionClass $holder): void + { + foreach ($this->getClassParents($holder) as $parent) { + $this->supplementDescriptorFromClassOrMethod($descriptor, $parent); + } + } + /** * Supplements the given descriptor from the given class or method * @@ -423,7 +442,8 @@ private function getClassDescriptors(ReflectionClass $class): Generator * * @return void */ - private function supplementDescriptor(Route $descriptor, ReflectionClass|ReflectionMethod $holder): void + // phpcs:ignore Generic.Files.LineLength + private function supplementDescriptorFromClassOrMethod(Route $descriptor, ReflectionClass|ReflectionMethod $holder): void { $annotations = $this->getAnnotations(Host::class, $holder); if ($annotations->valid()) { @@ -447,18 +467,12 @@ private function supplementDescriptor(Route $descriptor, ReflectionClass|Reflect $annotations = $this->getAnnotations(Consumes::class, $holder); foreach ($annotations as $annotation) { - $consumesMediaTypes = \Sunrise\Http\Router\parse_header_with_media_type($annotation->value); - foreach ($consumesMediaTypes as $consumesMediaType) { - $descriptor->consumes[] = $consumesMediaType; - } + $descriptor->consumes[] = new MediaType($annotation->type, $annotation->subtype); } $annotations = $this->getAnnotations(Produces::class, $holder); foreach ($annotations as $annotation) { - $producesMediaTypes = \Sunrise\Http\Router\parse_header_with_media_type($annotation->value); - foreach ($producesMediaTypes as $producesMediaType) { - $descriptor->produces[] = $producesMediaType; - } + $descriptor->produces[] = new MediaType($annotation->type, $annotation->subtype, $annotation->parameters); } $annotations = $this->getAnnotations(Middleware::class, $holder); @@ -487,22 +501,15 @@ private function supplementDescriptor(Route $descriptor, ReflectionClass|Reflect * * @param string $dirname * - * @return Generator + * @return Generator */ private function getDirectoryClasses(string $dirname): Generator { + $flags = FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_PATHNAME; + /** @var array $filenames */ - $filenames = [...( - new RegexIterator( - new RecursiveIteratorIterator( - new RecursiveDirectoryIterator( - $dirname, - FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_PATHNAME, - ) - ), - pattern: '/\.php$/', - ) - )]; + // phpcs:ignore Generic.Files.LineLength + $filenames = iterator_to_array(new RegexIterator(new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dirname, $flags)), '/\.php$/')); foreach ($filenames as $filename) { (static function (string $filename): void { @@ -519,13 +526,30 @@ private function getDirectoryClasses(string $dirname): Generator } } + /** + * Gets parents of the given class + * + * @param ReflectionClass $child + * + * @return Generator + */ + private function getClassParents(ReflectionClass $child): Generator + { + $ancestors = []; + while ($child = $child->getParentClass()) { + $ancestors = [$child, ...$ancestors]; + } + + yield from $ancestors; + } + /** * Gets the named annotations from the given class or method * * @param class-string $name * @param ReflectionClass|ReflectionMethod $source * - * @return Generator + * @return Generator * * @template T of object */ diff --git a/src/Middleware/CallbackMiddleware.php b/src/Middleware/CallbackMiddleware.php index 64d83c57..0dd32e3e 100644 --- a/src/Middleware/CallbackMiddleware.php +++ b/src/Middleware/CallbackMiddleware.php @@ -19,9 +19,9 @@ use Psr\Http\Server\RequestHandlerInterface; use ReflectionFunction; use ReflectionMethod; -use Sunrise\Http\Router\ParameterResolutionerInterface; -use Sunrise\Http\Router\ParameterResolver\PresetObjectParameterResolver; -use Sunrise\Http\Router\ResponseResolutionerInterface; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; +use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ObjectInjectionParameterResolver; +use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; use function Sunrise\Http\Router\reflect_callback; @@ -91,8 +91,8 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface $arguments = $this->parameterResolutioner ->withContext($request) ->withPriorityResolver( - new PresetObjectParameterResolver($request), - new PresetObjectParameterResolver($handler), + new ObjectInjectionParameterResolver($request), + new ObjectInjectionParameterResolver($handler), ) ->resolveParameters(...$source->getParameters()); diff --git a/src/Middleware/ErrorHandlingMiddleware.php b/src/Middleware/ErrorHandlingMiddleware.php new file mode 100644 index 00000000..bd77dc37 --- /dev/null +++ b/src/Middleware/ErrorHandlingMiddleware.php @@ -0,0 +1,177 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Middleware; + +use Psr\EventDispatcher\EventDispatcherInterface; +use Psr\Http\Message\ResponseFactoryInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; +use Psr\Log\LoggerInterface; +use SimpleXMLElement; +use Sunrise\Http\Router\Dto\ErrorDto; +use Sunrise\Http\Router\Entity\MediaType; +use Sunrise\Http\Router\Event\ErrorEvent; +use Sunrise\Http\Router\Exception\Http\HttpInternalServerErrorException; +use Sunrise\Http\Router\Exception\HttpExceptionInterface; +use Sunrise\Http\Router\ServerRequest; +use Throwable; + +use function extension_loaded; +use function json_encode; +use function ob_end_clean; +use function ob_get_clean; +use function ob_start; + +use const JSON_PARTIAL_OUTPUT_ON_ERROR; +use const LIBXML_COMPACT; +use const LIBXML_NOERROR; +use const LIBXML_NOWARNING; + +/** + * @since 3.0.0 + */ +final class ErrorHandlingMiddleware implements MiddlewareInterface +{ + + /** + * Constructor of the class + * + * @param ResponseFactoryInterface $responseFactory + * @param EventDispatcherInterface|null $eventDispatcher + * @param LoggerInterface|null $logger + */ + public function __construct( + private ResponseFactoryInterface $responseFactory, + private ?EventDispatcherInterface $eventDispatcher = null, + private ?LoggerInterface $logger = null, + ) { + } + + /** + * @inheritDoc + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + try { + return $handler->handle($request); + } catch (HttpExceptionInterface $error) { + return $this->handleHttpError($error, $request); + } catch (Throwable $error) { + return $this->handleFatalError($error, $request); + } + } + + private function handleHttpError(HttpExceptionInterface $error, ServerRequestInterface $request): ResponseInterface + { + $serverProducesMediaTypes = [MediaType::html(), MediaType::json()]; + + if (extension_loaded('simplexml')) { + $serverProducesMediaTypes[] = MediaType::xml(); + } + + $clientPreferredMediaType = ServerRequest::from($request) + ->getClientPreferredMediaType(...$serverProducesMediaTypes); + + $response = $this->responseFactory->createResponse($error->getStatusCode()) + ->withHeader('Content-Type', $clientPreferredMediaType->__toString()); + + foreach ($error->getHeaders() as [$fieldName, $fieldValue]) { + $response = $response->withHeader($fieldName, $fieldValue); + } + + if ($clientPreferredMediaType->equals(MediaType::html())) { + $response->getBody()->write($this->renderHtmlError($error)); + } elseif ($clientPreferredMediaType->equals(MediaType::json())) { + $response->getBody()->write($this->renderJsonError($error)); + } elseif ($clientPreferredMediaType->equals(MediaType::xml())) { + $response->getBody()->write($this->renderXmlError($error)); + } + + if (isset($this->eventDispatcher)) { + $event = new ErrorEvent($error, $request, $response); + $this->eventDispatcher->dispatch($event); + $response = $event->getResponse(); + } + + return $response; + } + + private function handleFatalError(Throwable $error, ServerRequestInterface $request): ResponseInterface + { + $this->logger?->error($error->getMessage(), ['error' => $error]); + + $httpError = new HttpInternalServerErrorException(previous: $error); + + return $this->handleHttpError($httpError, $request); + } + + private function renderHtmlError(HttpExceptionInterface $error): string + { + $view = __DIR__ . '/../../resources/views/error.phtml'; + + return $this->loadView($view, $error); + } + + private function renderJsonError(HttpExceptionInterface $error): string + { + $view = new ErrorDto( + $error->getMessage(), + $error->getViolations(), + ); + + return json_encode($view, flags: JSON_PARTIAL_OUTPUT_ON_ERROR); + } + + private function renderXmlError(HttpExceptionInterface $error): string + { + $xmlBlank = ''; + $xmlOptions = LIBXML_COMPACT | LIBXML_NOERROR | LIBXML_NOWARNING; + + $errorChild = new SimpleXMLElement($xmlBlank, $xmlOptions); + $errorChild->addChild('message', $error->getMessage()); + + foreach ($error->getViolations() as $violation) { + /** @var SimpleXMLElement $violationsChild */ + $violationsChild = $errorChild->addChild('violations'); + $violationsChild->addChild('message', $violation->message); + $violationsChild->addChild('source', $violation->source); + $violationsChild->addChild('code', $violation->code); + } + + /** @var string */ + return $errorChild->asXML(); + } + + private function loadView(string $filename, HttpExceptionInterface $error): string + { + try { + ob_start(); + + (function (string $filename): void { + /** @psalm-suppress UnresolvableInclude */ + include $filename; + })->call($error, $filename); + + return ob_get_clean(); + } catch (Throwable $exception) { + while (ob_get_level()) { + ob_end_clean(); + } + + throw $exception; + } + } +} diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 6dbd6d97..cd850ee3 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -19,14 +19,11 @@ use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Exception\InvalidRequestPayloadException; -use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; use Sunrise\Http\Router\ServerRequest; -use function extension_loaded; use function is_array; use function json_decode; -use function sprintf; use const JSON_BIGINT_AS_STRING; use const JSON_THROW_ON_ERROR; @@ -41,20 +38,6 @@ final class JsonPayloadDecodingMiddleware implements MiddlewareInterface { - /** - * Constructor of the class - * - * @throws LogicException If the JSON extension isn't loaded. - */ - public function __construct() - { - if (!extension_loaded('json')) { - throw new LogicException( - 'The JSON extension is required, run the `pecl install json` command to resolve it.' - ); - } - } - /** * @inheritDoc */ @@ -74,19 +57,22 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface * * @return array * - * @throws InvalidRequestPayloadException If the JSON payload cannot be decoded. + * @throws HttpBadRequestException If the JSON payload couldn't be decoded. */ private function decodePayload(string $payload): array { + if ($payload === '') { + throw new HttpBadRequestException('JSON payload cannot be empty.'); + } + try { $data = json_decode($payload, true, 512, JSON_BIGINT_AS_STRING | JSON_THROW_ON_ERROR); } catch (JsonException $e) { - throw new InvalidRequestPayloadException(sprintf('Invalid JSON payload: %s', $e->getMessage()), 0, $e); + throw new HttpBadRequestException('The JSON payload is invalid and could not be decoded.', previous: $e); } - // According to PSR-7, the data must be an array... - if (!is_array($data)) { - throw new InvalidRequestPayloadException('Unexpected JSON: Expects an array or object.'); + if (is_array($data) === false) { + throw new HttpBadRequestException('The JSON payload must be in the form of an array or an object.'); } return $data; diff --git a/src/ParameterResolver/ClientRemoteAddressParameterResolver.php b/src/ParameterResolver/ClientRemoteAddressParameterResolver.php deleted file mode 100644 index e1e00e80..00000000 --- a/src/ParameterResolver/ClientRemoteAddressParameterResolver.php +++ /dev/null @@ -1,66 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ParameterResolver; - -use Generator; -use Psr\Http\Message\ServerRequestInterface; -use ReflectionNamedType; -use ReflectionParameter; -use Sunrise\Http\Router\Entity\ClientRemoteAddress; -use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ServerRequest; - -/** - * ClientRemoteAddressParameterResolver - * - * @since 3.0.0 - */ -final class ClientRemoteAddressParameterResolver implements ParameterResolverInterface -{ - - /** - * Constructor of th class - * - * @param array $proxyChain - * - * @template TKey as non-empty-string Proxy address; e.g., 127.0.0.1 - * @template TValue as non-empty-string Trusted header; e.g., X-Forwarded-For, X-Real-IP, etc. - */ - public function __construct(private array $proxyChain = []) - { - } - - /** - * @inheritDoc - * - * @throws LogicException If the resolver is used incorrectly. - */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator - { - $type = $parameter->getType(); - - if (! ($type instanceof ReflectionNamedType) || - ! ($type->getName() === ClientRemoteAddress::class)) { - return; - } - - if (! $context instanceof ServerRequestInterface) { - throw new LogicException( - 'At this level of the application, any operations with the request are not possible.' - ); - } - - yield ServerRequest::from($context)->getClientRemoteAddress($this->proxyChain); - } -} diff --git a/src/ParameterResolver/RequestEntityParameterResolver.php b/src/ParameterResolver/RequestEntityParameterResolver.php deleted file mode 100644 index ed844278..00000000 --- a/src/ParameterResolver/RequestEntityParameterResolver.php +++ /dev/null @@ -1,132 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ParameterResolver; - -use Doctrine\Persistence\ManagerRegistry as EntityManagerRegistryInterface; -use Generator; -use Psr\Http\Message\ServerRequestInterface; -use ReflectionAttribute; -use ReflectionNamedType; -use ReflectionParameter; -use Sunrise\Http\Router\Annotation\RequestEntity; -use Sunrise\Http\Router\Exception\EntityNotFoundException; -use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ParameterResolutioner; - -use function count; -use function current; -use function sprintf; - -/** - * RequestEntityParameterResolver - * - * @since 3.0.0 - */ -final class RequestEntityParameterResolver implements ParameterResolverInterface -{ - - /** - * Constructor of the class - * - * @param EntityManagerRegistryInterface $entityManagerRegistry - * @param non-empty-string|null $defaultEntityManagerName - */ - public function __construct( - private EntityManagerRegistryInterface $entityManagerRegistry, - private string|null $defaultEntityManagerName = null, - ) { - } - - /** - * @inheritDoc - * - * @throws EntityNotFoundException If an entity wasn't found. - * @throws LogicException If the resolver is used incorrectly. - */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator - { - /** @var list> $attributes */ - $attributes = $parameter->getAttributes(RequestEntity::class); - if ($attributes === []) { - return; - } - - $type = $parameter->getType(); - - if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { - throw new LogicException(sprintf( - 'To use the #[RequestEntity] attribute, the parameter {%s} must be typed with an entity.', - ParameterResolutioner::stringifyParameter($parameter), - )); - } - - if (! $context instanceof ServerRequestInterface) { - throw new LogicException( - 'At this level of the application, any operations with the request are not possible.' - ); - } - - $requestEntity = $attributes[0]->newInstance(); - - $entityManagerName = $requestEntity->em ?? $this->defaultEntityManagerName; - $entityManager = $this->entityManagerRegistry->getManager($entityManagerName); - - $entityIdentificationFieldName = $requestEntity->findBy; - if ($entityIdentificationFieldName === null) { - $entityMetadata = $entityManager->getClassMetadata($type->getName()); - $entityIdentificationFieldNames = $entityMetadata->getIdentifier(); - if (empty($entityIdentificationFieldNames) || - count($entityIdentificationFieldNames) > 1) { - throw new LogicException(sprintf( - 'To use the #[RequestEntity] attribute with the parameter {%s}, ' . - 'it is necessary to explicitly set the "findBy" parameter within it, ' . - 'as the entity {%s} either has a composite identifier or does not have one at all.', - ParameterResolutioner::stringifyParameter($parameter), - $type->getName(), - )); - } - - $entityIdentificationFieldName = current($entityIdentificationFieldNames); - } - - $requestParameterName = $requestEntity->valueKey ?? $entityIdentificationFieldName; - $entityIdentificationFieldValue = $context->getAttribute($requestParameterName); - if ($entityIdentificationFieldValue === null) { - throw new LogicException(sprintf( - 'To use the #[RequestEntity] attribute with the parameter {%s}, ' . - 'it might be necessary to explicitly set the "valueKey" parameter within it, ' . - 'as the attribute with the name "%s" was not found in the current request.', - ParameterResolutioner::stringifyParameter($parameter), - $requestParameterName, - )); - } - - $entity = $entityManager->getRepository($type->getName())->findOneBy([ - $entityIdentificationFieldName => $entityIdentificationFieldValue, - ...$requestEntity->criteria, - ]); - - if (isset($entity)) { - yield $entity; - return; - } - - if ($parameter->allowsNull()) { - yield null; - return; - } - - throw new EntityNotFoundException(); - } -} diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php deleted file mode 100644 index 014c4f31..00000000 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ /dev/null @@ -1,37 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ParameterResolver; - -use Generator; -use ReflectionAttribute; -use ReflectionParameter; -use Sunrise\Http\Router\Annotation\RequestHeader; - -final class RequestHeaderParameterResolver implements ParameterResolverInterface -{ - - /** - * @inheritDoc - */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator - { - /** @var list> $attributes */ - $attributes = $parameter->getAttributes(RequestHeader::class); - if ($attributes === []) { - return; - } - - // TODO: Implement the method... - } -} diff --git a/src/ParameterResolver/RequestPathVariableParameterResolver.php b/src/ParameterResolver/RequestPathVariableParameterResolver.php deleted file mode 100644 index 4db162e1..00000000 --- a/src/ParameterResolver/RequestPathVariableParameterResolver.php +++ /dev/null @@ -1,37 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ParameterResolver; - -use Generator; -use ReflectionAttribute; -use ReflectionParameter; -use Sunrise\Http\Router\Annotation\RequestPathVariable; - -final class RequestPathVariableParameterResolver implements ParameterResolverInterface -{ - - /** - * @inheritDoc - */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator - { - /** @var list> $attributes */ - $attributes = $parameter->getAttributes(RequestPathVariable::class); - if ($attributes === []) { - return; - } - - // TODO: Implement the method... - } -} diff --git a/src/ParameterResolutioner.php b/src/ParameterResolving/ParameterResolutioner.php similarity index 89% rename from src/ParameterResolutioner.php rename to src/ParameterResolving/ParameterResolutioner.php index 3d9ed969..0a0a404b 100644 --- a/src/ParameterResolutioner.php +++ b/src/ParameterResolving/ParameterResolutioner.php @@ -11,13 +11,13 @@ declare(strict_types=1); -namespace Sunrise\Http\Router; +namespace Sunrise\Http\Router\ParameterResolving; use Generator; use ReflectionMethod; use ReflectionParameter; use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; +use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ParameterResolverInterface; use function sprintf; @@ -82,7 +82,7 @@ public function addResolver(ParameterResolverInterface ...$resolvers): void /** * @inheritDoc * - * @throws LogicException If one of the parameters cannot be resolved to an argument(s). + * @throws LogicException If one of the parameters couldn't be resolved to an argument(s). */ public function resolveParameters(ReflectionParameter ...$parameters): Generator { @@ -96,9 +96,9 @@ public function resolveParameters(ReflectionParameter ...$parameters): Generator * * @param ReflectionParameter $parameter * - * @return Generator + * @return Generator * - * @throws LogicException If the parameter cannot be resolved to an argument(s). + * @throws LogicException If the parameter couldn't be resolved to an argument(s). */ private function resolveParameter(ReflectionParameter $parameter): Generator { @@ -114,7 +114,7 @@ private function resolveParameter(ReflectionParameter $parameter): Generator } throw new LogicException(sprintf( - 'Unable to resolve the parameter {%s}', + 'Unable to resolve the parameter {%s}.', self::stringifyParameter($parameter) )); } diff --git a/src/ParameterResolutionerInterface.php b/src/ParameterResolving/ParameterResolutionerInterface.php similarity index 88% rename from src/ParameterResolutionerInterface.php rename to src/ParameterResolving/ParameterResolutionerInterface.php index bfbd04ea..97a0a1a6 100644 --- a/src/ParameterResolutionerInterface.php +++ b/src/ParameterResolving/ParameterResolutionerInterface.php @@ -11,11 +11,11 @@ declare(strict_types=1); -namespace Sunrise\Http\Router; +namespace Sunrise\Http\Router\ParameterResolving; use Generator; use ReflectionParameter; -use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; +use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ParameterResolverInterface; /** * ParameterResolutionerInterface @@ -61,7 +61,7 @@ public function addResolver(ParameterResolverInterface ...$resolvers): void; * * @param ReflectionParameter ...$parameters * - * @return Generator List of ready-to-pass arguments. + * @return Generator List of ready-to-pass arguments. */ public function resolveParameters(ReflectionParameter ...$parameters): Generator; } diff --git a/src/ParameterResolver/DependencyInjectionParameterResolver.php b/src/ParameterResolving/ParameterResolver/DependencyInjectionParameterResolver.php similarity index 94% rename from src/ParameterResolver/DependencyInjectionParameterResolver.php rename to src/ParameterResolving/ParameterResolver/DependencyInjectionParameterResolver.php index ba6db34d..252b837d 100644 --- a/src/ParameterResolver/DependencyInjectionParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/DependencyInjectionParameterResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; use Generator; use Psr\Container\ContainerInterface; diff --git a/src/ParameterResolver/PresetObjectParameterResolver.php b/src/ParameterResolving/ParameterResolver/ObjectInjectionParameterResolver.php similarity index 79% rename from src/ParameterResolver/PresetObjectParameterResolver.php rename to src/ParameterResolving/ParameterResolver/ObjectInjectionParameterResolver.php index 91e16fd7..f7692281 100644 --- a/src/ParameterResolver/PresetObjectParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/ObjectInjectionParameterResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; use Generator; use ReflectionNamedType; @@ -20,11 +20,11 @@ use function is_a; /** - * PresetObjectParameterResolver + * ObjectInjectionParameterResolver * * @since 3.0.0 */ -final class PresetObjectParameterResolver implements ParameterResolverInterface +final class ObjectInjectionParameterResolver implements ParameterResolverInterface { /** @@ -47,7 +47,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return; } - if (! is_a($this->object, $type->getName())) { + if (!is_a($this->object, $type->getName())) { return; } diff --git a/src/ParameterResolver/ParameterResolverInterface.php b/src/ParameterResolving/ParameterResolver/ParameterResolverInterface.php similarity index 87% rename from src/ParameterResolver/ParameterResolverInterface.php rename to src/ParameterResolving/ParameterResolver/ParameterResolverInterface.php index 6f29aaa7..05989698 100644 --- a/src/ParameterResolver/ParameterResolverInterface.php +++ b/src/ParameterResolving/ParameterResolver/ParameterResolverInterface.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; use Generator; use ReflectionParameter; @@ -30,7 +30,7 @@ interface ParameterResolverInterface * @param ReflectionParameter $parameter * @param mixed $context * - * @return Generator + * @return Generator */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator; } diff --git a/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php b/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php new file mode 100644 index 00000000..5aa2f61a --- /dev/null +++ b/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php @@ -0,0 +1,117 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; + +use Generator; +use InvalidArgumentException; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionAttribute; +use ReflectionParameter; +use Sunrise\Http\Router\Annotation\PathVariable; +use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; +use Sunrise\Http\Router\RouteInterface; +use Sunrise\Http\Router\TypeConversion\TypeConversionerInterface; + +use function sprintf; + +/** + * PathVariableParameterResolver + * + * @since 3.0.0 + */ +final class PathVariableParameterResolver implements ParameterResolverInterface +{ + + /** + * Constructor of the class + * + * @param TypeConversionerInterface $typeConversioner + */ + public function __construct(private TypeConversionerInterface $typeConversioner) + { + } + + /** + * @inheritDoc + * + * @throws LogicException If the resolver is used incorrectly. + * + * @throws HttpNotFoundException If the request's path variable isn't valid. + */ + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + { + /** @var list> $attributes */ + $attributes = $parameter->getAttributes(PathVariable::class); + if ($attributes === []) { + return; + } + + if (!$parameter->hasType()) { + throw new LogicException(sprintf( + 'To use the #[PathVariable] attribute, the parameter {%s} must be typed.', + ParameterResolutioner::stringifyParameter($parameter), + )); + } + + if (! $context instanceof ServerRequestInterface) { + throw new LogicException( + 'At this level of the application, any operations with the request are not possible.' + ); + } + + $route = $context->getAttribute('@route'); + + if (! $route instanceof RouteInterface) { + throw new LogicException( + 'The #[PathVariable] attribute cannot be applied to the parameter {%s}, ' . + 'because the request does not contain information about the requested route, ' . + 'at least at this level of the application.' + ); + } + + $variable = $attributes[0]->newInstance(); + $variableName = $variable->name ?? $parameter->getName(); + /** @var mixed $variableValue */ + $variableValue = $route->getAttribute($variableName); + + if ($variableValue === null) { + if ($parameter->isDefaultValueAvailable()) { + return yield $parameter->getDefaultValue(); + } elseif ($parameter->allowsNull()) { + return yield; + } + + throw new LogicException(sprintf( + 'The parameter {%1$s} expects the value of the variable "%2$s" from the route "%3$s", ' . + 'which is missing in the request, most likely, because this variable is optional. ' . + 'To resolve this issue, make this parameter nullable or assign it a default value.', + ParameterResolutioner::stringifyParameter($parameter), + $variableName, + $route->getName(), + )); + } + + try { + yield $this->typeConversioner->castValue($variableValue, $parameter->getType()); + } catch (InvalidArgumentException $violation) { + throw new HttpNotFoundException(sprintf( + 'The request cannot be completed with an invalid "%s". %s', + $variableName, + $violation->getMessage(), + ), previous: $violation); + } + } +} diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestBodyParameterResolver.php similarity index 73% rename from src/ParameterResolver/RequestBodyParameterResolver.php rename to src/ParameterResolving/ParameterResolver/RequestBodyParameterResolver.php index 78081a2c..b558c861 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/RequestBodyParameterResolver.php @@ -11,17 +11,16 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; use Generator; use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestBody; +use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\Exception\UnhydrableObjectException; -use Sunrise\Http\Router\Exception\UnprocessableRequestBodyException; -use Sunrise\Http\Router\ParameterResolutioner; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; @@ -44,18 +43,18 @@ final class RequestBodyParameterResolver implements ParameterResolverInterface * Constructor of the class * * @param HydratorInterface $hydrator - * @param ValidatorInterface $validator + * @param ValidatorInterface|null $validator */ - public function __construct(private HydratorInterface $hydrator, private ValidatorInterface $validator) + public function __construct(private HydratorInterface $hydrator, private ?ValidatorInterface $validator = null) { } /** * @inheritDoc * - * @throws UnhydrableObjectException If an object isn't valid. - * @throws UnprocessableRequestBodyException If the request's parsed body isn't valid. - * @throws LogicException If the resolver is used incorrectly. + * @throws LogicException If the resolver is used incorrectly or if an object isn't valid. + * + * @throws HttpUnprocessableEntityException If the request's parsed body isn't valid. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -81,14 +80,16 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) try { $object = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidObjectException $e) { - throw new UnhydrableObjectException($e->getMessage(), 0, $e); + throw new LogicException($e->getMessage(), 0, $e); } catch (InvalidDataException $e) { - throw new UnprocessableRequestBodyException($e->getViolations()); + throw (new HttpUnprocessableEntityException)->addHydratorViolation(...$e->getExceptions()); } - $violations = $this->validator->validate($object); - if ($violations->count() > 0) { - throw new UnprocessableRequestBodyException($violations); + if (isset($this->validator)) { + $violations = $this->validator->validate($object); + if ($violations->count() > 0) { + throw (new HttpUnprocessableEntityException)->addValidatorViolation(...$violations); + } } yield $object; diff --git a/src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php new file mode 100644 index 00000000..9341e222 --- /dev/null +++ b/src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php @@ -0,0 +1,100 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; + +use Generator; +use InvalidArgumentException; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionAttribute; +use ReflectionParameter; +use Sunrise\Http\Router\Annotation\RequestHeader; +use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; +use Sunrise\Http\Router\TypeConversion\TypeConversionerInterface; + +use function sprintf; + +/** + * RequestHeaderParameterResolver + * + * @since 3.0.0 + */ +final class RequestHeaderParameterResolver implements ParameterResolverInterface +{ + + /** + * Constructor of the class + * + * @param TypeConversionerInterface $typeConversioner + */ + public function __construct(private TypeConversionerInterface $typeConversioner) + { + } + + /** + * @inheritDoc + * + * @throws LogicException If the resolver is used incorrectly. + */ + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + { + /** @var list> $attributes */ + $attributes = $parameter->getAttributes(RequestHeader::class); + if ($attributes === []) { + return; + } + + if (!$parameter->hasType()) { + throw new LogicException(sprintf( + 'To use the #[RequestHeader] attribute, the parameter {%s} must be typed.', + ParameterResolutioner::stringifyParameter($parameter), + )); + } + + if (! $context instanceof ServerRequestInterface) { + throw new LogicException( + 'At this level of the application, any operations with the request are not possible.' + ); + } + + $header = $attributes[0]->newInstance(); + + if (!$context->hasHeader($header->name)) { + if ($parameter->isDefaultValueAvailable()) { + return yield $parameter->getDefaultValue(); + } elseif ($parameter->allowsNull()) { + return yield; + } + + throw new HttpBadRequestException(sprintf( + 'The HTTP header %s must be provided.', + $header->name, + )); + } + + try { + yield $this->typeConversioner->castValue( + $context->getHeaderLine($header->name), + $parameter->getType(), + ); + } catch (InvalidArgumentException $violation) { + throw new HttpBadRequestException(sprintf( + 'The value of the HTTP header %s is not valid. %s', + $header->name, + $violation->getMessage(), + ), previous: $violation); + } + } +} diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php similarity index 72% rename from src/ParameterResolver/RequestQueryParameterResolver.php rename to src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php index 9aea6c02..6274c282 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php @@ -11,17 +11,16 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; use Generator; use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestQuery; +use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\Exception\UnhydrableObjectException; -use Sunrise\Http\Router\Exception\UnprocessableRequestQueryException; -use Sunrise\Http\Router\ParameterResolutioner; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; @@ -44,18 +43,18 @@ final class RequestQueryParameterResolver implements ParameterResolverInterface * Constructor of the class * * @param HydratorInterface $hydrator - * @param ValidatorInterface $validator + * @param ValidatorInterface|null $validator */ - public function __construct(private HydratorInterface $hydrator, private ValidatorInterface $validator) + public function __construct(private HydratorInterface $hydrator, private ?ValidatorInterface $validator = null) { } /** * @inheritDoc * - * @throws UnhydrableObjectException If an object isn't valid. - * @throws UnprocessableRequestQueryException If the request's query parameters isn't valid. - * @throws LogicException If the resolver is used incorrectly. + * @throws LogicException If the resolver is used incorrectly or if an object isn't valid. + * + * @throws HttpUnprocessableEntityException If the request's query parameters isn't valid. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -81,14 +80,16 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) try { $object = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidObjectException $e) { - throw new UnhydrableObjectException($e->getMessage(), 0, $e); + throw new LogicException($e->getMessage(), 0, $e); } catch (InvalidDataException $e) { - throw new UnprocessableRequestQueryException($e->getViolations()); + throw (new HttpUnprocessableEntityException)->addHydratorViolation(...$e->getExceptions()); } - $violations = $this->validator->validate($object); - if ($violations->count() > 0) { - throw new UnprocessableRequestQueryException($violations); + if (isset($this->validator)) { + $violations = $this->validator->validate($object); + if ($violations->count() > 0) { + throw (new HttpUnprocessableEntityException)->addValidatorViolation(...$violations); + } } yield $object; diff --git a/src/ParameterResolver/RequestRouteParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestRouteParameterResolver.php similarity index 93% rename from src/ParameterResolver/RequestRouteParameterResolver.php rename to src/ParameterResolving/ParameterResolver/RequestRouteParameterResolver.php index 0d919b51..25c6283c 100644 --- a/src/ParameterResolver/RequestRouteParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/RequestRouteParameterResolver.php @@ -11,14 +11,14 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; use Generator; use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ParameterResolutioner; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; use Sunrise\Http\Router\RouteInterface; use function sprintf; diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index 954e391a..50f77cab 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -19,7 +19,9 @@ use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\Middleware\CallbackMiddleware; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; +use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; use function class_exists; use function get_debug_type; @@ -75,7 +77,7 @@ public function __construct( /** * @inheritDoc * - * @throws LogicException If the reference cannot be resolved. + * @throws LogicException If the reference couldn't be resolved. */ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface { @@ -132,7 +134,7 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface /** * @inheritDoc * - * @throws LogicException If the reference cannot be resolved. + * @throws LogicException If the reference couldn't be resolved. */ public function resolveMiddleware(mixed $reference): MiddlewareInterface { @@ -189,7 +191,7 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface /** * @inheritDoc * - * @throws LogicException If one of the references cannot be resolved. + * @throws LogicException If one of the references couldn't be resolved. */ public function resolveMiddlewares(array $references): Generator { diff --git a/src/RequestHandler/CallbackRequestHandler.php b/src/RequestHandler/CallbackRequestHandler.php index 3b52a405..960f258b 100644 --- a/src/RequestHandler/CallbackRequestHandler.php +++ b/src/RequestHandler/CallbackRequestHandler.php @@ -18,9 +18,9 @@ use Psr\Http\Server\RequestHandlerInterface; use ReflectionFunction; use ReflectionMethod; -use Sunrise\Http\Router\ParameterResolutionerInterface; -use Sunrise\Http\Router\ParameterResolver\PresetObjectParameterResolver; -use Sunrise\Http\Router\ResponseResolutionerInterface; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; +use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ObjectInjectionParameterResolver; +use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; use function Sunrise\Http\Router\reflect_callback; @@ -90,7 +90,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface $arguments = $this->parameterResolutioner ->withContext($request) ->withPriorityResolver( - new PresetObjectParameterResolver($request), + new ObjectInjectionParameterResolver($request), ) ->resolveParameters(...$source->getParameters()); diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index 83079a32..a3883af3 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -45,10 +45,10 @@ public function __construct(private RequestHandlerInterface $requestHandler, Mid */ public function handle(ServerRequestInterface $request): ResponseInterface { - if (! $this->isEmpty()) { - return ($clone = clone $this)->dequeue()->process($request, $clone); + if ($this->isEmpty()) { + return $this->requestHandler->handle($request); } - return $this->requestHandler->handle($request); + return ($clone = clone $this)->dequeue()->process($request, $clone); } } diff --git a/src/ResponseResolver/ExceptionResponseResolver.php b/src/ResponseResolver/ExceptionResponseResolver.php deleted file mode 100644 index bead398f..00000000 --- a/src/ResponseResolver/ExceptionResponseResolver.php +++ /dev/null @@ -1,96 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ResponseResolver; - -use Psr\Http\Message\ResponseFactoryInterface; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use ReflectionFunction; -use ReflectionMethod; -use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ServerRequest; -use Throwable; -use Whoops\Run as Whoops; - -use function class_exists; - -/** - * ExceptionResponseResolver - * - * @since 3.0.0 - * - * @link https://github.com/filp/whoops - */ -final class ExceptionResponseResolver implements ResponseResolverInterface -{ - - /** - * Constructor of the class - * - * @param ResponseFactoryInterface $responseFactory - * @param int<100, 599> $defaultResponseStatusCode - * - * @throws LogicException If the whoops package isn't installed. - */ - public function __construct( - private ResponseFactoryInterface $responseFactory, - private int $defaultResponseStatusCode = 500, - ) { - if (!class_exists(Whoops::class)) { - throw new LogicException( - 'The whoops package is required, run the `composer require filp/whoops` command to resolve it.' - ); - } - } - - /** - * @inheritDoc - */ - public function resolveResponse( - mixed $response, - ServerRequestInterface $request, - ReflectionMethod|ReflectionFunction $source, - ): ?ResponseInterface { - if (! $response instanceof Throwable) { - return null; - } - - $whoops = new Whoops(); - $whoops->allowQuit(false); - $whoops->writeToOutput(false); - - $clientPreferredMediaType = ServerRequest::from($request) - ->getClientPreferredMediaType( - MediaType::html(), - MediaType::json(), - MediaType::xml(), - ); - - if ($clientPreferredMediaType->equals(MediaType::html())) { - $whoops->pushHandler(new \Whoops\Handler\PrettyPageHandler()); - } elseif ($clientPreferredMediaType->equals(MediaType::json())) { - $whoops->pushHandler(new \Whoops\Handler\JsonResponseHandler()); - } elseif ($clientPreferredMediaType->equals(MediaType::xml())) { - $whoops->pushHandler(new \Whoops\Handler\XmlResponseHandler()); - } - - $result = $this->responseFactory->createResponse($this->defaultResponseStatusCode) - ->withHeader('Content-Type', $clientPreferredMediaType->__toString()); - - $result->getBody()->write($whoops->handleException($response)); - - return $result; - } -} diff --git a/src/ResponseResolutioner.php b/src/ResponseResolving/ResponseResolutioner.php similarity index 93% rename from src/ResponseResolutioner.php rename to src/ResponseResolving/ResponseResolutioner.php index 6313adb0..54785f9c 100644 --- a/src/ResponseResolutioner.php +++ b/src/ResponseResolving/ResponseResolutioner.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router; +namespace Sunrise\Http\Router\ResponseResolving; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; @@ -21,7 +21,7 @@ use Sunrise\Http\Router\Annotation\ResponseHeader; use Sunrise\Http\Router\Annotation\ResponseStatus; use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; +use Sunrise\Http\Router\ResponseResolving\ResponseResolver\ResponseResolverInterface; use function get_debug_type; use function sprintf; @@ -52,7 +52,7 @@ public function addResolver(ResponseResolverInterface ...$resolvers): void /** * @inheritDoc * - * @throws LogicException If the response cannot be resolved to PSR-7 response. + * @throws LogicException If the response couldn't be resolved to PSR-7 response. */ public function resolveResponse( mixed $response, @@ -71,7 +71,7 @@ public function resolveResponse( } throw new LogicException(sprintf( - 'Unable to resolve the response {%s->%s} to PSR-7 response', + 'Unable to resolve the response {%s->%s} to PSR-7 response.', self::stringifySource($source), get_debug_type($response), )); diff --git a/src/ResponseResolutionerInterface.php b/src/ResponseResolving/ResponseResolutionerInterface.php similarity index 90% rename from src/ResponseResolutionerInterface.php rename to src/ResponseResolving/ResponseResolutionerInterface.php index 78baeb1f..5061d287 100644 --- a/src/ResponseResolutionerInterface.php +++ b/src/ResponseResolving/ResponseResolutionerInterface.php @@ -11,13 +11,13 @@ declare(strict_types=1); -namespace Sunrise\Http\Router; +namespace Sunrise\Http\Router\ResponseResolving; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use ReflectionFunction; use ReflectionMethod; -use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; +use Sunrise\Http\Router\ResponseResolving\ResponseResolver\ResponseResolverInterface; /** * ResponseResolutionerInterface diff --git a/src/ResponseResolver/EmptyResponseResolver.php b/src/ResponseResolving/ResponseResolver/EmptyResponseResolver.php similarity index 85% rename from src/ResponseResolver/EmptyResponseResolver.php rename to src/ResponseResolving/ResponseResolver/EmptyResponseResolver.php index 595c8e60..a5cdf81a 100644 --- a/src/ResponseResolver/EmptyResponseResolver.php +++ b/src/ResponseResolving/ResponseResolver/EmptyResponseResolver.php @@ -11,9 +11,8 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ResponseResolver; +namespace Sunrise\Http\Router\ResponseResolving\ResponseResolver; -use Fig\Http\Message\StatusCodeInterface; use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; @@ -46,7 +45,7 @@ public function resolveResponse( ReflectionFunction|ReflectionMethod $source, ) : ?ResponseInterface { if ($response === null) { - return $this->responseFactory->createResponse(StatusCodeInterface::STATUS_NO_CONTENT); + return $this->responseFactory->createResponse(204); } return null; diff --git a/src/ResponseResolver/JsonResponseBodyResponseResolver.php b/src/ResponseResolving/ResponseResolver/JsonResponseBodyResponseResolver.php similarity index 60% rename from src/ResponseResolver/JsonResponseBodyResponseResolver.php rename to src/ResponseResolving/ResponseResolver/JsonResponseBodyResponseResolver.php index a0144b91..b11fc0e0 100644 --- a/src/ResponseResolver/JsonResponseBodyResponseResolver.php +++ b/src/ResponseResolving/ResponseResolver/JsonResponseBodyResponseResolver.php @@ -11,9 +11,8 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ResponseResolver; +namespace Sunrise\Http\Router\ResponseResolving\ResponseResolver; -use Fig\Http\Message\StatusCodeInterface; use JsonException; use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; @@ -23,16 +22,12 @@ use ReflectionMethod; use Sunrise\Http\Router\Annotation\JsonResponseBody; use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ResponseResolutioner; +use Sunrise\Http\Router\ResponseResolving\ResponseResolutioner; -use function extension_loaded; use function json_encode; use function sprintf; -use const JSON_PRESERVE_ZERO_FRACTION; use const JSON_THROW_ON_ERROR; -use const JSON_UNESCAPED_SLASHES; -use const JSON_UNESCAPED_UNICODE; /** * JsonResponseBodyResponseResolver @@ -43,26 +38,17 @@ */ final class JsonResponseBodyResponseResolver implements ResponseResolverInterface { - public const DEFAULT_JSON_ENCODING_FLAGS = JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRESERVE_ZERO_FRACTION; - public const DEFAULT_JSON_ENCODING_DEPTH = 512; /** * Constructor of the class * * @param ResponseFactoryInterface $responseFactory - * @param int|null $jsonEncodingFlags - * @param int|null $jsonEncodingDepth + * @param int $options */ public function __construct( private ResponseFactoryInterface $responseFactory, - private ?int $jsonEncodingFlags = null, - private ?int $jsonEncodingDepth = null, + private int $options = 0, ) { - if (!extension_loaded('json')) { - throw new LogicException( - 'The JSON extension is required, run the `pecl install json` command to resolve it.' - ); - } } /** @@ -81,22 +67,19 @@ public function resolveResponse( return null; } - $jsonResponseBody = $attributes[0]->newInstance(); - - $jsonEncodingFlags = $jsonResponseBody->jsonEncodingFlags ?? $this->jsonEncodingFlags ?? self::DEFAULT_JSON_ENCODING_FLAGS; - $jsonEncodingDepth = $jsonResponseBody->jsonEncodingDepth ?? $this->jsonEncodingDepth ?? self::DEFAULT_JSON_ENCODING_DEPTH; + $attribute = $attributes[0]->newInstance(); try { - $payload = json_encode($response, $jsonEncodingFlags | JSON_THROW_ON_ERROR, $jsonEncodingDepth); + $payload = json_encode($response, $this->options | $attribute->options | JSON_THROW_ON_ERROR); } catch (JsonException $e) { throw new LogicException(sprintf( 'Unable to encode a response from the source {%s} due to: %s', ResponseResolutioner::stringifySource($source), $e->getMessage(), - ), 0, $e); + ), previous: $e); } - $result = $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK) + $result = $this->responseFactory->createResponse(200) ->withHeader('Content-Type', 'application/json; charset=UTF-8'); $result->getBody()->write($payload); diff --git a/src/ResponseResolver/ResponseResolverInterface.php b/src/ResponseResolving/ResponseResolver/ResponseResolverInterface.php similarity index 93% rename from src/ResponseResolver/ResponseResolverInterface.php rename to src/ResponseResolving/ResponseResolver/ResponseResolverInterface.php index e6d28126..05597232 100644 --- a/src/ResponseResolver/ResponseResolverInterface.php +++ b/src/ResponseResolving/ResponseResolver/ResponseResolverInterface.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ResponseResolver; +namespace Sunrise\Http\Router\ResponseResolving\ResponseResolver; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; diff --git a/src/ResponseResolver/RouteResponseResolver.php b/src/ResponseResolving/ResponseResolver/RouteResponseResolver.php similarity index 93% rename from src/ResponseResolver/RouteResponseResolver.php rename to src/ResponseResolving/ResponseResolver/RouteResponseResolver.php index a0e4d0b3..1b2cfb37 100644 --- a/src/ResponseResolver/RouteResponseResolver.php +++ b/src/ResponseResolving/ResponseResolver/RouteResponseResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ResponseResolver; +namespace Sunrise\Http\Router\ResponseResolving\ResponseResolver; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; diff --git a/src/ResponseResolver/StreamResponseResolver.php b/src/ResponseResolving/ResponseResolver/StreamResponseResolver.php similarity index 87% rename from src/ResponseResolver/StreamResponseResolver.php rename to src/ResponseResolving/ResponseResolver/StreamResponseResolver.php index a014f6b3..8462d4ec 100644 --- a/src/ResponseResolver/StreamResponseResolver.php +++ b/src/ResponseResolving/ResponseResolver/StreamResponseResolver.php @@ -11,9 +11,8 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ResponseResolver; +namespace Sunrise\Http\Router\ResponseResolving\ResponseResolver; -use Fig\Http\Message\StatusCodeInterface; use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; @@ -47,7 +46,7 @@ public function resolveResponse( ReflectionFunction|ReflectionMethod $source, ) : ?ResponseInterface { if ($response instanceof StreamInterface) { - return $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK) + return $this->responseFactory->createResponse(200) ->withBody($response); } diff --git a/src/ResponseResolver/UriResponseResolver.php b/src/ResponseResolving/ResponseResolver/UriResponseResolver.php similarity index 87% rename from src/ResponseResolver/UriResponseResolver.php rename to src/ResponseResolving/ResponseResolver/UriResponseResolver.php index 9f553445..9c2dae92 100644 --- a/src/ResponseResolver/UriResponseResolver.php +++ b/src/ResponseResolving/ResponseResolver/UriResponseResolver.php @@ -11,9 +11,8 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ResponseResolver; +namespace Sunrise\Http\Router\ResponseResolving\ResponseResolver; -use Fig\Http\Message\StatusCodeInterface; use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; @@ -47,7 +46,7 @@ public function resolveResponse( ReflectionFunction|ReflectionMethod $source, ) : ?ResponseInterface { if ($response instanceof UriInterface) { - return $this->responseFactory->createResponse(StatusCodeInterface::STATUS_FOUND) + return $this->responseFactory->createResponse(302) ->withHeader('Location', $response->__toString()); } diff --git a/src/Route.php b/src/Route.php index 434be829..5663dde1 100644 --- a/src/Route.php +++ b/src/Route.php @@ -217,6 +217,14 @@ public function getAttributes(): array return $this->attributes; } + /** + * @inheritDoc + */ + public function getAttribute(string $name, mixed $default = null): mixed + { + return $this->attributes[$name] ?? $default; + } + /** * @inheritDoc */ diff --git a/src/RouteCollector.php b/src/RouteCollector.php index 2b77f784..1be0d8d8 100644 --- a/src/RouteCollector.php +++ b/src/RouteCollector.php @@ -15,8 +15,12 @@ use Fig\Http\Message\RequestMethodInterface; use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; -use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; +use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ParameterResolverInterface; +use Sunrise\Http\Router\ResponseResolving\ResponseResolutioner; +use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; +use Sunrise\Http\Router\ResponseResolving\ResponseResolver\ResponseResolverInterface; /** * RouteCollector @@ -110,7 +114,7 @@ public function addParameterResolver(ParameterResolverInterface ...$resolvers): if (!isset($this->parameterResolutioner)) { throw new LogicException( 'The route collector cannot accept parameter resolvers ' . - 'because a custom reference resolver was setted ' . + 'because a custom reference resolver was set ' . 'and a parameter resolutioner was not passed' ); } @@ -135,7 +139,7 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo if (!isset($this->responseResolutioner)) { throw new LogicException( 'The route collector cannot accept response resolvers ' . - 'because a custom reference resolver was setted ' . + 'because a custom reference resolver was set ' . 'and a response resolutioner was not passed' ); } diff --git a/src/RouteInterface.php b/src/RouteInterface.php index 83d8c861..79543e64 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -105,6 +105,16 @@ public function getMiddlewares(): array; */ public function getAttributes(): array; + /** + * Gets the route attribute by its given name + * + * @param non-empty-string $name + * @param mixed $default + * + * @return mixed + */ + public function getAttribute(string $name, mixed $default = null): mixed; + /** * Gets the route summary * diff --git a/src/Router.php b/src/Router.php index 318fe458..6ec211c3 100644 --- a/src/Router.php +++ b/src/Router.php @@ -19,19 +19,15 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Message\ServerRequestProxy; use Sunrise\Http\Router\Event\RouteEvent; -use Sunrise\Http\Router\Exception\ClientNotConsumedMediaTypeException; -use Sunrise\Http\Router\Exception\ClientNotProducedMediaTypeException; -use Sunrise\Http\Router\Exception\MethodNotAllowedException; -use Sunrise\Http\Router\Exception\PageNotFoundException; +use Sunrise\Http\Router\Exception\Http\HttpMethodNotAllowedException; +use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; +use Sunrise\Http\Router\Exception\Http\HttpUnsupportedMediaTypeException; use Sunrise\Http\Router\Loader\LoaderInterface; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use function array_keys; -use function Sunrise\Http\Router\path_build; -use function Sunrise\Http\Router\path_match; /** * Router @@ -229,17 +225,14 @@ public function generateUri(string $name, array $attributes = [], bool $strict = * * @return RouteInterface * - * @throws PageNotFoundException + * @throws HttpNotFoundException * If the request URI isn't served. * - * @throws MethodNotAllowedException + * @throws HttpMethodNotAllowedException * If the request method isn't allowed. * - * @throws ClientNotProducedMediaTypeException + * @throws HttpUnsupportedMediaTypeException * If the client not produces required media types. - * - * @throws ClientNotConsumedMediaTypeException - * If the client not consumed provided media types. */ public function match(ServerRequestInterface $request): RouteInterface { @@ -271,7 +264,7 @@ public function match(ServerRequestInterface $request): RouteInterface } if (!$request->clientProducesMediaType(...$route->getConsumesMediaTypes())) { - throw new ClientNotProducedMediaTypeException($route->getConsumesMediaTypes()); + throw new HttpUnsupportedMediaTypeException($route->getConsumesMediaTypes()); } /** @var array $attributes */ @@ -282,10 +275,10 @@ public function match(ServerRequestInterface $request): RouteInterface if (!empty($allowedMethods)) { $allowedMethods = array_keys($allowedMethods); - throw new MethodNotAllowedException($allowedMethods); + throw new HttpMethodNotAllowedException($allowedMethods); } - throw new PageNotFoundException('Page Not Found'); + throw new HttpNotFoundException(); } /** @@ -299,6 +292,8 @@ public function match(ServerRequestInterface $request): RouteInterface */ public function run(ServerRequestInterface $request): ResponseInterface { + // TODO: request event + // lazy resolving of the given request... $routing = new CallableRequestHandler( function (ServerRequestInterface $request): ResponseInterface { @@ -318,7 +313,11 @@ function (ServerRequestInterface $request): ResponseInterface { return $routing->handle($request); } - return (new QueueableRequestHandler($routing, ...$this->middlewares))->handle($request); + $response = (new QueueableRequestHandler($routing, ...$this->middlewares))->handle($request); + + // TODO: response event + + return $response; } /** diff --git a/src/ServerRequest.php b/src/ServerRequest.php index e4b81617..1c19f07d 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -17,15 +17,12 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\StreamInterface; use Psr\Http\Message\UriInterface; -use Sunrise\Http\Router\Entity\ClientRemoteAddress; use Sunrise\Http\Router\Entity\MediaType; use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Exception\LogicException; -use function preg_split; use function reset; -use function sprintf; use function usort; /** @@ -71,47 +68,6 @@ public function getOriginalRequest(): ServerRequestInterface return $this->request; } - /** - * Gets the client's remote address - * - * @param array $proxyChain - * - * @return ClientRemoteAddress - * - * @template TKey as non-empty-string Proxy address; e.g., 127.0.0.1 - * @template TValue as non-empty-string Trusted header; e.g., X-Forwarded-For, X-Real-IP, etc. - * - * @link https://www.rfc-editor.org/rfc/rfc3875#section-4.1.8 - * @link https://www.rfc-editor.org/rfc/rfc7239.html#section-5.2 - */ - public function getClientRemoteAddress(array $proxyChain = []): ClientRemoteAddress - { - $serverParams = $this->request->getServerParams(); - $clientRemoteAddress = $serverParams['REMOTE_ADDR'] ?? '::1'; - $clientRemoteAddressChain = [$clientRemoteAddress]; - - while (isset($proxyChain[$clientRemoteAddressChain[0]])) { - $trustedHeader = $proxyChain[$clientRemoteAddressChain[0]]; - unset($proxyChain[$clientRemoteAddressChain[0]]); - - $header = $this->request->getHeaderLine($trustedHeader); - $addresses = preg_split('/\s*,\s*/', $header, flags: \PREG_SPLIT_NO_EMPTY); - if ($addresses === []) { - break; - } - - $clientRemoteAddressChain = [...$addresses, ...$clientRemoteAddressChain]; - } - - $address = $clientRemoteAddressChain[0]; - unset($clientRemoteAddressChain[0]); - - /** @var list $proxies */ - $proxies = [...$clientRemoteAddressChain]; - - return new ClientRemoteAddress($address, $proxies); - } - /** * Gets a media type that the client produced * @@ -124,14 +80,14 @@ public function getClientProducedMediaType(): ?MediaType try { return parse_header_with_media_type($header)->current(); } catch (InvalidArgumentException $e) { - throw new HttpBadRequestException(sprintf('The Content-Type header is invalid: %s', $e->getMessage())); + throw new HttpBadRequestException('The Content-Type header is invalid.', previous: $e); } } /** * Gets media types that the client consumes * - * @return Generator + * @return Generator */ public function getClientConsumesMediaTypes(): Generator { @@ -140,10 +96,37 @@ public function getClientConsumesMediaTypes(): Generator try { yield from parse_header_with_media_type($header); } catch (InvalidArgumentException $e) { - throw new HttpBadRequestException(sprintf('The Accept header is invalid: %s', $e->getMessage())); + throw new HttpBadRequestException('The Accept header is invalid', previous: $e); } } + /** + * Checks if the client produces one of the given media types + * + * @param MediaType ...$serverConsumesMediaTypes + * + * @return bool + */ + public function clientProducesMediaType(MediaType ...$serverConsumesMediaTypes): bool + { + if ($serverConsumesMediaTypes === []) { + return true; + } + + $clientProducedMediaType = $this->getClientProducedMediaType(); + if ($clientProducedMediaType === null) { + return false; + } + + foreach ($serverConsumesMediaTypes as $serverConsumesMediaType) { + if ($clientProducedMediaType->equals($serverConsumesMediaType)) { + return true; + } + } + + return false; + } + /** * Gets the client's preferred media type * @@ -183,33 +166,6 @@ public function getClientPreferredMediaType(MediaType ...$serverProducesMediaTyp return reset($serverProducesMediaTypes); } - /** - * Checks if the client produces one of the given media types - * - * @param MediaType ...$serverConsumesMediaTypes - * - * @return bool - */ - public function clientProducesMediaType(MediaType ...$serverConsumesMediaTypes): bool - { - if ($serverConsumesMediaTypes === []) { - return true; - } - - $clientProducedMediaType = $this->getClientProducedMediaType(); - if ($clientProducedMediaType === null) { - return false; - } - - foreach ($serverConsumesMediaTypes as $serverConsumesMediaType) { - if ($clientProducedMediaType->equals($serverConsumesMediaType)) { - return true; - } - } - - return false; - } - /** * @inheritDoc */ diff --git a/src/TypeConversion/TypeConversioner.php b/src/TypeConversion/TypeConversioner.php new file mode 100644 index 00000000..8c559a8d --- /dev/null +++ b/src/TypeConversion/TypeConversioner.php @@ -0,0 +1,64 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\TypeConversion; + +use ReflectionType; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\TypeConversion\TypeConverter\TypeConverterInterface; + +use function get_debug_type; +use function sprintf; + +/** + * @since 3.0.0 + */ +final class TypeConversioner implements TypeConversionerInterface +{ + + /** + * @var list + */ + private array $converters = []; + + /** + * @inheritDoc + */ + public function addConverter(TypeConverterInterface ...$converters): void + { + foreach ($converters as $converter) { + $this->converters[] = $converter; + } + } + + /** + * @inheritDoc + * + * @throws LogicException If the type isn't supported or cannot be applied to the value. + */ + public function castValue(mixed $value, ReflectionType $type): mixed + { + foreach ($this->converters as $converter) { + $result = $converter->castValue($value, $type); + if ($result->valid()) { + return $result->current(); + } + } + + throw new LogicException(sprintf( + 'Unable to convert the value {%s} to the type %s.', + get_debug_type($value), + (string) $type, + )); + } +} diff --git a/src/TypeConversion/TypeConversionerInterface.php b/src/TypeConversion/TypeConversionerInterface.php new file mode 100644 index 00000000..095f0fcd --- /dev/null +++ b/src/TypeConversion/TypeConversionerInterface.php @@ -0,0 +1,46 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\TypeConversion; + +use LogicException; +use ReflectionType; +use Sunrise\Http\Router\TypeConversion\TypeConverter\TypeConverterInterface; + +/** + * @since 3.0.0 + */ +interface TypeConversionerInterface +{ + + /** + * Adds the given type converter(s) to the conversioner + * + * @param TypeConverterInterface ...$converters + * + * @return void + */ + public function addConverter(TypeConverterInterface ...$converters): void; + + /** + * Trying to cast the given value to the given type + * + * @param mixed $value + * @param ReflectionType $type + * + * @return mixed + * + * @throws LogicException If the type isn't supported. + */ + public function castValue(mixed $value, ReflectionType $type): mixed; +} diff --git a/src/TypeConversion/TypeConverter/BackedEnumTypeConverter.php b/src/TypeConversion/TypeConverter/BackedEnumTypeConverter.php new file mode 100644 index 00000000..a762b1d5 --- /dev/null +++ b/src/TypeConversion/TypeConverter/BackedEnumTypeConverter.php @@ -0,0 +1,122 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\TypeConversion\TypeConverter; + +use BackedEnum; +use Generator; +use ReflectionEnum; +use ReflectionNamedType; +use ReflectionType; +use Sunrise\Http\Router\Exception\InvalidArgumentException; +use ValueError; + +use function filter_var; +use function is_int; +use function is_string; +use function is_subclass_of; +use function join; +use function sprintf; +use function trim; + +use const FILTER_NULL_ON_FAILURE; +use const FILTER_VALIDATE_INT; +use const PHP_VERSION_ID; + +/** + * @since 3.0.0 + */ +final class BackedEnumTypeConverter implements TypeConverterInterface +{ + + /** + * @inheritDoc + * + * @throws InvalidArgumentException If the value isn't valid. + */ + public function castValue(mixed $value, ReflectionType $type): Generator + { + if (PHP_VERSION_ID < 80100) { + return; + } + + if (! $type instanceof ReflectionNamedType) { + return; + } + + $enumName = $type->getName(); + + if (!is_subclass_of($enumName, BackedEnum::class)) { + return; + } + + /** @var ReflectionNamedType $enumType */ + $enumType = (new ReflectionEnum($enumName))->getBackingType(); + + /** @var 'int'|'string' $enumTypeName */ + $enumTypeName = $enumType->getName(); + + if (is_string($value)) { + // As part of the support for HTML forms and other untyped data sources, + // an instance of BackedEnum should not be created from an empty string, + // therefore, such values should be treated as NULL. + if (trim($value) === '') { + // phpcs:ignore Generic.Files.LineLength + return $type->allowsNull() ? yield : throw new InvalidArgumentException('This value must not be empty.'); + } + + if ($enumTypeName === 'int') { + // https://github.com/php/php-src/blob/b7d90f09d4a1688f2692f2fa9067d0a07f78cc7d/ext/filter/logical_filters.c#L94 + // https://github.com/php/php-src/blob/b7d90f09d4a1688f2692f2fa9067d0a07f78cc7d/ext/filter/logical_filters.c#L197 + $value = filter_var($value, FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE); + } + } + + if ($enumTypeName === 'int' && !is_int($value)) { + throw new InvalidArgumentException('This value must be of type integer.'); + } + if ($enumTypeName === 'string' && !is_string($value)) { + throw new InvalidArgumentException('This value must be of type string.'); + } + + /** @var int|string $value */ + + try { + yield $enumName::from($value); + } catch (ValueError $e) { + $choices = [...$this->getBackedEnumChoices($enumName)]; + + throw new InvalidArgumentException(sprintf( + 'This value must be one of: %s.', + join(', ', $choices) + ), previous: $e); + } + } + + /** + * Gets choices from the given backed enum + * + * @param class-string $enumName + * + * @return Generator + */ + private function getBackedEnumChoices(string $enumName): Generator + { + /** @var list $cases */ + $cases = $enumName::cases(); + + foreach ($cases as $case) { + yield $case->value; + } + } +} diff --git a/src/TypeConversion/TypeConverter/BoolTypeConverter.php b/src/TypeConversion/TypeConverter/BoolTypeConverter.php new file mode 100644 index 00000000..f13f5579 --- /dev/null +++ b/src/TypeConversion/TypeConverter/BoolTypeConverter.php @@ -0,0 +1,65 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\TypeConversion\TypeConverter; + +use Generator; +use ReflectionNamedType; +use ReflectionType; +use Sunrise\Http\Router\Exception\InvalidArgumentException; + +use function filter_var; +use function is_bool; +use function is_string; +use function trim; + +use const FILTER_NULL_ON_FAILURE; +use const FILTER_VALIDATE_BOOL; + +/** + * @since 3.0.0 + */ +final class BoolTypeConverter implements TypeConverterInterface +{ + + /** + * @inheritDoc + * + * @throws InvalidArgumentException If the value isn't valid. + */ + public function castValue(mixed $value, ReflectionType $type): Generator + { + if (! $type instanceof ReflectionNamedType || $type->getName() !== 'bool') { + return; + } + + if (is_string($value)) { + // As part of the support for HTML forms and other untyped data sources, + // an empty string should not be cast to a boolean type, + // therefore, such values should be treated as NULL. + if (trim($value) === '') { + // phpcs:ignore Generic.Files.LineLength + return $type->allowsNull() ? yield : throw new InvalidArgumentException('This value must not be empty.'); + } + + // https://github.com/php/php-src/blob/b7d90f09d4a1688f2692f2fa9067d0a07f78cc7d/ext/filter/logical_filters.c#L273 + $value = filter_var($value, FILTER_VALIDATE_BOOL, FILTER_NULL_ON_FAILURE); + } + + if (!is_bool($value)) { + throw new InvalidArgumentException('This value must be of type boolean.'); + } + + yield $value; + } +} diff --git a/src/TypeConversion/TypeConverter/DateTimeTypeConverter.php b/src/TypeConversion/TypeConverter/DateTimeTypeConverter.php new file mode 100644 index 00000000..b849c1ed --- /dev/null +++ b/src/TypeConversion/TypeConverter/DateTimeTypeConverter.php @@ -0,0 +1,83 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\TypeConversion\TypeConverter; + +use DateTimeImmutable; +use DateTimeInterface; +use Exception; +use Generator; +use ReflectionNamedType; +use ReflectionType; +use Sunrise\Http\Router\Exception\InvalidArgumentException; + +use function ctype_digit; +use function is_a; +use function is_int; +use function is_string; +use function trim; + +/** + * @since 3.0.0 + */ +final class DateTimeTypeConverter implements TypeConverterInterface +{ + + /** + * @inheritDoc + * + * @throws InvalidArgumentException If the value isn't valid. + */ + public function castValue(mixed $value, ReflectionType $type): Generator + { + if (! $type instanceof ReflectionNamedType) { + return; + } + + $className = $type->getName(); + + if (!is_a($className, DateTimeInterface::class, true)) { + return; + } + + if (is_int($value)) { + $value = '@' . $value; + } + + if (!is_string($value)) { + throw new InvalidArgumentException('This value must be of a string or an integer type.'); + } + + // As part of the support for HTML forms and other untyped data sources, + // an instance of DateTime* should not be created from an empty string, + // therefore, such values should be treated as NULL. + if (trim($value) === '') { + return $type->allowsNull() ? yield : throw new InvalidArgumentException('This value must not be empty.'); + } + + if (ctype_digit($value)) { + $value = '@' . $value; + } + + // It is recommended to use only DateTimeImmutable... + if ($className === DateTimeInterface::class) { + $className = DateTimeImmutable::class; + } + + try { + yield new $className($value); + } catch (Exception $e) { + throw new InvalidArgumentException('This value is not a valid timestamp.', previous: $e); + } + } +} diff --git a/src/TypeConversion/TypeConverter/FloatTypeConverter.php b/src/TypeConversion/TypeConverter/FloatTypeConverter.php new file mode 100644 index 00000000..3ad75f68 --- /dev/null +++ b/src/TypeConversion/TypeConverter/FloatTypeConverter.php @@ -0,0 +1,70 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\TypeConversion\TypeConverter; + +use Generator; +use ReflectionNamedType; +use ReflectionType; +use Sunrise\Http\Router\Exception\InvalidArgumentException; + +use function filter_var; +use function is_float; +use function is_int; +use function is_string; +use function trim; + +use const FILTER_NULL_ON_FAILURE; +use const FILTER_VALIDATE_FLOAT; + +/** + * @since 3.0.0 + */ +final class FloatTypeConverter implements TypeConverterInterface +{ + + /** + * @inheritDoc + * + * @throws InvalidArgumentException If the value isn't valid. + */ + public function castValue(mixed $value, ReflectionType $type): Generator + { + if (! $type instanceof ReflectionNamedType || $type->getName() !== 'float') { + return; + } + + if (is_int($value)) { + return yield $value + .0; + } + + if (is_string($value)) { + // As part of the support for HTML forms and other untyped data sources, + // an empty string should not be cast to a number type, + // therefore, such values should be treated as NULL. + if (trim($value) === '') { + // phpcs:ignore Generic.Files.LineLength + return $type->allowsNull() ? yield : throw new InvalidArgumentException('This value must not be empty.'); + } + + // https://github.com/php/php-src/blob/b7d90f09d4a1688f2692f2fa9067d0a07f78cc7d/ext/filter/logical_filters.c#L342 + $value = filter_var($value, FILTER_VALIDATE_FLOAT, FILTER_NULL_ON_FAILURE); + } + + if (!is_float($value)) { + throw new InvalidArgumentException('This value must be of type number.'); + } + + yield $value; + } +} diff --git a/src/TypeConversion/TypeConverter/IntTypeConverter.php b/src/TypeConversion/TypeConverter/IntTypeConverter.php new file mode 100644 index 00000000..9c266013 --- /dev/null +++ b/src/TypeConversion/TypeConverter/IntTypeConverter.php @@ -0,0 +1,66 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\TypeConversion\TypeConverter; + +use Generator; +use ReflectionNamedType; +use ReflectionType; +use Sunrise\Http\Router\Exception\InvalidArgumentException; + +use function filter_var; +use function is_int; +use function is_string; +use function trim; + +use const FILTER_NULL_ON_FAILURE; +use const FILTER_VALIDATE_INT; + +/** + * @since 3.0.0 + */ +final class IntTypeConverter implements TypeConverterInterface +{ + + /** + * @inheritDoc + * + * @throws InvalidArgumentException If the value isn't valid. + */ + public function castValue(mixed $value, ReflectionType $type): Generator + { + if (! $type instanceof ReflectionNamedType || $type->getName() !== 'int') { + return; + } + + if (is_string($value)) { + // As part of the support for HTML forms and other untyped data sources, + // an empty string should not be cast to an integer type, + // therefore, such values should be treated as NULL. + if (trim($value) === '') { + // phpcs:ignore Generic.Files.LineLength + return $type->allowsNull() ? yield : throw new InvalidArgumentException('This value must not be empty.'); + } + + // https://github.com/php/php-src/blob/b7d90f09d4a1688f2692f2fa9067d0a07f78cc7d/ext/filter/logical_filters.c#L94 + // https://github.com/php/php-src/blob/b7d90f09d4a1688f2692f2fa9067d0a07f78cc7d/ext/filter/logical_filters.c#L197 + $value = filter_var($value, FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE); + } + + if (!is_int($value)) { + throw new InvalidArgumentException('This value must be of type integer.'); + } + + yield $value; + } +} diff --git a/src/TypeConversion/TypeConverter/StringTypeConverter.php b/src/TypeConversion/TypeConverter/StringTypeConverter.php new file mode 100644 index 00000000..87bc1b9b --- /dev/null +++ b/src/TypeConversion/TypeConverter/StringTypeConverter.php @@ -0,0 +1,46 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\TypeConversion\TypeConverter; + +use Generator; +use ReflectionNamedType; +use ReflectionType; +use Sunrise\Http\Router\Exception\InvalidArgumentException; + +use function is_string; + +/** + * @since 3.0.0 + */ +final class StringTypeConverter implements TypeConverterInterface +{ + + /** + * @inheritDoc + * + * @throws InvalidArgumentException If the value isn't valid. + */ + public function castValue(mixed $value, ReflectionType $type): Generator + { + if (! $type instanceof ReflectionNamedType || $type->getName() !== 'string') { + return; + } + + if (!is_string($value)) { + throw new InvalidArgumentException('This value must be of type string.'); + } + + yield $value; + } +} diff --git a/src/TypeConversion/TypeConverter/TypeConverterInterface.php b/src/TypeConversion/TypeConverter/TypeConverterInterface.php new file mode 100644 index 00000000..77b2ca53 --- /dev/null +++ b/src/TypeConversion/TypeConverter/TypeConverterInterface.php @@ -0,0 +1,37 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\TypeConversion\TypeConverter; + +use Generator; +use InvalidArgumentException; +use ReflectionType; + +/** + * @since 3.0.0 + */ +interface TypeConverterInterface +{ + + /** + * Tries to cast the given value to the given type + * + * @param mixed $value + * @param ReflectionType $type + * + * @return Generator + * + * @throws InvalidArgumentException If the value isn't valid. + */ + public function castValue(mixed $value, ReflectionType $type): Generator; +} From 4739c77c106b1ac888f77cc1c85c5b62d00dc359 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 27 Aug 2023 20:03:15 +0200 Subject: [PATCH 082/180] v3 --- .../views/{error.phtml => error.html.php} | 4 +- src/Annotation/Commit.php | 33 ++++ src/Annotation/{Host.php => ProvideRoute.php} | 10 +- src/Annotation/RequestCookie.php | 33 ++++ src/Annotation/RequestEntity.php | 40 +++++ src/Annotation/Route.php | 2 - src/Command/RouteListCommand.php | 2 - src/Event/AbstractEvent.php | 48 ++++++ src/Event/ErrorEvent.php | 2 +- src/Event/ResponseResolvedEvent.php | 76 +++++++++ src/Event/RouteEvent.php | 8 +- src/EventListener/CommitEventListener.php | 75 +++++++++ src/EventListener/WhoopsEventListener.php | 99 ++++++++++++ .../Http/HttpInternalServerErrorException.php | 17 +- src/Helper/ViewLoader.php | 72 +++++++++ src/HostTable.php | 80 ---------- src/Loader/DescriptorLoader.php | 8 +- src/Middleware/CallbackMiddleware.php | 16 +- .../CrossOriginResourceSharingMiddleware.php | 95 ++++++++++++ src/Middleware/ErrorHandlingMiddleware.php | 32 +--- .../PathVariableParameterResolver.php | 9 +- .../ProvideRouteParameterResolver.php | 71 +++++++++ .../RequestCookieParameterResolver.php | 103 ++++++++++++ .../RequestEntityParameterResolver.php | 146 ++++++++++++++++++ .../RequestHeaderParameterResolver.php | 2 + src/ReferenceResolver.php | 4 +- src/RequestHandler/CallbackRequestHandler.php | 16 +- .../ResponseResolutioner.php | 39 +++-- .../ResponseResolutionerInterface.php | 8 +- .../EmptyResponseResolver.php | 4 +- .../JsonResponseBodyResponseResolver.php | 4 +- .../ResponseResolverInterface.php | 8 +- .../RouteResponseResolver.php | 4 +- .../StreamResponseResolver.php | 4 +- .../ResponseResolver/UriResponseResolver.php | 4 +- src/Route.php | 48 +----- src/RouteCollection.php | 54 +------ src/RouteCollectionInterface.php | 25 --- src/RouteInterface.php | 32 ---- src/Router.php | 56 +++---- src/RouterBuilder.php | 23 --- src/TypeConversion/TypeConversioner.php | 2 +- .../TypeConverter/BackedEnumTypeConverter.php | 4 +- .../TypeConverter/DateTimeTypeConverter.php | 2 +- tests/Exception/BadRequestExceptionTest.php | 78 ---------- tests/Exception/ExceptionTest.php | 96 ------------ .../InvalidArgumentExceptionTest.php | 24 --- .../InvalidAttributeValueExceptionTest.php | 24 --- .../InvalidLoaderResourceExceptionTest.php | 24 --- tests/Exception/InvalidPathExceptionTest.php | 24 --- .../MethodNotAllowedExceptionTest.php | 100 ------------ .../MissingAttributeValueExceptionTest.php | 24 --- tests/Exception/PageNotFoundExceptionTest.php | 24 --- .../Exception/RouteNotFoundExceptionTest.php | 24 --- .../UnresolvableReferenceExceptionTest.php | 24 --- .../UnsupportedMediaTypeExceptionTest.php | 103 ------------ 56 files changed, 1012 insertions(+), 981 deletions(-) rename resources/views/{error.phtml => error.html.php} (95%) create mode 100644 src/Annotation/Commit.php rename src/Annotation/{Host.php => ProvideRoute.php} (71%) create mode 100644 src/Annotation/RequestCookie.php create mode 100644 src/Annotation/RequestEntity.php create mode 100644 src/Event/AbstractEvent.php create mode 100644 src/Event/ResponseResolvedEvent.php create mode 100644 src/EventListener/CommitEventListener.php create mode 100644 src/EventListener/WhoopsEventListener.php create mode 100644 src/Helper/ViewLoader.php delete mode 100644 src/HostTable.php create mode 100644 src/Middleware/CrossOriginResourceSharingMiddleware.php create mode 100644 src/ParameterResolving/ParameterResolver/ProvideRouteParameterResolver.php create mode 100644 src/ParameterResolving/ParameterResolver/RequestCookieParameterResolver.php create mode 100644 src/ParameterResolving/ParameterResolver/RequestEntityParameterResolver.php delete mode 100644 tests/Exception/BadRequestExceptionTest.php delete mode 100644 tests/Exception/ExceptionTest.php delete mode 100644 tests/Exception/InvalidArgumentExceptionTest.php delete mode 100644 tests/Exception/InvalidAttributeValueExceptionTest.php delete mode 100644 tests/Exception/InvalidLoaderResourceExceptionTest.php delete mode 100644 tests/Exception/InvalidPathExceptionTest.php delete mode 100644 tests/Exception/MethodNotAllowedExceptionTest.php delete mode 100644 tests/Exception/MissingAttributeValueExceptionTest.php delete mode 100644 tests/Exception/PageNotFoundExceptionTest.php delete mode 100644 tests/Exception/RouteNotFoundExceptionTest.php delete mode 100644 tests/Exception/UnresolvableReferenceExceptionTest.php delete mode 100644 tests/Exception/UnsupportedMediaTypeExceptionTest.php diff --git a/resources/views/error.phtml b/resources/views/error.html.php similarity index 95% rename from resources/views/error.phtml rename to resources/views/error.html.php index 9e604094..2d436886 100644 --- a/resources/views/error.phtml +++ b/resources/views/error.html.php @@ -68,10 +68,10 @@

getReasonPhrase() ?>

-

getMessage() ?>

+

getMessage()) ?>

getViolations() as $violation): ?> -

source ?> message ?>

+

source ?> message) ?>

diff --git a/src/Annotation/Commit.php b/src/Annotation/Commit.php new file mode 100644 index 00000000..e4ca5892 --- /dev/null +++ b/src/Annotation/Commit.php @@ -0,0 +1,33 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] +final class Commit +{ + + /** + * Constructor of the class + * + * @param non-empty-string|null $em + */ + public function __construct(public ?string $em = null) + { + } +} diff --git a/src/Annotation/Host.php b/src/Annotation/ProvideRoute.php similarity index 71% rename from src/Annotation/Host.php rename to src/Annotation/ProvideRoute.php index 95f0a5c0..92def8cd 100644 --- a/src/Annotation/Host.php +++ b/src/Annotation/ProvideRoute.php @@ -16,18 +16,18 @@ use Attribute; /** - * @since 2.11.0 + * @since 3.0.0 */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] -final class Host +#[Attribute(Attribute::TARGET_PARAMETER)] +final class ProvideRoute { /** * Constructor of the class * - * @param non-empty-string $value + * @param non-empty-string $name */ - public function __construct(public string $value) + public function __construct(public string $name) { } } diff --git a/src/Annotation/RequestCookie.php b/src/Annotation/RequestCookie.php new file mode 100644 index 00000000..77a38dca --- /dev/null +++ b/src/Annotation/RequestCookie.php @@ -0,0 +1,33 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_PARAMETER)] +final class RequestCookie +{ + + /** + * Constructor of the class + * + * @param non-empty-string $name + */ + public function __construct(public string $name) + { + } +} diff --git a/src/Annotation/RequestEntity.php b/src/Annotation/RequestEntity.php new file mode 100644 index 00000000..44d9aec8 --- /dev/null +++ b/src/Annotation/RequestEntity.php @@ -0,0 +1,40 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_PARAMETER)] +final class RequestEntity +{ + + /** + * Constructor of the class + * + * @param non-empty-string|null $em + * @param non-empty-string|null $findBy + * @param non-empty-string|null $pathVariable + * @param array $criteria An entity's additional criteria. + */ + public function __construct( + public ?string $em = null, + public ?string $findBy = null, + public ?string $pathVariable = null, + public array $criteria = [], + ) { + } +} diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index 9bec9b38..aecce6ff 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -52,7 +52,6 @@ final class Route implements RequestMethodInterface * Constructor of the class * * @param non-empty-string $name The route's name - * @param non-empty-string|null $host The route's host * @param non-empty-string $path The route's path * @param non-empty-string|null $method The route's method * @param list $methods The route's methods @@ -65,7 +64,6 @@ final class Route implements RequestMethodInterface */ public function __construct( public string $name, - public ?string $host = null, public string $path = '/', ?string $method = null, public array $methods = [], diff --git a/src/Command/RouteListCommand.php b/src/Command/RouteListCommand.php index fb4b9a63..91eb5395 100644 --- a/src/Command/RouteListCommand.php +++ b/src/Command/RouteListCommand.php @@ -84,7 +84,6 @@ final protected function execute(InputInterface $input, OutputInterface $output) $table->setHeaders([ 'Name', - 'Host', 'Path', 'Verb', ]); @@ -92,7 +91,6 @@ final protected function execute(InputInterface $input, OutputInterface $output) foreach ($this->getRouter()->getRoutes()->all() as $route) { $table->addRow([ $route->getName(), - $route->getHost() ?? '*', path_plain($route->getPath()), \join(', ', $route->getMethods()), ]); diff --git a/src/Event/AbstractEvent.php b/src/Event/AbstractEvent.php new file mode 100644 index 00000000..24f5f4ad --- /dev/null +++ b/src/Event/AbstractEvent.php @@ -0,0 +1,48 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Event; + +use Psr\EventDispatcher\StoppableEventInterface; + +/** + * @since 3.0.0 + */ +abstract class AbstractEvent implements StoppableEventInterface +{ + + /** + * Indicates that the event's handling must be interrupted + * + * @var bool + */ + private bool $isPropagationStopped = false; + + /** + * @inheritDoc + */ + final public function isPropagationStopped(): bool + { + return $this->isPropagationStopped; + } + + /** + * Interrupts the event's handling + * + * @return void + */ + final public function stopPropagation(): void + { + $this->isPropagationStopped = true; + } +} diff --git a/src/Event/ErrorEvent.php b/src/Event/ErrorEvent.php index cbd9a478..2c4a4abe 100644 --- a/src/Event/ErrorEvent.php +++ b/src/Event/ErrorEvent.php @@ -22,7 +22,7 @@ * * @since 3.0.0 */ -final class ErrorEvent +final class ErrorEvent extends AbstractEvent { /** diff --git a/src/Event/ResponseResolvedEvent.php b/src/Event/ResponseResolvedEvent.php new file mode 100644 index 00000000..7387fd2e --- /dev/null +++ b/src/Event/ResponseResolvedEvent.php @@ -0,0 +1,76 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Event; + +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionFunction; +use ReflectionMethod; + +/** + * ResponseResolvedEvent + * + * @since 3.0.0 + */ +final class ResponseResolvedEvent extends AbstractEvent +{ + + /** + * Constructor of the class + * + * @param ReflectionFunction|ReflectionMethod $source + * @param ServerRequestInterface $request + * @param ResponseInterface $response + */ + public function __construct( + private ReflectionFunction|ReflectionMethod $source, + private ServerRequestInterface $request, + private ResponseInterface $response, + ) { + } + + /** + * @return ReflectionMethod|ReflectionFunction + */ + public function getSource(): ReflectionMethod|ReflectionFunction + { + return $this->source; + } + + /** + * @return ServerRequestInterface + */ + public function getRequest(): ServerRequestInterface + { + return $this->request; + } + + /** + * @return ResponseInterface + */ + public function getResponse(): ResponseInterface + { + return $this->response; + } + + /** + * @param ResponseInterface $response + * + * @return void + */ + public function setResponse(ResponseInterface $response): void + { + $this->response = $response; + } +} diff --git a/src/Event/RouteEvent.php b/src/Event/RouteEvent.php index 45c9b9c0..0669de54 100644 --- a/src/Event/RouteEvent.php +++ b/src/Event/RouteEvent.php @@ -21,7 +21,7 @@ * * @since 2.13.0 */ -final class RouteEvent +final class RouteEvent extends AbstractEvent { /** @@ -30,8 +30,10 @@ final class RouteEvent * @param RouteInterface $route * @param ServerRequestInterface $request */ - public function __construct(private RouteInterface $route, private ServerRequestInterface $request) - { + public function __construct( + private RouteInterface $route, + private ServerRequestInterface $request, + ) { } /** diff --git a/src/EventListener/CommitEventListener.php b/src/EventListener/CommitEventListener.php new file mode 100644 index 00000000..4c890c9f --- /dev/null +++ b/src/EventListener/CommitEventListener.php @@ -0,0 +1,75 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\EventListener; + +use Doctrine\Persistence\ManagerRegistry as EntityManagerRegistryInterface; +use ReflectionAttribute; +use Sunrise\Http\Router\Annotation\Commit; +use Sunrise\Http\Router\Event\ResponseResolvedEvent; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ResponseResolving\ResponseResolutioner; + +use function sprintf; + +/** + * @since 3.0.0 + */ +final class CommitEventListener +{ + + /** + * Constructor of the class + * + * @param EntityManagerRegistryInterface $entityManagerRegistry + */ + public function __construct(private EntityManagerRegistryInterface $entityManagerRegistry) + { + } + + /** + * Handles the given event + * + * @param ResponseResolvedEvent $event + * + * @return ResponseResolvedEvent + * + * @throws LogicException + */ + public function __invoke(ResponseResolvedEvent $event): ResponseResolvedEvent + { + $source = $event->getSource(); + + /** @var list> $attributes */ + $attributes = $source->getAttributes(Commit::class); + if ($attributes === []) { + return $event; + } + + $commit = $attributes[0]->newInstance(); + + $entityManagerNames = $this->entityManagerRegistry->getManagerNames(); + if (isset($commit->em) && !isset($entityManagerNames[$commit->em])) { + throw new LogicException(sprintf( + 'The #[Commit] attribute cannot be applied to the source {%s}, ' . + 'because the specified entity manager "%s" does not exist.', + ResponseResolutioner::stringifySource($source), + $commit->em, + )); + } + + $this->entityManagerRegistry->getManager($commit->em)->flush(); + + return $event; + } +} diff --git a/src/EventListener/WhoopsEventListener.php b/src/EventListener/WhoopsEventListener.php new file mode 100644 index 00000000..bb8d53b1 --- /dev/null +++ b/src/EventListener/WhoopsEventListener.php @@ -0,0 +1,99 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\EventListener; + +use Psr\Http\Message\ResponseFactoryInterface; +use Sunrise\Http\Router\Entity\MediaType; +use Sunrise\Http\Router\Event\ErrorEvent; +use Sunrise\Http\Router\Exception\Http\HttpInternalServerErrorException; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ServerRequest; +use Whoops\Handler\JsonResponseHandler; +use Whoops\Handler\PrettyPageHandler; +use Whoops\Handler\XmlResponseHandler; +use Whoops\Run as Whoops; + +use function class_exists; + +/** + * Renders fatal errors using the Whoops package + * + * @link https://github.com/filp/whoops + * + * @since 3.0.0 + */ +final class WhoopsEventListener +{ + + /** + * Constructor of the class + * + * @param ResponseFactoryInterface $responseFactory + * + * @throws LogicException If the filp/whoops package wasn't installed. + */ + public function __construct(private ResponseFactoryInterface $responseFactory) + { + if (!class_exists(Whoops::class)) { + throw new LogicException( + 'The filp/whoops package is required, run the `composer require filp/whoops` to resolve it.' + ); + } + } + + /** + * Handles the given event + * + * @param ErrorEvent $event + * + * @return ErrorEvent + */ + public function __invoke(ErrorEvent $event): ErrorEvent + { + $error = $event->getError(); + + if (! $error instanceof HttpInternalServerErrorException) { + return $event; + } + + $clientPreferredMediaType = ServerRequest::from($event->getRequest()) + ->getClientPreferredMediaType( + MediaType::html(), + MediaType::json(), + MediaType::xml(), + ); + + $whoops = new Whoops(); + $whoops->allowQuit(false); + $whoops->writeToOutput(false); + + if ($clientPreferredMediaType->equals(MediaType::html())) { + $whoops->pushHandler(new PrettyPageHandler); + } elseif ($clientPreferredMediaType->equals(MediaType::json())) { + $whoops->pushHandler(new JsonResponseHandler()); + } elseif ($clientPreferredMediaType->equals(MediaType::xml())) { + $whoops->pushHandler(new XmlResponseHandler()); + } + + $response = $this->responseFactory->createResponse(500) + ->withHeader('Content-Type', $clientPreferredMediaType->__toString()); + + $response->getBody()->write($whoops->handleException($error->getError())); + + $event->setResponse($response); + $event->stopPropagation(); + + return $event; + } +} diff --git a/src/Exception/Http/HttpInternalServerErrorException.php b/src/Exception/Http/HttpInternalServerErrorException.php index 0bc04a19..4fe321c5 100644 --- a/src/Exception/Http/HttpInternalServerErrorException.php +++ b/src/Exception/Http/HttpInternalServerErrorException.php @@ -29,16 +29,27 @@ class HttpInternalServerErrorException extends HttpException /** * Constructor of the class * + * @param Throwable $error * @param non-empty-string|null $message * @param int $code - * @param Throwable|null $previous */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) + public function __construct(Throwable $error, ?string $message = null, int $code = 0) { $message ??= 'The server encountered an unexpected condition that prevented it from fulfilling the request.'; - parent::__construct(self::STATUS_INTERNAL_SERVER_ERROR, $message, $code, $previous); + parent::__construct(self::STATUS_INTERNAL_SERVER_ERROR, $message, $code, $error); $this->setReasonPhrase('Internal Server Error'); } + + /** + * Gets the error + * + * @return Throwable + */ + public function getError(): Throwable + { + /** @var Throwable */ + return $this->getPrevious(); + } } diff --git a/src/Helper/ViewLoader.php b/src/Helper/ViewLoader.php new file mode 100644 index 00000000..8d9a5de8 --- /dev/null +++ b/src/Helper/ViewLoader.php @@ -0,0 +1,72 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Helper; + +use InvalidArgumentException; +use Throwable; + +use function ob_end_clean; +use function ob_get_clean; +use function ob_get_level; +use function ob_start; +use function realpath; +use function sprintf; + +/** + * Internal view loader + * + * @internal + */ +final class ViewLoader +{ + + /** + * Loads a view by the given filename + * + * @param non-empty-string $filename + * @param object $scope + * + * @return string + * + * @throws InvalidArgumentException If the view doesn't exist or is inaccessible. + */ + public static function loadView(string $filename, object $scope): string + { + $pathname = realpath(__DIR__ . '/../../resources/views/' . $filename); + + if ($pathname === false) { + throw new InvalidArgumentException(sprintf( + 'The view {%s} does not exist or is inaccessible.', + $filename, + )); + } + + try { + ob_start(); + + (function (string $pathname): void { + /** @psalm-suppress UnresolvableInclude */ + include $pathname; + })->call($scope, $pathname); + + return ob_get_clean(); + } catch (Throwable $e) { + while (ob_get_level()) { + ob_end_clean(); + } + + throw $e; + } + } +} diff --git a/src/HostTable.php b/src/HostTable.php deleted file mode 100644 index 7e9b1733..00000000 --- a/src/HostTable.php +++ /dev/null @@ -1,80 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -/** - * The router host table - * - * @since 3.0.0 - */ -final class HostTable -{ - - /** - * @var array> - */ - private array $hosts = []; - - /** - * Adds the given alias with its hostnames to the table - * - * @param string $alias - * @param string ...$hostnames - * - * @return void - */ - public function add(string $alias, string ...$hostnames): void - { - foreach ($hostnames as $hostname) { - $this->hosts[$alias][] = $hostname; - } - } - - /** - * Loads the given hosts to the table - * - * @param array> $hosts - * - * @return void - */ - public function load(array $hosts): void - { - foreach ($hosts as $alias => $hostnames) { - foreach ($hostnames as $hostname) { - $this->hosts[$alias][] = $hostname; - } - } - } - - /** - * Resolves the given hostname to its alias - * if it exists in the table otherwise returns null - * - * @param string $hostname - * - * @return string|null - */ - public function resolve(string $hostname): ?string - { - foreach ($this->hosts as $alias => $hostnames) { - foreach ($hostnames as $value) { - if ($hostname === $value) { - return $alias; - } - } - } - - return null; - } -} diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 0d65c2c3..fb798d8a 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -25,7 +25,6 @@ use RegexIterator; use Sunrise\Http\Router\Annotation\Consumes; use Sunrise\Http\Router\Annotation\Description; -use Sunrise\Http\Router\Annotation\Host; use Sunrise\Http\Router\Annotation\Method; use Sunrise\Http\Router\Annotation\Middleware; use Sunrise\Http\Router\Annotation\Postfix; @@ -311,9 +310,9 @@ public function load(): RouteCollectionInterface $descriptor->attributes, ); - $route->setHost($descriptor->host); $route->setConsumesMediaTypes(...$descriptor->consumes); $route->setProducesMediaTypes(...$descriptor->produces); + $route->setSummary($descriptor->summary); $route->setDescription($descriptor->description); $route->setTags(...$descriptor->tags); @@ -445,11 +444,6 @@ private function supplementDescriptorFromParentClasses(Route $descriptor, Reflec // phpcs:ignore Generic.Files.LineLength private function supplementDescriptorFromClassOrMethod(Route $descriptor, ReflectionClass|ReflectionMethod $holder): void { - $annotations = $this->getAnnotations(Host::class, $holder); - if ($annotations->valid()) { - $descriptor->host = $annotations->current()->value; - } - $annotations = $this->getAnnotations(Prefix::class, $holder); if ($annotations->valid()) { $descriptor->path = $annotations->current()->value . $descriptor->path; diff --git a/src/Middleware/CallbackMiddleware.php b/src/Middleware/CallbackMiddleware.php index 0dd32e3e..77c19cef 100644 --- a/src/Middleware/CallbackMiddleware.php +++ b/src/Middleware/CallbackMiddleware.php @@ -17,8 +17,6 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use ReflectionFunction; -use ReflectionMethod; use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ObjectInjectionParameterResolver; use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; @@ -71,22 +69,12 @@ public function __construct( $this->responseResolutioner = $responseResolutioner; } - /** - * Gets the callback's reflection - * - * @return ReflectionFunction|ReflectionMethod - */ - public function getReflection(): ReflectionFunction|ReflectionMethod - { - return reflect_callback($this->callback); - } - /** * @inheritDoc */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - $source = $this->getReflection(); + $source = reflect_callback($this->callback); $arguments = $this->parameterResolutioner ->withContext($request) @@ -99,6 +87,6 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface /** @var mixed $response */ $response = ($this->callback)(...$arguments); - return $this->responseResolutioner->resolveResponse($response, $request, $source); + return $this->responseResolutioner->resolveResponse($source, $request, $response); } } diff --git a/src/Middleware/CrossOriginResourceSharingMiddleware.php b/src/Middleware/CrossOriginResourceSharingMiddleware.php new file mode 100644 index 00000000..ca0804a1 --- /dev/null +++ b/src/Middleware/CrossOriginResourceSharingMiddleware.php @@ -0,0 +1,95 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Middleware; + +use Neomerx\Cors\Contracts\AnalysisResultInterface; +use Neomerx\Cors\Contracts\AnalyzerInterface; +use Psr\Http\Message\ResponseFactoryInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; + +/** + * Cross-origin resource sharing + * + * @link https://github.com/neomerx/cors-psr7 + * + * @since 3.0.0 + */ +final class CrossOriginResourceSharingMiddleware implements MiddlewareInterface +{ + + /** + * Constructor of the class + * + * @param AnalyzerInterface $requestAnalyzer + * @param ResponseFactoryInterface $responseFactory + */ + public function __construct( + private AnalyzerInterface $requestAnalyzer, + private ResponseFactoryInterface $responseFactory, + ) { + } + + /** + * @inheritDoc + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + $requestAnalysisResult = $this->requestAnalyzer->analyze($request); + + switch ($requestAnalysisResult->getRequestType()) { + case AnalysisResultInterface::TYPE_REQUEST_OUT_OF_CORS_SCOPE: + return $handler->handle($request); + + case AnalysisResultInterface::ERR_NO_HOST_HEADER: + case AnalysisResultInterface::ERR_ORIGIN_NOT_ALLOWED: + case AnalysisResultInterface::ERR_METHOD_NOT_SUPPORTED: + case AnalysisResultInterface::ERR_HEADERS_NOT_SUPPORTED: + return $this->responseFactory->createResponse(403); + + case AnalysisResultInterface::TYPE_PRE_FLIGHT_REQUEST: + $response = $this->responseFactory->createResponse(200); + /** @var array $preflightResponseHeaders */ + $preflightResponseHeaders = $requestAnalysisResult->getResponseHeaders(); + + return $this->propagatePreflightResponseHeaders($response, $preflightResponseHeaders); + + default: + $response = $handler->handle($request); + /** @var array $preflightResponseHeaders */ + $preflightResponseHeaders = $requestAnalysisResult->getResponseHeaders(); + + return $this->propagatePreflightResponseHeaders($response, $preflightResponseHeaders); + } + } + + /** + * Propagates the given preflight headers to the given response + * + * @param ResponseInterface $response + * @param array $headers + * + * @return ResponseInterface + */ + private function propagatePreflightResponseHeaders(ResponseInterface $response, array $headers): ResponseInterface + { + foreach ($headers as $name => $value) { + $response = $response->withHeader($name, $value); + } + + return $response; + } +} diff --git a/src/Middleware/ErrorHandlingMiddleware.php b/src/Middleware/ErrorHandlingMiddleware.php index bd77dc37..607d56d8 100644 --- a/src/Middleware/ErrorHandlingMiddleware.php +++ b/src/Middleware/ErrorHandlingMiddleware.php @@ -26,14 +26,12 @@ use Sunrise\Http\Router\Event\ErrorEvent; use Sunrise\Http\Router\Exception\Http\HttpInternalServerErrorException; use Sunrise\Http\Router\Exception\HttpExceptionInterface; +use Sunrise\Http\Router\Helper\ViewLoader; use Sunrise\Http\Router\ServerRequest; use Throwable; use function extension_loaded; use function json_encode; -use function ob_end_clean; -use function ob_get_clean; -use function ob_start; use const JSON_PARTIAL_OUTPUT_ON_ERROR; use const LIBXML_COMPACT; @@ -113,16 +111,14 @@ private function handleFatalError(Throwable $error, ServerRequestInterface $requ { $this->logger?->error($error->getMessage(), ['error' => $error]); - $httpError = new HttpInternalServerErrorException(previous: $error); + $httpError = new HttpInternalServerErrorException($error); return $this->handleHttpError($httpError, $request); } private function renderHtmlError(HttpExceptionInterface $error): string { - $view = __DIR__ . '/../../resources/views/error.phtml'; - - return $this->loadView($view, $error); + return ViewLoader::loadView('error.html.php', $error); } private function renderJsonError(HttpExceptionInterface $error): string @@ -151,27 +147,7 @@ private function renderXmlError(HttpExceptionInterface $error): string $violationsChild->addChild('code', $violation->code); } - /** @var string */ + /** @var non-empty-string */ return $errorChild->asXML(); } - - private function loadView(string $filename, HttpExceptionInterface $error): string - { - try { - ob_start(); - - (function (string $filename): void { - /** @psalm-suppress UnresolvableInclude */ - include $filename; - })->call($error, $filename); - - return ob_get_clean(); - } catch (Throwable $exception) { - while (ob_get_level()) { - ob_end_clean(); - } - - throw $exception; - } - } } diff --git a/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php b/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php index 5aa2f61a..a967bf70 100644 --- a/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php @@ -75,11 +75,12 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $route = $context->getAttribute('@route'); if (! $route instanceof RouteInterface) { - throw new LogicException( + throw new LogicException(sprintf( 'The #[PathVariable] attribute cannot be applied to the parameter {%s}, ' . 'because the request does not contain information about the requested route, ' . - 'at least at this level of the application.' - ); + 'at least at this level of the application.', + ParameterResolutioner::stringifyParameter($parameter), + )); } $variable = $attributes[0]->newInstance(); @@ -108,7 +109,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) yield $this->typeConversioner->castValue($variableValue, $parameter->getType()); } catch (InvalidArgumentException $violation) { throw new HttpNotFoundException(sprintf( - 'The request cannot be completed with an invalid "%s". %s', + 'The request cannot be completed with an invalid %s. %s', $variableName, $violation->getMessage(), ), previous: $violation); diff --git a/src/ParameterResolving/ParameterResolver/ProvideRouteParameterResolver.php b/src/ParameterResolving/ParameterResolver/ProvideRouteParameterResolver.php new file mode 100644 index 00000000..edd622da --- /dev/null +++ b/src/ParameterResolving/ParameterResolver/ProvideRouteParameterResolver.php @@ -0,0 +1,71 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; + +use Generator; +use ReflectionAttribute; +use ReflectionNamedType; +use ReflectionParameter; +use Sunrise\Http\Router\Annotation\ProvideRoute; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; +use Sunrise\Http\Router\RouteInterface; +use Sunrise\Http\Router\Router; + +use function sprintf; + +/** + * ProvideRouteParameterResolver + * + * @since 3.0.0 + */ +final class ProvideRouteParameterResolver implements ParameterResolverInterface +{ + + /** + * Constructor of the class + * + * @param Router $router + */ + public function __construct(private Router $router) + { + } + + /** + * @inheritDoc + */ + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + { + /** @var list> $attributes */ + $attributes = $parameter->getAttributes(ProvideRoute::class); + if ($attributes === []) { + return; + } + + $type = $parameter->getType(); + + if (! ($type instanceof ReflectionNamedType) || + ! ($type->getName() === RouteInterface::class)) { + throw new LogicException(sprintf( + 'To use the #[ProvideRoute] attribute, the parameter {%s} must be typed with %s.', + ParameterResolutioner::stringifyParameter($parameter), + RouteInterface::class, + )); + } + + $attribute = $attributes[0]->newInstance(); + + yield $this->router->getRoutes()->get($attribute->name); + } +} diff --git a/src/ParameterResolving/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestCookieParameterResolver.php new file mode 100644 index 00000000..6cad56a1 --- /dev/null +++ b/src/ParameterResolving/ParameterResolver/RequestCookieParameterResolver.php @@ -0,0 +1,103 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; + +use Generator; +use InvalidArgumentException; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionAttribute; +use ReflectionParameter; +use Sunrise\Http\Router\Annotation\RequestCookie; +use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; +use Sunrise\Http\Router\TypeConversion\TypeConversionerInterface; + +use function sprintf; + +/** + * RequestCookieParameterResolver + * + * @since 3.0.0 + */ +final class RequestCookieParameterResolver implements ParameterResolverInterface +{ + + /** + * Constructor of the class + * + * @param TypeConversionerInterface $typeConversioner + */ + public function __construct(private TypeConversionerInterface $typeConversioner) + { + } + + /** + * @inheritDoc + * + * @throws LogicException If the resolver is used incorrectly. + * + * @throws HttpBadRequestException If a cookie was missed or invalid. + */ + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + { + /** @var list> $attributes */ + $attributes = $parameter->getAttributes(RequestCookie::class); + if ($attributes === []) { + return; + } + + if (!$parameter->hasType()) { + throw new LogicException(sprintf( + 'To use the #[RequestCookie] attribute, the parameter {%s} must be typed.', + ParameterResolutioner::stringifyParameter($parameter), + )); + } + + if (! $context instanceof ServerRequestInterface) { + throw new LogicException( + 'At this level of the application, any operations with the request are not possible.' + ); + } + + $cookie = $attributes[0]->newInstance(); + $cookies = $context->getCookieParams(); + + if (!isset($cookies[$cookie->name])) { + if ($parameter->isDefaultValueAvailable()) { + return yield $parameter->getDefaultValue(); + } elseif ($parameter->allowsNull()) { + return yield; + } + + throw new HttpBadRequestException(sprintf( + 'The cookie %s must be provided.', + $cookie->name, + )); + } + + try { + yield $this->typeConversioner->castValue( + $cookies[$cookie->name], + $parameter->getType(), + ); + } catch (InvalidArgumentException $violation) { + throw new HttpBadRequestException(sprintf( + 'The value of the cookie %s is not valid. %s', + $cookie->name, + $violation->getMessage(), + ), previous: $violation); + } + } +} diff --git a/src/ParameterResolving/ParameterResolver/RequestEntityParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestEntityParameterResolver.php new file mode 100644 index 00000000..2e03ca00 --- /dev/null +++ b/src/ParameterResolving/ParameterResolver/RequestEntityParameterResolver.php @@ -0,0 +1,146 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; + +use Doctrine\Persistence\ManagerRegistry as EntityManagerRegistryInterface; +use Generator; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionAttribute; +use ReflectionNamedType; +use ReflectionParameter; +use Sunrise\Http\Router\Annotation\RequestEntity; +use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; +use Sunrise\Http\Router\RouteInterface; + +use function count; +use function sprintf; + +/** + * RequestEntityParameterResolver + * + * @since 3.0.0 + */ +final class RequestEntityParameterResolver implements ParameterResolverInterface +{ + + /** + * Constructor of the class + * + * @param EntityManagerRegistryInterface $entityManagerRegistry + */ + public function __construct(private EntityManagerRegistryInterface $entityManagerRegistry) + { + } + + /** + * @inheritDoc + * + * @throws LogicException If the resolver is used incorrectly. + * + * @throws HttpNotFoundException If an entity wasn't found. + */ + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + { + /** @var list> $attributes */ + $attributes = $parameter->getAttributes(RequestEntity::class); + if ($attributes === []) { + return; + } + + $type = $parameter->getType(); + if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { + throw new LogicException(sprintf( + 'To use the #[RequestEntity] attribute, the parameter {%s} must be typed with an entity.', + ParameterResolutioner::stringifyParameter($parameter), + )); + } + + if (! $context instanceof ServerRequestInterface) { + throw new LogicException( + 'At this level of the application, any operations with the request are not possible.' + ); + } + + $route = $context->getAttribute('@route'); + if (! $route instanceof RouteInterface) { + throw new LogicException(sprintf( + 'The #[RequestEntity] attribute cannot be applied to the parameter {%s}, ' . + 'because the request does not contain information about the requested route, ' . + 'at least at this level of the application.', + ParameterResolutioner::stringifyParameter($parameter), + )); + } + + $entityRequest = $attributes[0]->newInstance(); + $entityManagerNames = $this->entityManagerRegistry->getManagerNames(); + if (isset($entityRequest->em) && !isset($entityManagerNames[$entityRequest->em])) { + throw new LogicException(sprintf( + 'The #[RequestEntity] attribute cannot be applied to the parameter {%s}, ' . + 'because the specified entity manager "%s" does not exist.', + ParameterResolutioner::stringifyParameter($parameter), + $entityRequest->em, + )); + } + + $entityName = $type->getName(); + $entityManager = $this->entityManagerRegistry->getManager($entityRequest->em); + $entityMetadata = $entityManager->getClassMetadata($entityName); + if (isset($entityRequest->findBy) && !$entityMetadata->hasField($entityRequest->findBy)) { + throw new LogicException(sprintf( + 'The #[RequestEntity] attribute cannot be applied to the parameter {%s}, ' . + 'because the specified field "%s" does not exist.', + ParameterResolutioner::stringifyParameter($parameter), + $entityRequest->findBy, + )); + } + + $entityIdentifierFieldNames = $entityMetadata->getIdentifier(); + if (!isset($entityRequest->findBy) && count($entityIdentifierFieldNames) <> 1) { + throw new LogicException(sprintf( + 'The #[RequestEntity] attribute cannot be applied to the parameter {%s}, ' . + 'because no entity search field name is provided, and automatic detection is not possible ' . + 'due to the entity having a composite identifier or no identifier at all. ' . + 'To resolve this issue, explicitly specify the field name within the attribute.', + ParameterResolutioner::stringifyParameter($parameter), + )); + } + + $entitySearchFieldName = $entityRequest->findBy ?? $entityIdentifierFieldNames[0]; + /** @var non-empty-string $routePathVariableName */ + $routePathVariableName = $entityRequest->pathVariable ?? $entitySearchFieldName; + /** @var non-empty-string|null $routePathVariableValue */ + $routePathVariableValue = $route->getAttribute($routePathVariableName); + if (!isset($routePathVariableValue)) { + throw new LogicException(sprintf( + 'The #[RequestEntity] attribute cannot be applied to the parameter {%s}, ' . + 'because the route is missing the value of variable "%s". ' . + 'To resolve this issue, explicitly specify the variable name within the attribute.', + ParameterResolutioner::stringifyParameter($parameter), + $routePathVariableName, + )); + } + + $entitySearchCriteria = $entityRequest->criteria; + $entitySearchCriteria[$entitySearchFieldName] = $routePathVariableValue; + $entityRepository = $entityManager->getRepository($entityName); + $entity = $entityRepository->findOneBy($entitySearchCriteria); + if (!isset($entity)) { + throw new HttpNotFoundException(); + } + + yield $entity; + } +} diff --git a/src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php index 9341e222..5c70232a 100644 --- a/src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php @@ -47,6 +47,8 @@ public function __construct(private TypeConversionerInterface $typeConversioner) * @inheritDoc * * @throws LogicException If the resolver is used incorrectly. + * + * @throws HttpBadRequestException If a header was missed or invalid. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index 50f77cab..653a36e3 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -126,7 +126,7 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface } throw new LogicException(sprintf( - 'Unable to resolve the reference {%s}', + 'Unable to resolve the reference {%s}.', self::stringifyReference($reference), )); } @@ -183,7 +183,7 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface } throw new LogicException(sprintf( - 'Unable to resolve the reference {%s}', + 'Unable to resolve the reference {%s}.', self::stringifyReference($reference), )); } diff --git a/src/RequestHandler/CallbackRequestHandler.php b/src/RequestHandler/CallbackRequestHandler.php index 960f258b..cbcc8526 100644 --- a/src/RequestHandler/CallbackRequestHandler.php +++ b/src/RequestHandler/CallbackRequestHandler.php @@ -16,8 +16,6 @@ use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; -use ReflectionFunction; -use ReflectionMethod; use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ObjectInjectionParameterResolver; use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; @@ -70,22 +68,12 @@ public function __construct( $this->responseResolutioner = $responseResolutioner; } - /** - * Gets the callback's reflection - * - * @return ReflectionFunction|ReflectionMethod - */ - public function getReflection(): ReflectionFunction|ReflectionMethod - { - return reflect_callback($this->callback); - } - /** * @inheritDoc */ public function handle(ServerRequestInterface $request): ResponseInterface { - $source = $this->getReflection(); + $source = reflect_callback($this->callback); $arguments = $this->parameterResolutioner ->withContext($request) @@ -97,6 +85,6 @@ public function handle(ServerRequestInterface $request): ResponseInterface /** @var mixed $response */ $response = ($this->callback)(...$arguments); - return $this->responseResolutioner->resolveResponse($response, $request, $source); + return $this->responseResolutioner->resolveResponse($source, $request, $response); } } diff --git a/src/ResponseResolving/ResponseResolutioner.php b/src/ResponseResolving/ResponseResolutioner.php index 54785f9c..c7df163e 100644 --- a/src/ResponseResolving/ResponseResolutioner.php +++ b/src/ResponseResolving/ResponseResolutioner.php @@ -13,6 +13,7 @@ namespace Sunrise\Http\Router\ResponseResolving; +use Psr\EventDispatcher\EventDispatcherInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; @@ -20,6 +21,7 @@ use ReflectionMethod; use Sunrise\Http\Router\Annotation\ResponseHeader; use Sunrise\Http\Router\Annotation\ResponseStatus; +use Sunrise\Http\Router\Event\ResponseResolvedEvent; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ResponseResolving\ResponseResolver\ResponseResolverInterface; @@ -39,6 +41,15 @@ final class ResponseResolutioner implements ResponseResolutionerInterface */ private array $resolvers = []; + /** + * Constructor of the class + * + * @param EventDispatcherInterface|null $eventDispatcher + */ + public function __construct(private ?EventDispatcherInterface $eventDispatcher = null) + { + } + /** * @inheritDoc */ @@ -55,18 +66,18 @@ public function addResolver(ResponseResolverInterface ...$resolvers): void * @throws LogicException If the response couldn't be resolved to PSR-7 response. */ public function resolveResponse( - mixed $response, - ServerRequestInterface $request, ReflectionFunction|ReflectionMethod $source, + ServerRequestInterface $request, + mixed $response, ) : ResponseInterface { if ($response instanceof ResponseInterface) { - return $response; + return $this->handleResponse($source, $request, $response); } foreach ($this->resolvers as $resolver) { - $result = $resolver->resolveResponse($response, $request, $source); - if ($result instanceof ResponseInterface) { - return $this->supplementResponse($result, $source); + $resolvedResponse = $resolver->resolveResponse($source, $request, $response); + if ($resolvedResponse instanceof ResponseInterface) { + return $this->handleResponse($source, $request, $response); } } @@ -78,16 +89,18 @@ public function resolveResponse( } /** - * Supplements the given response + * Handles the given response * - * @param ResponseInterface $response * @param ReflectionFunction|ReflectionMethod $source + * @param ServerRequestInterface $request + * @param ResponseInterface $response * * @return ResponseInterface */ - private function supplementResponse( - ResponseInterface $response, + private function handleResponse( ReflectionFunction|ReflectionMethod $source, + ServerRequestInterface $request, + mixed $response, ) : ResponseInterface { /** @var list> $attributes */ $attributes = $source->getAttributes(ResponseStatus::class); @@ -103,6 +116,12 @@ private function supplementResponse( $response = $response->withHeader($header->name, $header->value); } + if (isset($this->eventDispatcher)) { + $event = new ResponseResolvedEvent($source, $request, $response); + $this->eventDispatcher->dispatch($event); + $response = $event->getResponse(); + } + return $response; } diff --git a/src/ResponseResolving/ResponseResolutionerInterface.php b/src/ResponseResolving/ResponseResolutionerInterface.php index 5061d287..335445a3 100644 --- a/src/ResponseResolving/ResponseResolutionerInterface.php +++ b/src/ResponseResolving/ResponseResolutionerInterface.php @@ -39,15 +39,15 @@ public function addResolver(ResponseResolverInterface ...$resolvers): void; /** * Resolves the given response to PSR-7 response * - * @param mixed $response - * @param ServerRequestInterface $request * @param ReflectionFunction|ReflectionMethod $source + * @param ServerRequestInterface $request + * @param mixed $response * * @return ResponseInterface */ public function resolveResponse( - mixed $response, - ServerRequestInterface $request, ReflectionFunction|ReflectionMethod $source, + ServerRequestInterface $request, + mixed $response, ) : ResponseInterface; } diff --git a/src/ResponseResolving/ResponseResolver/EmptyResponseResolver.php b/src/ResponseResolving/ResponseResolver/EmptyResponseResolver.php index a5cdf81a..452c4d23 100644 --- a/src/ResponseResolving/ResponseResolver/EmptyResponseResolver.php +++ b/src/ResponseResolving/ResponseResolver/EmptyResponseResolver.php @@ -40,9 +40,9 @@ public function __construct(private ResponseFactoryInterface $responseFactory) * @inheritDoc */ public function resolveResponse( - mixed $response, - ServerRequestInterface $request, ReflectionFunction|ReflectionMethod $source, + ServerRequestInterface $request, + mixed $response, ) : ?ResponseInterface { if ($response === null) { return $this->responseFactory->createResponse(204); diff --git a/src/ResponseResolving/ResponseResolver/JsonResponseBodyResponseResolver.php b/src/ResponseResolving/ResponseResolver/JsonResponseBodyResponseResolver.php index b11fc0e0..0243425e 100644 --- a/src/ResponseResolving/ResponseResolver/JsonResponseBodyResponseResolver.php +++ b/src/ResponseResolving/ResponseResolver/JsonResponseBodyResponseResolver.php @@ -57,9 +57,9 @@ public function __construct( * @throws LogicException If the resolver is used incorrectly. */ public function resolveResponse( - mixed $response, - ServerRequestInterface $request, ReflectionFunction|ReflectionMethod $source, + ServerRequestInterface $request, + mixed $response, ) : ?ResponseInterface { /** @var list> $attributes */ $attributes = $source->getAttributes(JsonResponseBody::class); diff --git a/src/ResponseResolving/ResponseResolver/ResponseResolverInterface.php b/src/ResponseResolving/ResponseResolver/ResponseResolverInterface.php index 05597232..6cacc6a9 100644 --- a/src/ResponseResolving/ResponseResolver/ResponseResolverInterface.php +++ b/src/ResponseResolving/ResponseResolver/ResponseResolverInterface.php @@ -29,15 +29,15 @@ interface ResponseResolverInterface /** * Resolves the given response to PSR-7 response * - * @param mixed $response - * @param ServerRequestInterface $request * @param ReflectionFunction|ReflectionMethod $source + * @param ServerRequestInterface $request + * @param mixed $response * * @return ResponseInterface|null */ public function resolveResponse( - mixed $response, - ServerRequestInterface $request, ReflectionFunction|ReflectionMethod $source, + ServerRequestInterface $request, + mixed $response, ) : ?ResponseInterface; } diff --git a/src/ResponseResolving/ResponseResolver/RouteResponseResolver.php b/src/ResponseResolving/ResponseResolver/RouteResponseResolver.php index 1b2cfb37..4c888433 100644 --- a/src/ResponseResolving/ResponseResolver/RouteResponseResolver.php +++ b/src/ResponseResolving/ResponseResolver/RouteResponseResolver.php @@ -31,9 +31,9 @@ final class RouteResponseResolver implements ResponseResolverInterface * @inheritDoc */ public function resolveResponse( - mixed $response, - ServerRequestInterface $request, ReflectionFunction|ReflectionMethod $source, + ServerRequestInterface $request, + mixed $response, ) : ?ResponseInterface { if ($response instanceof RouteInterface) { return $response->handle($request); diff --git a/src/ResponseResolving/ResponseResolver/StreamResponseResolver.php b/src/ResponseResolving/ResponseResolver/StreamResponseResolver.php index 8462d4ec..9094a259 100644 --- a/src/ResponseResolving/ResponseResolver/StreamResponseResolver.php +++ b/src/ResponseResolving/ResponseResolver/StreamResponseResolver.php @@ -41,9 +41,9 @@ public function __construct(private ResponseFactoryInterface $responseFactory) * @inheritDoc */ public function resolveResponse( - mixed $response, - ServerRequestInterface $request, ReflectionFunction|ReflectionMethod $source, + ServerRequestInterface $request, + mixed $response, ) : ?ResponseInterface { if ($response instanceof StreamInterface) { return $this->responseFactory->createResponse(200) diff --git a/src/ResponseResolving/ResponseResolver/UriResponseResolver.php b/src/ResponseResolving/ResponseResolver/UriResponseResolver.php index 9c2dae92..1a593d02 100644 --- a/src/ResponseResolving/ResponseResolver/UriResponseResolver.php +++ b/src/ResponseResolving/ResponseResolver/UriResponseResolver.php @@ -41,9 +41,9 @@ public function __construct(private ResponseFactoryInterface $responseFactory) * @inheritDoc */ public function resolveResponse( - mixed $response, - ServerRequestInterface $request, ReflectionFunction|ReflectionMethod $source, + ServerRequestInterface $request, + mixed $response, ) : ?ResponseInterface { if ($response instanceof UriInterface) { return $this->responseFactory->createResponse(302) diff --git a/src/Route.php b/src/Route.php index 5663dde1..6d395104 100644 --- a/src/Route.php +++ b/src/Route.php @@ -17,12 +17,8 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use ReflectionFunction; -use ReflectionMethod; use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; -use ReflectionClass; use function rtrim; use function strtoupper; @@ -42,13 +38,6 @@ class Route implements RouteInterface */ private string $name; - /** - * The route host - * - * @var string|null - */ - private ?string $host = null; - /** * The route path * @@ -153,14 +142,6 @@ public function getName(): string return $this->name; } - /** - * @inheritDoc - */ - public function getHost(): ?string - { - return $this->host; - } - /** * @inheritDoc */ @@ -249,18 +230,6 @@ public function getTags(): array return $this->tags; } - /** - * @inheritDoc - */ - public function getHolder(): ReflectionClass|ReflectionMethod|ReflectionFunction - { - if ($this->requestHandler instanceof CallbackRequestHandler) { - return $this->requestHandler->getReflection(); - } - - return new ReflectionClass($this->requestHandler); - } - /** * @inheritDoc */ @@ -271,16 +240,6 @@ public function setName(string $name): RouteInterface return $this; } - /** - * @inheritDoc - */ - public function setHost(?string $host): RouteInterface - { - $this->host = $host; - - return $this; - } - /** * @inheritDoc */ @@ -540,6 +499,11 @@ public function handle(ServerRequestInterface $request): ResponseInterface return $this->requestHandler->handle($request); } - return (new QueueableRequestHandler($this->requestHandler, ...$this->middlewares))->handle($request); + $requestHandler = new QueueableRequestHandler( + $this->requestHandler, + ...$this->middlewares, + ); + + return $requestHandler->handle($request); } } diff --git a/src/RouteCollection.php b/src/RouteCollection.php index 11ac5830..0fb3b1be 100644 --- a/src/RouteCollection.php +++ b/src/RouteCollection.php @@ -15,7 +15,6 @@ use Psr\Http\Server\MiddlewareInterface; use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Exception\RouteAlreadyExistsException; use Sunrise\Http\Router\Exception\RouteNotFoundException; use Iterator; @@ -30,21 +29,11 @@ class RouteCollection implements RouteCollectionInterface { - /** - * @var string - */ - private const ANY = '*'; - /** * @var array */ private array $routes = []; - /** - * @var array> - */ - private array $hostMap = []; - /** * Constructor of the class * @@ -75,24 +64,6 @@ public function all(): Iterator } } - /** - * @inheritDoc - */ - public function allOnHost(?string $host): Iterator - { - if (isset($host) && isset($this->hostMap[$host])) { - foreach ($this->hostMap[$host] as $name) { - yield $this->routes[$name]; - } - } - - if (isset($this->hostMap[self::ANY])) { - foreach ($this->hostMap[self::ANY] as $name) { - yield $this->routes[$name]; - } - } - } - /** * @inheritDoc */ @@ -122,30 +93,7 @@ public function get(string $name): RouteInterface public function add(RouteInterface ...$routes): RouteCollectionInterface { foreach ($routes as $route) { - $name = $route->getName(); - $host = $route->getHost() ?? self::ANY; - - if (isset($this->routes[$name])) { - throw new RouteAlreadyExistsException(sprintf( - 'The collection already contains a route with the name %s', - $name - )); - } - - $this->routes[$name] = $route; - $this->hostMap[$host][] = $name; - } - - return $this; - } - - /** - * @inheritDoc - */ - public function setHost(string $host): RouteCollectionInterface - { - foreach ($this->routes as $route) { - $route->setHost($host); + $this->routes[$route->getName()] = $route; } return $this; diff --git a/src/RouteCollectionInterface.php b/src/RouteCollectionInterface.php index 2ae51da0..8aae5760 100644 --- a/src/RouteCollectionInterface.php +++ b/src/RouteCollectionInterface.php @@ -36,20 +36,6 @@ interface RouteCollectionInterface extends Countable, IteratorAggregate */ public function all(): Iterator; - /** - * Gets all routes from the collection by the given host - * - * This method should first return all routes that are served on the given host, - * and then return all routes that are not bound to any host. - * - * @param string|null $host - * - * @return Iterator - * - * @since 3.0.0 - */ - public function allOnHost(?string $host): Iterator; - /** * Checks by the given name if a route exists in the collection * @@ -87,17 +73,6 @@ public function get(string $name): RouteInterface; */ public function add(RouteInterface ...$routes): RouteCollectionInterface; - /** - * Sets the given host to all routes in the collection - * - * @param string $host - * - * @return RouteCollectionInterface - * - * @since 2.9.0 - */ - public function setHost(string $host): RouteCollectionInterface; - /** * Sets the given consumes media type(s) to all routes in the collection * diff --git a/src/RouteInterface.php b/src/RouteInterface.php index 79543e64..a5dec3ea 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -16,9 +16,6 @@ use Fig\Http\Message\RequestMethodInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use ReflectionClass; -use ReflectionMethod; -use ReflectionFunction; use Sunrise\Http\Router\Entity\MediaType; /** @@ -43,15 +40,6 @@ interface RouteInterface extends RequestHandlerInterface, RequestMethodInterface */ public function getName(): string; - /** - * Gets the route host - * - * @return string|null - * - * @since 2.6.0 - */ - public function getHost(): ?string; - /** * Gets the route path * @@ -142,15 +130,6 @@ public function getDescription(): string; */ public function getTags(): array; - /** - * Gets the route holder - * - * @return ReflectionClass|ReflectionMethod|ReflectionFunction - * - * @since 2.14.0 - */ - public function getHolder(): ReflectionClass|ReflectionMethod|ReflectionFunction; - /** * Sets the given name to the route * @@ -160,17 +139,6 @@ public function getHolder(): ReflectionClass|ReflectionMethod|ReflectionFunction */ public function setName(string $name): RouteInterface; - /** - * Sets the given host to the route - * - * @param string|null $host - * - * @return RouteInterface - * - * @since 2.6.0 - */ - public function setHost(?string $host): RouteInterface; - /** * Sets the given path to the route * diff --git a/src/Router.php b/src/Router.php index 6ec211c3..2291225d 100644 --- a/src/Router.php +++ b/src/Router.php @@ -45,11 +45,6 @@ class Router implements RequestHandlerInterface, RequestMethodInterface '@uuid' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}', ]; - /** - * @var HostTable - */ - private HostTable $hosts; - /** * @var RouteCollectionInterface */ @@ -73,16 +68,13 @@ class Router implements RequestHandlerInterface, RequestMethodInterface /** * Constructor of the class * - * @param HostTable|null $hosts * @param RouteCollectionInterface|null $routes * * @since 3.0.0 */ public function __construct( - ?HostTable $hosts = null, ?RouteCollectionInterface $routes = null ) { - $this->hosts = $hosts ?? new HostTable(); $this->routes = $routes ?? new RouteCollection(); } @@ -100,18 +92,6 @@ public function load(LoaderInterface ...$loaders): void } } - /** - * Gets the router's host table - * - * @return HostTable - * - * @since 2.6.0 - */ - public function getHosts(): HostTable - { - return $this->hosts; - } - /** * Gets the router's route collection * @@ -238,15 +218,11 @@ public function match(ServerRequestInterface $request): RouteInterface { $request = ServerRequest::from($request); $requestUri = $request->getUri(); - $requestHost = $requestUri->getHost(); $requestPath = $requestUri->getPath(); $requestMethod = $request->getMethod(); $allowedMethods = []; - $host = $this->hosts->resolve($requestHost); - $routes = $this->routes->allOnHost($host); - - foreach ($routes as $route) { + foreach ($this->routes->all() as $route) { // https://github.com/sunrise-php/http-router/issues/50 // https://tools.ietf.org/html/rfc7231#section-6.5.5 if (!path_match($route->getPath(), $requestPath, $attributes)) { @@ -292,20 +268,18 @@ public function match(ServerRequestInterface $request): RouteInterface */ public function run(ServerRequestInterface $request): ResponseInterface { - // TODO: request event - // lazy resolving of the given request... $routing = new CallableRequestHandler( function (ServerRequestInterface $request): ResponseInterface { - $this->matchedRoute = $this->match($request); + $this->matchedRoute = $route = $this->match($request); if (isset($this->eventDispatcher)) { - $event = new RouteEvent($this->matchedRoute, $request); + $event = new RouteEvent($route, $request); $this->eventDispatcher->dispatch($event); $request = $event->getRequest(); } - return $this->matchedRoute->handle($request); + return $route->handle($request); } ); @@ -313,11 +287,12 @@ function (ServerRequestInterface $request): ResponseInterface { return $routing->handle($request); } - $response = (new QueueableRequestHandler($routing, ...$this->middlewares))->handle($request); - - // TODO: response event + $requestHandler = new QueueableRequestHandler( + $routing, + ...$this->middlewares, + ); - return $response; + return $requestHandler->handle($request); } /** @@ -325,18 +300,23 @@ function (ServerRequestInterface $request): ResponseInterface { */ public function handle(ServerRequestInterface $request): ResponseInterface { - $this->matchedRoute = $this->match($request); + $this->matchedRoute = $route = $this->match($request); if (isset($this->eventDispatcher)) { - $event = new RouteEvent($this->matchedRoute, $request); + $event = new RouteEvent($route, $request); $this->eventDispatcher->dispatch($event); $request = $event->getRequest(); } if (empty($this->middlewares)) { - return $this->matchedRoute->handle($request); + return $route->handle($request); } - return (new QueueableRequestHandler($this->matchedRoute, ...$this->middlewares))->handle($request); + $requestHandler = new QueueableRequestHandler( + $route, + ...$this->middlewares, + ); + + return $requestHandler->handle($request); } } diff --git a/src/RouterBuilder.php b/src/RouterBuilder.php index 4ac1e5cb..6337f9b4 100644 --- a/src/RouterBuilder.php +++ b/src/RouterBuilder.php @@ -47,11 +47,6 @@ final class RouterBuilder */ private $patterns = null; - /** - * @var array|null - */ - private $hosts = null; - /** * @var MiddlewareInterface[]|null */ @@ -175,20 +170,6 @@ public function setPatterns(?array $patterns): self return $this; } - /** - * Sets the given hosts to the builder - * - * @param array|null $hosts - * - * @return self - */ - public function setHosts(?array $hosts): self - { - $this->hosts = $hosts; - - return $this; - } - /** * Sets the given middlewares to the builder * @@ -230,10 +211,6 @@ public function build(): Router $router->addPatterns($this->patterns); } - if (!empty($this->hosts)) { - $router->addHosts($this->hosts); - } - if (!empty($this->middlewares)) { $router->addMiddleware(...$this->middlewares); } diff --git a/src/TypeConversion/TypeConversioner.php b/src/TypeConversion/TypeConversioner.php index 8c559a8d..e12484ea 100644 --- a/src/TypeConversion/TypeConversioner.php +++ b/src/TypeConversion/TypeConversioner.php @@ -56,7 +56,7 @@ public function castValue(mixed $value, ReflectionType $type): mixed } throw new LogicException(sprintf( - 'Unable to convert the value {%s} to the type %s.', + 'Unable to convert the value {%s} to the type {%s}.', get_debug_type($value), (string) $type, )); diff --git a/src/TypeConversion/TypeConverter/BackedEnumTypeConverter.php b/src/TypeConversion/TypeConverter/BackedEnumTypeConverter.php index a762b1d5..4de51e2d 100644 --- a/src/TypeConversion/TypeConverter/BackedEnumTypeConverter.php +++ b/src/TypeConversion/TypeConverter/BackedEnumTypeConverter.php @@ -68,7 +68,7 @@ public function castValue(mixed $value, ReflectionType $type): Generator if (is_string($value)) { // As part of the support for HTML forms and other untyped data sources, - // an instance of BackedEnum should not be created from an empty string, + // an instance of Enum should not be created from an empty string, // therefore, such values should be treated as NULL. if (trim($value) === '') { // phpcs:ignore Generic.Files.LineLength @@ -98,7 +98,7 @@ public function castValue(mixed $value, ReflectionType $type): Generator throw new InvalidArgumentException(sprintf( 'This value must be one of: %s.', - join(', ', $choices) + join(', ', $choices), ), previous: $e); } } diff --git a/src/TypeConversion/TypeConverter/DateTimeTypeConverter.php b/src/TypeConversion/TypeConverter/DateTimeTypeConverter.php index b849c1ed..3f98a0ef 100644 --- a/src/TypeConversion/TypeConverter/DateTimeTypeConverter.php +++ b/src/TypeConversion/TypeConverter/DateTimeTypeConverter.php @@ -59,7 +59,7 @@ public function castValue(mixed $value, ReflectionType $type): Generator } // As part of the support for HTML forms and other untyped data sources, - // an instance of DateTime* should not be created from an empty string, + // an instance of DateTime should not be created from an empty string, // therefore, such values should be treated as NULL. if (trim($value) === '') { return $type->allowsNull() ? yield : throw new InvalidArgumentException('This value must not be empty.'); diff --git a/tests/Exception/BadRequestExceptionTest.php b/tests/Exception/BadRequestExceptionTest.php deleted file mode 100644 index 2ab92b5d..00000000 --- a/tests/Exception/BadRequestExceptionTest.php +++ /dev/null @@ -1,78 +0,0 @@ -assertInstanceOf(Exception::class, $exception); - } - - /** - * @return void - */ - public function testErrors() : void - { - $expected = [ - 'foo' => 'bar', - 'bar' => 'baz', - ]; - - $exception = new BadRequestException('blah', [ - 'errors' => $expected, - ]); - - $this->assertSame($expected, $exception->getErrors()); - } - - /** - * @return void - */ - public function testErrorsWithEmptyContext() : void - { - $exception = new BadRequestException('blah'); - - $this->assertSame([], $exception->getErrors()); - } - - /** - * @return void - */ - public function testViolations() : void - { - $expected = [ - 'foo' => 'bar', - 'bar' => 'baz', - ]; - - $exception = new BadRequestException('blah', [ - 'violations' => $expected, - ]); - - $this->assertSame($expected, $exception->getViolations()); - } - - /** - * @return void - */ - public function testViolationsWithEmptyContext() : void - { - $exception = new BadRequestException('blah'); - - $this->assertSame([], $exception->getViolations()); - } -} diff --git a/tests/Exception/ExceptionTest.php b/tests/Exception/ExceptionTest.php deleted file mode 100644 index 98f513a3..00000000 --- a/tests/Exception/ExceptionTest.php +++ /dev/null @@ -1,96 +0,0 @@ -assertInstanceOf(Throwable::class, $exception); - $this->assertInstanceOf(ExceptionInterface::class, $exception); - } - - /** - * @return void - */ - public function testConstructorWithoutParameters() : void - { - $exception = new Exception(); - - $this->assertSame('', $exception->getMessage()); - $this->assertSame([], $exception->getContext()); - $this->assertSame(0, $exception->getCode()); - $this->assertNull($exception->getPrevious()); - } - - /** - * @return void - */ - public function testMessage() : void - { - $message = 'blah'; - - $exception = new Exception($message); - - $this->assertSame($message, $exception->getMessage()); - } - - /** - * @return void - */ - public function testContext() : void - { - $context = [ - 'foo' => 'bar', - 'bar' => 'baz', - ]; - - $exception = new Exception('blah', $context); - - $this->assertSame($context, $exception->getContext()); - - $this->assertSame($context['foo'], $exception->fromContext('foo')); - $this->assertSame($context['bar'], $exception->fromContext('bar')); - - $this->assertNull($exception->fromContext('baz')); - $this->assertFalse($exception->fromContext('baz', false)); - } - - /** - * @return void - */ - public function testCode() : void - { - $code = 100; - - $exception = new Exception('blah', [], $code); - - $this->assertSame($code, $exception->getCode()); - } - - /** - * @return void - */ - public function testPrevious() : void - { - $previous = new Exception(); - - $exception = new Exception('blah', [], 0, $previous); - - $this->assertSame($previous, $exception->getPrevious()); - } -} diff --git a/tests/Exception/InvalidArgumentExceptionTest.php b/tests/Exception/InvalidArgumentExceptionTest.php deleted file mode 100644 index cedf93ee..00000000 --- a/tests/Exception/InvalidArgumentExceptionTest.php +++ /dev/null @@ -1,24 +0,0 @@ -assertInstanceOf(Exception::class, $exception); - } -} diff --git a/tests/Exception/InvalidAttributeValueExceptionTest.php b/tests/Exception/InvalidAttributeValueExceptionTest.php deleted file mode 100644 index 02bf80e2..00000000 --- a/tests/Exception/InvalidAttributeValueExceptionTest.php +++ /dev/null @@ -1,24 +0,0 @@ -assertInstanceOf(Exception::class, $exception); - } -} diff --git a/tests/Exception/InvalidLoaderResourceExceptionTest.php b/tests/Exception/InvalidLoaderResourceExceptionTest.php deleted file mode 100644 index 72b5e07a..00000000 --- a/tests/Exception/InvalidLoaderResourceExceptionTest.php +++ /dev/null @@ -1,24 +0,0 @@ -assertInstanceOf(Exception::class, $exception); - } -} diff --git a/tests/Exception/InvalidPathExceptionTest.php b/tests/Exception/InvalidPathExceptionTest.php deleted file mode 100644 index 71bfbc73..00000000 --- a/tests/Exception/InvalidPathExceptionTest.php +++ /dev/null @@ -1,24 +0,0 @@ -assertInstanceOf(Exception::class, $exception); - } -} diff --git a/tests/Exception/MethodNotAllowedExceptionTest.php b/tests/Exception/MethodNotAllowedExceptionTest.php deleted file mode 100644 index 34930bba..00000000 --- a/tests/Exception/MethodNotAllowedExceptionTest.php +++ /dev/null @@ -1,100 +0,0 @@ -assertInstanceOf(Exception::class, $exception); - } - - /** - * @return void - */ - public function testMethod() : void - { - $expected = 'foo'; - - $exception = new MethodNotAllowedException('blah', [ - 'method' => $expected, - ]); - - $this->assertSame($expected, $exception->getMethod()); - } - - /** - * @return void - */ - public function testMethodWithEmptyContext() : void - { - $exception = new MethodNotAllowedException('blah'); - - $this->assertSame('', $exception->getMethod()); - } - - /** - * @return void - */ - public function testAllowedMethods() : void - { - $expected = ['foo', 'bar']; - - $exception = new MethodNotAllowedException('blah', [ - 'allowed' => $expected, - ]); - - $this->assertSame($expected, $exception->getAllowedMethods()); - } - - /** - * @return void - */ - public function testAllowedMethodsWithEmptyContext() : void - { - $exception = new MethodNotAllowedException('blah'); - - $this->assertSame([], $exception->getAllowedMethods()); - } - - /** - * @return void - */ - public function testGluingAllowedMethods() : void - { - $methods = ['foo', 'bar']; - - $expected = implode(',', $methods); - - $exception = new MethodNotAllowedException('blah', [ - 'allowed' => $methods, - ]); - - $this->assertSame($expected, $exception->getJoinedAllowedMethods()); - } - - /** - * @return void - */ - public function testGluingAllowedMethodsWithEmptyContext() : void - { - $exception = new MethodNotAllowedException('blah'); - - $this->assertSame('', $exception->getJoinedAllowedMethods()); - } -} diff --git a/tests/Exception/MissingAttributeValueExceptionTest.php b/tests/Exception/MissingAttributeValueExceptionTest.php deleted file mode 100644 index 5380358b..00000000 --- a/tests/Exception/MissingAttributeValueExceptionTest.php +++ /dev/null @@ -1,24 +0,0 @@ -assertInstanceOf(Exception::class, $exception); - } -} diff --git a/tests/Exception/PageNotFoundExceptionTest.php b/tests/Exception/PageNotFoundExceptionTest.php deleted file mode 100644 index 7aed6f9e..00000000 --- a/tests/Exception/PageNotFoundExceptionTest.php +++ /dev/null @@ -1,24 +0,0 @@ -assertInstanceOf(RouteNotFoundException::class, $exception); - } -} diff --git a/tests/Exception/RouteNotFoundExceptionTest.php b/tests/Exception/RouteNotFoundExceptionTest.php deleted file mode 100644 index 1295debf..00000000 --- a/tests/Exception/RouteNotFoundExceptionTest.php +++ /dev/null @@ -1,24 +0,0 @@ -assertInstanceOf(Exception::class, $exception); - } -} diff --git a/tests/Exception/UnresolvableReferenceExceptionTest.php b/tests/Exception/UnresolvableReferenceExceptionTest.php deleted file mode 100644 index c844afa5..00000000 --- a/tests/Exception/UnresolvableReferenceExceptionTest.php +++ /dev/null @@ -1,24 +0,0 @@ -assertInstanceOf(Exception::class, $exception); - } -} diff --git a/tests/Exception/UnsupportedMediaTypeExceptionTest.php b/tests/Exception/UnsupportedMediaTypeExceptionTest.php deleted file mode 100644 index 375d8141..00000000 --- a/tests/Exception/UnsupportedMediaTypeExceptionTest.php +++ /dev/null @@ -1,103 +0,0 @@ -assertInstanceOf(Exception::class, $exception); - } - - /** - * @return void - */ - public function testType() : void - { - $expected = 'application/octet-stream'; - - $exception = new UnsupportedMediaTypeException('blah', [ - 'type' => $expected, - ]); - - $this->assertSame($expected, $exception->getType()); - } - - /** - * @return void - */ - public function testTypeWithEmptyContext() : void - { - $exception = new UnsupportedMediaTypeException('blah'); - - $this->assertSame('', $exception->getType()); - } - - /** - * @return void - */ - public function testSupportedTypes() : void - { - $expected = [ - 'application/json', - 'application/x-www-form-urlencoded', - ]; - - $exception = new UnsupportedMediaTypeException('blah', [ - 'supported' => $expected, - ]); - - $this->assertSame($expected, $exception->getSupportedTypes()); - } - - /** - * @return void - */ - public function testSupportedTypesWithEmptyContext() : void - { - $exception = new UnsupportedMediaTypeException('blah'); - - $this->assertSame([], $exception->getSupportedTypes()); - } - - /** - * @return void - */ - public function testGluingSupportedTypes() : void - { - $types = ['foo', 'bar']; - - $expected = implode(',', $types); - - $exception = new UnsupportedMediaTypeException('blah', [ - 'supported' => $types, - ]); - - $this->assertSame($expected, $exception->getJoinedSupportedTypes()); - } - - /** - * @return void - */ - public function testGluingSupportedTypesWithEmptyContext() : void - { - $exception = new UnsupportedMediaTypeException('blah'); - - $this->assertSame('', $exception->getJoinedSupportedTypes()); - } -} From 4b0dabc5973b025dd1c6fe446f1a1dec968a550d Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 27 Aug 2023 20:10:28 +0200 Subject: [PATCH 083/180] v3 --- resources/views/error.html.php | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/resources/views/error.html.php b/resources/views/error.html.php index 2d436886..50cb0e49 100644 --- a/resources/views/error.html.php +++ b/resources/views/error.html.php @@ -6,6 +6,8 @@ /** @var HttpExceptionInterface $this */ +$e = static fn(string $string): string => htmlspecialchars($string, ENT_HTML5 | ENT_SUBSTITUTE, 'UTF-8', false); + ?> @@ -68,10 +70,10 @@

getReasonPhrase() ?>

-

getMessage()) ?>

+

getMessage()) ?>

getViolations() as $violation): ?> -

source ?> message) ?>

+

source ?> message) ?>

From e64b02e1cd8cfe7731510f833bbc068871f7470a Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Wed, 6 Sep 2023 04:13:15 +0200 Subject: [PATCH 084/180] v3 --- functions/parse_header.php | 167 ------------ functions/parse_header_with_media_type.php | 103 -------- functions/reflect_callback.php | 62 ----- .../error.html.php => templates/error.html} | 25 +- src/Annotation/Commit.php | 2 +- ...eBody.php => SerializableResponseBody.php} | 6 +- src/Dictionary/Charset.php | 31 +++ src/Dto/ErrorDto.php | 29 ++- src/Dto/ViolationDto.php | 8 + src/Entity/Language.php | 74 ++++++ src/Entity/MediaType.php | 52 ++-- ...{ErrorEvent.php => ErrorOccurredEvent.php} | 4 +- .../{RouteEvent.php => RouteMatchedEvent.php} | 6 +- ...rredEventListenerDisplayingFatalError.php} | 44 ++-- ...ccurredEventListenerRenderingHtmlError.php | 79 ++++++ ...esolvedEventListenerCommittingChanges.php} | 28 +- .../Http/HttpBadRequestException.php | 2 +- src/Exception/Http/HttpConflictException.php | 2 +- .../Http/HttpFailedDependencyException.php | 2 +- src/Exception/Http/HttpForbiddenException.php | 2 +- src/Exception/Http/HttpGoneException.php | 2 +- .../Http/HttpInternalServerErrorException.php | 2 +- src/Exception/Http/HttpLockedException.php | 2 +- .../Http/HttpMethodNotAllowedException.php | 7 +- src/Exception/Http/HttpNotFoundException.php | 4 +- .../Http/HttpPayloadTooLargeException.php | 2 +- .../Http/HttpServiceUnavailableException.php | 2 +- .../Http/HttpTooManyRequestsException.php | 2 +- .../Http/HttpUnauthorizedException.php | 2 +- ...ttpUnavailableForLegalReasonsException.php | 2 +- .../Http/HttpUnprocessableEntityException.php | 2 +- .../HttpUnsupportedMediaTypeException.php | 8 +- src/Exception/HttpException.php | 13 +- src/Exception/HttpExceptionInterface.php | 11 +- src/Exception/RouteAlreadyExistsException.php | 23 -- src/Helper/CallbackReflector.php | 70 +++++ src/Helper/HeaderParser.php | 244 ++++++++++++++++++ src/Helper/ViewLoader.php | 72 ------ src/Loader/DescriptorLoader.php | 8 +- src/Middleware/CallbackMiddleware.php | 5 +- .../CrossOriginResourceSharingMiddleware.php | 35 +-- src/Middleware/ErrorHandlingMiddleware.php | 93 +++---- .../JsonPayloadDecodingMiddleware.php | 2 +- .../ParameterResolutioner.php | 2 +- .../PathVariableParameterResolver.php | 1 + .../ProvideRouteParameterResolver.php | 3 +- .../RequestEntityParameterResolver.php | 4 +- .../RequestRouteParameterResolver.php | 3 +- .../RequestStreamParameterResolver.php | 52 ++++ .../RequestUriParameterResolver.php | 52 ++++ src/RequestHandler/CallbackRequestHandler.php | 5 +- .../ResponseResolutioner.php | 4 +- ...p => SerializableResponseBodyResolver.php} | 48 ++-- src/Route.php | 7 +- src/RouteCollectionInterface.php | 4 - src/RouteInterface.php | 4 +- src/Router.php | 6 +- src/ServerRequest.php | 75 +++++- src/TypeConversion/TypeConversioner.php | 22 ++ .../TypeConverter/BackedEnumTypeConverter.php | 6 +- 60 files changed, 939 insertions(+), 700 deletions(-) delete mode 100644 functions/parse_header.php delete mode 100644 functions/parse_header_with_media_type.php delete mode 100644 functions/reflect_callback.php rename resources/{views/error.html.php => templates/error.html} (74%) rename src/Annotation/{JsonResponseBody.php => SerializableResponseBody.php} (76%) create mode 100644 src/Entity/Language.php rename src/Event/{ErrorEvent.php => ErrorOccurredEvent.php} (95%) rename src/Event/{RouteEvent.php => RouteMatchedEvent.php} (93%) rename src/EventListener/{WhoopsEventListener.php => ErrorOccurredEventListenerDisplayingFatalError.php} (63%) create mode 100644 src/EventListener/ErrorOccurredEventListenerRenderingHtmlError.php rename src/EventListener/{CommitEventListener.php => ResponseResolvedEventListenerCommittingChanges.php} (57%) delete mode 100644 src/Exception/RouteAlreadyExistsException.php create mode 100644 src/Helper/CallbackReflector.php create mode 100644 src/Helper/HeaderParser.php delete mode 100644 src/Helper/ViewLoader.php create mode 100644 src/ParameterResolving/ParameterResolver/RequestStreamParameterResolver.php create mode 100644 src/ParameterResolving/ParameterResolver/RequestUriParameterResolver.php rename src/ResponseResolving/ResponseResolver/{JsonResponseBodyResponseResolver.php => SerializableResponseBodyResolver.php} (54%) diff --git a/functions/parse_header.php b/functions/parse_header.php deleted file mode 100644 index 7d91e500..00000000 --- a/functions/parse_header.php +++ /dev/null @@ -1,167 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -use Sunrise\Http\Router\Dictionary\Charset; -use Sunrise\Http\Router\Exception\InvalidArgumentException; - -use function sprintf; - -/** - * Parses the given header - * - * @param string $header - * - * @return T - * - * @throws InvalidArgumentException If the given header is invalid. - * - * @template T as list}> - * - * @since 3.0.0 - */ -function parse_header(string $header): array -{ - /** @var T $matches */ - $matches = []; - - $offset = -1; - $inToken = true; - $inParamName = false; - $inParamValue = false; - $inQuotedString = false; - $isQuotedChar = false; - - $tokenIndex = 0; - $paramIndex = 0; - - while (true) { - $offset++; - - $char = $header[$offset] ?? null; - if ($char === null) { - break; - } - - // en-GB; q=0.8[,] ... - // ~~~~~~~~~~~~~^~~~~~ - if (!$inQuotedString && $char === ',') { - $inToken = true; - $inParamName = false; - $inParamValue = false; - $tokenIndex++; - $paramIndex = 0; - continue; - } - // en-GB[;] q=0.8, ... - // ~~~~~~^~~~~~~~~~~~~ - if (!$inQuotedString && $char === ';') { - $inToken = false; - $inParamName = true; - $inParamValue = false; - $paramIndex++; - continue; - } - // en-GB; q[=]0.8, ... - // ~~~~~~~~~^~~~~~~~~~ - if (!$inQuotedString && $char === '=') { - $inToken = false; - $inParamName = false; - $inParamValue = true; - continue; - } - - // en-GB[ ]; q=0.8, ... - // ~~~~~~^~~~~~~~~~~~~~ - if (!$inQuotedString && $inToken && isset(Charset::RFC7230_OWS[$char]) && isset($matches[$tokenIndex][0][0])) { - // The cursor is no longer inside the token, as it cannot contain OWS characters... - $inToken = false; - continue; - } - // en-GB; q[ ]=0.8, ... - // ~~~~~~~~~^~~~~~~~~~~ - // phpcs:ignore Generic.Files.LineLength - if (!$inQuotedString && $inParamName && isset(Charset::RFC7230_OWS[$char]) && isset($matches[$tokenIndex][1][$paramIndex][0][0])) { - // The cursor is no longer inside the parameter name, as it cannot contain OWS characters... - $inParamName = false; - continue; - } - // en-GB; q=0.8[ ], ... - // ~~~~~~~~~~~~~^~~~~~~ - // phpcs:ignore Generic.Files.LineLength - if (!$inQuotedString && $inParamValue && isset(Charset::RFC7230_OWS[$char]) && isset($matches[$tokenIndex][1][$paramIndex][1][0])) { - // The cursor is no longer inside the parameter value, as it cannot contain OWS characters... - $inParamValue = false; - continue; - } - - // Ignore any OWS characters outside the quoted string... - if (!$inQuotedString && isset(Charset::RFC7230_OWS[$char])) { - continue; - } - - // en-GB; q=["]0.8", ... - // ~~~~~~~~~~^~~~~~~~~~~ - if (!$inQuotedString && $inParamValue && $char === '"' && !isset($matches[$tokenIndex][1][$paramIndex][1][0])) { - $inQuotedString = true; - continue; - } - // en-GB; q="0.8["], ... - // ~~~~~~~~~~~~~~^~~~~~~ - if ($inQuotedString && $inParamValue && !$isQuotedChar && $char === '"') { - $inParamValue = false; - $inQuotedString = false; - continue; - } - - // en-GB; param="foo [\]"bar[\]" [\]\0", ... - // ~~~~~~~~~~~~~~~~~~~^~~~~~^~~~~~^~~~~~~~~~ - if ($inQuotedString && !$isQuotedChar && $char === '\\') { - $nextChar = $header[$offset + 1] ?? null; - // phpcs:ignore Generic.Files.LineLength - if (isset($nextChar) && ($nextChar === '\\' || $nextChar === '"' || isset(Charset::RFC7230_QUOTED_STRING[$nextChar]))) { - $isQuotedChar = true; - continue; - } - } - - // [en-GB]; q=0.8, ... - // ~^^^^^~~~~~~~~~~~~~ - if ($inToken) { // AS IS - $matches[$tokenIndex][0] ??= ''; - $matches[$tokenIndex][0] .= $char; - continue; - } - // en-GB; [q]=0.8, ... - // ~~~~~~~~^~~~~~~~~~~ - if ($inParamName && isset(Charset::RFC7230_TOKEN[$char]) && isset($matches[$tokenIndex][0][0])) { - $matches[$tokenIndex][1][$paramIndex][0] ??= ''; - $matches[$tokenIndex][1][$paramIndex][0] .= $char; - continue; - } - // en-GB; q=[0.8], ... - // ~~~~~~~~~~^^^~~~~~~ - // phpcs:ignore Generic.Files.LineLength - if ($inParamValue && (isset(Charset::RFC7230_TOKEN[$char]) || ($inQuotedString && isset(Charset::RFC7230_QUOTED_STRING[$char])) || $isQuotedChar) && isset($matches[$tokenIndex][1][$paramIndex][0][0])) { - $matches[$tokenIndex][1][$paramIndex][1] ??= ''; - $matches[$tokenIndex][1][$paramIndex][1] .= $char; - $isQuotedChar = false; - continue; - } - - throw new InvalidArgumentException(sprintf('Unexpected character at position %d.', $offset)); - } - - return $matches; -} diff --git a/functions/parse_header_with_media_type.php b/functions/parse_header_with_media_type.php deleted file mode 100644 index c53587fd..00000000 --- a/functions/parse_header_with_media_type.php +++ /dev/null @@ -1,103 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -use Generator; -use Sunrise\Http\Router\Dictionary\Charset; -use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Exception\InvalidArgumentException; - -use function sprintf; - -/** - * Parses the given header that contains media types - * - * @param string $header - * - * @return Generator - * - * @throws InvalidArgumentException If one of the media types is invalid. - * - * @since 3.0.0 - */ -function parse_header_with_media_type(string $header): Generator -{ - $matches = parse_header($header); - if ($matches === []) { - return; - } - - foreach ($matches as $index => $match) { - $offset = -1; - - $inType = true; - $inSubtype = false; - - $type = null; - $subtype = null; - - while (true) { - $offset++; - - $char = $match[0][$offset] ?? null; - if ($char === null) { - break; - } - - if ($inType && $char === '/') { - $inType = false; - $inSubtype = true; - continue; - } - - if ($inType && isset(Charset::RFC7230_TOKEN[$char])) { - $type .= $char; - continue; - } - if ($inSubtype && isset(Charset::RFC7230_TOKEN[$char])) { - $subtype .= $char; - continue; - } - - throw new InvalidArgumentException(sprintf( - 'Unexpected character at position %d inside media type with index %d.', - $offset, - $index, - )); - } - - if ($subtype === null) { - throw new InvalidArgumentException(sprintf( - 'Missing subtype for media type with index %d.', - $index, - )); - } - - if ($type === '*' && $subtype !== '*') { - throw new InvalidArgumentException(sprintf( - 'Subtype "*" expected for media type with index %d.', - $index, - )); - } - - $parameters = []; - if (isset($match[1])) { - foreach ($match[1] as $param) { - $parameters[$param[0]] = $param[1] ?? null; - } - } - - yield new MediaType($type, $subtype, $parameters); - } -} diff --git a/functions/reflect_callback.php b/functions/reflect_callback.php deleted file mode 100644 index be81733b..00000000 --- a/functions/reflect_callback.php +++ /dev/null @@ -1,62 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -use Closure; -use InvalidArgumentException; -use ReflectionFunction; -use ReflectionMethod; - -use function function_exists; -use function is_array; -use function is_object; -use function is_string; -use function method_exists; -use function strpos; - -/** - * Tries to reflect the given callback - * - * @param callable $callback - * - * @return ReflectionFunction|ReflectionMethod - * - * @throws InvalidArgumentException If the given callback cannot be reflected. - * - * @since 3.0.0 - */ -function reflect_callback(callable $callback): ReflectionFunction|ReflectionMethod -{ - if ($callback instanceof Closure) { - return new ReflectionFunction($callback); - } - - if (is_array($callback)) { - return new ReflectionMethod(...$callback); - } - - if (is_object($callback) && method_exists($callback, '__invoke')) { - return new ReflectionMethod($callback, '__invoke'); - } - - if (is_string($callback) && strpos($callback, '::')) { - return new ReflectionMethod($callback); - } - - if (is_string($callback) && function_exists($callback)) { - return new ReflectionFunction($callback); - } - - throw new InvalidArgumentException('Unsupported callback notation'); -} diff --git a/resources/views/error.html.php b/resources/templates/error.html similarity index 74% rename from resources/views/error.html.php rename to resources/templates/error.html index 50cb0e49..515728c0 100644 --- a/resources/views/error.html.php +++ b/resources/templates/error.html @@ -1,20 +1,9 @@ - htmlspecialchars($string, ENT_HTML5 | ENT_SUBSTITUTE, 'UTF-8', false); - -?> - <?= sprintf('%d | %s', $this->getStatusCode(), $this->getReasonPhrase()) ?> + {{ error.reasonPhrase }} -
-

{{ error.statusCode }} | {{ error.reasonPhrase }}

+
+

{{ error.reasonPhrase }}

{{ error.message }}

-
- {% for violation in error.violations %} -

{{ violation.source }} {{ violation.message }}

- {% endfor %} -
-
-

- Home - Back -

-
-
+ + {% if error.violations %} +
+ {% for violation in error.violations %} +

{{ violation.source }} {{ violation.message }}

+ {% endfor %} +
+ {% endif %} + + + diff --git a/src/Annotation/SerializableResponseBody.php b/src/Annotation/SerializableResponseBody.php index 2162dd9c..cf3688d8 100644 --- a/src/Annotation/SerializableResponseBody.php +++ b/src/Annotation/SerializableResponseBody.php @@ -25,7 +25,7 @@ final class SerializableResponseBody /** * Constructor of the class * - * @param array $context Serializing context + * @param array $context */ public function __construct(public array $context = []) { diff --git a/src/Entity/Language.php b/src/Entity/Language.php index 7edf337e..c9076a66 100644 --- a/src/Entity/Language.php +++ b/src/Entity/Language.php @@ -13,37 +13,39 @@ namespace Sunrise\Http\Router\Entity; +use Stringable; + /** * Language * * @since 3.0.0 */ -final class Language +final class Language implements Stringable { /** * Constructor of the class * - * @param string $tag + * @param string $code * @param list $subtags * @param array $parameters */ - public function __construct(private string $tag, private array $subtags = [], private array $parameters = []) + public function __construct(private string $code, private array $subtags = [], private array $parameters = []) { } /** - * Gets the language's tag + * Gets the language code * * @return string */ - public function getTag(): string + public function getCode(): string { - return $this->tag; + return $this->code; } /** - * Gets the language's subtags + * Gets the language subtags * * @return list */ @@ -53,7 +55,7 @@ public function getSubtags(): array } /** - * Gets the language's parameters + * Gets the language parameters * * @return array */ @@ -63,12 +65,41 @@ public function getParameters(): array } /** - * Gets the language's quality factor + * Gets the language parameter's value by the given its name or + * returns the given default value if the parameter doesn't exist or is empty + * + * @param string $name + * @param ?string $default * - * @return float + * @return ?string */ - public function getQualityFactor(): float + public function getParameter(string $name, ?string $default = null): ?string { - return (float) ($this->parameters['q'] ?? 1); + return isset($this->parameters[$name][0]) ? $this->parameters[$name] : $default; + } + + /** + * Checks if this language equals to the given language + * + * @param Language $other + * + * @return bool + */ + public function equals(Language $other): bool + { + return $this->code === '*' || $other->code === '*' || $this->code === $other->code; + } + + /** + * @inheritDoc + */ + public function __toString(): string + { + $result = $this->code; + foreach ($this->subtags as $subtag) { + $result .= '-' . $subtag; + } + + return $result; } } diff --git a/src/Entity/MediaType.php b/src/Entity/MediaType.php index 722dc84b..0ed7bcb3 100644 --- a/src/Entity/MediaType.php +++ b/src/Entity/MediaType.php @@ -37,7 +37,7 @@ public function __construct(private string $type, private string $subtype, priva } /** - * Creates the json media type + * Creates the json media type with the given parameters * * @param array $parameters * @@ -49,7 +49,7 @@ public static function json(array $parameters = []): self } /** - * Creates the xml media type + * Creates the xml media type with the given parameters * * @param array $parameters * @@ -61,7 +61,7 @@ public static function xml(array $parameters = []): self } /** - * Creates the yaml media type + * Creates the yaml media type with the given parameters * * @param array $parameters * @@ -73,7 +73,7 @@ public static function yaml(array $parameters = []): self } /** - * Creates the html media type + * Creates the html media type with the given parameters * * @param array $parameters * @@ -85,7 +85,7 @@ public static function html(array $parameters = []): self } /** - * Creates the text media type + * Creates the text media type with the given parameters * * @param array $parameters * @@ -97,7 +97,7 @@ public static function text(array $parameters = []): self } /** - * Creates the image media range + * Creates the image media range with the given parameters * * @param array $parameters * @@ -139,13 +139,17 @@ public function getParameters(): array } /** - * Gets the media type quality factor + * Gets the media type parameter's value by the given its name or + * returns the given default value if the parameter doesn't exist or is empty * - * @return float + * @param string $name + * @param ?string $default + * + * @return ?string */ - public function getQualityFactor(): float + public function getParameter(string $name, ?string $default = null): ?string { - return (float) ($this->parameters['q'] ?? 1.); + return isset($this->parameters[$name][0]) ? $this->parameters[$name] : $default; } /** @@ -162,7 +166,7 @@ public function equals(MediaType $other): bool } /** - * Build the media type + * Build the media type with the given parameters * * @param array $parameters * diff --git a/src/EventListener/ErrorOccurredEventListenerDisplayingFatalError.php b/src/EventListener/ErrorOccurredEventListenerDisplayingFatalError.php index ea528059..9b2814b4 100644 --- a/src/EventListener/ErrorOccurredEventListenerDisplayingFatalError.php +++ b/src/EventListener/ErrorOccurredEventListenerDisplayingFatalError.php @@ -81,9 +81,12 @@ public function __invoke(ErrorOccurredEvent $event): ErrorOccurredEvent $whoops->pushHandler(new XmlResponseHandler()); } - $response = $event->getResponse(); - $response = $response->withHeader('Content-Type', $clientPreferredMediaType->build(['charset' => 'UTF-8'])); - $response->getBody()->write($whoops->handleException($error->getError())); + $response = $event->getResponse() + ->withHeader('Content-Type', $clientPreferredMediaType->build(['charset' => 'UTF-8'])); + + $response->getBody()->write( + $whoops->handleException($error->getError()) + ); $event->setResponse($response); $event->stopPropagation(); diff --git a/src/EventListener/ErrorOccurredEventListenerRenderingHtmlError.php b/src/EventListener/ErrorOccurredEventListenerRenderingHtmlError.php index 2a984f61..69297c5e 100644 --- a/src/EventListener/ErrorOccurredEventListenerRenderingHtmlError.php +++ b/src/EventListener/ErrorOccurredEventListenerRenderingHtmlError.php @@ -64,13 +64,14 @@ public function __invoke(ErrorOccurredEvent $event): ErrorOccurredEvent $loader->addPath(__DIR__ . '/../../resources/templates'); } - $html = $this->twig->render('error.html', [ - 'error' => ErrorDto::fromHttpError($error), - ]); + $response = $event->getResponse() + ->withHeader('Content-Type', 'text/html; charset=UTF-8'); - $response = $event->getResponse(); - $response = $response->withHeader('Content-Type', MediaType::html()->build(['charset' => 'UTF-8'])); - $response->getBody()->write($html); + $response->getBody()->write( + $this->twig->render('error.html', [ + 'error' => ErrorDto::fromHttpError($error), + ]) + ); $event->setResponse($response); diff --git a/src/Helper/HeaderParser.php b/src/Helper/HeaderParser.php index ff20459f..ba12d72f 100644 --- a/src/Helper/HeaderParser.php +++ b/src/Helper/HeaderParser.php @@ -31,214 +31,233 @@ final class HeaderParser { /** + * Parses the given "Accept" header or any other semantically similar header + * * @param string $header + * @param bool $supportRange * - * @return Generator + * @return Generator * * @throws InvalidArgumentException If the header isn't valid. */ - public static function parseAcceptHeader(string $header): Generator + public static function parseAcceptHeader(string $header, bool $supportRange = true): Generator { $matches = self::parseHeader($header); - foreach ($matches as $match) { - $range = explode('/', $match[0], 2); + foreach ($matches as $index => [$keyword, $parameterNames, $parameterValues]) { + $range = explode('/', $keyword, 3); - yield new MediaType($range[0], $range[1] ?? '*', $match[1]); - } - } + if ($range[0] === '' || !isset($range[1]) || $range[1] === '' || isset($range[2])) { + throw new InvalidArgumentException(sprintf( + 'The media type with index %d has an incorrect format.', + $index, + )); + } - /** - * @param string $header - * - * @return Generator - * - * @throws InvalidArgumentException If the header isn't valid. - */ - public static function parseAcceptLanguageHeader(string $header): Generator - { - $matches = self::parseHeader($header); - foreach ($matches as $match) { - $tags = explode('-', $match[0]); + if ($range[0] === '*' && $range[1] !== '*') { + throw new InvalidArgumentException(sprintf( + 'The media type with index %d has an incorrect range.', + $index, + )); + } - $tag = $tags[0]; - unset($tags[0]); + if (!$supportRange && ($range[0] === '*' || $range[1] === '*')) { + throw new InvalidArgumentException(sprintf( + 'The media type with index %d cannot be a range.', + $index, + )); + } + + $parameters = []; + foreach ($parameterNames as $parameterIndex => $parameterName) { + $parameters[$parameterName] = $parameterValues[$parameterIndex] ?? null; + } - yield new Language($tag, [...$tags], $match[1]); + yield new MediaType($range[0], $range[1], $parameters); } } /** + * Parses the given "Accept-Language" header or any other semantically similar header + * * @param string $header * - * @return MediaType|null + * @return Generator * * @throws InvalidArgumentException If the header isn't valid. */ - public static function parseContentTypeHeader(string $header): ?MediaType + public static function parseAcceptLanguageHeader(string $header): Generator { $matches = self::parseHeader($header); - if (!$matches->valid()) { - return null; - } + foreach ($matches as $index => [$keyword, $parameterNames, $parameterValues]) { + $tags = explode('-', $keyword); - $match = $matches->current(); + foreach ($tags as $key => $tag) { + if ($tag === '') { + throw new InvalidArgumentException(sprintf( + 'The language with index %d has an empty tag with index %d.', + $index, + $key, + )); + } + } - $range = explode('/', $match[0], 2); + $code = $tags[0]; + unset($tags[0]); + + $parameters = []; + foreach ($parameterNames as $parameterIndex => $parameterName) { + $parameters[$parameterName] = $parameterValues[$parameterIndex] ?? null; + } - return new MediaType($range[0], $range[1] ?? '*', $match[1]); + yield new Language($code, [...$tags], $parameters); + } } /** - * Parses the given header, such as Accept, Content-Type, etc. + * Parses the given header, which is semantically similar to the "Accept" header * * @param string $header * - * @return Generator}> + * @return Generator * * @throws InvalidArgumentException If the header isn't valid. */ private static function parseHeader(string $header): Generator { - /** - * Prepares the given match for the return - * - * @param array{0: string, 1?: array} $match - * - * @return array{0: string, 1: array} - */ - $return = static function (array $match): array { - $params = []; - foreach ($match[1] ?? [] as $param) { - $params[$param[0]] = $param[1] ?? null; - } - - return [$match[0], $params]; - }; - - /** @var array{0?: string, 1?: array} $match */ - $match = []; + /** @var array{0: ?string, 1: string[], 2: string[]} $match */ + $match = [null, [], []]; + $offset = -1; $inKeyword = true; - $paramIndex = -1; - $inParamName = false; - $inParamValue = false; + $parameterIndex = -1; + $inParameterName = false; + $inParameterValue = false; $inQuotedString = false; $isQuotedChar = false; - $offset = -1; while (isset($header[++$offset])) { - // https://tools.ietf.org/html/rfc7230#section-3.2 if (!isset(Charset::RFC7230_FIELD_VALUE[$header[$offset]])) { - throw new InvalidArgumentException(sprintf('Invalid character at position %d.', $offset)); + throw new InvalidArgumentException(sprintf( + 'Unallowed character at position %d.', + $offset, + )); } - // en-GB; q=0.9[,]... - // ~~~~~~~~~~~~~^~~~~ - if (!$inQuotedString && $header[$offset] === ',') { - if (isset($match[0])) { - yield $return($match); + if (!$inQuotedString) { + if ($header[$offset] === ',') { + if (!isset($match[0])) { + throw new InvalidArgumentException(sprintf( + 'The character "%s" at position %d must be preceded by a non-empty keyword.', + $header[$offset], + $offset, + )); + } + + yield $match; + $match = [null, [], []]; + $inKeyword = true; + $parameterIndex = -1; + $inParameterName = false; + $inParameterValue = false; + continue; } + if ($header[$offset] === ';') { + if (!isset($match[0]) || !isset($match[1][$parameterIndex]) && $parameterIndex > -1) { + throw new InvalidArgumentException(sprintf( + 'The character "%s" at position %d must be preceded by a non-empty keyword or parameter.', + $header[$offset], + $offset, + )); + } - $match = []; - $inKeyword = true; - $paramIndex = 0; - $inParamName = false; - $inParamValue = false; - continue; - } - // en-GB[;] q=0.9,... - // ~~~~~~^~~~~~~~~~~~ - if (!$inQuotedString && $header[$offset] === ';') { - $inKeyword = false; - $paramIndex++; - $inParamName = true; - $inParamValue = false; - continue; - } - // en-GB; q[=]0.9,... - // ~~~~~~~~~^~~~~~~~~ - if ($inParamName && $header[$offset] === '=') { - $inParamName = false; - $inParamValue = true; - continue; - } + $inKeyword = false; + $parameterIndex++; + $inParameterName = true; + $inParameterValue = false; + continue; + } + if ($header[$offset] === '=') { + if (!isset($match[1][$parameterIndex]) || $inParameterValue || isset($match[2][$parameterIndex])) { + throw new InvalidArgumentException(sprintf( + 'The character "%s" at position %d must be preceded by a non-empty parameter name.', + $header[$offset], + $offset, + )); + } - // en-GB[ ]; q=0.9,... - // ~~~~~~^~~~~~~~~~~~~ - if ($inKeyword && isset(Charset::RFC7230_OWS[$header[$offset]]) && isset($match[0])) { - $inKeyword = false; - continue; - } - // en-GB; q[ ]=0.9,... - // ~~~~~~~~~^~~~~~~~~~ - if ($inParamName && isset(Charset::RFC7230_OWS[$header[$offset]]) && isset($match[1][$paramIndex][0])) { - $inParamName = false; - continue; - } - // en-GB; q=0.9[ ],... - // ~~~~~~~~~~~~~^~~~~~ - // phpcs:ignore Generic.Files.LineLength - if ($inParamValue && !$inQuotedString && isset(Charset::RFC7230_OWS[$header[$offset]]) && isset($match[1][$paramIndex][1])) { - $inParamValue = false; - continue; - } + $inParameterName = false; + $inParameterValue = true; + continue; + } + if ($header[$offset] === '"') { + if (!$inParameterValue || isset($match[2][$parameterIndex])) { + throw new InvalidArgumentException(sprintf( + 'The character "%s" at position %d must be the first in a parameter value.', + $header[$offset], + $offset, + )); + } - // [ ]en-GB;[ ]q=[ ]0.9,... - // ~^~~~~~~~~^~~~~^~~~~~~~~ - if (!$inQuotedString && isset(Charset::RFC7230_OWS[$header[$offset]])) { - continue; - } + $inQuotedString = true; + continue; + } - // en-GB; q=["]0.9",... - // ~~~~~~~~~~^~~~~~~~~~ - if ($inParamValue && !$inQuotedString && $header[$offset] === '"' && !isset($match[1][$paramIndex][1])) { - $inQuotedString = true; - continue; - } - // en-US; foo="[\\][\"][\*]",... - // ~~~~~~~~~~~~~^^~~^^~~^^~~~~~~ - // phpcs:ignore Generic.Files.LineLength - if ($inQuotedString && !$isQuotedChar && $header[$offset] === '\\' && isset($header[$offset + 1]) && ($header[$offset + 1] === '\\' || $header[$offset + 1] === '"' || isset(Charset::RFC7230_QUOTED_STRING[$header[$offset + 1]]))) { - $isQuotedChar = true; - continue; + if (isset(Charset::RFC7230_OWS[$header[$offset]])) { + if ($inKeyword && isset($match[0])) { + $inKeyword = false; + continue; + } + if ($inParameterName && isset($match[1][$parameterIndex])) { + $inParameterName = false; + continue; + } + if ($inParameterValue && isset($match[2][$parameterIndex])) { + $inParameterValue = false; + continue; + } + + // any whitespaces must be ignored... + continue; + } } - // en-GB; q="0.9["],... - // ~~~~~~~~~~~~~~^~~~~~ - if ($inQuotedString && !$isQuotedChar && $header[$offset] === '"') { - $inParamValue = false; - $inQuotedString = false; - continue; + + if ($inQuotedString && !$isQuotedChar) { + if ($header[$offset] === '\\') { + $isQuotedChar = true; + continue; + } + if ($header[$offset] === '"') { + $inQuotedString = false; + $inParameterValue = false; + continue; + } } - // [en-GB]; q=0.9,... - // ~^^^^^~~~~~~~~~~~~ - if ($inKeyword) { // AS IS + if ($inKeyword) { $match[0] ??= ''; $match[0] .= $header[$offset]; continue; } - // en-GB; [q]=0.9,... - // ~~~~~~~~^~~~~~~~~~ - if ($inParamName && isset(Charset::RFC7230_TOKEN[$header[$offset]]) && isset($match[0])) { - $match[1][$paramIndex][0] ??= ''; - $match[1][$paramIndex][0] .= $header[$offset]; + if ($inParameterName && isset(Charset::RFC7230_TOKEN[$header[$offset]])) { + $match[1][$parameterIndex] ??= ''; + $match[1][$parameterIndex] .= $header[$offset]; continue; } - // en-GB; q=[0.9],... - // ~~~~~~~~~~^^^~~~~~ - // phpcs:ignore Generic.Files.LineLength - if ($inParamValue && (isset(Charset::RFC7230_TOKEN[$header[$offset]]) || ($inQuotedString && isset(Charset::RFC7230_QUOTED_STRING[$header[$offset]])) || $isQuotedChar) && isset($match[1][$paramIndex][0])) { - $match[1][$paramIndex][1] ??= ''; - $match[1][$paramIndex][1] .= $header[$offset]; + if ($inParameterValue && (isset(Charset::RFC7230_TOKEN[$header[$offset]])) || $inQuotedString) { + $match[2][$parameterIndex] ??= ''; + $match[2][$parameterIndex] .= $header[$offset]; $isQuotedChar = false; continue; } - throw new InvalidArgumentException(sprintf('Unexpected character at position %d.', $offset)); + throw new InvalidArgumentException(sprintf( + 'Unexpected character at position %d.', + $offset, + )); } if (isset($match[0])) { - yield $return($match); + yield $match; } } } diff --git a/src/ParameterResolving/ParameterResolver/ServerRequestParameterResolver.php b/src/ParameterResolving/ParameterResolver/ServerRequestParameterResolver.php new file mode 100644 index 00000000..adf23b70 --- /dev/null +++ b/src/ParameterResolving/ParameterResolver/ServerRequestParameterResolver.php @@ -0,0 +1,52 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; + +use Generator; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionNamedType; +use ReflectionParameter; +use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\ServerRequest; + +/** + * ServerRequestParameterResolver + * + * @since 3.0.0 + */ +final class ServerRequestParameterResolver implements ParameterResolverInterface +{ + + /** + * @inheritDoc + * + * @throws LogicException If the resolver is used incorrectly. + */ + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + { + $type = $parameter->getType(); + + if (! $type instanceof ReflectionNamedType || $type->getName() !== ServerRequest::class) { + return; + } + + if (! $context instanceof ServerRequestInterface) { + throw new LogicException( + 'At this level of the application, any operations with the request are not possible.' + ); + } + + yield ServerRequest::from($context); + } +} diff --git a/src/Router.php b/src/Router.php index c0c7c38b..a775e6ae 100644 --- a/src/Router.php +++ b/src/Router.php @@ -239,8 +239,10 @@ public function match(ServerRequestInterface $request): RouteInterface continue; } - if (!$request->clientProducesMediaType(...$route->getConsumesMediaTypes())) { - throw new HttpUnsupportedMediaTypeException($route->getConsumesMediaTypes()); + $serverConsumesMediaTypes = $route->getConsumesMediaTypes(); + if (!empty($serverConsumesMediaTypes)) { + $request->clientProducesMediaType(...$serverConsumesMediaTypes) or + throw new HttpUnsupportedMediaTypeException($serverConsumesMediaTypes); } /** @var array $attributes */ diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 9614efd4..c339c649 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -22,15 +22,14 @@ use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Exception\LogicException; - use Sunrise\Http\Router\Helper\HeaderParser; -use function reset; + +use function current; use function sprintf; -use function strpos; use function usort; /** - * ServerRequest + * Server Request Proxy * * @since 3.0.0 */ @@ -72,12 +71,33 @@ public function getOriginalRequest(): ServerRequestInterface return $this->request; } + /** + * Gets a media type that the client produced + * + * @return MediaType|null + * + * @throws HttpBadRequestException If the "Content-Type" header isn't valid. + */ + public function getClientProducedMediaType(): ?MediaType + { + $header = $this->request->getHeaderLine('Content-Type'); + + try { + return HeaderParser::parseAcceptHeader($header, supportRange: false)->current(); + } catch (InvalidArgumentException $e) { + throw new HttpBadRequestException(sprintf( + 'The "Content-Type" header is invalid: %s', + $e->getMessage(), + ), previous: $e); + } + } + /** * Gets media types that the client consumes * * @return Generator * - * @throws HttpBadRequestException If the Accept header isn't valid. + * @throws HttpBadRequestException If the "Accept" header isn't valid. */ public function getClientConsumesMediaTypes(): Generator { @@ -87,7 +107,7 @@ public function getClientConsumesMediaTypes(): Generator yield from HeaderParser::parseAcceptHeader($header); } catch (InvalidArgumentException $e) { throw new HttpBadRequestException(sprintf( - 'The Accept header is invalid. %s', + 'The "Accept" header is invalid: %s', $e->getMessage(), ), previous: $e); } @@ -98,7 +118,7 @@ public function getClientConsumesMediaTypes(): Generator * * @return Generator * - * @throws HttpBadRequestException If the Accept-Language header isn't valid. + * @throws HttpBadRequestException If the "Accept-Language" header isn't valid. */ public function getClientConsumesLanguages(): Generator { @@ -108,31 +128,82 @@ public function getClientConsumesLanguages(): Generator yield from HeaderParser::parseAcceptLanguageHeader($header); } catch (InvalidArgumentException $e) { throw new HttpBadRequestException(sprintf( - 'The Accept-Language header is invalid. %s', + 'The "Accept-Language" header is invalid: %s', $e->getMessage(), ), previous: $e); } } /** - * Gets a media type that the client produced + * Gets the client's preferred media type * - * @return MediaType|null + * @param MediaType ...$serverProducesMediaTypes + * + * @return MediaType * - * @throws HttpBadRequestException If the Content-Type header isn't valid. + * @throws LogicException If the list of produces media types is empty. */ - public function getClientProducedMediaType(): ?MediaType + public function getClientPreferredMediaType(MediaType ...$serverProducesMediaTypes): MediaType { - $header = $this->request->getHeaderLine('Content-Type'); + if ($serverProducesMediaTypes === []) { + throw new LogicException('The media types that the server produces must be provided.'); + } - try { - return HeaderParser::parseContentTypeHeader($header); - } catch (InvalidArgumentException $e) { - throw new HttpBadRequestException(sprintf( - 'The Content-Type header is invalid. %s', - $e->getMessage(), - ), previous: $e); + /** @var list $clientConsumesMediaTypes */ + $clientConsumesMediaTypes = [...$this->getClientConsumesMediaTypes()]; + if ($clientConsumesMediaTypes === []) { + return current($serverProducesMediaTypes); } + + usort($clientConsumesMediaTypes, static fn(MediaType $a, MediaType $b): int => ( + $b->getParameter('q', '1.0') <=> $a->getParameter('q', '1.0') + )); + + foreach ($clientConsumesMediaTypes as $clientConsumesMediaType) { + foreach ($serverProducesMediaTypes as $serverProducesMediaType) { + if ($serverProducesMediaType->equals($clientConsumesMediaType)) { + return $serverProducesMediaType; + } + } + } + + return current($serverProducesMediaTypes); + } + + /** + * Gets the client's preferred language + * + * @param Language ...$serverProducesLanguages + * + * @return Language + * + * @throws LogicException If the list of produces languages is empty. + */ + public function getClientPreferredLanguage(Language ...$serverProducesLanguages): Language + { + if ($serverProducesLanguages === []) { + throw new LogicException('The languages that the server produces must be provided.'); + } + + /** @var list $clientConsumesLanguages */ + $clientConsumesLanguages = [...$this->getClientConsumesLanguages()]; + if ($clientConsumesLanguages === []) { + return current($serverProducesLanguages); + } + + usort($clientConsumesLanguages, static fn(Language $a, Language $b): int => ( + $b->getParameter('q', '1.0') <=> $a->getParameter('q', '1.0') + )); + + foreach ($clientConsumesLanguages as $clientConsumesLanguage) { + foreach ($serverProducesLanguages as $serverProducesLanguage) { + if ($serverProducesLanguage->equals($clientConsumesLanguage)) { + return $serverProducesLanguage; + } + } + } + + return current($serverProducesLanguages); } /** @@ -141,11 +212,13 @@ public function getClientProducedMediaType(): ?MediaType * @param MediaType ...$serverConsumesMediaTypes * * @return bool + * + * @throws LogicException If the media types that the server consumes were not provided. */ public function clientProducesMediaType(MediaType ...$serverConsumesMediaTypes): bool { if ($serverConsumesMediaTypes === []) { - return true; + throw new LogicException('The media types that the server consumes must be provided.'); } $clientProducedMediaType = $this->getClientProducedMediaType(); @@ -162,57 +235,31 @@ public function clientProducesMediaType(MediaType ...$serverConsumesMediaTypes): return false; } - public function clientConsumesMediaType(MediaType ...$serverProducesMediaTypes): bool - { - $clientConsumesMediaTypes = $this->getClientConsumesMediaTypes(); - foreach ($clientConsumesMediaTypes as $clientConsumesMediaType) { - foreach ($serverProducesMediaTypes as $serverProducesMediaType) { - if ($serverProducesMediaType->equals($clientConsumesMediaType)) { - return true; - } - } - } - - return false; - } - /** - * Gets the client's preferred media type + * Checks if the client consumes one of the given media types * * @param MediaType ...$serverProducesMediaTypes * - * @return MediaType + * @return bool * - * @throws LogicException If the list of produces media types is empty. + * @throws LogicException If the media types that the server produces were not provided. */ - public function getClientPreferredMediaType(MediaType ...$serverProducesMediaTypes): MediaType + public function clientConsumesMediaType(MediaType ...$serverProducesMediaTypes): bool { if ($serverProducesMediaTypes === []) { - throw new LogicException( - 'The list of media types produced by the server is empty, ' . - 'making it impossible to determine the preferred media type for the client.' - ); + throw new LogicException('The media types that the server produces must be provided.'); } - /** @var list $clientConsumesMediaTypes */ - $clientConsumesMediaTypes = [...$this->getClientConsumesMediaTypes()]; - if ($clientConsumesMediaTypes === []) { - return reset($serverProducesMediaTypes); - } - - usort($clientConsumesMediaTypes, static fn(MediaType $a, MediaType $b): int => ( - $b->getQualityFactor() <=> $a->getQualityFactor() - )); - + $clientConsumesMediaTypes = $this->getClientConsumesMediaTypes(); foreach ($clientConsumesMediaTypes as $clientConsumesMediaType) { foreach ($serverProducesMediaTypes as $serverProducesMediaType) { if ($serverProducesMediaType->equals($clientConsumesMediaType)) { - return $serverProducesMediaType; + return true; } } } - return reset($serverProducesMediaTypes); + return false; } /** diff --git a/src/TypeConversion/TypeConversioner.php b/src/TypeConversion/TypeConversioner.php index 2bd19601..bef038c3 100644 --- a/src/TypeConversion/TypeConversioner.php +++ b/src/TypeConversion/TypeConversioner.php @@ -18,7 +18,7 @@ use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\TypeConversion\TypeConverter\BackedEnumTypeConverter; use Sunrise\Http\Router\TypeConversion\TypeConverter\BoolTypeConverter; -use Sunrise\Http\Router\TypeConversion\TypeConverter\DateTimeTypeConverter; +use Sunrise\Http\Router\TypeConversion\TypeConverter\TimestampTypeConverter; use Sunrise\Http\Router\TypeConversion\TypeConverter\FloatTypeConverter; use Sunrise\Http\Router\TypeConversion\TypeConverter\IntTypeConverter; use Sunrise\Http\Router\TypeConversion\TypeConverter\StringTypeConverter; @@ -81,6 +81,6 @@ public static function defaultConverters(): Generator yield new FloatTypeConverter(); yield new StringTypeConverter(); yield new BackedEnumTypeConverter(); - yield new DateTimeTypeConverter(); + yield new TimestampTypeConverter(); } } diff --git a/src/TypeConversion/TypeConverter/DateTimeTypeConverter.php b/src/TypeConversion/TypeConverter/TimestampTypeConverter.php similarity index 96% rename from src/TypeConversion/TypeConverter/DateTimeTypeConverter.php rename to src/TypeConversion/TypeConverter/TimestampTypeConverter.php index 3f98a0ef..b39a40bb 100644 --- a/src/TypeConversion/TypeConverter/DateTimeTypeConverter.php +++ b/src/TypeConversion/TypeConverter/TimestampTypeConverter.php @@ -30,7 +30,7 @@ /** * @since 3.0.0 */ -final class DateTimeTypeConverter implements TypeConverterInterface +final class TimestampTypeConverter implements TypeConverterInterface { /** diff --git a/tests/RouterTest.php b/tests/RouterTest.php index 8fa81167..81be7102 100644 --- a/tests/RouterTest.php +++ b/tests/RouterTest.php @@ -5,10 +5,9 @@ use PHPUnit\Framework\TestCase; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Event\RouteEvent; +use Sunrise\Http\Router\Event\RouteMatchedEvent; use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Exception\MethodNotAllowedException; -use Sunrise\Http\Router\Exception\PageNotFoundException; use Sunrise\Http\Router\Exception\RouteNotFoundException; use Sunrise\Http\Router\Middleware\CallbackMiddleware; use Sunrise\Http\Router\Loader\LoaderInterface; @@ -395,11 +394,11 @@ public function testMatchWithUndefinedRoute() : void $request = (new ServerRequestFactory) ->createServerRequest($routes[0]->getMethods()[0], '/'); - $this->expectException(PageNotFoundException::class); + $this->expectException(RouteNotFoundException::class); try { $router->match($request); - } catch (PageNotFoundException $e) { + } catch (RouteNotFoundException $e) { throw $e; } } @@ -847,7 +846,7 @@ public function testRouteEvent() : void ); $eventDispatcher = new EventDispatcher(); - $eventDispatcher->addListener(RouteEvent::NAME, function (RouteEvent $event) use ($routes, $request) { + $eventDispatcher->addListener(RouteMatchedEvent::NAME, function (RouteMatchedEvent $event) use ($routes, $request) { $this->assertSame($routes[1]->getName(), $event->getRoute()->getName()); $this->assertSame($request, $event->getRequest()); }); @@ -872,7 +871,7 @@ public function testRouteEventOverrideRequest() : void ); $eventDispatcher = new EventDispatcher(); - $eventDispatcher->addListener(RouteEvent::NAME, function (RouteEvent $event) use ($request) { + $eventDispatcher->addListener(RouteMatchedEvent::NAME, function (RouteMatchedEvent $event) use ($request) { $event->setRequest($request->withAttribute('foo', 'bar')); $this->assertNotSame($request, $event->getRequest()); }); From 88af378c0a98494f8b063598c20ec2667d10b483 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 17 Sep 2023 07:39:04 +0200 Subject: [PATCH 086/180] v3 --- functions/path_regex.php | 3 +- resources/templates/error.html | 11 +- src/Annotation/{Commit.php => Deprecated.php} | 13 +- src/Annotation/Description.php | 2 +- src/Annotation/RequestEntity.php | 2 +- src/Annotation/Route.php | 26 +-- src/Dictionary/Charset.php | 31 --- src/Dictionary/ErrorSource.php | 41 ++++ src/Dto/ErrorDto.php | 3 + src/Entity/Language.php | 15 +- src/Entity/MediaType.php | 17 +- src/Event/AbstractEvent.php | 2 + ...urredEventListenerDisplayingFatalError.php | 10 +- ...ccurredEventListenerRenderingHtmlError.php | 3 +- ...ResolvedEventListenerCommittingChanges.php | 59 ------ .../Http/HttpFailedDependencyException.php | 5 +- src/Exception/Http/HttpForbiddenException.php | 4 +- .../Http/HttpInternalServerErrorException.php | 2 + .../Http/HttpMethodNotAllowedException.php | 5 +- src/Exception/Http/HttpNotFoundException.php | 2 + .../Http/HttpPayloadTooLargeException.php | 2 + .../Http/HttpServiceUnavailableException.php | 2 + .../Http/HttpUnauthorizedException.php | 2 + ...ttpUnavailableForLegalReasonsException.php | 2 +- .../HttpUnsupportedMediaTypeException.php | 3 +- src/Exception/HttpException.php | 30 +++ src/Exception/HttpExceptionInterface.php | 7 + src/Exception/RuntimeException.php | 25 +++ src/Helper/HeaderParser.php | 14 +- src/Loader/DescriptorLoader.php | 16 +- .../CrossOriginResourceSharingMiddleware.php | 4 +- src/Middleware/ErrorHandlingMiddleware.php | 3 +- .../JsonPayloadDecodingMiddleware.php | 27 ++- .../PathVariableParameterResolver.php | 13 +- .../ProvideRouteParameterResolver.php | 12 +- .../RequestBodyParameterResolver.php | 12 +- .../RequestCookieParameterResolver.php | 23 +-- .../RequestEntityParameterResolver.php | 48 ++--- .../RequestHeaderParameterResolver.php | 24 +-- .../RequestQueryParameterResolver.php | 12 +- src/RequestHandler/CallbackRequestHandler.php | 14 +- .../QueueableRequestHandler.php | 9 +- .../SerializableResponseBodyResolver.php | 11 +- src/Route.php | 113 ++++++----- src/RouteCollection.php | 68 ++----- src/RouteCollectionFactoryInterface.php | 2 +- src/RouteCollectionInterface.php | 83 +++----- src/RouteCollector.php | 103 ++++++---- src/RouteFactory.php | 4 +- src/RouteFactoryInterface.php | 2 +- src/RouteInterface.php | 130 ++++++------ src/Router.php | 191 +++++++++++++----- src/ServerRequest.php | 34 ++-- .../TypeConverter/TimestampTypeConverter.php | 4 +- 54 files changed, 731 insertions(+), 574 deletions(-) rename src/Annotation/{Commit.php => Deprecated.php} (60%) create mode 100644 src/Dictionary/ErrorSource.php delete mode 100644 src/EventListener/ResponseResolvedEventListenerCommittingChanges.php create mode 100644 src/Exception/RuntimeException.php diff --git a/functions/path_regex.php b/functions/path_regex.php index bf287177..7c0aca7f 100644 --- a/functions/path_regex.php +++ b/functions/path_regex.php @@ -43,8 +43,7 @@ function path_regex(string $path) : string $path = str_replace(['(', ')'], ['(?:', ')?'], $path); foreach ($matches as $match) { - $pattern = $match['pattern'] ?? '[^/]+'; - $subpattern = '(?<' . $match['name'] . '>' . $pattern . ')'; + $subpattern = '(?<' . $match['name'] . '>' . ($match['pattern'] ?? '[^/]+') . ')'; $path = str_replace('{' . $match['name'] . '}', $subpattern, $path); } diff --git a/resources/templates/error.html b/resources/templates/error.html index a1350968..f167d610 100644 --- a/resources/templates/error.html +++ b/resources/templates/error.html @@ -5,8 +5,11 @@ {{ error.reasonPhrase }}
-

{{ reasonPhrase }}

- -

{{ error.source }} {{ error.message }}

- +

Oops! Error {{ statusCode }} — {{ reasonPhrase }}

+

{{ error.message }} {{ error.source }}

{% if error.violations %}
{% for violation in error.violations %} @@ -66,10 +63,10 @@

{{ reasonPhrase }}

{% endfor %}
{% endif %} -
diff --git a/src/RouteCollection.php b/src/RouteCollection.php index b1fe8708..9e5e46a1 100644 --- a/src/RouteCollection.php +++ b/src/RouteCollection.php @@ -179,18 +179,6 @@ public function addTag(string ...$tags): static return $this; } - /** - * @inheritDoc - */ - public function setAttribute(string $name, mixed $value): static - { - foreach ($this->routes as $route) { - $route->setAttribute($name, $value); - } - - return $this; - } - /** * @inheritDoc */ @@ -205,6 +193,8 @@ public function setDeprecation(bool $isDeprecated): static /** * @inheritDoc + * + * @since 3.0.0 */ public function count(): int { @@ -213,6 +203,8 @@ public function count(): int /** * @inheritDoc + * + * @since 3.0.0 */ public function getIterator(): Traversable { diff --git a/src/RouteCollectionInterface.php b/src/RouteCollectionInterface.php index 5d6e8c6d..b5621d5b 100644 --- a/src/RouteCollectionInterface.php +++ b/src/RouteCollectionInterface.php @@ -153,18 +153,6 @@ public function addMiddleware(MiddlewareInterface ...$middlewares): static; */ public function addTag(string ...$tags): static; - /** - * Sets the given attribute to all routes in the collection - * - * @param string $name - * @param mixed $value - * - * @return static - * - * @since 3.0.0 - */ - public function setAttribute(string $name, mixed $value): static; - /** * Sets the given deprecation sign to all routes in the collection * From 30184a86664d2c3f28e196ca6ca0e73a7b0419d1 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 17 Nov 2023 02:31:09 +0100 Subject: [PATCH 095/180] v3 --- ...orOccurredEventAbstract.php => ErrorOccurredEvent.php} | 2 +- ...esolvedEventAbstract.php => ResponseResolvedEvent.php} | 2 +- ...outeMatchedEventAbstract.php => RouteMatchedEvent.php} | 2 +- .../ErrorOccurredEventListenerDisplayingFatalError.php | 8 ++++---- .../ErrorOccurredEventListenerRenderingHtmlError.php | 8 ++++---- ...ErrorOccurredEventListenerRenderingSerializedError.php | 8 ++++---- src/Middleware/ErrorHandlingMiddleware.php | 4 ++-- src/ResponseResolving/ResponseResolutioner.php | 4 ++-- src/Router.php | 6 +++--- 9 files changed, 22 insertions(+), 22 deletions(-) rename src/Event/{ErrorOccurredEventAbstract.php => ErrorOccurredEvent.php} (96%) rename src/Event/{ResponseResolvedEventAbstract.php => ResponseResolvedEvent.php} (96%) rename src/Event/{RouteMatchedEventAbstract.php => RouteMatchedEvent.php} (95%) diff --git a/src/Event/ErrorOccurredEventAbstract.php b/src/Event/ErrorOccurredEvent.php similarity index 96% rename from src/Event/ErrorOccurredEventAbstract.php rename to src/Event/ErrorOccurredEvent.php index 18086ebd..64479145 100644 --- a/src/Event/ErrorOccurredEventAbstract.php +++ b/src/Event/ErrorOccurredEvent.php @@ -22,7 +22,7 @@ * * @since 3.0.0 */ -final class ErrorOccurredEventAbstract extends AbstractEvent +final class ErrorOccurredEvent extends AbstractEvent { /** diff --git a/src/Event/ResponseResolvedEventAbstract.php b/src/Event/ResponseResolvedEvent.php similarity index 96% rename from src/Event/ResponseResolvedEventAbstract.php rename to src/Event/ResponseResolvedEvent.php index 10e4b41d..bd809d79 100644 --- a/src/Event/ResponseResolvedEventAbstract.php +++ b/src/Event/ResponseResolvedEvent.php @@ -23,7 +23,7 @@ * * @since 3.0.0 */ -final class ResponseResolvedEventAbstract extends AbstractEvent +final class ResponseResolvedEvent extends AbstractEvent { /** diff --git a/src/Event/RouteMatchedEventAbstract.php b/src/Event/RouteMatchedEvent.php similarity index 95% rename from src/Event/RouteMatchedEventAbstract.php rename to src/Event/RouteMatchedEvent.php index d7c292e3..2a451b4a 100644 --- a/src/Event/RouteMatchedEventAbstract.php +++ b/src/Event/RouteMatchedEvent.php @@ -21,7 +21,7 @@ * * @since 3.0.0 */ -final class RouteMatchedEventAbstract extends AbstractEvent +final class RouteMatchedEvent extends AbstractEvent { /** diff --git a/src/EventListener/ErrorOccurredEventListenerDisplayingFatalError.php b/src/EventListener/ErrorOccurredEventListenerDisplayingFatalError.php index cc5fb65a..9c908ed9 100644 --- a/src/EventListener/ErrorOccurredEventListenerDisplayingFatalError.php +++ b/src/EventListener/ErrorOccurredEventListenerDisplayingFatalError.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\EventListener; use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Event\ErrorOccurredEventAbstract; +use Sunrise\Http\Router\Event\ErrorOccurredEvent; use Sunrise\Http\Router\Exception\Http\HttpInternalServerErrorException; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ServerRequest; @@ -53,11 +53,11 @@ public function __construct() /** * Handles the given event * - * @param ErrorOccurredEventAbstract $event + * @param ErrorOccurredEvent $event * - * @return ErrorOccurredEventAbstract + * @return ErrorOccurredEvent */ - public function __invoke(ErrorOccurredEventAbstract $event): ErrorOccurredEventAbstract + public function __invoke(ErrorOccurredEvent $event): ErrorOccurredEvent { $error = $event->getError(); if (! $error instanceof HttpInternalServerErrorException) { diff --git a/src/EventListener/ErrorOccurredEventListenerRenderingHtmlError.php b/src/EventListener/ErrorOccurredEventListenerRenderingHtmlError.php index 698ebeac..d9cf739e 100644 --- a/src/EventListener/ErrorOccurredEventListenerRenderingHtmlError.php +++ b/src/EventListener/ErrorOccurredEventListenerRenderingHtmlError.php @@ -15,7 +15,7 @@ use Sunrise\Http\Router\Dto\ErrorDto; use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Event\ErrorOccurredEventAbstract; +use Sunrise\Http\Router\Event\ErrorOccurredEvent; use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ServerRequest; use Twig\Environment; @@ -45,11 +45,11 @@ public function __construct(private Environment $twig) /** * Handles the given event * - * @param ErrorOccurredEventAbstract $event + * @param ErrorOccurredEvent $event * - * @return ErrorOccurredEventAbstract + * @return ErrorOccurredEvent */ - public function __invoke(ErrorOccurredEventAbstract $event): ErrorOccurredEventAbstract + public function __invoke(ErrorOccurredEvent $event): ErrorOccurredEvent { $error = $event->getError(); if (! $error instanceof HttpExceptionInterface) { diff --git a/src/EventListener/ErrorOccurredEventListenerRenderingSerializedError.php b/src/EventListener/ErrorOccurredEventListenerRenderingSerializedError.php index 4e7f7525..9f409f78 100644 --- a/src/EventListener/ErrorOccurredEventListenerRenderingSerializedError.php +++ b/src/EventListener/ErrorOccurredEventListenerRenderingSerializedError.php @@ -15,7 +15,7 @@ use Sunrise\Http\Router\Dto\ErrorDto; use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Event\ErrorOccurredEventAbstract; +use Sunrise\Http\Router\Event\ErrorOccurredEvent; use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ServerRequest; use Symfony\Component\Serializer\Encoder\JsonEncode; @@ -47,11 +47,11 @@ public function __construct(private SerializerInterface $serializer) /** * Handles the given event * - * @param ErrorOccurredEventAbstract $event + * @param ErrorOccurredEvent $event * - * @return ErrorOccurredEventAbstract + * @return ErrorOccurredEvent */ - public function __invoke(ErrorOccurredEventAbstract $event): ErrorOccurredEventAbstract + public function __invoke(ErrorOccurredEvent $event): ErrorOccurredEvent { $error = $event->getError(); if (! $error instanceof HttpExceptionInterface) { diff --git a/src/Middleware/ErrorHandlingMiddleware.php b/src/Middleware/ErrorHandlingMiddleware.php index a97e1239..f79028bc 100644 --- a/src/Middleware/ErrorHandlingMiddleware.php +++ b/src/Middleware/ErrorHandlingMiddleware.php @@ -21,7 +21,7 @@ use Psr\Http\Server\RequestHandlerInterface; use Psr\Log\LoggerInterface; use Sunrise\Http\Router\Dto\ErrorDto; -use Sunrise\Http\Router\Event\ErrorOccurredEventAbstract; +use Sunrise\Http\Router\Event\ErrorOccurredEvent; use Sunrise\Http\Router\Exception\Http\HttpInternalServerErrorException; use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Throwable; @@ -74,7 +74,7 @@ private function handleHttpError(HttpExceptionInterface $error, ServerRequestInt } if (isset($this->eventDispatcher)) { - $event = new ErrorOccurredEventAbstract($error, $request, $response); + $event = new ErrorOccurredEvent($error, $request, $response); $this->eventDispatcher->dispatch($event); $response = $event->getResponse(); } diff --git a/src/ResponseResolving/ResponseResolutioner.php b/src/ResponseResolving/ResponseResolutioner.php index 54a8b2fc..8b7306bb 100644 --- a/src/ResponseResolving/ResponseResolutioner.php +++ b/src/ResponseResolving/ResponseResolutioner.php @@ -21,7 +21,7 @@ use ReflectionMethod; use Sunrise\Http\Router\Annotation\ResponseHeader; use Sunrise\Http\Router\Annotation\ResponseStatus; -use Sunrise\Http\Router\Event\ResponseResolvedEventAbstract; +use Sunrise\Http\Router\Event\ResponseResolvedEvent; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ResponseResolving\ResponseResolver\ResponseResolverInterface; @@ -115,7 +115,7 @@ private function handleResponse( } if (isset($this->eventDispatcher)) { - $event = new ResponseResolvedEventAbstract($request, $response, $responder); + $event = new ResponseResolvedEvent($request, $response, $responder); $this->eventDispatcher->dispatch($event); $response = $event->getResponse(); } diff --git a/src/Router.php b/src/Router.php index fb96ad04..983fe694 100644 --- a/src/Router.php +++ b/src/Router.php @@ -21,7 +21,7 @@ use Psr\Http\Server\RequestHandlerInterface; use Psr\SimpleCache\CacheInterface; use Sunrise\Http\Router\Dictionary\ErrorSource; -use Sunrise\Http\Router\Event\RouteMatchedEventAbstract; +use Sunrise\Http\Router\Event\RouteMatchedEvent; use Sunrise\Http\Router\Exception\Http\HttpMethodNotAllowedException; use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; use Sunrise\Http\Router\Exception\Http\HttpUnsupportedMediaTypeException; @@ -440,7 +440,7 @@ function (ServerRequestInterface $request): ResponseInterface { $route = $this->match($request); if (isset($this->eventDispatcher)) { - $event = new RouteMatchedEventAbstract($route, $request); + $event = new RouteMatchedEvent($route, $request); $this->eventDispatcher->dispatch($event); $request = $event->getRequest(); } @@ -470,7 +470,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface $route = $this->match($request); if (isset($this->eventDispatcher)) { - $event = new RouteMatchedEventAbstract($route, $request); + $event = new RouteMatchedEvent($route, $request); $this->eventDispatcher->dispatch($event); $request = $event->getRequest(); } From d70ae756217a632769a33a3941dd859d28dca9ef Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 18 Nov 2023 04:45:51 +0100 Subject: [PATCH 096/180] v3 --- resources/templates/error.twig.html | 14 +- src/Annotation/ProvideRoute.php | 33 -- src/CompiledRoute.php | 374 ------------------ ...dEventListenerRenderingSerializedError.php | 1 + src/Helper/RouteCompiler.php | 13 +- src/Loader/ConfigLoader.php | 82 +--- src/Loader/DescriptorLoader.php | 82 +--- src/Middleware/ErrorHandlingMiddleware.php | 58 ++- .../ProvideRouteParameterResolver.php | 79 ---- .../RequestQueryParameterResolver.php | 6 +- src/ReferenceResolver.php | 14 +- .../QueueableRequestHandler.php | 8 +- .../ResponseResolver/JsonResponseResolver.php | 2 +- .../SerializableResponseResolver.php | 4 +- src/Route.php | 7 +- src/RouteCollector.php | 84 +--- src/Router.php | 111 +----- 17 files changed, 97 insertions(+), 875 deletions(-) delete mode 100644 src/Annotation/ProvideRoute.php delete mode 100644 src/CompiledRoute.php delete mode 100644 src/ParameterResolving/ParameterResolver/ProvideRouteParameterResolver.php diff --git a/resources/templates/error.twig.html b/resources/templates/error.twig.html index bc795d1d..456fecad 100644 --- a/resources/templates/error.twig.html +++ b/resources/templates/error.twig.html @@ -21,6 +21,7 @@ color: #f44336; } span.source { + cursor: help; display: inline-block; padding: .25em .5em; border: 1px solid #9e9e9e; @@ -45,27 +46,32 @@ nav a:active { box-shadow: none; } - nav small { + nav > span.separator { display: inline-block; margin: 0 .25em; color: #9e9e9e; + font-size: .8em; + } + details > summary { + cursor: pointer; }

Oops! Error {{ statusCode }} — {{ reasonPhrase }}

-

{{ error.message }} {{ error.source }}

+

{{ error.message }} {{ error.source }}

{% if error.violations %}
+ Details {% for violation in error.violations %} -

{{ violation.source }} {{ violation.message }}

+

{{ violation.source }} {{ violation.message }}

{% endfor %}
{% endif %}
diff --git a/src/Annotation/ProvideRoute.php b/src/Annotation/ProvideRoute.php deleted file mode 100644 index 92def8cd..00000000 --- a/src/Annotation/ProvideRoute.php +++ /dev/null @@ -1,33 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation; - -use Attribute; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_PARAMETER)] -final class ProvideRoute -{ - - /** - * Constructor of the class - * - * @param non-empty-string $name - */ - public function __construct(public string $name) - { - } -} diff --git a/src/CompiledRoute.php b/src/CompiledRoute.php deleted file mode 100644 index ca3c1baf..00000000 --- a/src/CompiledRoute.php +++ /dev/null @@ -1,374 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Entity\MediaType; - -/** - * Compiled route - * - * @since 3.0.0 - */ -final class CompiledRoute implements RouteInterface -{ - - /** - * Constructor of the class - * - * @param RouteInterface $route - * @param string $regex - */ - public function __construct( - private RouteInterface $route, - private string $regex, - ) { - } - - /** - * Gets the route's regular expression - * - * @return string - */ - public function getRegex(): string - { - return $this->regex; - } - - /** - * @inheritDoc - */ - public function getName(): string - { - return $this->route->getName(); - } - - /** - * @inheritDoc - */ - public function getPath(): string - { - return $this->route->getPath(); - } - - /** - * @inheritDoc - */ - public function getMethods(): array - { - return $this->route->getMethods(); - } - - /** - * @inheritDoc - */ - public function getConsumesMediaTypes(): array - { - return $this->route->getConsumesMediaTypes(); - } - - /** - * @inheritDoc - */ - public function getProducesMediaTypes(): array - { - return $this->route->getProducesMediaTypes(); - } - - /** - * @inheritDoc - */ - public function getRequestHandler(): RequestHandlerInterface - { - return $this->route->getRequestHandler(); - } - - /** - * @inheritDoc - */ - public function getMiddlewares(): array - { - return $this->route->getMiddlewares(); - } - - /** - * @inheritDoc - */ - public function getAttributes(): array - { - return $this->route->getAttributes(); - } - - /** - * @inheritDoc - */ - public function getAttribute(string $name, mixed $default = null): mixed - { - return $this->route->getAttribute($name, $default); - } - - /** - * @inheritDoc - */ - public function getSummary(): ?string - { - return $this->route->getSummary(); - } - - /** - * @inheritDoc - */ - public function getDescription(): ?string - { - return $this->route->getDescription(); - } - - /** - * @inheritDoc - */ - public function getTags(): array - { - return $this->route->getTags(); - } - - /** - * @inheritDoc - */ - public function isDeprecated(): bool - { - return $this->route->isDeprecated(); - } - - /** - * @inheritDoc - */ - public function setName(string $name): static - { - $this->route->setName($name); - - return $this; - } - - /** - * @inheritDoc - */ - public function setPath(string $path): static - { - $this->route->setPath($path); - - return $this; - } - - /** - * @inheritDoc - */ - public function setMethods(string ...$methods): static - { - $this->route->setMethods(...$methods); - - return $this; - } - - /** - * @inheritDoc - */ - public function setConsumesMediaTypes(MediaType ...$mediaTypes): static - { - $this->route->setConsumesMediaTypes(...$mediaTypes); - - return $this; - } - - /** - * @inheritDoc - */ - public function setProducesMediaTypes(MediaType ...$mediaTypes): static - { - $this->route->setProducesMediaTypes(...$mediaTypes); - - return $this; - } - - /** - * @inheritDoc - */ - public function setRequestHandler(RequestHandlerInterface $requestHandler): static - { - $this->route->setRequestHandler($requestHandler); - - return $this; - } - - /** - * @inheritDoc - */ - public function setMiddlewares(MiddlewareInterface ...$middlewares): static - { - $this->route->setMiddlewares(...$middlewares); - - return $this; - } - - /** - * @inheritDoc - */ - public function setAttributes(array $attributes): static - { - $this->route->setAttributes($attributes); - - return $this; - } - - /** - * @inheritDoc - */ - public function setAttribute(string $name, mixed $value): static - { - $this->route->setAttribute($name, $value); - - return $this; - } - - /** - * @inheritDoc - */ - public function setSummary(?string $summary): static - { - $this->route->setSummary($summary); - - return $this; - } - - /** - * @inheritDoc - */ - public function setDescription(?string $description): static - { - $this->route->setDescription($description); - - return $this; - } - - /** - * @inheritDoc - */ - public function setTags(string ...$tags): static - { - $this->route->setTags(...$tags); - - return $this; - } - - /** - * @inheritDoc - */ - public function setDeprecation(bool $isDeprecated): static - { - $this->route->setDeprecation($isDeprecated); - - return $this; - } - - /** - * @inheritDoc - */ - public function addPrefix(string $prefix): static - { - $this->route->addPrefix($prefix); - - return $this; - } - - /** - * @inheritDoc - */ - public function addSuffix(string $suffix): static - { - $this->route->addSuffix($suffix); - - return $this; - } - - /** - * @inheritDoc - */ - public function addMethod(string ...$methods): static - { - $this->route->addMethod(...$methods); - - return $this; - } - - /** - * @inheritDoc - */ - public function addConsumesMediaType(MediaType ...$mediaTypes): static - { - $this->route->addConsumesMediaType(...$mediaTypes); - - return $this; - } - - /** - * @inheritDoc - */ - public function addProducesMediaType(MediaType ...$mediaTypes): static - { - $this->route->addProducesMediaType(...$mediaTypes); - - return $this; - } - - /** - * @inheritDoc - */ - public function addMiddleware(MiddlewareInterface ...$middlewares): static - { - $this->route->addMiddleware(...$middlewares); - - return $this; - } - - /** - * @inheritDoc - */ - public function addTag(string ...$tags): static - { - $this->route->addTag(...$tags); - - return $this; - } - - /** - * @inheritDoc - */ - public function withAddedAttributes(array $attributes): static - { - $clone = clone $this; - $clone->route = $this->route->withAddedAttributes($attributes); - - return $clone; - } - - /** - * @inheritDoc - */ - public function handle(ServerRequestInterface $request): ResponseInterface - { - return $this->route->handle($request); - } -} diff --git a/src/EventListener/ErrorOccurredEventListenerRenderingSerializedError.php b/src/EventListener/ErrorOccurredEventListenerRenderingSerializedError.php index 9f409f78..6b9e2ef3 100644 --- a/src/EventListener/ErrorOccurredEventListenerRenderingSerializedError.php +++ b/src/EventListener/ErrorOccurredEventListenerRenderingSerializedError.php @@ -74,6 +74,7 @@ public function __invoke(ErrorOccurredEvent $event): ErrorOccurredEvent ); $event->setResponse($response); + $event->stopPropagation(); return $event; } diff --git a/src/Helper/RouteCompiler.php b/src/Helper/RouteCompiler.php index de227f63..6245c99f 100644 --- a/src/Helper/RouteCompiler.php +++ b/src/Helper/RouteCompiler.php @@ -26,13 +26,6 @@ final class RouteCompiler { - /** - * Cached compiled regular expressions - * - * @var array - */ - private static array $regex = []; - /** * Compiles a regular expression from the given route * @@ -42,10 +35,6 @@ final class RouteCompiler */ public static function compileRegex(string $route): string { - if (isset(self::$regex[$route])) { - return self::$regex[$route]; - } - $matches = RouteParser::parseRoute($route); foreach ($matches as $match) { @@ -66,6 +55,6 @@ public static function compileRegex(string $route): string $route = str_replace('{' . $match['name'] . '}', $subpattern, $route); } - return self::$regex[$route] = '#^' . $route . '$#uD'; + return '#^' . $route . '$#uD'; } } diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index 0f787c09..472a5e8e 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -14,15 +14,8 @@ namespace Sunrise\Http\Router\Loader; use Sunrise\Http\Router\Exception\InvalidArgumentException; -use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; -use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ParameterResolverInterface; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; -use Sunrise\Http\Router\ResponseResolving\ResponseResolutioner; -use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; -use Sunrise\Http\Router\ResponseResolving\ResponseResolver\ResponseResolverInterface; use Sunrise\Http\Router\RouteCollectionFactory; use Sunrise\Http\Router\RouteCollectionFactoryInterface; use Sunrise\Http\Router\RouteCollectionInterface; @@ -64,94 +57,21 @@ final class ConfigLoader implements LoaderInterface */ private ReferenceResolverInterface $referenceResolver; - /** - * @var ParameterResolutionerInterface|null - */ - private ?ParameterResolutionerInterface $parameterResolutioner; - - /** - * @var ResponseResolutionerInterface|null - */ - private ?ResponseResolutionerInterface $responseResolutioner; - /** * Constructor of the class * * @param RouteCollectionFactoryInterface|null $collectionFactory * @param RouteFactoryInterface|null $routeFactory * @param ReferenceResolverInterface|null $referenceResolver - * @param ParameterResolutionerInterface|null $parameterResolutioner - * @param ResponseResolutionerInterface|null $responseResolutioner */ public function __construct( ?RouteCollectionFactoryInterface $collectionFactory = null, ?RouteFactoryInterface $routeFactory = null, ?ReferenceResolverInterface $referenceResolver = null, - ?ParameterResolutionerInterface $parameterResolutioner = null, - ?ResponseResolutionerInterface $responseResolutioner = null, ) { $this->collectionFactory = $collectionFactory ?? new RouteCollectionFactory(); $this->routeFactory = $routeFactory ?? new RouteFactory(); - - $this->parameterResolutioner = $parameterResolutioner; - $this->responseResolutioner = $responseResolutioner; - - $this->referenceResolver = $referenceResolver ?? new ReferenceResolver( - $this->parameterResolutioner ??= new ParameterResolutioner(), - $this->responseResolutioner ??= new ResponseResolutioner(), - ); - } - - /** - * Adds the given parameter resolver(s) to the parameter resolutioner - * - * @param ParameterResolverInterface ...$resolvers - * - * @return void - * - * @throws LogicException - * If a custom reference resolver has been set, - * but a parameter resolutioner has not been set. - * - * @since 3.0.0 - */ - public function addParameterResolver(ParameterResolverInterface ...$resolvers): void - { - if (!isset($this->parameterResolutioner)) { - throw new LogicException( - 'The config route loader cannot accept parameter resolvers ' . - 'because a custom reference resolver has been set, ' . - 'but a parameter resolutioner has not been set.' - ); - } - - $this->parameterResolutioner->addResolver(...$resolvers); - } - - /** - * Adds the given response resolver(s) to the response resolutioner - * - * @param ResponseResolverInterface ...$resolvers - * - * @return void - * - * @throws LogicException - * If a custom reference resolver has been set, - * but a response resolutioner has not been set. - * - * @since 3.0.0 - */ - public function addResponseResolver(ResponseResolverInterface ...$resolvers): void - { - if (!isset($this->responseResolutioner)) { - throw new LogicException( - 'The config route loader cannot accept response resolvers ' . - 'because a custom reference resolver has been set, ' . - 'but a response resolutioner has not been set.' - ); - } - - $this->responseResolutioner->addResolver(...$resolvers); + $this->referenceResolver = $referenceResolver ?? new ReferenceResolver(); } /** diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 65170442..6e461d30 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -36,15 +36,8 @@ use Sunrise\Http\Router\Annotation\Tag; use Sunrise\Http\Router\Entity\MediaType; use Sunrise\Http\Router\Exception\InvalidArgumentException; -use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; -use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ParameterResolverInterface; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; -use Sunrise\Http\Router\ResponseResolving\ResponseResolutioner; -use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; -use Sunrise\Http\Router\ResponseResolving\ResponseResolver\ResponseResolverInterface; use Sunrise\Http\Router\RouteCollectionFactory; use Sunrise\Http\Router\RouteCollectionFactoryInterface; use Sunrise\Http\Router\RouteCollectionInterface; @@ -88,16 +81,6 @@ final class DescriptorLoader implements LoaderInterface */ private ReferenceResolverInterface $referenceResolver; - /** - * @var ParameterResolutionerInterface|null - */ - private ?ParameterResolutionerInterface $parameterResolutioner; - - /** - * @var ResponseResolutionerInterface|null - */ - private ?ResponseResolutionerInterface $responseResolutioner; - /** * @var CacheInterface|null */ @@ -114,84 +97,21 @@ final class DescriptorLoader implements LoaderInterface * @param RouteCollectionFactoryInterface|null $collectionFactory * @param RouteFactoryInterface|null $routeFactory * @param ReferenceResolverInterface|null $referenceResolver - * @param ParameterResolutionerInterface|null $parameterResolutioner - * @param ResponseResolutionerInterface|null $responseResolutioner * @param CacheInterface|null $cache */ public function __construct( ?RouteCollectionFactoryInterface $collectionFactory = null, ?RouteFactoryInterface $routeFactory = null, ?ReferenceResolverInterface $referenceResolver = null, - ?ParameterResolutionerInterface $parameterResolutioner = null, - ?ResponseResolutionerInterface $responseResolutioner = null, ?CacheInterface $cache = null, ) { $this->collectionFactory = $collectionFactory ?? new RouteCollectionFactory(); $this->routeFactory = $routeFactory ?? new RouteFactory(); - - $this->parameterResolutioner = $parameterResolutioner; - $this->responseResolutioner = $responseResolutioner; - - $this->referenceResolver = $referenceResolver ?? new ReferenceResolver( - $this->parameterResolutioner ??= new ParameterResolutioner(), - $this->responseResolutioner ??= new ResponseResolutioner(), - ); + $this->referenceResolver = $referenceResolver ?? new ReferenceResolver(); $this->cache = $cache; } - /** - * Adds the given parameter resolver(s) to the parameter resolutioner - * - * @param ParameterResolverInterface ...$resolvers - * - * @return void - * - * @throws LogicException - * If a custom reference resolver has been set, - * but a parameter resolutioner has not been set. - * - * @since 3.0.0 - */ - public function addParameterResolver(ParameterResolverInterface ...$resolvers): void - { - if (!isset($this->parameterResolutioner)) { - throw new LogicException( - 'The descriptor route loader cannot accept parameter resolvers ' . - 'because a custom reference resolver has been set, ' . - 'but a parameter resolutioner has not been set.' - ); - } - - $this->parameterResolutioner->addResolver(...$resolvers); - } - - /** - * Adds the given response resolver(s) to the response resolutioner - * - * @param ResponseResolverInterface ...$resolvers - * - * @return void - * - * @throws LogicException - * If a custom reference resolver has been set, - * but a response resolutioner has not been set. - * - * @since 3.0.0 - */ - public function addResponseResolver(ResponseResolverInterface ...$resolvers): void - { - if (!isset($this->responseResolutioner)) { - throw new LogicException( - 'The descriptor route loader cannot accept response resolvers ' . - 'because a custom reference resolver has been set, ' . - 'but a response resolutioner has not been set.' - ); - } - - $this->responseResolutioner->addResolver(...$resolvers); - } - /** * Sets the given cache key to the loader * diff --git a/src/Middleware/ErrorHandlingMiddleware.php b/src/Middleware/ErrorHandlingMiddleware.php index f79028bc..0593a955 100644 --- a/src/Middleware/ErrorHandlingMiddleware.php +++ b/src/Middleware/ErrorHandlingMiddleware.php @@ -20,15 +20,22 @@ use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use Psr\Log\LoggerInterface; +use SimpleXMLElement; use Sunrise\Http\Router\Dto\ErrorDto; +use Sunrise\Http\Router\Entity\MediaType; use Sunrise\Http\Router\Event\ErrorOccurredEvent; use Sunrise\Http\Router\Exception\Http\HttpInternalServerErrorException; use Sunrise\Http\Router\Exception\HttpExceptionInterface; +use Sunrise\Http\Router\ServerRequest; use Throwable; +use function extension_loaded; use function json_encode; use const JSON_PARTIAL_OUTPUT_ON_ERROR; +use const LIBXML_COMPACT; +use const LIBXML_NOERROR; +use const LIBXML_NOWARNING; /** * Error handling middleware @@ -83,15 +90,24 @@ private function handleHttpError(HttpExceptionInterface $error, ServerRequestInt return $response; } - $response = $response->withHeader('Content-Type', 'application/json; charset=UTF-8'); + $serverProducesMediaTypes = [MediaType::json()]; + if (extension_loaded('simplexml')) { + $serverProducesMediaTypes[] = MediaType::xml(); + } - /** @var string $payload */ - $payload = json_encode( - value: ErrorDto::fromHttpError($error), - flags: JSON_PARTIAL_OUTPUT_ON_ERROR, - ); + $clientPreferredMediaType = ServerRequest::from($request) + ->getClientPreferredMediaType(...$serverProducesMediaTypes) + ?? $serverProducesMediaTypes[0]; - $response->getBody()->write($payload); + $mimeType = $clientPreferredMediaType . '; charset=UTF-8'; + $response = $response->withHeader('Content-Type', $mimeType); + + $response->getBody()->write( + match ($clientPreferredMediaType) { + $serverProducesMediaTypes[0] => $this->renderJsonError($error), + default => $this->renderXmlError($error), + } + ); return $response; } @@ -104,4 +120,32 @@ private function handleFatalError(Throwable $error, ServerRequestInterface $requ return $this->handleHttpError($httpError, $request); } + + private function renderJsonError(HttpExceptionInterface $error): string + { + $view = ErrorDto::fromHttpError($error); + + /** @var non-empty-string */ + return json_encode($view, flags: JSON_PARTIAL_OUTPUT_ON_ERROR); + } + + private function renderXmlError(HttpExceptionInterface $error): string + { + $xmlBlank = ''; + $xmlOptions = LIBXML_COMPACT | LIBXML_NOERROR | LIBXML_NOWARNING; + + $rootChild = new SimpleXMLElement($xmlBlank, $xmlOptions); + $rootChild->addChild('source', $error->getSource()); + $rootChild->addChild('message', $error->getMessage()); + + foreach ($error->getViolations() as $violation) { + /** @var SimpleXMLElement $violationChild */ + $violationChild = $rootChild->addChild('violations'); + $violationChild->addChild('source', $violation->source); + $violationChild->addChild('message', $violation->message); + } + + /** @var non-empty-string */ + return $rootChild->asXML(); + } } diff --git a/src/ParameterResolving/ParameterResolver/ProvideRouteParameterResolver.php b/src/ParameterResolving/ParameterResolver/ProvideRouteParameterResolver.php deleted file mode 100644 index c14ec493..00000000 --- a/src/ParameterResolving/ParameterResolver/ProvideRouteParameterResolver.php +++ /dev/null @@ -1,79 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; - -use Generator; -use ReflectionAttribute; -use ReflectionNamedType; -use ReflectionParameter; -use Sunrise\Http\Router\Annotation\ProvideRoute; -use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; -use Sunrise\Http\Router\RouteInterface; -use Sunrise\Http\Router\Router; - -use function sprintf; - -/** - * ProvideRouteParameterResolver - * - * @since 3.0.0 - */ -final class ProvideRouteParameterResolver implements ParameterResolverInterface -{ - - /** - * Constructor of the class - * - * @param Router $router - */ - public function __construct(private Router $router) - { - } - - /** - * @inheritDoc - */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator - { - /** @var list> $attributes */ - $attributes = $parameter->getAttributes(ProvideRoute::class); - if ($attributes === []) { - return; - } - - $type = $parameter->getType(); - if (! $type instanceof ReflectionNamedType || $type->getName() <> RouteInterface::class) { - throw new LogicException(sprintf( - 'To use the #[ProvideRoute] attribute, the parameter {%s} must be typed with %s.', - ParameterResolutioner::stringifyParameter($parameter), - RouteInterface::class, - )); - } - - $routes = $this->router->getRoutes(); - $attribute = $attributes[0]->newInstance(); - - if (!$routes->has($attribute->name) && !$parameter->allowsNull()) { - throw new LogicException(sprintf( - 'The parameter {%1$s} expects a non-existent route "%2$s". ' . - 'To resolve this issue, simply make this parameter nullable.', - ParameterResolutioner::stringifyParameter($parameter), - $attribute->name, - )); - } - - yield $routes->get($attribute->name); - } -} diff --git a/src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php index 1c7dbc2d..18e439b4 100644 --- a/src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php @@ -45,8 +45,10 @@ final class RequestQueryParameterResolver implements ParameterResolverInterface * @param HydratorInterface $hydrator * @param ValidatorInterface|null $validator */ - public function __construct(private HydratorInterface $hydrator, private ?ValidatorInterface $validator = null) - { + public function __construct( + private HydratorInterface $hydrator, + private ?ValidatorInterface $validator = null, + ) { } /** diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index 54c08229..eb8220f4 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -20,8 +20,10 @@ use ReflectionClass; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\Middleware\CallbackMiddleware; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; +use Sunrise\Http\Router\ResponseResolving\ResponseResolutioner; use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; use function class_exists; @@ -58,15 +60,15 @@ final class ReferenceResolver implements ReferenceResolverInterface /** * Constructor of the class * - * @param ParameterResolutionerInterface $parameterResolutioner - * @param ResponseResolutionerInterface $responseResolutioner + * @param ParameterResolutionerInterface|null $parameterResolutioner + * @param ResponseResolutionerInterface|null $responseResolutioner */ public function __construct( - ParameterResolutionerInterface $parameterResolutioner, - ResponseResolutionerInterface $responseResolutioner, + ?ParameterResolutionerInterface $parameterResolutioner = null, + ?ResponseResolutionerInterface $responseResolutioner = null, ) { - $this->parameterResolutioner = $parameterResolutioner; - $this->responseResolutioner = $responseResolutioner; + $this->parameterResolutioner = $parameterResolutioner ?? new ParameterResolutioner(); + $this->responseResolutioner = $responseResolutioner ?? new ResponseResolutioner(); } /** diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index 9be05ceb..58c1442f 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -47,8 +47,10 @@ public function __construct( */ public function handle(ServerRequestInterface $request): ResponseInterface { - return $this->isEmpty() ? - $this->requestHandler->handle($request) : - ($clone = clone $this)->dequeue()->process($request, $clone); + if ($this->isEmpty()) { + return $this->requestHandler->handle($request); + } + + return ($clone = clone $this)->dequeue()->process($request, $clone); } } diff --git a/src/ResponseResolving/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolving/ResponseResolver/JsonResponseResolver.php index ae0b3584..ece17ba7 100644 --- a/src/ResponseResolving/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolving/ResponseResolver/JsonResponseResolver.php @@ -64,7 +64,7 @@ public function resolveResponse( try { /** - * ignore the depth... + * Ignores the depth... * @psalm-suppress ArgumentTypeCoercion * @phpstan-ignore-next-line */ diff --git a/src/ResponseResolving/ResponseResolver/SerializableResponseResolver.php b/src/ResponseResolving/ResponseResolver/SerializableResponseResolver.php index e202f8be..ff196193 100644 --- a/src/ResponseResolving/ResponseResolver/SerializableResponseResolver.php +++ b/src/ResponseResolving/ResponseResolver/SerializableResponseResolver.php @@ -77,11 +77,11 @@ public function resolveResponse( }; $result = $this->responseFactory->createResponse(200); - $mimeType = $clientPreferredMediaType . '; charset=UTF-8'; $result = $result->withHeader('Content-Type', $mimeType); - $payload = $this->serializer->serialize($response, $format, $attribute->context + $this->context); + $context = $attribute->context + $this->context; + $payload = $this->serializer->serialize($response, $format, $context); $result->getBody()->write($payload); return $result; diff --git a/src/Route.php b/src/Route.php index 3783387b..b364ce3c 100644 --- a/src/Route.php +++ b/src/Route.php @@ -504,8 +504,9 @@ public function handle(ServerRequestInterface $request): ResponseInterface return $this->requestHandler->handle($request); } - $handler = new QueueableRequestHandler($this->requestHandler, ...$this->middlewares); - - return $handler->handle($request); + return (new QueueableRequestHandler( + $this->requestHandler, + ...$this->middlewares, + ))->handle($request); } } diff --git a/src/RouteCollector.php b/src/RouteCollector.php index 0ce59708..2efcda50 100644 --- a/src/RouteCollector.php +++ b/src/RouteCollector.php @@ -14,13 +14,6 @@ namespace Sunrise\Http\Router; use Fig\Http\Message\RequestMethodInterface; -use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; -use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ParameterResolverInterface; -use Sunrise\Http\Router\ResponseResolving\ResponseResolutioner; -use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; -use Sunrise\Http\Router\ResponseResolving\ResponseResolver\ResponseResolverInterface; /** * RouteCollector @@ -48,42 +41,21 @@ class RouteCollector */ private ReferenceResolverInterface $referenceResolver; - /** - * @var ParameterResolutionerInterface|null - */ - private ?ParameterResolutionerInterface $parameterResolutioner; - - /** - * @var ResponseResolutionerInterface|null - */ - private ?ResponseResolutionerInterface $responseResolutioner; - /** * Constructor of the class * * @param RouteCollectionFactoryInterface|null $collectionFactory * @param RouteFactoryInterface|null $routeFactory * @param ReferenceResolverInterface|null $referenceResolver - * @param ParameterResolutionerInterface|null $parameterResolutioner - * @param ResponseResolutionerInterface|null $responseResolutioner */ public function __construct( ?RouteCollectionFactoryInterface $collectionFactory = null, ?RouteFactoryInterface $routeFactory = null, ?ReferenceResolverInterface $referenceResolver = null, - ?ParameterResolutionerInterface $parameterResolutioner = null, - ?ResponseResolutionerInterface $responseResolutioner = null, ) { $this->collectionFactory = $collectionFactory ?? new RouteCollectionFactory(); $this->routeFactory = $routeFactory ?? new RouteFactory(); - - $this->parameterResolutioner = $parameterResolutioner; - $this->responseResolutioner = $responseResolutioner; - - $this->referenceResolver = $referenceResolver ?? new ReferenceResolver( - $this->parameterResolutioner ??= new ParameterResolutioner(), - $this->responseResolutioner ??= new ResponseResolutioner(), - ); + $this->referenceResolver = $referenceResolver ?? new ReferenceResolver(); $this->collection = $this->collectionFactory->createCollection(); } @@ -98,58 +70,6 @@ public function getCollection(): RouteCollectionInterface return $this->collection; } - /** - * Adds the given parameter resolver(s) to the parameter resolutioner - * - * @param ParameterResolverInterface ...$resolvers - * - * @return void - * - * @throws LogicException - * If a custom reference resolver has been set, - * but a parameter resolutioner has not been set. - * - * @since 3.0.0 - */ - public function addParameterResolver(ParameterResolverInterface ...$resolvers): void - { - if (!isset($this->parameterResolutioner)) { - throw new LogicException( - 'The route collector cannot accept parameter resolvers ' . - 'because a custom reference resolver has been set, ' . - 'but a parameter resolutioner has not been set.' - ); - } - - $this->parameterResolutioner->addResolver(...$resolvers); - } - - /** - * Adds the given response resolver(s) to the response resolutioner - * - * @param ResponseResolverInterface ...$resolvers - * - * @return void - * - * @throws LogicException - * If a custom reference resolver has been set, - * but a response resolutioner has not been set. - * - * @since 3.0.0 - */ - public function addResponseResolver(ResponseResolverInterface ...$resolvers): void - { - if (!isset($this->responseResolutioner)) { - throw new LogicException( - 'The route collector cannot accept response resolvers ' . - 'because a custom reference resolver has been set, ' . - 'but a response resolutioner has not been set.' - ); - } - - $this->responseResolutioner->addResolver(...$resolvers); - } - /** * Makes a new route with the given parameters * @@ -394,8 +314,6 @@ public function group(callable $callback, array $middlewares = []): RouteCollect $this->collectionFactory, $this->routeFactory, $this->referenceResolver, - $this->parameterResolutioner, - $this->responseResolutioner, ); $callback($collector); diff --git a/src/Router.php b/src/Router.php index 983fe694..199e676d 100644 --- a/src/Router.php +++ b/src/Router.php @@ -26,18 +26,10 @@ use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; use Sunrise\Http\Router\Exception\Http\HttpUnsupportedMediaTypeException; use Sunrise\Http\Router\Exception\InvalidArgumentException; -use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\Helper\RouteCompiler; -use Sunrise\Http\Router\Helper\RouteParser; use Sunrise\Http\Router\Loader\LoaderInterface; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; -use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ParameterResolverInterface; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; -use Sunrise\Http\Router\ResponseResolving\ResponseResolutioner; -use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; -use Sunrise\Http\Router\ResponseResolving\ResponseResolver\ResponseResolverInterface; use function array_keys; use function preg_match; @@ -71,16 +63,6 @@ class Router implements RequestHandlerInterface, RequestMethodInterface */ private ReferenceResolverInterface $referenceResolver; - /** - * @var ParameterResolutionerInterface|null - */ - private ?ParameterResolutionerInterface $parameterResolutioner; - - /** - * @var ResponseResolutionerInterface|null - */ - private ?ResponseResolutionerInterface $responseResolutioner; - /** * @var CacheInterface|null */ @@ -101,13 +83,13 @@ class Router implements RequestHandlerInterface, RequestMethodInterface */ private ?EventDispatcherInterface $eventDispatcher = null; + private array $compiledRegularExpressions = []; + /** * Constructor of the class * * @param RouteCollectionFactoryInterface|null $collectionFactory * @param ReferenceResolverInterface|null $referenceResolver - * @param ParameterResolutionerInterface|null $parameterResolutioner - * @param ResponseResolutionerInterface|null $responseResolutioner * @param CacheInterface|null $cache * * @since 3.0.0 @@ -115,75 +97,12 @@ class Router implements RequestHandlerInterface, RequestMethodInterface public function __construct( ?RouteCollectionFactoryInterface $collectionFactory = null, ?ReferenceResolverInterface $referenceResolver = null, - ?ParameterResolutionerInterface $parameterResolutioner = null, - ?ResponseResolutionerInterface $responseResolutioner = null, ?CacheInterface $cache = null, ) { $collectionFactory ??= new RouteCollectionFactory(); - - $this->routes = $collectionFactory->createCollection(); - - $this->parameterResolutioner = $parameterResolutioner; - $this->responseResolutioner = $responseResolutioner; - - $this->referenceResolver = $referenceResolver ?? new ReferenceResolver( - $this->parameterResolutioner ??= new ParameterResolutioner(), - $this->responseResolutioner ??= new ResponseResolutioner(), - ); - + $this->referenceResolver = $referenceResolver ?? new ReferenceResolver(); $this->cache = $cache; - } - - /** - * Adds the given parameter resolver(s) to the parameter resolutioner - * - * @param ParameterResolverInterface ...$resolvers - * - * @return void - * - * @throws LogicException - * If a custom reference resolver has been set, - * but a parameter resolutioner has not been set. - * - * @since 3.0.0 - */ - public function addParameterResolver(ParameterResolverInterface ...$resolvers): void - { - if (!isset($this->parameterResolutioner)) { - throw new LogicException( - 'The router cannot accept parameter resolvers ' . - 'because a custom reference resolver has been set, ' . - 'but a parameter resolutioner has not been set.' - ); - } - - $this->parameterResolutioner->addResolver(...$resolvers); - } - - /** - * Adds the given response resolver(s) to the response resolutioner - * - * @param ResponseResolverInterface ...$resolvers - * - * @return void - * - * @throws LogicException - * If a custom reference resolver has been set, - * but a response resolutioner has not been set. - * - * @since 3.0.0 - */ - public function addResponseResolver(ResponseResolverInterface ...$resolvers): void - { - if (!isset($this->responseResolutioner)) { - throw new LogicException( - 'The router cannot accept response resolvers ' . - 'because a custom reference resolver has been set, ' . - 'but a response resolutioner has not been set.' - ); - } - - $this->responseResolutioner->addResolver(...$resolvers); + $this->routes = $collectionFactory->createCollection(); } /** @@ -200,22 +119,6 @@ public function load(LoaderInterface ...$loaders): void } } - public function warmCache(): void - { - $data = []; - foreach ($this->routes as $route) { - $regex = RouteCompiler::compileRegex($route->getPath()); - $variables = RouteParser::parseRoute($route->getPath()); - - $attributes = []; - foreach ($variables as $variable) { - $attributes[$variable['name']] ??= $variable['value'] ?? null; - } - - $data[$route->getName()] = [$regex, $attributes]; - } - } - /** * Gets the router's routes * @@ -377,12 +280,12 @@ public function match(ServerRequestInterface $request): RouteInterface $allowedMethods = []; foreach ($this->routes->all() as $route) { - // phpcs:ignore Generic.Files.LineLength - $routeRegex = ($route instanceof CompiledRoute) ? $route->getRegex() : RouteCompiler::compileRegex($route->getPath()); + $this->compiledRegularExpressions[$route->getName()] ??= RouteCompiler::compileRegex($route->getPath()); // https://github.com/sunrise-php/http-router/issues/50 // https://tools.ietf.org/html/rfc7231#section-6.5.5 - if (!preg_match($routeRegex, $requestPath, $matches, PREG_UNMATCHED_AS_NULL)) { + // phpcs:ignore Generic.Files.LineLength + if (!preg_match($this->compiledRegularExpressions[$route->getName()], $requestPath, $matches, PREG_UNMATCHED_AS_NULL)) { continue; } From 86280a7155d2445170e9378c19a892c2161c0f90 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 6 Jan 2024 06:09:39 +0100 Subject: [PATCH 097/180] v3 --- README.md | 4 +- composer.json | 5 +- functions/path_build.php | 78 --------- resources/templates/error.twig.html | 79 --------- src/Annotation/JsonResponse.php | 2 + src/Annotation/PathVariable.php | 2 +- src/Annotation/SerializableResponse.php | 33 ---- src/Dictionary/Charset.php | 6 - src/Dictionary/ErrorSource.php | 35 ---- src/Dto/ErrorDto.php | 54 ------- src/Dto/ViolationDto.php | 66 -------- src/Entity/Language.php | 18 ++- src/Entity/MediaType.php | 6 +- src/Event/ErrorOccurredEvent.php | 75 --------- src/Event/ResponseResolvedEvent.php | 2 - src/Event/RouteMatchedEvent.php | 2 - ...urredEventListenerDisplayingFatalError.php | 93 ----------- ...ccurredEventListenerRenderingHtmlError.php | 87 ---------- ...dEventListenerRenderingSerializedError.php | 99 ------------ src/Exception/Exception.php | 2 +- src/Exception/ExceptionInterface.php | 2 +- .../Http/HttpBadRequestException.php | 11 +- src/Exception/Http/HttpConflictException.php | 12 +- .../Http/HttpFailedDependencyException.php | 15 +- src/Exception/Http/HttpForbiddenException.php | 14 +- src/Exception/Http/HttpGoneException.php | 42 ----- .../Http/HttpInternalServerErrorException.php | 19 ++- src/Exception/Http/HttpLockedException.php | 12 +- .../Http/HttpMethodNotAllowedException.php | 16 +- src/Exception/Http/HttpNotFoundException.php | 14 +- .../Http/HttpPayloadTooLargeException.php | 14 +- .../Http/HttpServiceUnavailableException.php | 16 +- .../Http/HttpTooManyRequestsException.php | 11 +- .../Http/HttpUnauthorizedException.php | 15 +- ...ttpUnavailableForLegalReasonsException.php | 12 +- .../Http/HttpUnprocessableEntityException.php | 11 +- .../HttpUnsupportedMediaTypeException.php | 17 +- src/Exception/HttpException.php | 127 +++------------ src/Exception/HttpExceptionInterface.php | 21 +-- src/Helper/CallbackReflector.php | 70 -------- src/Helper/RouteBuilder.php | 58 +++++++ src/Helper/RouteCompiler.php | 15 +- src/Helper/RouteParser.php | 26 +-- src/Loader/ConfigLoader.php | 27 +--- src/Loader/DescriptorLoader.php | 50 +++--- src/Middleware/CallbackMiddleware.php | 34 ++-- .../CrossOriginResourceSharingMiddleware.php | 84 ---------- src/Middleware/ErrorHandlingMiddleware.php | 151 ------------------ .../JsonPayloadDecodingMiddleware.php | 10 +- .../PathVariableParameterResolver.php | 8 +- .../RequestBodyParameterResolver.php | 9 +- .../RequestCookieParameterResolver.php | 11 +- .../RequestHeaderParameterResolver.php | 11 +- .../RequestQueryParameterResolver.php | 9 +- src/ReferenceResolver.php | 49 +++--- src/RequestHandler/CallbackRequestHandler.php | 34 +--- .../QueueableRequestHandler.php | 2 +- .../ResponseResolutioner.php | 14 +- .../ResponseResolver/JsonResponseResolver.php | 2 +- .../SerializableResponseResolver.php | 89 ----------- src/Router.php | 45 ++---- src/ServerRequest.php | 10 +- src/Validation/ConstraintViolation.php | 69 ++++++++ .../HydratorConstraintViolationProxy.php | 80 ++++++++++ .../ValidatorConstraintViolationProxy.php | 81 ++++++++++ .../ConstraintViolationInterface.php | 49 ++++++ 66 files changed, 670 insertions(+), 1576 deletions(-) delete mode 100644 functions/path_build.php delete mode 100644 resources/templates/error.twig.html delete mode 100644 src/Annotation/SerializableResponse.php delete mode 100644 src/Dictionary/ErrorSource.php delete mode 100644 src/Dto/ErrorDto.php delete mode 100644 src/Dto/ViolationDto.php delete mode 100644 src/Event/ErrorOccurredEvent.php delete mode 100644 src/EventListener/ErrorOccurredEventListenerDisplayingFatalError.php delete mode 100644 src/EventListener/ErrorOccurredEventListenerRenderingHtmlError.php delete mode 100644 src/EventListener/ErrorOccurredEventListenerRenderingSerializedError.php delete mode 100644 src/Exception/Http/HttpGoneException.php delete mode 100644 src/Helper/CallbackReflector.php create mode 100644 src/Helper/RouteBuilder.php delete mode 100644 src/Middleware/CrossOriginResourceSharingMiddleware.php delete mode 100644 src/Middleware/ErrorHandlingMiddleware.php delete mode 100644 src/ResponseResolving/ResponseResolver/SerializableResponseResolver.php create mode 100644 src/Validation/ConstraintViolation.php create mode 100644 src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php create mode 100644 src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php create mode 100644 src/Validation/ConstraintViolationInterface.php diff --git a/README.md b/README.md index af9c94a9..eb857b53 100644 --- a/README.md +++ b/README.md @@ -681,12 +681,12 @@ composer require symfony/event-dispatcher ``` ```php -use Sunrise\Http\Router\Event\RouteMatchedEventAbstract; +use Sunrise\Http\Router\Event\RouteMatchedEvent; use Symfony\Component\EventDispatcher\EventDispatcher; $eventDispatcher = new EventDispatcher(); -$eventDispatcher->addListener(RouteMatchedEventAbstract::NAME, function (RouteMatchedEventAbstract $event) { +$eventDispatcher->addListener(RouteMatchedEvent::NAME, function (RouteMatchedEvent $event) { // gets the matched route: $event->getRoute(); // gets the current request: diff --git a/composer.json b/composer.json index 3abba7e3..e28ccb40 100644 --- a/composer.json +++ b/composer.json @@ -42,7 +42,7 @@ "vimeo/psalm": "^5.15", "sunrise/coding-standard": "^1.0", "sunrise/http-message": "^3.0", - "sunrise/hydrator": "^3.5", + "sunrise/hydrator": "^3.7", "symfony/console": "^6.0", "symfony/validator": "^6.0", "monolog/monolog": "^2.9", @@ -60,8 +60,7 @@ }, "autoload": { "files": [ - "functions/emit.php", - "functions/path_build.php" + "functions/emit.php" ], "psr-4": { "Sunrise\\Http\\Router\\": "src/" diff --git a/functions/path_build.php b/functions/path_build.php deleted file mode 100644 index c9c5340d..00000000 --- a/functions/path_build.php +++ /dev/null @@ -1,78 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -use Sunrise\Http\Router\Exception\RoutePathBuildException; - -use function preg_match; -use function sprintf; -use function str_replace; - -/** - * Builds the given path using the given attributes - * - * If strict mode is enabled then each attribute value will be validated. - * - * @param string $path - * @param array $attributes - * @param bool $strict - * - * @return string - * - * @throws RoutePathBuildException - */ -function path_build(string $path, array $attributes = [], bool $strict = false) : string -{ - $result = $path; - $matches = path_parse($path); - - foreach ($matches as $match) { - // handle not required attributes... - if (!isset($attributes[$match['name']])) { - if (!$match['isOptional']) { - $errmsg = '[%s] build error: no value given for the attribute "%s".'; - - throw new RoutePathBuildException(sprintf($errmsg, $path, $match['name']), [ - 'path' => $path, - 'match' => $match, - ]); - } - - $result = str_replace($match['withParentheses'], '', $result); - - continue; - } - - $replacement = (string) $attributes[$match['name']]; - - // validate the given attributes values... - if ($strict && isset($match['pattern'])) { - if (!preg_match('#^' . $match['pattern'] . '$#u', $replacement)) { - $errmsg = '[%s] build error: the given value for the attribute "%s" does not match its pattern.'; - - throw new RoutePathBuildException(sprintf($errmsg, $path, $match['name']), [ - 'path' => $path, - 'value' => $replacement, - 'match' => $match, - ]); - } - } - - $result = str_replace($match['raw'], $replacement, $result); - } - - $result = str_replace(['(', ')'], '', $result); - - return $result; -} diff --git a/resources/templates/error.twig.html b/resources/templates/error.twig.html deleted file mode 100644 index 456fecad..00000000 --- a/resources/templates/error.twig.html +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - Error {{ statusCode }} - - - -
-

Oops! Error {{ statusCode }} — {{ reasonPhrase }}

-

{{ error.message }} {{ error.source }}

- {% if error.violations %} -
- Details - {% for violation in error.violations %} -

{{ violation.source }} {{ violation.message }}

- {% endfor %} -
- {% endif %} - -
- - diff --git a/src/Annotation/JsonResponse.php b/src/Annotation/JsonResponse.php index 4b277ad2..2ccf5871 100644 --- a/src/Annotation/JsonResponse.php +++ b/src/Annotation/JsonResponse.php @@ -27,6 +27,8 @@ final class JsonResponse * * @param int $flags * @param int $depth + * + * @link http://php.net/json_encode */ public function __construct(public int $flags = 0, public int $depth = 512) { diff --git a/src/Annotation/PathVariable.php b/src/Annotation/PathVariable.php index 9f180e4a..d16e7874 100644 --- a/src/Annotation/PathVariable.php +++ b/src/Annotation/PathVariable.php @@ -25,7 +25,7 @@ final class PathVariable /** * Constructor of the class * - * @param non-empty-string|null $name + * @param non-empty-string|null $name If null, the parameter's name will be used. */ public function __construct(public ?string $name = null) { diff --git a/src/Annotation/SerializableResponse.php b/src/Annotation/SerializableResponse.php deleted file mode 100644 index 5ed38ae5..00000000 --- a/src/Annotation/SerializableResponse.php +++ /dev/null @@ -1,33 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation; - -use Attribute; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] -final class SerializableResponse -{ - - /** - * Constructor of the class - * - * @param array $context - */ - public function __construct(public array $context = []) - { - } -} diff --git a/src/Dictionary/Charset.php b/src/Dictionary/Charset.php index 8064b266..f368ea2a 100644 --- a/src/Dictionary/Charset.php +++ b/src/Dictionary/Charset.php @@ -14,18 +14,12 @@ namespace Sunrise\Http\Router\Dictionary; /** - * Charset - * * @since 3.0.0 */ final class Charset { public const WILDCARD = '*'; - public const DIGIT = [ - 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, - ]; - public const RFC7230_OWS = [ "\x09" => 1, "\x20" => 1, ]; diff --git a/src/Dictionary/ErrorSource.php b/src/Dictionary/ErrorSource.php deleted file mode 100644 index eeabb0b5..00000000 --- a/src/Dictionary/ErrorSource.php +++ /dev/null @@ -1,35 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Dictionary; - -/** - * ErrorSource - * - * @since 3.0.0 - */ -final class ErrorSource -{ - public const CLIENT_CREDENTIALS = 'client.credentials'; - public const CLIENT_PERMISSIONS = 'client.permissions'; - public const CLIENT_REQUEST = 'client.request'; - public const CLIENT_REQUEST_METHOD = 'client.request.method'; - public const CLIENT_REQUEST_URI = 'client.request.uri'; - public const CLIENT_REQUEST_PATH = 'client.request.path'; - public const CLIENT_REQUEST_QUERY = 'client.request.query'; - public const CLIENT_REQUEST_COOKIE = 'client.request.cookie'; - public const CLIENT_REQUEST_HEADER = 'client.request.header'; - public const CLIENT_REQUEST_BODY = 'client.request.body'; - public const DEPENDENCY = 'dependency'; - public const SERVER = 'server'; -} diff --git a/src/Dto/ErrorDto.php b/src/Dto/ErrorDto.php deleted file mode 100644 index ffaf4c5b..00000000 --- a/src/Dto/ErrorDto.php +++ /dev/null @@ -1,54 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Dto; - -use Sunrise\Http\Router\Dictionary\ErrorSource; -use Sunrise\Http\Router\Exception\HttpExceptionInterface; - -/** - * @since 3.0.0 - */ -final class ErrorDto -{ - - /** - * Constructor of the class - * - * @param string $source See the {@see ErrorSource} dictionary. - * @param string $message - * @param list $violations - */ - public function __construct( - public string $source, - public string $message, - public array $violations, - ) { - } - - /** - * Creates the error from the given HTTP error - * - * @param HttpExceptionInterface $error - * - * @return self - */ - public static function fromHttpError(HttpExceptionInterface $error): self - { - return new self( - $error->getSource(), - $error->getMessage(), - $error->getViolations(), - ); - } -} diff --git a/src/Dto/ViolationDto.php b/src/Dto/ViolationDto.php deleted file mode 100644 index d8dbc9ba..00000000 --- a/src/Dto/ViolationDto.php +++ /dev/null @@ -1,66 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Dto; - -use Sunrise\Hydrator\Exception\InvalidValueException; -use Symfony\Component\Validator\ConstraintViolationInterface; - -/** - * @since 3.0.0 - */ -final class ViolationDto -{ - - /** - * Constructor of the class - * - * @param string $source - * @param string $message - */ - public function __construct( - public string $source, - public string $message, - ) { - } - - /** - * Creates the violation from the given hydrator violation - * - * @param InvalidValueException $violation - * - * @return self - */ - public static function fromHydratorViolation(InvalidValueException $violation): self - { - return new self( - $violation->getPropertyPath(), - $violation->getMessage(), - ); - } - - /** - * Creates the violation from the given validator violation - * - * @param ConstraintViolationInterface $violation - * - * @return self - */ - public static function fromValidatorViolation(ConstraintViolationInterface $violation): self - { - return new self( - $violation->getPropertyPath(), - (string) $violation->getMessage(), - ); - } -} diff --git a/src/Entity/Language.php b/src/Entity/Language.php index a60a5b77..19c02ed5 100644 --- a/src/Entity/Language.php +++ b/src/Entity/Language.php @@ -16,11 +16,7 @@ use Stringable; use Sunrise\Http\Router\Dictionary\Charset; -use function join; - /** - * Language - * * @since 3.0.0 */ final class Language implements Stringable @@ -71,6 +67,10 @@ public function getParameters(): array * Gets the language parameter's value by its given name or * returns the given default value if the parameter doesn't exist or is empty * + * + * $language->getParameter('q', '1.0'); + * + * * @param string $name * @param ?string $default * @@ -84,7 +84,7 @@ public function getParameter(string $name, ?string $default = null): ?string /** * Checks if this language's code equals to the given language's code * - * Please note that when comparing languages, their subtags are not factored in. + * Please note that when comparing languages, their subtags aren't factored in. * * @param Language $other * @@ -100,6 +100,12 @@ public function equals(Language $other): bool */ public function __toString(): string { - return join('-', [$this->code, ...$this->subtags]); + $result = $this->code; + + foreach ($this->subtags as $subtag) { + $result .= '-' . $subtag; + } + + return $result; } } diff --git a/src/Entity/MediaType.php b/src/Entity/MediaType.php index a7c238d7..f09ab2cb 100644 --- a/src/Entity/MediaType.php +++ b/src/Entity/MediaType.php @@ -17,8 +17,6 @@ use Sunrise\Http\Router\Dictionary\Charset; /** - * MediaType - * * @since 3.0.0 */ final class MediaType implements Stringable @@ -141,6 +139,10 @@ public function getParameters(): array * Gets the media type parameter's value by its given name or * returns the given default value if the parameter doesn't exist or is empty * + * + * $mediaType->getParameter('q', '1.0'); + * + * * @param string $name * @param ?string $default * diff --git a/src/Event/ErrorOccurredEvent.php b/src/Event/ErrorOccurredEvent.php deleted file mode 100644 index 64479145..00000000 --- a/src/Event/ErrorOccurredEvent.php +++ /dev/null @@ -1,75 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Event; - -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Throwable; - -/** - * ErrorOccurredEvent - * - * @since 3.0.0 - */ -final class ErrorOccurredEvent extends AbstractEvent -{ - - /** - * Constructor of the class - * - * @param Throwable $error - * @param ServerRequestInterface $request - * @param ResponseInterface $response - */ - public function __construct( - private Throwable $error, - private ServerRequestInterface $request, - private ResponseInterface $response, - ) { - } - - /** - * @return Throwable - */ - public function getError(): Throwable - { - return $this->error; - } - - /** - * @return ServerRequestInterface - */ - public function getRequest(): ServerRequestInterface - { - return $this->request; - } - - /** - * @return ResponseInterface - */ - public function getResponse(): ResponseInterface - { - return $this->response; - } - - /** - * @param ResponseInterface $response - * - * @return void - */ - public function setResponse(ResponseInterface $response): void - { - $this->response = $response; - } -} diff --git a/src/Event/ResponseResolvedEvent.php b/src/Event/ResponseResolvedEvent.php index bd809d79..1cbaee5d 100644 --- a/src/Event/ResponseResolvedEvent.php +++ b/src/Event/ResponseResolvedEvent.php @@ -19,8 +19,6 @@ use ReflectionMethod; /** - * ResponseResolvedEvent - * * @since 3.0.0 */ final class ResponseResolvedEvent extends AbstractEvent diff --git a/src/Event/RouteMatchedEvent.php b/src/Event/RouteMatchedEvent.php index 2a451b4a..9a4982b9 100644 --- a/src/Event/RouteMatchedEvent.php +++ b/src/Event/RouteMatchedEvent.php @@ -17,8 +17,6 @@ use Sunrise\Http\Router\RouteInterface; /** - * RouteMatchedEvent - * * @since 3.0.0 */ final class RouteMatchedEvent extends AbstractEvent diff --git a/src/EventListener/ErrorOccurredEventListenerDisplayingFatalError.php b/src/EventListener/ErrorOccurredEventListenerDisplayingFatalError.php deleted file mode 100644 index 9c908ed9..00000000 --- a/src/EventListener/ErrorOccurredEventListenerDisplayingFatalError.php +++ /dev/null @@ -1,93 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\EventListener; - -use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Event\ErrorOccurredEvent; -use Sunrise\Http\Router\Exception\Http\HttpInternalServerErrorException; -use Sunrise\Http\Router\Exception\LogicException; -use Sunrise\Http\Router\ServerRequest; -use Whoops\Handler\JsonResponseHandler; -use Whoops\Handler\PrettyPageHandler; -use Whoops\Handler\XmlResponseHandler; -use Whoops\Run as Whoops; - -use function class_exists; - -/** - * Renders fatal errors using the whoops package - * - * @link https://github.com/filp/whoops - * - * @since 3.0.0 - */ -final class ErrorOccurredEventListenerDisplayingFatalError -{ - - /** - * Constructor of the class - * - * @throws LogicException If the filp/whoops package wasn't installed. - */ - public function __construct() - { - if (!class_exists(Whoops::class)) { - throw new LogicException( - 'The whoops package is required to display fatal errors, ' . - 'run the `composer require filp/whoops` to resolve it.' - ); - } - } - - /** - * Handles the given event - * - * @param ErrorOccurredEvent $event - * - * @return ErrorOccurredEvent - */ - public function __invoke(ErrorOccurredEvent $event): ErrorOccurredEvent - { - $error = $event->getError(); - if (! $error instanceof HttpInternalServerErrorException) { - return $event; - } - - $whoops = new Whoops(); - $whoops->allowQuit(false); - $whoops->writeToOutput(false); - - $serverProducesMediaTypes = [MediaType::html(), MediaType::json(), MediaType::xml()]; - $clientPreferredMediaType = ServerRequest::from($event->getRequest()) - ->getClientPreferredMediaType(...$serverProducesMediaTypes) - ?? $serverProducesMediaTypes[0]; - - if ($clientPreferredMediaType === $serverProducesMediaTypes[0]) { - $whoops->pushHandler(new PrettyPageHandler()); - } elseif ($clientPreferredMediaType === $serverProducesMediaTypes[1]) { - $whoops->pushHandler(new JsonResponseHandler()); - } elseif ($clientPreferredMediaType === $serverProducesMediaTypes[2]) { - $whoops->pushHandler(new XmlResponseHandler()); - } - - $mimeType = $clientPreferredMediaType . '; charset=UTF-8'; - $response = $event->getResponse()->withHeader('Content-Type', $mimeType); - $response->getBody()->write($whoops->handleException($error->getError())); - - $event->setResponse($response); - $event->stopPropagation(); - - return $event; - } -} diff --git a/src/EventListener/ErrorOccurredEventListenerRenderingHtmlError.php b/src/EventListener/ErrorOccurredEventListenerRenderingHtmlError.php deleted file mode 100644 index d9cf739e..00000000 --- a/src/EventListener/ErrorOccurredEventListenerRenderingHtmlError.php +++ /dev/null @@ -1,87 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\EventListener; - -use Sunrise\Http\Router\Dto\ErrorDto; -use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Event\ErrorOccurredEvent; -use Sunrise\Http\Router\Exception\HttpExceptionInterface; -use Sunrise\Http\Router\ServerRequest; -use Twig\Environment; -use Twig\Loader\FilesystemLoader; - -use function in_array; - -/** - * Renders errors using the twig package - * - * @link https://github.com/twigphp/Twig - * - * @since 3.0.0 - */ -final class ErrorOccurredEventListenerRenderingHtmlError -{ - - /** - * Constructor of the class - * - * @param Environment $twig - */ - public function __construct(private Environment $twig) - { - } - - /** - * Handles the given event - * - * @param ErrorOccurredEvent $event - * - * @return ErrorOccurredEvent - */ - public function __invoke(ErrorOccurredEvent $event): ErrorOccurredEvent - { - $error = $event->getError(); - if (! $error instanceof HttpExceptionInterface) { - return $event; - } - - $request = ServerRequest::from($event->getRequest()); - if (! $request->clientConsumesMediaType(MediaType::html())) { - return $event; - } - - $loader = $this->twig->getLoader(); - if ($loader instanceof FilesystemLoader) { - $dirname = __DIR__ . '/../../resources/templates'; - if (!in_array($dirname, $loader->getPaths())) { - $loader->addPath($dirname); - } - } - - $response = $event->getResponse()->withHeader('Content-Type', 'text/html; charset=UTF-8'); - - $response->getBody()->write( - $this->twig->render('error.twig.html', [ - 'statusCode' => $response->getStatusCode(), - 'reasonPhrase' => $response->getReasonPhrase(), - 'error' => ErrorDto::fromHttpError($error), - ]) - ); - - $event->setResponse($response); - $event->stopPropagation(); - - return $event; - } -} diff --git a/src/EventListener/ErrorOccurredEventListenerRenderingSerializedError.php b/src/EventListener/ErrorOccurredEventListenerRenderingSerializedError.php deleted file mode 100644 index 6b9e2ef3..00000000 --- a/src/EventListener/ErrorOccurredEventListenerRenderingSerializedError.php +++ /dev/null @@ -1,99 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\EventListener; - -use Sunrise\Http\Router\Dto\ErrorDto; -use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Event\ErrorOccurredEvent; -use Sunrise\Http\Router\Exception\HttpExceptionInterface; -use Sunrise\Http\Router\ServerRequest; -use Symfony\Component\Serializer\Encoder\JsonEncode; -use Symfony\Component\Serializer\Encoder\JsonEncoder; -use Symfony\Component\Serializer\Encoder\XmlEncoder; -use Symfony\Component\Serializer\SerializerInterface; - -use const JSON_PARTIAL_OUTPUT_ON_ERROR; - -/** - * Renders errors using the symfony/serializer package - * - * @link https://github.com/symfony/serializer - * - * @since 3.0.0 - */ -final class ErrorOccurredEventListenerRenderingSerializedError -{ - - /** - * Constructor of the class - * - * @param SerializerInterface $serializer - */ - public function __construct(private SerializerInterface $serializer) - { - } - - /** - * Handles the given event - * - * @param ErrorOccurredEvent $event - * - * @return ErrorOccurredEvent - */ - public function __invoke(ErrorOccurredEvent $event): ErrorOccurredEvent - { - $error = $event->getError(); - if (! $error instanceof HttpExceptionInterface) { - return $event; - } - - $serverProducesMediaTypes = [MediaType::json(), MediaType::xml()]; - $clientPreferredMediaType = ServerRequest::from($event->getRequest()) - ->getClientPreferredMediaType(...$serverProducesMediaTypes) - ?? $serverProducesMediaTypes[0]; - - $mimeType = $clientPreferredMediaType . '; charset=UTF-8'; - $response = $event->getResponse()->withHeader('Content-Type', $mimeType); - - $response->getBody()->write( - match ($clientPreferredMediaType) { - $serverProducesMediaTypes[0] => $this->renderJsonError($error), - default => $this->renderXmlError($error), - } - ); - - $event->setResponse($response); - $event->stopPropagation(); - - return $event; - } - - private function renderJsonError(HttpExceptionInterface $error): string - { - $view = ErrorDto::fromHttpError($error); - - return $this->serializer->serialize($view, JsonEncoder::FORMAT, [ - JsonEncode::OPTIONS => JSON_PARTIAL_OUTPUT_ON_ERROR, - ]); - } - - private function renderXmlError(HttpExceptionInterface $error): string - { - $view = ErrorDto::fromHttpError($error); - - return $this->serializer->serialize($view, XmlEncoder::FORMAT, [ - XmlEncoder::ROOT_NODE_NAME => 'error', - ]); - } -} diff --git a/src/Exception/Exception.php b/src/Exception/Exception.php index ddcf312e..52d29dfb 100644 --- a/src/Exception/Exception.php +++ b/src/Exception/Exception.php @@ -16,7 +16,7 @@ use Exception as BaseException; /** - * The package base exception + * The package's base exception */ class Exception extends BaseException implements ExceptionInterface { diff --git a/src/Exception/ExceptionInterface.php b/src/Exception/ExceptionInterface.php index ce8b7d6b..8e8b28c8 100644 --- a/src/Exception/ExceptionInterface.php +++ b/src/Exception/ExceptionInterface.php @@ -16,7 +16,7 @@ use Throwable; /** - * The package base exception interface + * The package's base exception interface */ interface ExceptionInterface extends Throwable { diff --git a/src/Exception/Http/HttpBadRequestException.php b/src/Exception/Http/HttpBadRequestException.php index 32cae148..33d7bd6f 100644 --- a/src/Exception/Http/HttpBadRequestException.php +++ b/src/Exception/Http/HttpBadRequestException.php @@ -26,6 +26,13 @@ class HttpBadRequestException extends HttpException { + /** + * The error's default message + * + * @var string + */ + public const DEFAULT_MESSAGE = 'The request could not be processed due to malformed syntax or invalid parameters.'; + /** * Constructor of the class * @@ -35,8 +42,6 @@ class HttpBadRequestException extends HttpException */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'The request could not be processed due to malformed syntax or invalid parameters.'; - - parent::__construct(self::STATUS_BAD_REQUEST, $message, $code, $previous); + parent::__construct(self::STATUS_BAD_REQUEST, $message ?? self::DEFAULT_MESSAGE, $code, $previous); } } diff --git a/src/Exception/Http/HttpConflictException.php b/src/Exception/Http/HttpConflictException.php index db0b7477..59150575 100644 --- a/src/Exception/Http/HttpConflictException.php +++ b/src/Exception/Http/HttpConflictException.php @@ -26,6 +26,14 @@ class HttpConflictException extends HttpException { + /** + * The error's default message + * + * @var string + */ + // phpcs:ignore Generic.Files.LineLength + public const DEFAULT_MESSAGE = 'The request could not be processed due to conflicts with the resource‘s current state.'; + /** * Constructor of the class * @@ -35,8 +43,6 @@ class HttpConflictException extends HttpException */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'The request could not be processed due to conflicts with the resource‘s current state.'; - - parent::__construct(self::STATUS_CONFLICT, $message, $code, $previous); + parent::__construct(self::STATUS_CONFLICT, $message ?? self::DEFAULT_MESSAGE, $code, $previous); } } diff --git a/src/Exception/Http/HttpFailedDependencyException.php b/src/Exception/Http/HttpFailedDependencyException.php index 9be6f68c..3a20e7df 100644 --- a/src/Exception/Http/HttpFailedDependencyException.php +++ b/src/Exception/Http/HttpFailedDependencyException.php @@ -13,7 +13,6 @@ namespace Sunrise\Http\Router\Exception\Http; -use Sunrise\Http\Router\Dictionary\ErrorSource; use Sunrise\Http\Router\Exception\HttpException; use Throwable; @@ -27,6 +26,14 @@ class HttpFailedDependencyException extends HttpException { + /** + * The error's default message + * + * @var string + */ + // phpcs:ignore Generic.Files.LineLength + public const DEFAULT_MESSAGE = 'The request could not be processed due to failures with the resource‘s dependencies.'; + /** * Constructor of the class * @@ -36,10 +43,6 @@ class HttpFailedDependencyException extends HttpException */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'The request could not be processed due to failures with the resource‘s dependencies.'; - - parent::__construct(self::STATUS_FAILED_DEPENDENCY, $message, $code, $previous); - - $this->setSource(ErrorSource::DEPENDENCY); + parent::__construct(self::STATUS_FAILED_DEPENDENCY, $message ?? self::DEFAULT_MESSAGE, $code, $previous); } } diff --git a/src/Exception/Http/HttpForbiddenException.php b/src/Exception/Http/HttpForbiddenException.php index d7bdc586..865c182a 100644 --- a/src/Exception/Http/HttpForbiddenException.php +++ b/src/Exception/Http/HttpForbiddenException.php @@ -13,7 +13,6 @@ namespace Sunrise\Http\Router\Exception\Http; -use Sunrise\Http\Router\Dictionary\ErrorSource; use Sunrise\Http\Router\Exception\HttpException; use Throwable; @@ -27,6 +26,13 @@ class HttpForbiddenException extends HttpException { + /** + * The error's default message + * + * @var string + */ + public const DEFAULT_MESSAGE = 'The request could not be processed due to insufficient permissions.'; + /** * Constructor of the class * @@ -36,10 +42,6 @@ class HttpForbiddenException extends HttpException */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'The request could not be processed due to insufficient permissions.'; - - parent::__construct(self::STATUS_FORBIDDEN, $message, $code, $previous); - - $this->setSource(ErrorSource::CLIENT_PERMISSIONS); + parent::__construct(self::STATUS_FORBIDDEN, $message ?? self::DEFAULT_MESSAGE, $code, $previous); } } diff --git a/src/Exception/Http/HttpGoneException.php b/src/Exception/Http/HttpGoneException.php deleted file mode 100644 index fe364463..00000000 --- a/src/Exception/Http/HttpGoneException.php +++ /dev/null @@ -1,42 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Gone Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/410 - * - * @since 3.0.0 - */ -class HttpGoneException extends HttpException -{ - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - $message ??= 'The resource is no longer available.'; - - parent::__construct(self::STATUS_GONE, $message, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpInternalServerErrorException.php b/src/Exception/Http/HttpInternalServerErrorException.php index 4795f334..f6db02c6 100644 --- a/src/Exception/Http/HttpInternalServerErrorException.php +++ b/src/Exception/Http/HttpInternalServerErrorException.php @@ -13,7 +13,6 @@ namespace Sunrise\Http\Router\Exception\Http; -use Sunrise\Http\Router\Dictionary\ErrorSource; use Sunrise\Http\Router\Exception\HttpException; use Throwable; @@ -27,6 +26,14 @@ class HttpInternalServerErrorException extends HttpException { + /** + * The error's default message + * + * @var string + */ + // phpcs:ignore Generic.Files.LineLength + public const DEFAULT_MESSAGE = 'The server encountered an unexpected condition that prevented it from fulfilling the request.'; + /** * Constructor of the class * @@ -36,19 +43,15 @@ class HttpInternalServerErrorException extends HttpException */ public function __construct(Throwable $error, ?string $message = null, int $code = 0) { - $message ??= 'The server encountered an unexpected condition that prevented it from fulfilling the request.'; - - parent::__construct(self::STATUS_INTERNAL_SERVER_ERROR, $message, $code, $error); - - $this->setSource(ErrorSource::SERVER); + parent::__construct(self::STATUS_INTERNAL_SERVER_ERROR, $message ?? self::DEFAULT_MESSAGE, $code, $error); } /** - * Gets the error + * Gets the server error * * @return Throwable */ - public function getError(): Throwable + public function getServerError(): Throwable { /** @var Throwable */ return $this->getPrevious(); diff --git a/src/Exception/Http/HttpLockedException.php b/src/Exception/Http/HttpLockedException.php index d525d40d..68516237 100644 --- a/src/Exception/Http/HttpLockedException.php +++ b/src/Exception/Http/HttpLockedException.php @@ -26,6 +26,14 @@ class HttpLockedException extends HttpException { + /** + * The error's default message + * + * @var string + */ + // phpcs:ignore Generic.Files.LineLength + public const DEFAULT_MESSAGE = 'The request could not be processed due to the resource‘s temporary lock and inaccessibility.'; + /** * Constructor of the class * @@ -35,8 +43,6 @@ class HttpLockedException extends HttpException */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'The request could not be processed due to the resource‘s temporary lock and inaccessibility.'; - - parent::__construct(self::STATUS_LOCKED, $message, $code, $previous); + parent::__construct(self::STATUS_LOCKED, $message ?? self::DEFAULT_MESSAGE, $code, $previous); } } diff --git a/src/Exception/Http/HttpMethodNotAllowedException.php b/src/Exception/Http/HttpMethodNotAllowedException.php index d570fe50..e6123cac 100644 --- a/src/Exception/Http/HttpMethodNotAllowedException.php +++ b/src/Exception/Http/HttpMethodNotAllowedException.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router\Exception\Http; use Stringable; -use Sunrise\Http\Router\Dictionary\ErrorSource; use Sunrise\Http\Router\Exception\HttpException; use Throwable; @@ -28,6 +27,13 @@ class HttpMethodNotAllowedException extends HttpException { + /** + * The error's default message + * + * @var string + */ + public const DEFAULT_MESSAGE = 'The request could not be processed using the requested HTTP method.'; + /** * Constructor of the class * @@ -39,14 +45,10 @@ class HttpMethodNotAllowedException extends HttpException // phpcs:ignore Generic.Files.LineLength public function __construct(private array $allowedMethods, ?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'The request could not be processed using the requested HTTP method.'; - - parent::__construct(self::STATUS_METHOD_NOT_ALLOWED, $message, $code, $previous); - - $this->setSource(ErrorSource::CLIENT_REQUEST_METHOD); + parent::__construct(self::STATUS_METHOD_NOT_ALLOWED, $message ?? self::DEFAULT_MESSAGE, $code, $previous); // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Allow - $this->addHeader('Allow', ...$allowedMethods); + $this->addHeaderField('Allow', ...$allowedMethods); } /** diff --git a/src/Exception/Http/HttpNotFoundException.php b/src/Exception/Http/HttpNotFoundException.php index 0718a64a..dc2d1103 100644 --- a/src/Exception/Http/HttpNotFoundException.php +++ b/src/Exception/Http/HttpNotFoundException.php @@ -13,7 +13,6 @@ namespace Sunrise\Http\Router\Exception\Http; -use Sunrise\Http\Router\Dictionary\ErrorSource; use Sunrise\Http\Router\Exception\HttpException; use Throwable; @@ -27,6 +26,13 @@ class HttpNotFoundException extends HttpException { + /** + * The error's default message + * + * @var string + */ + public const DEFAULT_MESSAGE = 'The requested page or resource could not be found.'; + /** * Constructor of the class * @@ -36,10 +42,6 @@ class HttpNotFoundException extends HttpException */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'The requested page or resource could not be found.'; - - parent::__construct(self::STATUS_NOT_FOUND, $message, $code, $previous); - - $this->setSource(ErrorSource::CLIENT_REQUEST_URI); + parent::__construct(self::STATUS_NOT_FOUND, $message ?? self::DEFAULT_MESSAGE, $code, $previous); } } diff --git a/src/Exception/Http/HttpPayloadTooLargeException.php b/src/Exception/Http/HttpPayloadTooLargeException.php index 1071a5cd..ab30cab9 100644 --- a/src/Exception/Http/HttpPayloadTooLargeException.php +++ b/src/Exception/Http/HttpPayloadTooLargeException.php @@ -13,7 +13,6 @@ namespace Sunrise\Http\Router\Exception\Http; -use Sunrise\Http\Router\Dictionary\ErrorSource; use Sunrise\Http\Router\Exception\HttpException; use Throwable; @@ -27,6 +26,13 @@ class HttpPayloadTooLargeException extends HttpException { + /** + * The error's default message + * + * @var string + */ + public const DEFAULT_MESSAGE = 'The request could not be processed due to the payload size exceeding limits.'; + /** * Constructor of the class * @@ -36,10 +42,6 @@ class HttpPayloadTooLargeException extends HttpException */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'The request could not be processed due to the payload size exceeding limits.'; - - parent::__construct(self::STATUS_PAYLOAD_TOO_LARGE, $message, $code, $previous); - - $this->setSource(ErrorSource::CLIENT_REQUEST_BODY); + parent::__construct(self::STATUS_PAYLOAD_TOO_LARGE, $message ?? self::DEFAULT_MESSAGE, $code, $previous); } } diff --git a/src/Exception/Http/HttpServiceUnavailableException.php b/src/Exception/Http/HttpServiceUnavailableException.php index e183a9e8..0cc25725 100644 --- a/src/Exception/Http/HttpServiceUnavailableException.php +++ b/src/Exception/Http/HttpServiceUnavailableException.php @@ -13,7 +13,6 @@ namespace Sunrise\Http\Router\Exception\Http; -use Sunrise\Http\Router\Dictionary\ErrorSource; use Sunrise\Http\Router\Exception\HttpException; use Throwable; @@ -27,6 +26,14 @@ class HttpServiceUnavailableException extends HttpException { + /** + * The error's default message + * + * @var string + */ + // phpcs:ignore Generic.Files.LineLength + public const DEFAULT_MESSAGE = 'The server is currently unable to process the request due to temporary overloading or maintenance.'; + /** * Constructor of the class * @@ -36,11 +43,6 @@ class HttpServiceUnavailableException extends HttpException */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - // phpcs:ignore Generic.Files.LineLength - $message ??= 'The server is currently unable to process the request due to temporary overloading or maintenance.'; - - parent::__construct(self::STATUS_SERVICE_UNAVAILABLE, $message, $code, $previous); - - $this->setSource(ErrorSource::SERVER); + parent::__construct(self::STATUS_SERVICE_UNAVAILABLE, $message ?? self::DEFAULT_MESSAGE, $code, $previous); } } diff --git a/src/Exception/Http/HttpTooManyRequestsException.php b/src/Exception/Http/HttpTooManyRequestsException.php index 29347a32..61af43aa 100644 --- a/src/Exception/Http/HttpTooManyRequestsException.php +++ b/src/Exception/Http/HttpTooManyRequestsException.php @@ -26,6 +26,13 @@ class HttpTooManyRequestsException extends HttpException { + /** + * The error's default message + * + * @var string + */ + public const DEFAULT_MESSAGE = 'The request could not be processed due to exceeding rate-limiting thresholds.'; + /** * Constructor of the class * @@ -35,8 +42,6 @@ class HttpTooManyRequestsException extends HttpException */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'The request could not be processed due to exceeding rate-limiting thresholds.'; - - parent::__construct(self::STATUS_TOO_MANY_REQUESTS, $message, $code, $previous); + parent::__construct(self::STATUS_TOO_MANY_REQUESTS, $message ?? self::DEFAULT_MESSAGE, $code, $previous); } } diff --git a/src/Exception/Http/HttpUnauthorizedException.php b/src/Exception/Http/HttpUnauthorizedException.php index 097579da..0b8c6351 100644 --- a/src/Exception/Http/HttpUnauthorizedException.php +++ b/src/Exception/Http/HttpUnauthorizedException.php @@ -13,7 +13,6 @@ namespace Sunrise\Http\Router\Exception\Http; -use Sunrise\Http\Router\Dictionary\ErrorSource; use Sunrise\Http\Router\Exception\HttpException; use Throwable; @@ -27,6 +26,14 @@ class HttpUnauthorizedException extends HttpException { + /** + * The error's default message + * + * @var string + */ + // phpcs:ignore Generic.Files.LineLength + public const DEFAULT_MESSAGE = 'The request could not processed due to insufficient or invalid authentication credentials.'; + /** * Constructor of the class * @@ -36,10 +43,6 @@ class HttpUnauthorizedException extends HttpException */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'The request could not processed due to insufficient or invalid authentication credentials.'; - - parent::__construct(self::STATUS_UNAUTHORIZED, $message, $code, $previous); - - $this->setSource(ErrorSource::CLIENT_CREDENTIALS); + parent::__construct(self::STATUS_UNAUTHORIZED, $message ?? self::DEFAULT_MESSAGE, $code, $previous); } } diff --git a/src/Exception/Http/HttpUnavailableForLegalReasonsException.php b/src/Exception/Http/HttpUnavailableForLegalReasonsException.php index a55ede29..fe9ac5a4 100644 --- a/src/Exception/Http/HttpUnavailableForLegalReasonsException.php +++ b/src/Exception/Http/HttpUnavailableForLegalReasonsException.php @@ -26,6 +26,13 @@ class HttpUnavailableForLegalReasonsException extends HttpException { + /** + * The error's default message + * + * @var string + */ + public const DEFAULT_MESSAGE = 'The request could not be processed due to legal restrictions.'; + /** * Constructor of the class * @@ -35,8 +42,7 @@ class HttpUnavailableForLegalReasonsException extends HttpException */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'The request could not be processed due to legal restrictions.'; - - parent::__construct(self::STATUS_UNAVAILABLE_FOR_LEGAL_REASONS, $message, $code, $previous); + // phpcs:ignore Generic.Files.LineLength + parent::__construct(self::STATUS_UNAVAILABLE_FOR_LEGAL_REASONS, $message ?? self::DEFAULT_MESSAGE, $code, $previous); } } diff --git a/src/Exception/Http/HttpUnprocessableEntityException.php b/src/Exception/Http/HttpUnprocessableEntityException.php index 2a4be054..3f583b41 100644 --- a/src/Exception/Http/HttpUnprocessableEntityException.php +++ b/src/Exception/Http/HttpUnprocessableEntityException.php @@ -26,6 +26,13 @@ class HttpUnprocessableEntityException extends HttpException { + /** + * The error's default message + * + * @var string + */ + public const DEFAULT_MESSAGE = 'The request could not be processed due to semantic violations.'; + /** * Constructor of the class * @@ -35,8 +42,6 @@ class HttpUnprocessableEntityException extends HttpException */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'The request could not be processed due to semantic violations.'; - - parent::__construct(self::STATUS_UNPROCESSABLE_ENTITY, $message, $code, $previous); + parent::__construct(self::STATUS_UNPROCESSABLE_ENTITY, $message ?? self::DEFAULT_MESSAGE, $code, $previous); } } diff --git a/src/Exception/Http/HttpUnsupportedMediaTypeException.php b/src/Exception/Http/HttpUnsupportedMediaTypeException.php index 63494a31..ca8f752b 100644 --- a/src/Exception/Http/HttpUnsupportedMediaTypeException.php +++ b/src/Exception/Http/HttpUnsupportedMediaTypeException.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router\Exception\Http; use Stringable; -use Sunrise\Http\Router\Dictionary\ErrorSource; use Sunrise\Http\Router\Exception\HttpException; use Throwable; @@ -28,6 +27,14 @@ class HttpUnsupportedMediaTypeException extends HttpException { + /** + * The error's default message + * + * @var string + */ + // phpcs:ignore Generic.Files.LineLength + public const DEFAULT_MESSAGE = 'The request could not be processed due to an unsupported format of the request payload.'; + /** * Constructor of the class * @@ -39,14 +46,10 @@ class HttpUnsupportedMediaTypeException extends HttpException // phpcs:ignore Generic.Files.LineLength public function __construct(private array $supportedMediaTypes, ?string $message = null, int $code = 0, ?Throwable $previous = null) { - $message ??= 'The request could not be processed due to an unsupported format of the request payload.'; - - parent::__construct(self::STATUS_UNSUPPORTED_MEDIA_TYPE, $message, $code, $previous); - - $this->setSource(ErrorSource::CLIENT_REQUEST_BODY); + parent::__construct(self::STATUS_UNSUPPORTED_MEDIA_TYPE, $message ?? self::DEFAULT_MESSAGE, $code, $previous); // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept - $this->addHeader('Accept', ...$supportedMediaTypes); + $this->addHeaderField('Accept', ...$supportedMediaTypes); } /** diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index 69d98d3c..ca8c39c3 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -15,16 +15,13 @@ use RuntimeException; use Stringable; -use Sunrise\Http\Router\Dictionary\ErrorSource; -use Sunrise\Http\Router\Dto\ViolationDto; -use Sunrise\Hydrator\Exception\InvalidValueException; -use Symfony\Component\Validator\ConstraintViolationInterface; +use Sunrise\Http\Router\Validation\ConstraintViolationInterface; use Throwable; use function join; /** - * Base HTTP exception + * The package's base HTTP exception * * @since 3.0.0 */ @@ -43,21 +40,14 @@ class HttpException extends RuntimeException implements HttpExceptionInterface * * @var list */ - private array $headers = []; + private array $headerFields = []; /** - * The error's source + * The list of constraint violations associated with the error * - * @var string + * @var list */ - private string $source = ErrorSource::CLIENT_REQUEST; - - /** - * The list of violations associated with the error - * - * @var list - */ - private array $violations = []; + private array $constraintViolations = []; /** * Constructor of the class @@ -85,53 +75,17 @@ final public function getStatusCode(): int /** * @inheritDoc */ - final public function getHeaders(): array + final public function getHeaderFields(): array { - return $this->headers; + return $this->headerFields; } /** * @inheritDoc */ - final public function getSource(): string + final public function getConstraintViolations(): array { - return $this->source; - } - - /** - * @inheritDoc - */ - final public function getViolations(): array - { - return $this->violations; - } - - /** - * Sets the given message to the error - * - * @param string $message - * - * @return static - */ - final public function setMessage(string $message): static - { - $this->message = $message; - - return $this; - } - - /** - * Sets the given HTTP status code that will be sent to the client - * - * @param int<100, 599> $statusCode - * - * @return static - */ - final public function setStatusCode(int $statusCode): static - { - $this->statusCode = $statusCode; - - return $this; + return $this->constraintViolations; } /** @@ -142,72 +96,27 @@ final public function setStatusCode(int $statusCode): static * * @return static */ - final public function addHeader(string $fieldName, Stringable|string ...$fieldValues): static + final public function addHeaderField(string $fieldName, Stringable|string ...$fieldValues): static { + // https://datatracker.ietf.org/doc/html/rfc7230#section-7 $fieldValue = join(', ', $fieldValues); - $this->headers[] = [$fieldName, $fieldValue]; - - return $this; - } - - /** - * Sets the given source to the error - * - * @param string $source - * - * @return static - */ - final public function setSource(string $source): static - { - $this->source = $source; - - return $this; - } - - /** - * Adds the given violation(s) associated with the error - * - * @param ViolationDto ...$violations - * - * @return static - */ - final public function addViolation(ViolationDto ...$violations): static - { - foreach ($violations as $violation) { - $this->violations[] = $violation; - } - - return $this; - } - - /** - * Adds the given hydrator violation(s) associated with the error - * - * @param InvalidValueException ...$violations - * - * @return static - */ - final public function addHydratorViolation(InvalidValueException ...$violations): static - { - foreach ($violations as $violation) { - $this->violations[] = ViolationDto::fromHydratorViolation($violation); - } + $this->headerFields[] = [$fieldName, $fieldValue]; return $this; } /** - * Adds the given validator violation(s) associated with the error + * Adds the given constraint violation(s) to the error * - * @param ConstraintViolationInterface ...$violations + * @param ConstraintViolationInterface ...$constraintViolations * * @return static */ - final public function addValidatorViolation(ConstraintViolationInterface ...$violations): static + final public function addConstraintViolation(ConstraintViolationInterface ...$constraintViolations): static { - foreach ($violations as $violation) { - $this->violations[] = ViolationDto::fromValidatorViolation($violation); + foreach ($constraintViolations as $constraintViolation) { + $this->constraintViolations[] = $constraintViolation; } return $this; diff --git a/src/Exception/HttpExceptionInterface.php b/src/Exception/HttpExceptionInterface.php index 9ed0ab59..96eef599 100644 --- a/src/Exception/HttpExceptionInterface.php +++ b/src/Exception/HttpExceptionInterface.php @@ -14,10 +14,10 @@ namespace Sunrise\Http\Router\Exception; use Fig\Http\Message\StatusCodeInterface; -use Sunrise\Http\Router\Dto\ViolationDto; +use Sunrise\Http\Router\Validation\ConstraintViolationInterface; /** - * Base HTTP exception interface + * The package's base HTTP exception interface * * @since 3.0.0 */ @@ -27,6 +27,8 @@ interface HttpExceptionInterface extends ExceptionInterface, StatusCodeInterface /** * Gets HTTP status code that will be sent to the client * + * See the {@see StatusCodeInterface} dictionary. + * * @return int<100, 599> */ public function getStatusCode(): int; @@ -36,19 +38,12 @@ public function getStatusCode(): int; * * @return list */ - public function getHeaders(): array; - - /** - * Gets the error's source - * - * @return string - */ - public function getSource(): string; + public function getHeaderFields(): array; /** - * Gets the list of violations associated with the error + * Gets the list of constraint violations associated with the error * - * @return list + * @return list */ - public function getViolations(): array; + public function getConstraintViolations(): array; } diff --git a/src/Helper/CallbackReflector.php b/src/Helper/CallbackReflector.php deleted file mode 100644 index a8196a04..00000000 --- a/src/Helper/CallbackReflector.php +++ /dev/null @@ -1,70 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Helper; - -use Closure; -use LogicException; -use ReflectionFunction; -use ReflectionMethod; - -use function function_exists; -use function is_array; -use function is_object; -use function is_string; -use function method_exists; -use function str_contains; - -/** - * Internal callback reflector - * - * @since 3.0.0 - */ -final class CallbackReflector -{ - - /** - * Tries to reflect the given callback - * - * @param callable $callback - * - * @return ReflectionFunction|ReflectionMethod - * - * @throws LogicException If the callback couldn't be reflected. - */ - public static function reflectCallback(callable $callback): ReflectionFunction|ReflectionMethod - { - if ($callback instanceof Closure) { - return new ReflectionFunction($callback); - } - - if (is_array($callback)) { - /** @psalm-suppress MixedArgument */ - return new ReflectionMethod(...$callback); - } - - if (is_object($callback) && method_exists($callback, '__invoke')) { - return new ReflectionMethod($callback, '__invoke'); - } - - if (is_string($callback) && str_contains($callback, '::')) { - return new ReflectionMethod($callback); - } - - if (is_string($callback) && function_exists($callback)) { - return new ReflectionFunction($callback); - } - - throw new LogicException('Unsupported callback declaration.'); - } -} diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php new file mode 100644 index 00000000..36f09798 --- /dev/null +++ b/src/Helper/RouteBuilder.php @@ -0,0 +1,58 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Helper; + +use InvalidArgumentException; +use Stringable; + +use function str_replace; + +/** + * Internal route builder + * + * @since 3.0.0 + */ +final class RouteBuilder +{ + + /** + * Builds the given route with the given variables + * + * @param string $route + * @param array $variables + * + * @return string + * + * @throws InvalidArgumentException + */ + public static function buildRoute(string $route, array $variables = []): string + { + $matches = RouteParser::parseRoute($route); + + $search = []; + $replace = []; + foreach ($matches as $match) { + $replacement = $variables[$match['name']] ?? $match['value'] ?? null; + + if (!isset($replacement) && !isset($match['isOptional'])) { + throw new InvalidArgumentException(); + } + + $search[] = $match['replaceable']; + $replace[] = (string) $replacement; + } + + return str_replace($search, $replace, $route); + } +} diff --git a/src/Helper/RouteCompiler.php b/src/Helper/RouteCompiler.php index 6245c99f..009ba00f 100644 --- a/src/Helper/RouteCompiler.php +++ b/src/Helper/RouteCompiler.php @@ -37,24 +37,31 @@ public static function compileRegex(string $route): string { $matches = RouteParser::parseRoute($route); + $search = []; + $replace = []; foreach ($matches as $match) { - $route = str_replace($match['variable'], '{' . $match['name'] . '}', $route); + $search[] = $match['variable']; + $replace[] = '{' . $match['name'] . '}'; } + $route = str_replace($search, $replace, $route); $route = addcslashes($route, '#$*+-.?[\]^|'); $route = str_replace(['(', ')'], ['(?:', ')?'], $route); + $search = []; + $replace = []; foreach ($matches as $match) { $pattern = $match['pattern'] ?? '[^/]+'; if (isset(Router::$patterns[$pattern])) { $pattern = Router::$patterns[$pattern]; } - $subpattern = '(?<' . $match['name'] . '>' . $pattern . ')'; - - $route = str_replace('{' . $match['name'] . '}', $subpattern, $route); + $search[] = '{' . $match['name'] . '}'; + $replace[] = '(?<' . $match['name'] . '>' . $pattern . ')'; } + $route = str_replace($search, $replace, $route); + return '#^' . $route . '$#uD'; } } diff --git a/src/Helper/RouteParser.php b/src/Helper/RouteParser.php index ccc665f2..10feda2b 100644 --- a/src/Helper/RouteParser.php +++ b/src/Helper/RouteParser.php @@ -35,18 +35,19 @@ final class RouteParser * name: string, * value?: string, * pattern?: string, - * optional?: true, - * before?: ?string, - * after?: ?string, - * variable: string + * isOptional?: true, + * variable: string, + * replaceable: string * }> * * @throws InvalidArgumentException If the route isn't valid. */ public static function parseRoute(string $route): array { + static $digits = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]; + // phpcs:ignore Generic.Files.LineLength - /** @var list $matches */ + /** @var list $matches */ $matches = []; $index = -1; @@ -89,7 +90,7 @@ public static function parseRoute(string $route): array } if ($optionalPartIsOccupied) { - $matches[$index]['optional'] = true; + $matches[$index]['isOptional'] = true; $matches[$index]['before'] = $optionalPartBeforeVariable; $matches[$index]['after'] = $optionalPartAfterVariable; } @@ -231,7 +232,7 @@ public static function parseRoute(string $route): array if ($inVariableName) { /** @psalm-suppress InvalidArrayOffset */ - if (!isset($matches[$index]['name']) && isset(Charset::DIGIT[$route[$offset]])) { + if (!isset($matches[$index]['name']) && isset($digits[$route[$offset]])) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An invalid character was found at position %d. ' . @@ -319,7 +320,7 @@ public static function parseRoute(string $route): array } // phpcs:ignore Generic.Files.LineLength - /** @var list $matches */ + /** @var list $matches */ foreach ($matches as $index => $match) { $matches[$index]['variable'] = '{' . $match['name']; @@ -332,10 +333,17 @@ public static function parseRoute(string $route): array } $matches[$index]['variable'] .= '}'; + + $matches[$index]['replaceable'] = $matches[$index]['variable']; + + if (isset($match['isOptional'])) { + // phpcs:ignore Generic.Files.LineLength + $matches[$index]['replaceable'] = '(' . ($match['before'] ?? '') . $matches[$index]['variable'] . ($match['after'] ?? '') . ')'; + } } // phpcs:ignore Generic.Files.LineLength - /** @var list $matches */ + /** @var list $matches */ return $matches; } diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index 472a5e8e..40304228 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -42,21 +42,6 @@ final class ConfigLoader implements LoaderInterface */ private array $resources = []; - /** - * @var RouteCollectionFactoryInterface - */ - private RouteCollectionFactoryInterface $collectionFactory; - - /** - * @var RouteFactoryInterface - */ - private RouteFactoryInterface $routeFactory; - - /** - * @var ReferenceResolverInterface - */ - private ReferenceResolverInterface $referenceResolver; - /** * Constructor of the class * @@ -65,13 +50,13 @@ final class ConfigLoader implements LoaderInterface * @param ReferenceResolverInterface|null $referenceResolver */ public function __construct( - ?RouteCollectionFactoryInterface $collectionFactory = null, - ?RouteFactoryInterface $routeFactory = null, - ?ReferenceResolverInterface $referenceResolver = null, + private ?RouteCollectionFactoryInterface $collectionFactory = null, + private ?RouteFactoryInterface $routeFactory = null, + private ?ReferenceResolverInterface $referenceResolver = null, ) { - $this->collectionFactory = $collectionFactory ?? new RouteCollectionFactory(); - $this->routeFactory = $routeFactory ?? new RouteFactory(); - $this->referenceResolver = $referenceResolver ?? new ReferenceResolver(); + $this->collectionFactory ??= new RouteCollectionFactory(); + $this->routeFactory ??= new RouteFactory(); + $this->referenceResolver ??= new ReferenceResolver(); } /** diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 6e461d30..e86b4e7e 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -66,26 +66,6 @@ final class DescriptorLoader implements LoaderInterface */ private array $resources = []; - /** - * @var RouteCollectionFactoryInterface - */ - private RouteCollectionFactoryInterface $collectionFactory; - - /** - * @var RouteFactoryInterface - */ - private RouteFactoryInterface $routeFactory; - - /** - * @var ReferenceResolverInterface - */ - private ReferenceResolverInterface $referenceResolver; - - /** - * @var CacheInterface|null - */ - private ?CacheInterface $cache; - /** * @var string|null */ @@ -100,16 +80,14 @@ final class DescriptorLoader implements LoaderInterface * @param CacheInterface|null $cache */ public function __construct( - ?RouteCollectionFactoryInterface $collectionFactory = null, - ?RouteFactoryInterface $routeFactory = null, - ?ReferenceResolverInterface $referenceResolver = null, - ?CacheInterface $cache = null, + private ?RouteCollectionFactoryInterface $collectionFactory = null, + private ?RouteFactoryInterface $routeFactory = null, + private ?ReferenceResolverInterface $referenceResolver = null, + private ?CacheInterface $cache = null, ) { - $this->collectionFactory = $collectionFactory ?? new RouteCollectionFactory(); - $this->routeFactory = $routeFactory ?? new RouteFactory(); - $this->referenceResolver = $referenceResolver ?? new ReferenceResolver(); - - $this->cache = $cache; + $this->collectionFactory ??= new RouteCollectionFactory(); + $this->routeFactory ??= new RouteFactory(); + $this->referenceResolver ??= new ReferenceResolver(); } /** @@ -415,8 +393,18 @@ private function supplementDescriptorFromClassOrMethod(Route $descriptor, Reflec private function getDirectoryClasses(string $dirname): Generator { /** @var array $filenames */ - // phpcs:ignore Generic.Files.LineLength - $filenames = iterator_to_array(new RegexIterator(new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dirname, FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_PATHNAME)), '/\.php$/')); + $filenames = iterator_to_array( + new RegexIterator( + new RecursiveIteratorIterator( + new RecursiveDirectoryIterator( + $dirname, + FilesystemIterator::KEY_AS_PATHNAME | + FilesystemIterator::CURRENT_AS_PATHNAME, + ), + ), + '/\.php$/', + ), + ); foreach ($filenames as $filename) { (static function (string $filename): void { diff --git a/src/Middleware/CallbackMiddleware.php b/src/Middleware/CallbackMiddleware.php index 87949609..8b50f06d 100644 --- a/src/Middleware/CallbackMiddleware.php +++ b/src/Middleware/CallbackMiddleware.php @@ -17,7 +17,8 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Helper\CallbackReflector; +use ReflectionFunction; +use ReflectionMethod; use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ObjectInjectionParameterResolver; use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; @@ -37,35 +38,21 @@ final class CallbackMiddleware implements MiddlewareInterface */ private $callback; - /** - * The callback's parameter resolutioner - * - * @var ParameterResolutionerInterface - */ - private ParameterResolutionerInterface $parameterResolutioner; - - /** - * The callback's response resolutioner - * - * @var ResponseResolutionerInterface - */ - private ResponseResolutionerInterface $responseResolutioner; - /** * Constructor of the class * * @param callable $callback + * @param ReflectionFunction|ReflectionMethod $callbackReflection * @param ParameterResolutionerInterface $parameterResolutioner * @param ResponseResolutionerInterface $responseResolutioner */ public function __construct( callable $callback, - ParameterResolutionerInterface $parameterResolutioner, - ResponseResolutionerInterface $responseResolutioner, + private ReflectionFunction|ReflectionMethod $callbackReflection, + private ParameterResolutionerInterface $parameterResolutioner, + private ResponseResolutionerInterface $responseResolutioner, ) { $this->callback = $callback; - $this->parameterResolutioner = $parameterResolutioner; - $this->responseResolutioner = $responseResolutioner; } /** @@ -73,18 +60,15 @@ public function __construct( */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - $responder = CallbackReflector::reflectCallback($this->callback); - $arguments = $this->parameterResolutioner ->withContext($request) ->withPriorityResolver( new ObjectInjectionParameterResolver($request), new ObjectInjectionParameterResolver($handler), ) - ->resolveParameters(...$responder->getParameters()); - - $response = ($this->callback)(...$arguments); + ->resolveParameters(...$this->callbackReflection->getParameters()); - return $this->responseResolutioner->resolveResponse($request, $response, $responder); + // phpcs:ignore Generic.Files.LineLength + return $this->responseResolutioner->resolveResponse($request, ($this->callback)(...$arguments), $this->callbackReflection); } } diff --git a/src/Middleware/CrossOriginResourceSharingMiddleware.php b/src/Middleware/CrossOriginResourceSharingMiddleware.php deleted file mode 100644 index de11c96e..00000000 --- a/src/Middleware/CrossOriginResourceSharingMiddleware.php +++ /dev/null @@ -1,84 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Middleware; - -use Neomerx\Cors\Contracts\AnalysisResultInterface; -use Neomerx\Cors\Contracts\AnalyzerInterface; -use Psr\Http\Message\ResponseFactoryInterface; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; - -/** - * Cross-origin resource sharing - * - * @link https://github.com/neomerx/cors-psr7 - * - * @since 3.0.0 - */ -final class CrossOriginResourceSharingMiddleware implements MiddlewareInterface -{ - - /** - * Constructor of the class - * - * @param ResponseFactoryInterface $responseFactory - * @param AnalyzerInterface $requestAnalyzer - */ - public function __construct( - private ResponseFactoryInterface $responseFactory, - private AnalyzerInterface $requestAnalyzer, - ) { - } - - /** - * @inheritDoc - */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface - { - $requestAnalysisResult = $this->requestAnalyzer->analyze($request); - - switch ($requestAnalysisResult->getRequestType()) { - case AnalysisResultInterface::TYPE_REQUEST_OUT_OF_CORS_SCOPE: - return $handler->handle($request); - - case AnalysisResultInterface::ERR_NO_HOST_HEADER: - case AnalysisResultInterface::ERR_ORIGIN_NOT_ALLOWED: - case AnalysisResultInterface::ERR_METHOD_NOT_SUPPORTED: - case AnalysisResultInterface::ERR_HEADERS_NOT_SUPPORTED: - return $this->responseFactory->createResponse(403); - - case AnalysisResultInterface::TYPE_PRE_FLIGHT_REQUEST: - $response = $this->responseFactory->createResponse(200); - /** @var array $preflightHeaders */ - $preflightHeaders = $requestAnalysisResult->getResponseHeaders(); - foreach ($preflightHeaders as $fieldName => $fieldValue) { - $response = $response->withHeader($fieldName, $fieldValue); - } - - return $response; - - default: - $response = $handler->handle($request); - /** @var array $preflightHeaders */ - $preflightHeaders = $requestAnalysisResult->getResponseHeaders(); - foreach ($preflightHeaders as $fieldName => $fieldValue) { - $response = $response->withHeader($fieldName, $fieldValue); - } - - return $response; - } - } -} diff --git a/src/Middleware/ErrorHandlingMiddleware.php b/src/Middleware/ErrorHandlingMiddleware.php deleted file mode 100644 index 0593a955..00000000 --- a/src/Middleware/ErrorHandlingMiddleware.php +++ /dev/null @@ -1,151 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Middleware; - -use Psr\EventDispatcher\EventDispatcherInterface; -use Psr\Http\Message\ResponseFactoryInterface; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; -use Psr\Log\LoggerInterface; -use SimpleXMLElement; -use Sunrise\Http\Router\Dto\ErrorDto; -use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Event\ErrorOccurredEvent; -use Sunrise\Http\Router\Exception\Http\HttpInternalServerErrorException; -use Sunrise\Http\Router\Exception\HttpExceptionInterface; -use Sunrise\Http\Router\ServerRequest; -use Throwable; - -use function extension_loaded; -use function json_encode; - -use const JSON_PARTIAL_OUTPUT_ON_ERROR; -use const LIBXML_COMPACT; -use const LIBXML_NOERROR; -use const LIBXML_NOWARNING; - -/** - * Error handling middleware - * - * @since 3.0.0 - */ -final class ErrorHandlingMiddleware implements MiddlewareInterface -{ - - /** - * Constructor of the class - * - * @param ResponseFactoryInterface $responseFactory - * @param EventDispatcherInterface|null $eventDispatcher - * @param LoggerInterface|null $logger - */ - public function __construct( - private ResponseFactoryInterface $responseFactory, - private ?EventDispatcherInterface $eventDispatcher = null, - private ?LoggerInterface $logger = null, - ) { - } - - /** - * @inheritDoc - */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface - { - try { - return $handler->handle($request); - } catch (HttpExceptionInterface $error) { - return $this->handleHttpError($error, $request); - } catch (Throwable $error) { - return $this->handleFatalError($error, $request); - } - } - - private function handleHttpError(HttpExceptionInterface $error, ServerRequestInterface $request): ResponseInterface - { - $response = $this->responseFactory->createResponse($error->getStatusCode()); - foreach ($error->getHeaders() as [$fieldName, $fieldValue]) { - $response = $response->withHeader($fieldName, $fieldValue); - } - - if (isset($this->eventDispatcher)) { - $event = new ErrorOccurredEvent($error, $request, $response); - $this->eventDispatcher->dispatch($event); - $response = $event->getResponse(); - } - - if ($response->getBody()->getSize() > 0) { - return $response; - } - - $serverProducesMediaTypes = [MediaType::json()]; - if (extension_loaded('simplexml')) { - $serverProducesMediaTypes[] = MediaType::xml(); - } - - $clientPreferredMediaType = ServerRequest::from($request) - ->getClientPreferredMediaType(...$serverProducesMediaTypes) - ?? $serverProducesMediaTypes[0]; - - $mimeType = $clientPreferredMediaType . '; charset=UTF-8'; - $response = $response->withHeader('Content-Type', $mimeType); - - $response->getBody()->write( - match ($clientPreferredMediaType) { - $serverProducesMediaTypes[0] => $this->renderJsonError($error), - default => $this->renderXmlError($error), - } - ); - - return $response; - } - - private function handleFatalError(Throwable $error, ServerRequestInterface $request): ResponseInterface - { - $this->logger?->error($error->getMessage(), ['error' => $error]); - - $httpError = new HttpInternalServerErrorException($error); - - return $this->handleHttpError($httpError, $request); - } - - private function renderJsonError(HttpExceptionInterface $error): string - { - $view = ErrorDto::fromHttpError($error); - - /** @var non-empty-string */ - return json_encode($view, flags: JSON_PARTIAL_OUTPUT_ON_ERROR); - } - - private function renderXmlError(HttpExceptionInterface $error): string - { - $xmlBlank = ''; - $xmlOptions = LIBXML_COMPACT | LIBXML_NOERROR | LIBXML_NOWARNING; - - $rootChild = new SimpleXMLElement($xmlBlank, $xmlOptions); - $rootChild->addChild('source', $error->getSource()); - $rootChild->addChild('message', $error->getMessage()); - - foreach ($error->getViolations() as $violation) { - /** @var SimpleXMLElement $violationChild */ - $violationChild = $rootChild->addChild('violations'); - $violationChild->addChild('source', $violation->source); - $violationChild->addChild('message', $violation->message); - } - - /** @var non-empty-string */ - return $rootChild->asXML(); - } -} diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 25b9f651..2f0204e5 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -18,7 +18,6 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Dictionary\ErrorSource; use Sunrise\Http\Router\Entity\MediaType; use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; use Sunrise\Http\Router\ServerRequest; @@ -61,20 +60,17 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface private function decodePayload(string $payload): array { if ($payload === '') { - throw (new HttpBadRequestException('JSON payload cannot be empty.')) - ->setSource(ErrorSource::CLIENT_REQUEST_BODY); + throw new HttpBadRequestException('JSON payload cannot be empty.'); } try { $data = json_decode($payload, true, flags: JSON_BIGINT_AS_STRING | JSON_THROW_ON_ERROR); } catch (JsonException $e) { - throw (new HttpBadRequestException('The JSON payload is invalid and could not be decoded.', previous: $e)) - ->setSource(ErrorSource::CLIENT_REQUEST_BODY); + throw new HttpBadRequestException('The JSON payload is invalid and could not be decoded.', previous: $e); } if (is_array($data) === false) { - throw (new HttpBadRequestException('The JSON payload must be in the form of an array or an object.')) - ->setSource(ErrorSource::CLIENT_REQUEST_BODY); + throw new HttpBadRequestException('The JSON payload must be in the form of an array or an object.'); } return $data; diff --git a/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php b/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php index b4b8815d..3229fca7 100644 --- a/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php @@ -18,11 +18,11 @@ use ReflectionAttribute; use ReflectionParameter; use Sunrise\Http\Router\Annotation\PathVariable; -use Sunrise\Http\Router\Dictionary\ErrorSource; use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; use Sunrise\Http\Router\RouteInterface; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; @@ -108,12 +108,10 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } catch (InvalidDataException $e) { throw (new HttpNotFoundException(previous: $e)) - ->setSource(ErrorSource::CLIENT_REQUEST_PATH) - ->addHydratorViolation(...$e->getExceptions()); + ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); } catch (InvalidValueException $e) { throw (new HttpNotFoundException(previous: $e)) - ->setSource(ErrorSource::CLIENT_REQUEST_PATH) - ->addHydratorViolation($e); + ->addConstraintViolation(...HydratorConstraintViolationProxy::create($e)); } } } diff --git a/src/ParameterResolving/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestBodyParameterResolver.php index 01f40e9a..0bff31a1 100644 --- a/src/ParameterResolving/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/RequestBodyParameterResolver.php @@ -18,10 +18,11 @@ use ReflectionNamedType; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestBody; -use Sunrise\Http\Router\Dictionary\ErrorSource; use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; @@ -82,16 +83,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $object = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidDataException $e) { throw (new HttpUnprocessableEntityException) - ->setSource(ErrorSource::CLIENT_REQUEST_BODY) - ->addHydratorViolation(...$e->getExceptions()); + ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); } if (isset($this->validator)) { $violations = $this->validator->validate($object); if ($violations->count() > 0) { throw (new HttpUnprocessableEntityException) - ->setSource(ErrorSource::CLIENT_REQUEST_BODY) - ->addValidatorViolation(...$violations); + ->addConstraintViolation(...ValidatorConstraintViolationProxy::create(...$violations)); } } diff --git a/src/ParameterResolving/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestCookieParameterResolver.php index e758894c..d065d649 100644 --- a/src/ParameterResolving/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/RequestCookieParameterResolver.php @@ -18,9 +18,9 @@ use ReflectionAttribute; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestCookie; -use Sunrise\Http\Router\Dictionary\ErrorSource; use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; @@ -74,8 +74,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return yield; } - throw (new HttpBadRequestException("The cookie {$attribute->name} must be provided.")) - ->setSource(ErrorSource::CLIENT_REQUEST_COOKIE); + throw new HttpBadRequestException("The cookie {$attribute->name} must be provided."); } try { @@ -86,12 +85,10 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } catch (InvalidDataException $e) { throw (new HttpBadRequestException(previous: $e)) - ->setSource(ErrorSource::CLIENT_REQUEST_COOKIE) - ->addHydratorViolation(...$e->getExceptions()); + ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); } catch (InvalidValueException $e) { throw (new HttpBadRequestException(previous: $e)) - ->setSource(ErrorSource::CLIENT_REQUEST_COOKIE) - ->addHydratorViolation($e); + ->addConstraintViolation(...HydratorConstraintViolationProxy::create($e)); } } } diff --git a/src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php index 068df1ca..4439b9e8 100644 --- a/src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php @@ -18,9 +18,9 @@ use ReflectionAttribute; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestHeader; -use Sunrise\Http\Router\Dictionary\ErrorSource; use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; @@ -73,8 +73,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return yield; } - throw (new HttpBadRequestException("The header {$attribute->name} must be provided.")) - ->setSource(ErrorSource::CLIENT_REQUEST_HEADER); + throw new HttpBadRequestException("The header {$attribute->name} must be provided."); } try { @@ -85,12 +84,10 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } catch (InvalidDataException $e) { throw (new HttpBadRequestException(previous: $e)) - ->setSource(ErrorSource::CLIENT_REQUEST_HEADER) - ->addHydratorViolation(...$e->getExceptions()); + ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); } catch (InvalidValueException $e) { throw (new HttpBadRequestException(previous: $e)) - ->setSource(ErrorSource::CLIENT_REQUEST_HEADER) - ->addHydratorViolation($e); + ->addConstraintViolation(...HydratorConstraintViolationProxy::create($e)); } } } diff --git a/src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php index 18e439b4..99313148 100644 --- a/src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php @@ -18,10 +18,11 @@ use ReflectionNamedType; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestQuery; -use Sunrise\Http\Router\Dictionary\ErrorSource; use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; @@ -82,16 +83,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $object = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { throw (new HttpUnprocessableEntityException) - ->setSource(ErrorSource::CLIENT_REQUEST_QUERY) - ->addHydratorViolation(...$e->getExceptions()); + ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); } if (isset($this->validator)) { $violations = $this->validator->validate($object); if ($violations->count() > 0) { throw (new HttpUnprocessableEntityException) - ->setSource(ErrorSource::CLIENT_REQUEST_QUERY) - ->addValidatorViolation(...$violations); + ->addConstraintViolation(...ValidatorConstraintViolationProxy::create(...$violations)); } } diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index eb8220f4..cd1beda2 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -18,6 +18,8 @@ use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use ReflectionClass; +use ReflectionFunction; +use ReflectionMethod; use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\Middleware\CallbackMiddleware; use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; @@ -42,16 +44,6 @@ final class ReferenceResolver implements ReferenceResolverInterface { - /** - * @var ParameterResolutionerInterface - */ - private ParameterResolutionerInterface $parameterResolutioner; - - /** - * @var ResponseResolutionerInterface - */ - private ResponseResolutionerInterface $responseResolutioner; - /** * @var array */ @@ -64,11 +56,11 @@ final class ReferenceResolver implements ReferenceResolverInterface * @param ResponseResolutionerInterface|null $responseResolutioner */ public function __construct( - ?ParameterResolutionerInterface $parameterResolutioner = null, - ?ResponseResolutionerInterface $responseResolutioner = null, + private ?ParameterResolutionerInterface $parameterResolutioner = null, + private ?ResponseResolutionerInterface $responseResolutioner = null, ) { - $this->parameterResolutioner = $parameterResolutioner ?? new ParameterResolutioner(); - $this->responseResolutioner = $responseResolutioner ?? new ResponseResolutioner(); + $this->parameterResolutioner ??= new ParameterResolutioner(); + $this->responseResolutioner ??= new ResponseResolutioner(); } /** @@ -83,7 +75,12 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface } if ($reference instanceof Closure) { - return new CallbackRequestHandler($reference, $this->parameterResolutioner, $this->responseResolutioner); + return new CallbackRequestHandler( + $reference, + new ReflectionFunction($reference), + $this->parameterResolutioner, + $this->responseResolutioner, + ); } // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 @@ -95,8 +92,12 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface } if (is_callable($reference)) { - // phpcs:ignore Generic.Files.LineLength - return new CallbackRequestHandler($reference, $this->parameterResolutioner, $this->responseResolutioner); + return new CallbackRequestHandler( + $reference, + new ReflectionMethod($reference[0], $reference[1]), + $this->parameterResolutioner, + $this->responseResolutioner, + ); } } @@ -122,7 +123,12 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface } if ($reference instanceof Closure) { - return new CallbackMiddleware($reference, $this->parameterResolutioner, $this->responseResolutioner); + return new CallbackMiddleware( + $reference, + new ReflectionFunction($reference), + $this->parameterResolutioner, + $this->responseResolutioner, + ); } if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { @@ -138,7 +144,12 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface } if (is_callable($reference)) { - return new CallbackMiddleware($reference, $this->parameterResolutioner, $this->responseResolutioner); + return new CallbackMiddleware( + $reference, + new ReflectionMethod($reference[0], $reference[1]), + $this->parameterResolutioner, + $this->responseResolutioner, + ); } } diff --git a/src/RequestHandler/CallbackRequestHandler.php b/src/RequestHandler/CallbackRequestHandler.php index f8edb9d4..2fab897b 100644 --- a/src/RequestHandler/CallbackRequestHandler.php +++ b/src/RequestHandler/CallbackRequestHandler.php @@ -18,7 +18,6 @@ use Psr\Http\Server\RequestHandlerInterface; use ReflectionFunction; use ReflectionMethod; -use Sunrise\Http\Router\Helper\CallbackReflector; use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ObjectInjectionParameterResolver; use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; @@ -38,35 +37,21 @@ final class CallbackRequestHandler implements RequestHandlerInterface */ private $callback; - /** - * The callback's parameter resolutioner - * - * @var ParameterResolutionerInterface - */ - private ParameterResolutionerInterface $parameterResolutioner; - - /** - * The callback's response resolutioner - * - * @var ResponseResolutionerInterface - */ - private ResponseResolutionerInterface $responseResolutioner; - /** * Constructor of the class * * @param callable $callback + * @param ReflectionFunction|ReflectionMethod $callbackReflection * @param ParameterResolutionerInterface $parameterResolutioner * @param ResponseResolutionerInterface $responseResolutioner */ public function __construct( callable $callback, - ParameterResolutionerInterface $parameterResolutioner, - ResponseResolutionerInterface $responseResolutioner, + private ReflectionFunction|ReflectionMethod $callbackReflection, + private ParameterResolutionerInterface $parameterResolutioner, + private ResponseResolutionerInterface $responseResolutioner, ) { $this->callback = $callback; - $this->parameterResolutioner = $parameterResolutioner; - $this->responseResolutioner = $responseResolutioner; } /** @@ -76,7 +61,7 @@ public function __construct( */ public function getCallbackReflection(): ReflectionFunction|ReflectionMethod { - return CallbackReflector::reflectCallback($this->callback); + return $this->callbackReflection; } /** @@ -84,17 +69,14 @@ public function getCallbackReflection(): ReflectionFunction|ReflectionMethod */ public function handle(ServerRequestInterface $request): ResponseInterface { - $responder = $this->getCallbackReflection(); - $arguments = $this->parameterResolutioner ->withContext($request) ->withPriorityResolver( new ObjectInjectionParameterResolver($request), ) - ->resolveParameters(...$responder->getParameters()); - - $response = ($this->callback)(...$arguments); + ->resolveParameters(...$this->callbackReflection->getParameters()); - return $this->responseResolutioner->resolveResponse($request, $response, $responder); + // phpcs:ignore Generic.Files.LineLength + return $this->responseResolutioner->resolveResponse($request, ($this->callback)(...$arguments), $this->callbackReflection); } } diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index 58c1442f..08f795f1 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -35,7 +35,7 @@ final class QueueableRequestHandler extends SplQueue implements RequestHandlerIn */ public function __construct( private RequestHandlerInterface $requestHandler, - MiddlewareInterface ...$middlewares + MiddlewareInterface ...$middlewares, ) { foreach ($middlewares as $middleware) { $this->enqueue($middleware); diff --git a/src/ResponseResolving/ResponseResolutioner.php b/src/ResponseResolving/ResponseResolutioner.php index 8b7306bb..cb92218a 100644 --- a/src/ResponseResolving/ResponseResolutioner.php +++ b/src/ResponseResolving/ResponseResolutioner.php @@ -82,7 +82,7 @@ public function resolveResponse( throw new LogicException(sprintf( 'The responder {%s} returned an unsupported response.', - self::stringifySource($responder), + self::stringifyResponder($responder), )); } @@ -124,18 +124,18 @@ private function handleResponse( } /** - * Stringifies the given source of a response + * Stringifies the given responder * - * @param ReflectionFunction|ReflectionMethod $source + * @param ReflectionFunction|ReflectionMethod $responder * * @return string */ - public static function stringifySource(ReflectionFunction|ReflectionMethod $source): string + public static function stringifyResponder(ReflectionFunction|ReflectionMethod $responder): string { - if ($source instanceof ReflectionMethod) { - return sprintf('%s::%s(...)', $source->getDeclaringClass()->getName(), $source->getName()); + if ($responder instanceof ReflectionMethod) { + return sprintf('%s::%s(...)', $responder->getDeclaringClass()->getName(), $responder->getName()); } - return sprintf('%s(...)', $source->getName()); + return sprintf('%s(...)', $responder->getName()); } } diff --git a/src/ResponseResolving/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolving/ResponseResolver/JsonResponseResolver.php index ece17ba7..2f4a2131 100644 --- a/src/ResponseResolving/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolving/ResponseResolver/JsonResponseResolver.php @@ -72,7 +72,7 @@ public function resolveResponse( } catch (JsonException $e) { throw new LogicException(sprintf( 'The responder {%s} returned a response that could not be encoded to JSON due to: %s', - ResponseResolutioner::stringifySource($responder), + ResponseResolutioner::stringifyResponder($responder), $e->getMessage(), )); } diff --git a/src/ResponseResolving/ResponseResolver/SerializableResponseResolver.php b/src/ResponseResolving/ResponseResolver/SerializableResponseResolver.php deleted file mode 100644 index ff196193..00000000 --- a/src/ResponseResolving/ResponseResolver/SerializableResponseResolver.php +++ /dev/null @@ -1,89 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ResponseResolving\ResponseResolver; - -use Psr\Http\Message\ResponseFactoryInterface; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use ReflectionAttribute; -use ReflectionFunction; -use ReflectionMethod; -use Sunrise\Http\Router\Annotation\SerializableResponse; -use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\ServerRequest; -use Symfony\Component\Serializer\Encoder\JsonEncoder; -use Symfony\Component\Serializer\Encoder\XmlEncoder; -use Symfony\Component\Serializer\SerializerInterface; - -/** - * SerializableResponseResolver - * - * @link https://github.com/symfony/serializer - * - * @since 3.0.0 - */ -final class SerializableResponseResolver implements ResponseResolverInterface -{ - - /** - * Constructor of the class - * - * @param ResponseFactoryInterface $responseFactory - * @param SerializerInterface $serializer - * @param array $context - */ - public function __construct( - private ResponseFactoryInterface $responseFactory, - private SerializerInterface $serializer, - private array $context = [], - ) { - } - - /** - * @inheritDoc - */ - public function resolveResponse( - ServerRequestInterface $request, - mixed $response, - ReflectionFunction|ReflectionMethod $responder, - ) : ?ResponseInterface { - /** @var list> $attributes */ - $attributes = $responder->getAttributes(SerializableResponse::class); - if ($attributes === []) { - return null; - } - - $attribute = $attributes[0]->newInstance(); - - $serverProducesMediaTypes = [MediaType::json(), MediaType::xml()]; - $clientPreferredMediaType = ServerRequest::from($request) - ->getClientPreferredMediaType(...$serverProducesMediaTypes) - ?? $serverProducesMediaTypes[0]; - - $format = match ($clientPreferredMediaType) { - $serverProducesMediaTypes[0] => JsonEncoder::FORMAT, - default => XmlEncoder::FORMAT, - }; - - $result = $this->responseFactory->createResponse(200); - $mimeType = $clientPreferredMediaType . '; charset=UTF-8'; - $result = $result->withHeader('Content-Type', $mimeType); - - $context = $attribute->context + $this->context; - $payload = $this->serializer->serialize($response, $format, $context); - $result->getBody()->write($payload); - - return $result; - } -} diff --git a/src/Router.php b/src/Router.php index 199e676d..09618495 100644 --- a/src/Router.php +++ b/src/Router.php @@ -19,13 +19,12 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Psr\SimpleCache\CacheInterface; -use Sunrise\Http\Router\Dictionary\ErrorSource; use Sunrise\Http\Router\Event\RouteMatchedEvent; use Sunrise\Http\Router\Exception\Http\HttpMethodNotAllowedException; use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; use Sunrise\Http\Router\Exception\Http\HttpUnsupportedMediaTypeException; use Sunrise\Http\Router\Exception\InvalidArgumentException; +use Sunrise\Http\Router\Helper\RouteBuilder; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Loader\LoaderInterface; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; @@ -63,11 +62,6 @@ class Router implements RequestHandlerInterface, RequestMethodInterface */ private ReferenceResolverInterface $referenceResolver; - /** - * @var CacheInterface|null - */ - private ?CacheInterface $cache; - /** * @var list */ @@ -83,25 +77,22 @@ class Router implements RequestHandlerInterface, RequestMethodInterface */ private ?EventDispatcherInterface $eventDispatcher = null; - private array $compiledRegularExpressions = []; + private array $routeRegex = []; /** * Constructor of the class * * @param RouteCollectionFactoryInterface|null $collectionFactory * @param ReferenceResolverInterface|null $referenceResolver - * @param CacheInterface|null $cache * * @since 3.0.0 */ public function __construct( ?RouteCollectionFactoryInterface $collectionFactory = null, ?ReferenceResolverInterface $referenceResolver = null, - ?CacheInterface $cache = null, ) { $collectionFactory ??= new RouteCollectionFactory(); $this->referenceResolver = $referenceResolver ?? new ReferenceResolver(); - $this->cache = $cache; $this->routes = $collectionFactory->createCollection(); } @@ -140,11 +131,8 @@ public function getRoutes(): RouteCollectionInterface */ public function getRoute(string $name): RouteInterface { - if ($this->routes->has($name)) { - return $this->routes->get($name); - } - - throw new InvalidArgumentException(sprintf('The route %s does not exist.', $name)); + return $this->routes->get($name) ?? + throw new InvalidArgumentException(sprintf('The route %s does not exist.', $name)); } /** @@ -217,6 +205,8 @@ public function addMiddleware(mixed ...$middlewares): void * @param mixed ...$middlewares * * @return void + * + * @since 3.0.0 */ public function addRouteAwareMiddleware(mixed ...$middlewares): void { @@ -243,18 +233,17 @@ public function setEventDispatcher(?EventDispatcherInterface $eventDispatcher): * Generates a URI for the given named route * * @param string $name - * @param array $attributes - * @param bool $strict + * @param array $variables * * @return string + * + * @throws \InvalidArgumentException */ - public function generateUri(string $name, array $attributes = [], bool $strict = false): string + public function generateUri(string $name, array $variables = []): string { - $route = $this->routes->get($name); - - $attributes += $route->getAttributes(); + $route = $this->getRoute($name); - return path_build($route->getPath(), $attributes, $strict); + return RouteBuilder::buildRoute($route->getPath(), $variables); } /** @@ -280,12 +269,11 @@ public function match(ServerRequestInterface $request): RouteInterface $allowedMethods = []; foreach ($this->routes->all() as $route) { - $this->compiledRegularExpressions[$route->getName()] ??= RouteCompiler::compileRegex($route->getPath()); + $this->routeRegex[$route->getName()] ??= RouteCompiler::compileRegex($route->getPath()); // https://github.com/sunrise-php/http-router/issues/50 // https://tools.ietf.org/html/rfc7231#section-6.5.5 - // phpcs:ignore Generic.Files.LineLength - if (!preg_match($this->compiledRegularExpressions[$route->getName()], $requestPath, $matches, PREG_UNMATCHED_AS_NULL)) { + if (!preg_match($this->routeRegex[$route->getName()], $requestPath, $matches, PREG_UNMATCHED_AS_NULL)) { continue; } @@ -308,7 +296,7 @@ public function match(ServerRequestInterface $request): RouteInterface /** @var array $attributes */ $attributes = []; foreach ($matches as $key => $value) { - if ((string) $key === $key && isset($value)) { + if (isset($value) && (string) $key === $key) { $attributes[$key] = $value; } } @@ -322,8 +310,7 @@ public function match(ServerRequestInterface $request): RouteInterface throw new HttpMethodNotAllowedException($allowedMethods); } - throw (new HttpNotFoundException) - ->setSource(ErrorSource::CLIENT_REQUEST_PATH); + throw new HttpNotFoundException(); } /** diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 807460a8..1a753b77 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -17,7 +17,6 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\StreamInterface; use Psr\Http\Message\UriInterface; -use Sunrise\Http\Router\Dictionary\ErrorSource; use Sunrise\Http\Router\Entity\Language; use Sunrise\Http\Router\Entity\MediaType; use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; @@ -86,8 +85,7 @@ public function getClientProducedMediaType(): ?MediaType } catch (\InvalidArgumentException $e) { $message = sprintf('The "Content-Type" header is invalid: %s', $e->getMessage()); - throw (new HttpBadRequestException($message, previous: $e)) - ->setSource(ErrorSource::CLIENT_REQUEST_HEADER); + throw new HttpBadRequestException($message, previous: $e); } } @@ -107,8 +105,7 @@ public function getClientConsumesMediaTypes(): Generator } catch (\InvalidArgumentException $e) { $message = sprintf('The "Accept" header is invalid: %s', $e->getMessage()); - throw (new HttpBadRequestException($message, previous: $e)) - ->setSource(ErrorSource::CLIENT_REQUEST_HEADER); + throw new HttpBadRequestException($message, previous: $e); } } @@ -128,8 +125,7 @@ public function getClientConsumesLanguages(): Generator } catch (\InvalidArgumentException $e) { $message = sprintf('The "Accept-Language" header is invalid: %s', $e->getMessage()); - throw (new HttpBadRequestException($message, previous: $e)) - ->setSource(ErrorSource::CLIENT_REQUEST_HEADER); + throw new HttpBadRequestException($message, previous: $e); } } diff --git a/src/Validation/ConstraintViolation.php b/src/Validation/ConstraintViolation.php new file mode 100644 index 00000000..35220298 --- /dev/null +++ b/src/Validation/ConstraintViolation.php @@ -0,0 +1,69 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Validation; + +/** + * @since 3.0.0 + */ +final class ConstraintViolation implements ConstraintViolationInterface +{ + + /** + * Constructor of the class + * + * @param string $message + * @param string $messageTemplate + * @param array $messagePlaceholders + * @param string $propertyPath + */ + public function __construct( + private string $message, + private string $messageTemplate, + private array $messagePlaceholders, + private string $propertyPath, + ) { + } + + /** + * @inheritDoc + */ + public function getMessage(): string + { + return $this->message; + } + + /** + * @inheritDoc + */ + public function getMessageTemplate(): string + { + return $this->messageTemplate; + } + + /** + * @inheritDoc + */ + public function getMessagePlaceholders(): array + { + return $this->messagePlaceholders; + } + + /** + * @inheritDoc + */ + public function getPropertyPath(): string + { + return $this->propertyPath; + } +} diff --git a/src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php b/src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php new file mode 100644 index 00000000..0c1b47f7 --- /dev/null +++ b/src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php @@ -0,0 +1,80 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Validation\ConstraintViolation; + +use Generator; +use Sunrise\Http\Router\Validation\ConstraintViolationInterface; +use Sunrise\Hydrator\Exception\InvalidValueException as HydratorConstraintViolation; + +/** + * @since 3.0.0 + */ +final class HydratorConstraintViolationProxy implements ConstraintViolationInterface +{ + + /** + * Constructor of the class + * + * @param HydratorConstraintViolation $hydratorConstraintViolation + */ + public function __construct(private HydratorConstraintViolation $hydratorConstraintViolation) + { + } + + /** + * Creates the {@see ConstraintViolationInterface} object(s) from the given hydrator's constraint violation(s) + * + * @param HydratorConstraintViolation ...$hydratorConstraintViolations + * + * @return Generator + */ + public static function create(HydratorConstraintViolation ...$hydratorConstraintViolations): Generator + { + foreach ($hydratorConstraintViolations as $hydratorConstraintViolation) { + yield new self($hydratorConstraintViolation); + } + } + + /** + * @inheritDoc + */ + public function getMessage(): string + { + return $this->hydratorConstraintViolation->getMessage(); + } + + /** + * @inheritDoc + */ + public function getMessageTemplate(): string + { + return $this->hydratorConstraintViolation->getMessageTemplate(); + } + + /** + * @inheritDoc + */ + public function getMessagePlaceholders(): array + { + return $this->hydratorConstraintViolation->getMessagePlaceholders(); + } + + /** + * @inheritDoc + */ + public function getPropertyPath(): string + { + return $this->hydratorConstraintViolation->getPropertyPath(); + } +} diff --git a/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php b/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php new file mode 100644 index 00000000..5d8fc901 --- /dev/null +++ b/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php @@ -0,0 +1,81 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Validation\ConstraintViolation; + +use Generator; +use Sunrise\Http\Router\Validation\ConstraintViolationInterface; +use Symfony\Component\Validator\ConstraintViolationInterface as ValidatorConstraintViolation; + +/** + * @since 3.0.0 + */ +final class ValidatorConstraintViolationProxy implements ConstraintViolationInterface +{ + + /** + * Constructor of the class + * + * @param ValidatorConstraintViolation $validatorConstraintViolation + */ + public function __construct(private ValidatorConstraintViolation $validatorConstraintViolation) + { + } + + /** + * Creates the {@see ConstraintViolationInterface} object(s) from the given validator's constraint violation(s) + * + * @param ValidatorConstraintViolation ...$validatorConstraintViolations + * + * @return Generator + */ + public static function create(ValidatorConstraintViolation ...$validatorConstraintViolations): Generator + { + foreach ($validatorConstraintViolations as $validatorConstraintViolation) { + yield new self($validatorConstraintViolation); + } + } + + /** + * @inheritDoc + */ + public function getMessage(): string + { + return $this->validatorConstraintViolation->getMessage(); + } + + /** + * @inheritDoc + */ + public function getMessageTemplate(): string + { + return $this->validatorConstraintViolation->getMessageTemplate(); + } + + /** + * @inheritDoc + */ + public function getMessagePlaceholders(): array + { + /** @var array */ + return $this->validatorConstraintViolation->getParameters(); + } + + /** + * @inheritDoc + */ + public function getPropertyPath(): string + { + return $this->validatorConstraintViolation->getPropertyPath(); + } +} diff --git a/src/Validation/ConstraintViolationInterface.php b/src/Validation/ConstraintViolationInterface.php new file mode 100644 index 00000000..b25ac0cc --- /dev/null +++ b/src/Validation/ConstraintViolationInterface.php @@ -0,0 +1,49 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Validation; + +/** + * @since 3.0.0 + */ +interface ConstraintViolationInterface +{ + + /** + * Gets the violation's interpolated message + * + * @return string + */ + public function getMessage(): string; + + /** + * Gets the violation's message template + * + * @return string + */ + public function getMessageTemplate(): string; + + /** + * Gets the violation's message placeholders + * + * @return array + */ + public function getMessagePlaceholders(): array; + + /** + * Gets the violation's property path + * + * @return string + */ + public function getPropertyPath(): string; +} From 2fe2c100f55a795f58befcf10ec70cdded6c5cc4 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 18 Feb 2024 08:53:07 +0100 Subject: [PATCH 098/180] v3 --- README.md | 6 +- composer.json | 4 +- .../{Consumes.php => Constraint.php} | 15 +- .../{Produces.php => ConsumesEncoding.php} | 16 +- src/Annotation/ConsumesMediaType.php | 29 ++ src/Annotation/DefaultAttribute.php | 29 ++ src/Annotation/Description.php | 11 +- src/Annotation/JsonResponse.php | 15 +- src/Annotation/Method.php | 11 +- src/Annotation/Middleware.php | 11 +- src/Annotation/PathVariable.php | 11 +- src/Annotation/Postfix.php | 11 +- src/Annotation/Prefix.php | 11 +- src/Annotation/ProducesEncoding.php | 29 ++ src/Annotation/ProducesMediaType.php | 29 ++ src/Annotation/RequestCookie.php | 11 +- src/Annotation/RequestHeader.php | 11 +- src/Annotation/ResponseHeader.php | 13 +- src/Annotation/ResponseStatus.php | 14 +- src/Annotation/Route.php | 48 ++- src/Annotation/Summary.php | 11 +- src/Annotation/Tag.php | 11 +- src/Command/RouteListCommand.php | 56 +-- src/Dictionary/Charset.php | 14 +- src/Entity/Encoding.php | 40 +++ .../EncodingComparator.php} | 12 +- .../EncodingInterface.php} | 7 +- src/Entity/Language.php | 85 +---- .../LanguageComparator.php} | 10 +- .../LanguageInterface.php} | 7 +- src/Entity/MediaType.php | 147 +------- src/Entity/MediaTypeComparator.php | 26 ++ .../MediaTypeInterface.php} | 9 +- src/Event/AbstractEvent.php | 48 --- src/Event/ResponseResolvedEvent.php | 74 ---- src/Event/RouteMatchedEvent.php | 62 ---- .../HttpUnsupportedMediaTypeException.php | 11 +- src/Exception/InvalidArgumentException.php | 25 -- src/Helper/FilesystemHelper.php | 79 +++++ src/Helper/HeaderParser.php | 329 ++++++++---------- src/Helper/RouteBuilder.php | 65 +++- src/Helper/RouteCompiler.php | 50 ++- src/Helper/RouteMatcher.php | 79 +++++ src/Helper/RouteParser.php | 260 ++++++-------- src/Loader/ConfigLoader.php | 94 ++--- src/Loader/DescriptorLoader.php | 302 +++++----------- src/Loader/LoaderInterface.php | 30 +- src/Middleware/CallableMiddleware.php | 7 - src/Middleware/CallbackMiddleware.php | 19 +- .../JsonPayloadDecodingMiddleware.php | 9 +- .../ParameterResolutioner.php | 2 +- .../PathVariableParameterResolver.php | 2 +- .../RequestBodyParameterResolver.php | 2 +- .../RequestCookieParameterResolver.php | 2 +- .../RequestHeaderParameterResolver.php | 2 +- .../RequestQueryParameterResolver.php | 2 +- .../RequestRouteParameterResolver.php | 2 +- .../RequestStreamParameterResolver.php | 2 +- .../RequestUriParameterResolver.php | 2 +- .../RouterParameterResolver.php | 54 +++ .../ServerRequestParameterResolver.php | 4 +- src/ReferenceResolver.php | 17 +- src/RequestHandler/CallableRequestHandler.php | 7 - src/RequestHandler/CallbackRequestHandler.php | 19 +- .../QueueableRequestHandler.php | 20 +- .../ResponseResolutioner.php | 19 +- .../ResponseResolver/JsonResponseResolver.php | 2 +- .../RouteResponseResolver.php | 9 +- src/Route.php | 105 +++--- src/RouteCollection.php | 213 ------------ src/RouteCollectionFactory.php | 29 -- src/RouteCollectionFactoryInterface.php | 30 -- src/RouteCollectionInterface.php | 166 --------- src/RouteCollector.php | 175 ++++++---- src/RouteInterface.php | 58 ++- src/Router.php | 308 ++++------------ src/ServerRequest.php | 222 ++++-------- src/Validation/ConstraintViolation.php | 12 +- .../ValidatorConstraintViolationProxy.php | 2 +- .../ConstraintViolationInterface.php | 2 +- functions/emit.php => src/functions.php | 7 - tests/RouteCollectorTest.php | 44 +-- 82 files changed, 1395 insertions(+), 2460 deletions(-) rename src/Annotation/{Consumes.php => Constraint.php} (68%) rename src/Annotation/{Produces.php => ConsumesEncoding.php} (61%) create mode 100644 src/Annotation/ConsumesMediaType.php create mode 100644 src/Annotation/DefaultAttribute.php create mode 100644 src/Annotation/ProducesEncoding.php create mode 100644 src/Annotation/ProducesMediaType.php create mode 100644 src/Entity/Encoding.php rename src/{Exception/LogicException.php => Entity/EncodingComparator.php} (57%) rename src/{Exception/RoutePathProcessingException.php => Entity/EncodingInterface.php} (73%) rename src/{Exception/RoutePathBuildException.php => Entity/LanguageComparator.php} (58%) rename src/{Exception/RouteNotFoundException.php => Entity/LanguageInterface.php} (74%) create mode 100644 src/Entity/MediaTypeComparator.php rename src/{Exception/RoutePathParseException.php => Entity/MediaTypeInterface.php} (70%) delete mode 100644 src/Event/AbstractEvent.php delete mode 100644 src/Event/ResponseResolvedEvent.php delete mode 100644 src/Event/RouteMatchedEvent.php delete mode 100644 src/Exception/InvalidArgumentException.php create mode 100644 src/Helper/FilesystemHelper.php create mode 100644 src/Helper/RouteMatcher.php create mode 100644 src/ParameterResolving/ParameterResolver/RouterParameterResolver.php delete mode 100644 src/RouteCollection.php delete mode 100644 src/RouteCollectionFactory.php delete mode 100644 src/RouteCollectionFactoryInterface.php delete mode 100644 src/RouteCollectionInterface.php rename functions/emit.php => src/functions.php (90%) diff --git a/README.md b/README.md index eb857b53..20828682 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ $collector->get('home', '/', [HomeRequestHandler::class, 'index']); $collector->setContainer($container); $router = new Router(); -$router->addRoute(...$collector->getCollection()->all()); +$router->addRoute(...$collector->getRoutes()->all()); $request = ServerRequestFactory::fromGlobals(); $response = $router->handle($request); @@ -244,7 +244,7 @@ $collector->setContainer($container); $collector->get('home', '/', new HomeController()); $router = new Router(); -$router->addRoute(...$collector->getCollection()->all()); +$router->addRoute(...$collector->getRoutes()->all()); // if the router matching should be isolated for top middlewares... // for example for error handling... @@ -279,7 +279,7 @@ $collector->get('home', '/', new CallbackRequestHandler(function ($request) { })); $router = new Router(); -$router->addRoute(...$collector->getCollection()->all()); +$router->addRoute(...$collector->getRoutes()->all()); $router->addMiddleware(new CallbackMiddleware(function ($request, $handler) { try { diff --git a/composer.json b/composer.json index e28ccb40..3e30b579 100644 --- a/composer.json +++ b/composer.json @@ -27,7 +27,7 @@ } ], "require": { - "php": ">=8.0", + "php": ">=8.1", "fig/http-message-util": "^1.1", "psr/container": "^1.0 || ^2.0", "psr/event-dispatcher": "^1.0", @@ -60,7 +60,7 @@ }, "autoload": { "files": [ - "functions/emit.php" + "src/functions.php" ], "psr-4": { "Sunrise\\Http\\Router\\": "src/" diff --git a/src/Annotation/Consumes.php b/src/Annotation/Constraint.php similarity index 68% rename from src/Annotation/Consumes.php rename to src/Annotation/Constraint.php index c2f4905a..a62b69c0 100644 --- a/src/Annotation/Consumes.php +++ b/src/Annotation/Constraint.php @@ -19,16 +19,11 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Consumes +final class Constraint { - - /** - * Constructor of the class - * - * @param non-empty-string $type - * @param non-empty-string $subtype - */ - public function __construct(public string $type, public string $subtype) - { + public function __construct( + public readonly string $name, + public readonly mixed $value, + ) { } } diff --git a/src/Annotation/Produces.php b/src/Annotation/ConsumesEncoding.php similarity index 61% rename from src/Annotation/Produces.php rename to src/Annotation/ConsumesEncoding.php index a121a4ed..36f82fce 100644 --- a/src/Annotation/Produces.php +++ b/src/Annotation/ConsumesEncoding.php @@ -14,22 +14,16 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; +use Sunrise\Http\Router\Entity\EncodingInterface; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Produces +final class ConsumesEncoding { - - /** - * Constructor of the class - * - * @param non-empty-string $type - * @param non-empty-string $subtype - * @param array $parameters - */ - public function __construct(public string $type, public string $subtype, public array $parameters = []) - { + public function __construct( + public readonly EncodingInterface $value, + ) { } } diff --git a/src/Annotation/ConsumesMediaType.php b/src/Annotation/ConsumesMediaType.php new file mode 100644 index 00000000..c9a3a983 --- /dev/null +++ b/src/Annotation/ConsumesMediaType.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; +use Sunrise\Http\Router\Entity\MediaTypeInterface; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class ConsumesMediaType +{ + public function __construct( + public readonly MediaTypeInterface $value, + ) { + } +} diff --git a/src/Annotation/DefaultAttribute.php b/src/Annotation/DefaultAttribute.php new file mode 100644 index 00000000..b55c0fe1 --- /dev/null +++ b/src/Annotation/DefaultAttribute.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class DefaultAttribute +{ + public function __construct( + public readonly string $name, + public readonly mixed $value, + ) { + } +} diff --git a/src/Annotation/Description.php b/src/Annotation/Description.php index 52864e32..57f60491 100644 --- a/src/Annotation/Description.php +++ b/src/Annotation/Description.php @@ -21,13 +21,8 @@ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Description { - - /** - * Constructor of the class - * - * @param non-empty-string $value - */ - public function __construct(public string $value) - { + public function __construct( + public readonly string $value, + ) { } } diff --git a/src/Annotation/JsonResponse.php b/src/Annotation/JsonResponse.php index 2ccf5871..b2615787 100644 --- a/src/Annotation/JsonResponse.php +++ b/src/Annotation/JsonResponse.php @@ -21,16 +21,9 @@ #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] final class JsonResponse { - - /** - * Constructor of the class - * - * @param int $flags - * @param int $depth - * - * @link http://php.net/json_encode - */ - public function __construct(public int $flags = 0, public int $depth = 512) - { + public function __construct( + public readonly int $flags = 0, + public readonly int $depth = 512, + ) { } } diff --git a/src/Annotation/Method.php b/src/Annotation/Method.php index f2544223..06b6969e 100644 --- a/src/Annotation/Method.php +++ b/src/Annotation/Method.php @@ -22,13 +22,8 @@ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Method implements RequestMethodInterface { - - /** - * Constructor of the class - * - * @param non-empty-string $value - */ - public function __construct(public string $value) - { + public function __construct( + public readonly string $value, + ) { } } diff --git a/src/Annotation/Middleware.php b/src/Annotation/Middleware.php index 19dd49ed..879a7f8a 100644 --- a/src/Annotation/Middleware.php +++ b/src/Annotation/Middleware.php @@ -21,13 +21,8 @@ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Middleware { - - /** - * Constructor of the class - * - * @param mixed $value - */ - public function __construct(public mixed $value) - { + public function __construct( + public readonly mixed $value, + ) { } } diff --git a/src/Annotation/PathVariable.php b/src/Annotation/PathVariable.php index d16e7874..78b5e32d 100644 --- a/src/Annotation/PathVariable.php +++ b/src/Annotation/PathVariable.php @@ -21,13 +21,8 @@ #[Attribute(Attribute::TARGET_PARAMETER)] final class PathVariable { - - /** - * Constructor of the class - * - * @param non-empty-string|null $name If null, the parameter's name will be used. - */ - public function __construct(public ?string $name = null) - { + public function __construct( + public readonly ?string $name = null, + ) { } } diff --git a/src/Annotation/Postfix.php b/src/Annotation/Postfix.php index 48ff6d85..94d84eda 100644 --- a/src/Annotation/Postfix.php +++ b/src/Annotation/Postfix.php @@ -21,13 +21,8 @@ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] final class Postfix { - - /** - * Constructor of the class - * - * @param non-empty-string $value - */ - public function __construct(public string $value) - { + public function __construct( + public readonly string $value, + ) { } } diff --git a/src/Annotation/Prefix.php b/src/Annotation/Prefix.php index aaccdeca..c260e0d0 100644 --- a/src/Annotation/Prefix.php +++ b/src/Annotation/Prefix.php @@ -21,13 +21,8 @@ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] final class Prefix { - - /** - * Constructor of the class - * - * @param non-empty-string $value - */ - public function __construct(public string $value) - { + public function __construct( + public readonly string $value, + ) { } } diff --git a/src/Annotation/ProducesEncoding.php b/src/Annotation/ProducesEncoding.php new file mode 100644 index 00000000..7e50be27 --- /dev/null +++ b/src/Annotation/ProducesEncoding.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; +use Sunrise\Http\Router\Entity\EncodingInterface; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class ProducesEncoding +{ + public function __construct( + public readonly EncodingInterface $value, + ) { + } +} diff --git a/src/Annotation/ProducesMediaType.php b/src/Annotation/ProducesMediaType.php new file mode 100644 index 00000000..5dcd6767 --- /dev/null +++ b/src/Annotation/ProducesMediaType.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; +use Sunrise\Http\Router\Entity\MediaTypeInterface; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class ProducesMediaType +{ + public function __construct( + public readonly MediaTypeInterface $value, + ) { + } +} diff --git a/src/Annotation/RequestCookie.php b/src/Annotation/RequestCookie.php index 77a38dca..17517c29 100644 --- a/src/Annotation/RequestCookie.php +++ b/src/Annotation/RequestCookie.php @@ -21,13 +21,8 @@ #[Attribute(Attribute::TARGET_PARAMETER)] final class RequestCookie { - - /** - * Constructor of the class - * - * @param non-empty-string $name - */ - public function __construct(public string $name) - { + public function __construct( + public readonly string $name, + ) { } } diff --git a/src/Annotation/RequestHeader.php b/src/Annotation/RequestHeader.php index 1dd0bb43..c87f9773 100644 --- a/src/Annotation/RequestHeader.php +++ b/src/Annotation/RequestHeader.php @@ -21,13 +21,8 @@ #[Attribute(Attribute::TARGET_PARAMETER)] final class RequestHeader { - - /** - * Constructor of the class - * - * @param non-empty-string $name - */ - public function __construct(public string $name) - { + public function __construct( + public readonly string $name, + ) { } } diff --git a/src/Annotation/ResponseHeader.php b/src/Annotation/ResponseHeader.php index 0e5d020b..24f4b4b4 100644 --- a/src/Annotation/ResponseHeader.php +++ b/src/Annotation/ResponseHeader.php @@ -21,14 +21,9 @@ #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION | Attribute::IS_REPEATABLE)] final class ResponseHeader { - - /** - * Constructor of the class - * - * @param non-empty-string $name - * @param non-empty-string $value - */ - public function __construct(public string $name, public string $value) - { + public function __construct( + public readonly string $name, + public readonly string $value, + ) { } } diff --git a/src/Annotation/ResponseStatus.php b/src/Annotation/ResponseStatus.php index f1f8dde1..e3d4da89 100644 --- a/src/Annotation/ResponseStatus.php +++ b/src/Annotation/ResponseStatus.php @@ -22,14 +22,10 @@ #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] final class ResponseStatus implements StatusCodeInterface { - - /** - * Constructor of the class - * - * @param int<100, 599> $code - * @param string $phrase See RFC-7231. - */ - public function __construct(public int $code, public string $phrase = '') - { + public function __construct( + /** @var int<100, 599> */ + public readonly int $code, + public readonly string $phrase = '', + ) { } } diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index a869e8c3..6627b39c 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -15,47 +15,43 @@ use Attribute; use Fig\Http\Message\RequestMethodInterface; -use Sunrise\Http\Router\Entity\MediaType; +use Sunrise\Http\Router\Entity\EncodingInterface; +use Sunrise\Http\Router\Entity\MediaTypeInterface; #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] final class Route implements RequestMethodInterface { - - /** - * The annotation's holder - * - * @var mixed - */ public mixed $holder; - /** - * Constructor of the class - * - * @param non-empty-string $name The route's name - * @param non-empty-string $path The route's path - * @param non-empty-string|null $method The route's method - * @param list $methods The route's methods - * @param list $middlewares The route's middlewares - * @param array $attributes The route's attributes - * @param list $consumes The route's consumes media types - * @param list $produces The route's produces media types - * @param non-empty-string|null $summary The route's summary - * @param non-empty-string|null $description The route's description - * @param list $tags The route's tags - * @param bool $isDeprecated The route's deprecation sign - * @param int $priority The route's priority (default 0) - */ + /** @var list */ + public array $prefixes = []; + + /** @var non-empty-string|null */ + public ?string $pattern = null; + public function __construct( public string $name, public string $path = '/', ?string $method = null, + /** @var list */ public array $methods = [], + /** @var list */ public array $middlewares = [], + /** @var array */ public array $attributes = [], - public array $consumes = [], - public array $produces = [], + /** @var array */ + public array $constraints = [], + /** @var list */ + public array $consumesEncodings = [], + /** @var list */ + public array $producesEncodings = [], + /** @var list */ + public array $consumesMediaTypes = [], + /** @var list */ + public array $producesMediaTypes = [], public ?string $summary = null, public ?string $description = null, + /** @var list */ public array $tags = [], public bool $isDeprecated = false, public int $priority = 0, diff --git a/src/Annotation/Summary.php b/src/Annotation/Summary.php index 0e294cea..9d0a3398 100644 --- a/src/Annotation/Summary.php +++ b/src/Annotation/Summary.php @@ -21,13 +21,8 @@ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Summary { - - /** - * Constructor of the class - * - * @param non-empty-string $value - */ - public function __construct(public string $value) - { + public function __construct( + public readonly string $value, + ) { } } diff --git a/src/Annotation/Tag.php b/src/Annotation/Tag.php index 8cbe90f2..f6c84879 100644 --- a/src/Annotation/Tag.php +++ b/src/Annotation/Tag.php @@ -21,13 +21,8 @@ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Tag { - - /** - * Constructor of the class - * - * @param non-empty-string $value - */ - public function __construct(public string $value) - { + public function __construct( + public readonly string $value, + ) { } } diff --git a/src/Command/RouteListCommand.php b/src/Command/RouteListCommand.php index 9a73443a..1bc6a72c 100644 --- a/src/Command/RouteListCommand.php +++ b/src/Command/RouteListCommand.php @@ -13,66 +13,26 @@ namespace Sunrise\Http\Router\Command; -use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\Router; +use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Helper\Table; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; +use function join; + /** - * This command will list all routes in your application - * - * If you can't pass the router to the constructor or your architecture has problems with the autowiring, - * then just inherit this class and override the {@see self::getRouter()} method. - * * @since 2.9.0 */ +#[AsCommand('router:route-list', 'Lists all routes.')] class RouteListCommand extends Command { - - /** - * Constructor of the class - * - * @param Router|null $router - */ - public function __construct(private ?Router $router = null) + public function __construct(private readonly Router $router) { parent::__construct(); } - /** - * Gets the router instance populated with routes - * - * @return Router - * - * @throws LogicException If the command doesn't contain the router instance. - * - * @since 2.11.0 - */ - protected function getRouter(): Router - { - if (!isset($this->router)) { - throw new LogicException(\sprintf( - 'The {%2$s()} method MUST return the instance of the {%1$s} class. ' . - 'To resolve this issue, pass the instance to the constructor or override the method.', - Router::class, - __METHOD__, - )); - } - - return $this->router; - } - - /** - * @inheritDoc - */ - protected function configure(): void - { - $this->setName('router:route-list'); - $this->setDescription('Lists all routes in your application'); - } - /** * @inheritDoc */ @@ -83,14 +43,14 @@ final protected function execute(InputInterface $input, OutputInterface $output) $table->setHeaders([ 'Name', 'Path', - 'Verb', + 'Methods', ]); - foreach ($this->getRouter()->getRoutes()->all() as $route) { + foreach ($this->router->getRoutes() as $route) { $table->addRow([ $route->getName(), $route->getPath(), - \join(', ', $route->getMethods()), + join(', ', $route->getMethods()), ]); } diff --git a/src/Dictionary/Charset.php b/src/Dictionary/Charset.php index f368ea2a..35d2f2e1 100644 --- a/src/Dictionary/Charset.php +++ b/src/Dictionary/Charset.php @@ -18,12 +18,16 @@ */ final class Charset { - public const WILDCARD = '*'; - + /** + * @link https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.3 + */ public const RFC7230_OWS = [ "\x09" => 1, "\x20" => 1, ]; + /** + * @link https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6 + */ public const RFC7230_TOKEN = [ "\x21" => 1, "\x23" => 1, "\x24" => 1, "\x25" => 1, "\x26" => 1, "\x27" => 1, "\x2a" => 1, "\x2b" => 1, "\x2d" => 1, "\x2e" => 1, "\x5e" => 1, "\x5f" => 1, "\x60" => 1, "\x7c" => 1, "\x7e" => 1, "\x30" => 1, @@ -37,6 +41,9 @@ final class Charset "\x76" => 1, "\x77" => 1, "\x78" => 1, "\x79" => 1, "\x7a" => 1, ]; + /** + * @link https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6 + */ public const RFC7230_FIELD_VALUE = [ "\x09" => 1, "\x20" => 1, "\x21" => 1, "\x22" => 1, "\x23" => 1, "\x24" => 1, "\x25" => 1, "\x26" => 1, "\x27" => 1, "\x28" => 1, "\x29" => 1, "\x2a" => 1, "\x2b" => 1, "\x2c" => 1, "\x2d" => 1, "\x2e" => 1, @@ -68,6 +75,9 @@ final class Charset "\xf8" => 1, "\xf9" => 1, "\xfa" => 1, "\xfb" => 1, "\xfc" => 1, "\xfd" => 1, "\xfe" => 1, "\xff" => 1, ]; + /** + * @link https://www.pcre.org/original/doc/html/pcrepattern.html#SEC16 + */ public const PCRE_SUBPATTERN_NAME = [ "\x30" => 1, "\x31" => 1, "\x32" => 1, "\x33" => 1, "\x34" => 1, "\x35" => 1, "\x36" => 1, "\x37" => 1, "\x38" => 1, "\x39" => 1, "\x41" => 1, "\x42" => 1, "\x43" => 1, "\x44" => 1, "\x45" => 1, "\x46" => 1, diff --git a/src/Entity/Encoding.php b/src/Entity/Encoding.php new file mode 100644 index 00000000..d1ef083c --- /dev/null +++ b/src/Entity/Encoding.php @@ -0,0 +1,40 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Entity; + +/** + * @since 3.0.0 + */ +final class Encoding implements EncodingInterface +{ + public function __construct( + private readonly string $method, + /** @var array */ + private readonly array $parameters = [], + ) { + } + + public function getMethod(): string + { + return $this->method; + } + + /** + * @return array + */ + public function getParameters(): array + { + return $this->parameters; + } +} diff --git a/src/Exception/LogicException.php b/src/Entity/EncodingComparator.php similarity index 57% rename from src/Exception/LogicException.php rename to src/Entity/EncodingComparator.php index 6070fa3c..f5b2dfb4 100644 --- a/src/Exception/LogicException.php +++ b/src/Entity/EncodingComparator.php @@ -11,15 +11,15 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Exception; - -use LogicException as BaseLogicException; +namespace Sunrise\Http\Router\Entity; /** - * LogicException - * * @since 3.0.0 */ -class LogicException extends BaseLogicException implements ExceptionInterface +final class EncodingComparator { + public function equals(EncodingInterface $a, EncodingInterface $b): bool + { + return $a->getMethod() === $b->getMethod() || $a->getMethod() === '*' || $b->getMethod() === '*'; + } } diff --git a/src/Exception/RoutePathProcessingException.php b/src/Entity/EncodingInterface.php similarity index 73% rename from src/Exception/RoutePathProcessingException.php rename to src/Entity/EncodingInterface.php index d68d3577..fb915d08 100644 --- a/src/Exception/RoutePathProcessingException.php +++ b/src/Entity/EncodingInterface.php @@ -11,13 +11,12 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Exception; +namespace Sunrise\Http\Router\Entity; /** - * RoutePathProcessingException - * * @since 3.0.0 */ -class RoutePathProcessingException extends Exception +interface EncodingInterface { + public function getMethod(): string; } diff --git a/src/Entity/Language.php b/src/Entity/Language.php index 19c02ed5..1fb10d02 100644 --- a/src/Entity/Language.php +++ b/src/Entity/Language.php @@ -13,99 +13,34 @@ namespace Sunrise\Http\Router\Entity; -use Stringable; -use Sunrise\Http\Router\Dictionary\Charset; - /** * @since 3.0.0 */ -final class Language implements Stringable +final class Language implements LanguageInterface { - - /** - * Constructor of the class - * - * @param string $code - * @param list $subtags - * @param array $parameters - */ - public function __construct(private string $code, private array $subtags = [], private array $parameters = []) - { + public function __construct( + private readonly string $code, + private readonly string $locale, + /** @var array */ + private readonly array $parameters = [], + ) { } - /** - * Gets the language code - * - * @return string - */ public function getCode(): string { return $this->code; } - /** - * Gets the language subtags - * - * @return list - */ - public function getSubtags(): array + public function getLocale(): string { - return $this->subtags; + return $this->locale; } /** - * Gets the language parameters - * - * @return array + * @return array */ public function getParameters(): array { return $this->parameters; } - - /** - * Gets the language parameter's value by its given name or - * returns the given default value if the parameter doesn't exist or is empty - * - * - * $language->getParameter('q', '1.0'); - * - * - * @param string $name - * @param ?string $default - * - * @return ?string - */ - public function getParameter(string $name, ?string $default = null): ?string - { - return isset($this->parameters[$name][0]) ? $this->parameters[$name] : $default; - } - - /** - * Checks if this language's code equals to the given language's code - * - * Please note that when comparing languages, their subtags aren't factored in. - * - * @param Language $other - * - * @return bool - */ - public function equals(Language $other): bool - { - return $this->code === Charset::WILDCARD || $other->code === Charset::WILDCARD || $this->code === $other->code; - } - - /** - * @inheritDoc - */ - public function __toString(): string - { - $result = $this->code; - - foreach ($this->subtags as $subtag) { - $result .= '-' . $subtag; - } - - return $result; - } } diff --git a/src/Exception/RoutePathBuildException.php b/src/Entity/LanguageComparator.php similarity index 58% rename from src/Exception/RoutePathBuildException.php rename to src/Entity/LanguageComparator.php index fdc004c6..9cde669a 100644 --- a/src/Exception/RoutePathBuildException.php +++ b/src/Entity/LanguageComparator.php @@ -11,13 +11,15 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Exception; +namespace Sunrise\Http\Router\Entity; /** - * RoutePathBuildException - * * @since 3.0.0 */ -class RoutePathBuildException extends RoutePathProcessingException +final class LanguageComparator { + public function equals(LanguageInterface $a, LanguageInterface $b): bool + { + return $a->getCode() === $b->getCode() || $a->getCode() === '*' || $b->getCode() === '*'; + } } diff --git a/src/Exception/RouteNotFoundException.php b/src/Entity/LanguageInterface.php similarity index 74% rename from src/Exception/RouteNotFoundException.php rename to src/Entity/LanguageInterface.php index 0b348e3a..8fc0ac80 100644 --- a/src/Exception/RouteNotFoundException.php +++ b/src/Entity/LanguageInterface.php @@ -11,11 +11,12 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Exception; +namespace Sunrise\Http\Router\Entity; /** - * RouteNotFoundException + * @since 3.0.0 */ -class RouteNotFoundException extends LogicException +interface LanguageInterface { + public function getCode(): string; } diff --git a/src/Entity/MediaType.php b/src/Entity/MediaType.php index f09ab2cb..af065d12 100644 --- a/src/Entity/MediaType.php +++ b/src/Entity/MediaType.php @@ -13,165 +13,34 @@ namespace Sunrise\Http\Router\Entity; -use Stringable; -use Sunrise\Http\Router\Dictionary\Charset; - /** * @since 3.0.0 */ -final class MediaType implements Stringable +final class MediaType implements MediaTypeInterface { - - /** - * Constructor of the class - * - * @param string $type - * @param string $subtype - * @param array $parameters - */ - public function __construct(private string $type, private string $subtype, private array $parameters = []) - { - } - - /** - * Creates the json media type with the given parameters - * - * @param array $parameters - * - * @return self - */ - public static function json(array $parameters = []): self - { - return new self('application', 'json', $parameters); - } - - /** - * Creates the xml media type with the given parameters - * - * @param array $parameters - * - * @return self - */ - public static function xml(array $parameters = []): self - { - return new self('application', 'xml', $parameters); - } - - /** - * Creates the yaml media type with the given parameters - * - * @param array $parameters - * - * @return self - */ - public static function yaml(array $parameters = []): self - { - return new self('application', 'yaml', $parameters); - } - - /** - * Creates the html media type with the given parameters - * - * @param array $parameters - * - * @return self - */ - public static function html(array $parameters = []): self - { - return new self('text', 'html', $parameters); - } - - /** - * Creates the text media type with the given parameters - * - * @param array $parameters - * - * @return self - */ - public static function text(array $parameters = []): self - { - return new self('text', 'plain', $parameters); - } - - /** - * Creates the image media range with the given parameters - * - * @param array $parameters - * - * @return self - */ - public static function image(array $parameters = []): self - { - return new self('image', Charset::WILDCARD, $parameters); + public function __construct( + private readonly string $type, + private readonly string $subtype, + /** @var array */ + private readonly array $parameters = [], + ) { } - /** - * Gets the media range type - * - * @return string - */ public function getType(): string { return $this->type; } - /** - * Gets the media range subtype - * - * @return string - */ public function getSubtype(): string { return $this->subtype; } /** - * Gets the media type parameters - * - * @return array + * @return array */ public function getParameters(): array { return $this->parameters; } - - /** - * Gets the media type parameter's value by its given name or - * returns the given default value if the parameter doesn't exist or is empty - * - * - * $mediaType->getParameter('q', '1.0'); - * - * - * @param string $name - * @param ?string $default - * - * @return ?string - */ - public function getParameter(string $name, ?string $default = null): ?string - { - return isset($this->parameters[$name][0]) ? $this->parameters[$name] : $default; - } - - /** - * Checks if this media type equals to the given media type - * - * @param MediaType $other - * - * @return bool - */ - public function equals(MediaType $other): bool - { - return ($this->type === Charset::WILDCARD || $other->type === Charset::WILDCARD || $this->type === $other->type) - // phpcs:ignore Generic.Files.LineLength - && ($this->subtype === Charset::WILDCARD || $other->subtype === Charset::WILDCARD || $this->subtype === $other->subtype); - } - - /** - * @inheritDoc - */ - public function __toString(): string - { - return $this->type . '/' . $this->subtype; - } } diff --git a/src/Entity/MediaTypeComparator.php b/src/Entity/MediaTypeComparator.php new file mode 100644 index 00000000..99a56e56 --- /dev/null +++ b/src/Entity/MediaTypeComparator.php @@ -0,0 +1,26 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Entity; + +/** + * @since 3.0.0 + */ +final class MediaTypeComparator +{ + public function equals(MediaTypeInterface $a, MediaTypeInterface $b): bool + { + return ($a->getType() === $b->getType() || $a->getType() === '*' || $b->getType() === '*') + && ($a->getSubtype() === $b->getSubtype() || $a->getSubtype() === '*' || $b->getSubtype() === '*'); + } +} diff --git a/src/Exception/RoutePathParseException.php b/src/Entity/MediaTypeInterface.php similarity index 70% rename from src/Exception/RoutePathParseException.php rename to src/Entity/MediaTypeInterface.php index 1348cd45..6e10732a 100644 --- a/src/Exception/RoutePathParseException.php +++ b/src/Entity/MediaTypeInterface.php @@ -11,13 +11,14 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Exception; +namespace Sunrise\Http\Router\Entity; /** - * RoutePathParseException - * * @since 3.0.0 */ -class RoutePathParseException extends RoutePathProcessingException +interface MediaTypeInterface { + public function getType(): string; + + public function getSubtype(): string; } diff --git a/src/Event/AbstractEvent.php b/src/Event/AbstractEvent.php deleted file mode 100644 index 24f5f4ad..00000000 --- a/src/Event/AbstractEvent.php +++ /dev/null @@ -1,48 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Event; - -use Psr\EventDispatcher\StoppableEventInterface; - -/** - * @since 3.0.0 - */ -abstract class AbstractEvent implements StoppableEventInterface -{ - - /** - * Indicates that the event's handling must be interrupted - * - * @var bool - */ - private bool $isPropagationStopped = false; - - /** - * @inheritDoc - */ - final public function isPropagationStopped(): bool - { - return $this->isPropagationStopped; - } - - /** - * Interrupts the event's handling - * - * @return void - */ - final public function stopPropagation(): void - { - $this->isPropagationStopped = true; - } -} diff --git a/src/Event/ResponseResolvedEvent.php b/src/Event/ResponseResolvedEvent.php deleted file mode 100644 index 1cbaee5d..00000000 --- a/src/Event/ResponseResolvedEvent.php +++ /dev/null @@ -1,74 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Event; - -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use ReflectionFunction; -use ReflectionMethod; - -/** - * @since 3.0.0 - */ -final class ResponseResolvedEvent extends AbstractEvent -{ - - /** - * Constructor of the class - * - * @param ServerRequestInterface $request - * @param ResponseInterface $response - * @param ReflectionFunction|ReflectionMethod $responder - */ - public function __construct( - private ServerRequestInterface $request, - private ResponseInterface $response, - private ReflectionFunction|ReflectionMethod $responder, - ) { - } - - /** - * @return ServerRequestInterface - */ - public function getRequest(): ServerRequestInterface - { - return $this->request; - } - - /** - * @return ResponseInterface - */ - public function getResponse(): ResponseInterface - { - return $this->response; - } - - /** - * @return ReflectionMethod|ReflectionFunction - */ - public function getResponder(): ReflectionMethod|ReflectionFunction - { - return $this->responder; - } - - /** - * @param ResponseInterface $response - * - * @return void - */ - public function setResponse(ResponseInterface $response): void - { - $this->response = $response; - } -} diff --git a/src/Event/RouteMatchedEvent.php b/src/Event/RouteMatchedEvent.php deleted file mode 100644 index 9a4982b9..00000000 --- a/src/Event/RouteMatchedEvent.php +++ /dev/null @@ -1,62 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Event; - -use Psr\Http\Message\ServerRequestInterface; -use Sunrise\Http\Router\RouteInterface; - -/** - * @since 3.0.0 - */ -final class RouteMatchedEvent extends AbstractEvent -{ - - /** - * Constructor of the class - * - * @param RouteInterface $route - * @param ServerRequestInterface $request - */ - public function __construct( - private RouteInterface $route, - private ServerRequestInterface $request, - ) { - } - - /** - * @return RouteInterface - */ - public function getRoute(): RouteInterface - { - return $this->route; - } - - /** - * @return ServerRequestInterface - */ - public function getRequest(): ServerRequestInterface - { - return $this->request; - } - - /** - * @param ServerRequestInterface $request - * - * @return void - */ - public function setRequest(ServerRequestInterface $request): void - { - $this->request = $request; - } -} diff --git a/src/Exception/Http/HttpUnsupportedMediaTypeException.php b/src/Exception/Http/HttpUnsupportedMediaTypeException.php index ca8f752b..c1648cca 100644 --- a/src/Exception/Http/HttpUnsupportedMediaTypeException.php +++ b/src/Exception/Http/HttpUnsupportedMediaTypeException.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router\Exception\Http; use Stringable; +use Sunrise\Http\Router\Entity\MediaTypeInterface; use Sunrise\Http\Router\Exception\HttpException; use Throwable; @@ -38,14 +39,20 @@ class HttpUnsupportedMediaTypeException extends HttpException /** * Constructor of the class * - * @param list $supportedMediaTypes + * @param list $supportedMediaTypes * @param string|null $message * @param int $code * @param Throwable|null $previous */ // phpcs:ignore Generic.Files.LineLength - public function __construct(private array $supportedMediaTypes, ?string $message = null, int $code = 0, ?Throwable $previous = null) + public function __construct(private readonly array $supportedMediaTypes, ?string $message = null, int $code = 0, ?Throwable $previous = null) { + foreach ($supportedMediaTypes as $index => $supportedMediaType) { + if ($supportedMediaType instanceof MediaTypeInterface) { + $supportedMediaTypes[$index] = $supportedMediaType->getType() . '/' . $supportedMediaType->getSubtype(); + } + } + parent::__construct(self::STATUS_UNSUPPORTED_MEDIA_TYPE, $message ?? self::DEFAULT_MESSAGE, $code, $previous); // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept diff --git a/src/Exception/InvalidArgumentException.php b/src/Exception/InvalidArgumentException.php deleted file mode 100644 index 569aa0d9..00000000 --- a/src/Exception/InvalidArgumentException.php +++ /dev/null @@ -1,25 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use InvalidArgumentException as BaseInvalidArgumentException; - -/** - * InvalidArgumentException - * - * @since 2.9.0 - */ -class InvalidArgumentException extends BaseInvalidArgumentException implements ExceptionInterface -{ -} diff --git a/src/Helper/FilesystemHelper.php b/src/Helper/FilesystemHelper.php new file mode 100644 index 00000000..aa4e56a9 --- /dev/null +++ b/src/Helper/FilesystemHelper.php @@ -0,0 +1,79 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Helper; + +use FilesystemIterator; +use Generator; +use InvalidArgumentException; +use RecursiveDirectoryIterator; +use RecursiveIteratorIterator; +use ReflectionClass; +use RegexIterator; + +use function get_declared_classes; +use function is_dir; +use function sprintf; + +/** + * @since 3.0.0 + */ +final class FilesystemHelper +{ + /** + * @return Generator + * + * @throws InvalidArgumentException If the directory doesn't exist. + */ + public static function getDirectoryClasses(string $dirname): Generator + { + if (!is_dir($dirname)) { + throw new InvalidArgumentException(sprintf( + 'The directory %s could not be scanned because it does not exist.', + $dirname, + )); + } + + /** @var iterable $iterator */ + $iterator = new RegexIterator( + new RecursiveIteratorIterator( + new RecursiveDirectoryIterator( + $dirname, + FilesystemIterator::KEY_AS_PATHNAME + | FilesystemIterator::CURRENT_AS_PATHNAME + | FilesystemIterator::SKIP_DOTS, + ), + RecursiveIteratorIterator::LEAVES_ONLY, + ), + '/\.php$/', + RegexIterator::MATCH, + ); + + /** @var array $filenames */ + $filenames = [...$iterator]; + + foreach ($filenames as $filename) { + (static function (string $filename): void { + /** @psalm-suppress UnresolvableInclude */ + require_once $filename; + })($filename); + } + + foreach (get_declared_classes() as $className) { + $classReflection = new ReflectionClass($className); + if (isset($filenames[$classReflection->getFileName()])) { + yield $classReflection; + } + } + } +} diff --git a/src/Helper/HeaderParser.php b/src/Helper/HeaderParser.php index 7a3b0a82..42dd0f1a 100644 --- a/src/Helper/HeaderParser.php +++ b/src/Helper/HeaderParser.php @@ -14,247 +14,198 @@ namespace Sunrise\Http\Router\Helper; use Generator; -use InvalidArgumentException; use Sunrise\Http\Router\Dictionary\Charset; +use Sunrise\Http\Router\Entity\Encoding; use Sunrise\Http\Router\Entity\Language; use Sunrise\Http\Router\Entity\MediaType; -use function explode; -use function sprintf; +use function preg_match; +use function reset; +use function trim; +use function usort; /** - * Internal header parser - * * @since 3.0.0 */ final class HeaderParser { - /** - * Parses the given "Accept" header or any other semantically similar header, e.g. "Content-Type" - * - * @param string $header - * @param bool $allowRange - * - * @return Generator - * - * @throws InvalidArgumentException If the header isn't valid. + * @return Generator, Encoding> */ - public static function parseAcceptHeader(string $header, bool $allowRange = true): Generator + public static function parseContentEncodingHeader(string $header): Generator { - $matches = self::parseHeaderWithAcceptSemantic($header); - foreach ($matches as $index => [$keyword, $parameterNames, $parameterValues]) { - $range = explode('/', $keyword, 3); - - if ($range[0] === '' || !isset($range[1]) || $range[1] === '' || isset($range[2])) { - throw new InvalidArgumentException(sprintf( - 'The media type with index %d has an incorrect format.', - $index, - )); - } + $values = self::parseHeader($header); + if ($values === []) { + return; + } - if (!$allowRange && ($range[0] === Charset::WILDCARD || $range[1] === Charset::WILDCARD)) { - throw new InvalidArgumentException(sprintf( - 'The media type with index %d cannot be a range.', - $index, - )); - } + foreach ($values as $index => [$identifier]) { + yield $index => new Encoding($identifier); + } + } - if ($range[0] === Charset::WILDCARD && $range[1] !== Charset::WILDCARD) { - throw new InvalidArgumentException(sprintf( - 'The media type with index %d has an incorrect range.', - $index, - )); - } + public static function parseContentTypeHeader(string $header): ?MediaType + { + $values = self::parseHeader($header); + if ($values === []) { + return null; + } - $parameters = []; - foreach ($parameterNames as $parameterIndex => $parameterName) { - $parameters[$parameterName] = $parameterValues[$parameterIndex] ?? null; - } + [$identifier, $parameters] = reset($values); - yield new MediaType($range[0], $range[1], $parameters); + if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier, $matches)) { + return new MediaType($matches[1], $matches[2], $parameters); } + + return null; } /** - * Parses the given "Accept-Language" header or any other semantically similar header - * - * @param string $header - * - * @return Generator - * - * @throws InvalidArgumentException If the header isn't valid. + * @return Generator, MediaType> */ - public static function parseAcceptLanguageHeader(string $header): Generator + public static function parseAcceptHeader(string $header): Generator { - $matches = self::parseHeaderWithAcceptSemantic($header); - foreach ($matches as $index => [$keyword, $parameterNames, $parameterValues]) { - $tags = explode('-', $keyword); + $values = self::parseHeader($header); + if ($values === []) { + return; + } - foreach ($tags as $key => $tag) { - if ($tag === '') { - throw new InvalidArgumentException(sprintf( - 'The language with index %d has an empty tag with index %d.', - $index, - $key, - )); - } + usort($values, static fn(array $a, array $b): int => ( + (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') + )); + + foreach ($values as $index => [$identifier, $parameters]) { + if (preg_match('|^([^/]+)/([^/]+)$|', $identifier, $matches)) { + yield $index => new MediaType($matches[1], $matches[2], $parameters); } + } + } - $code = $tags[0]; - unset($tags[0]); + /** + * @return Generator, Encoding> + */ + public static function parseAcceptEncodingHeader(string $header): Generator + { + $values = self::parseHeader($header); + if ($values === []) { + return; + } - $parameters = []; - foreach ($parameterNames as $parameterIndex => $parameterName) { - $parameters[$parameterName] = $parameterValues[$parameterIndex] ?? null; - } + usort($values, static fn(array $a, array $b): int => ( + (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') + )); - yield new Language($code, [...$tags], $parameters); + foreach ($values as $index => [$identifier, $parameters]) { + yield $index => new Encoding($identifier, $parameters); } } /** - * Parses the given header, which is semantically similar to the "Accept" header, according to RFC-7231 - * - * @param string $header - * - * @return Generator - * - * @throws InvalidArgumentException If the header isn't valid. + * @return Generator, Language> */ - public static function parseHeaderWithAcceptSemantic(string $header): Generator + public static function parseAcceptLanguageHeader(string $header): Generator { - if (isset($header[4096])) { - throw new InvalidArgumentException('The header is too long.'); + $values = self::parseHeader($header); + if ($values === []) { + return; } - /** @var array{0: ?string, 1: string[], 2: string[]} $match */ - $match = [null, [], []]; + usort($values, static fn(array $a, array $b): int => ( + (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') + )); - $offset = -1; - $inKeyword = true; - $parameterIndex = -1; - $inParameterName = false; - $inParameterValue = false; - $inQuotedString = false; - $isQuotedChar = false; + foreach ($values as $index => [$identifier, $parameters]) { + if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches)) { + yield $index => new Language($matches[1], $identifier, $parameters); + } + } + } - while (isset($header[++$offset])) { + /** + * @return array, array{0: string, 1: array}> + */ + private static function parseHeader(string $header): array + { + $inIdentifier = 1; + $inParameterName = 2; + $inParameterValue = 4; + $inQuotedString = 8; + $inQuotedPair = 16; + + $cursor = $inIdentifier; + $value = 0; + $param = -1; + $values = []; + + for ($offset = 0; isset($header[$offset]) && $offset < 1024; $offset++) { if (!isset(Charset::RFC7230_FIELD_VALUE[$header[$offset]])) { - throw new InvalidArgumentException(sprintf( - 'Invalid character at position %d.', - $offset, - )); + continue; } - if (!$inQuotedString) { - if ($header[$offset] === ',') { - if (!isset($match[0])) { - throw new InvalidArgumentException(sprintf( - 'The comma (,) at position %d must be preceded by a keyword.', - $offset, - )); - } - - yield $match; - $match = [null, [], []]; - $inKeyword = true; - $parameterIndex = -1; - $inParameterName = false; - $inParameterValue = false; - continue; - } - if ($header[$offset] === ';') { - if (!isset($match[0]) || !isset($match[1][$parameterIndex]) && $parameterIndex > -1) { - throw new InvalidArgumentException(sprintf( - 'The semicolon (;) at position %d must be preceded by a keyword or parameter.', - $offset, - )); - } - - $inKeyword = false; - $parameterIndex++; - $inParameterName = true; - $inParameterValue = false; - continue; - } - if ($header[$offset] === '=' && $inParameterName) { - if (!isset($match[1][$parameterIndex])) { - throw new InvalidArgumentException(sprintf( - 'The equal sign (=) at position %d must be preceded by a parameter‘s name.', - $offset, - )); - } - - $inParameterName = false; - $inParameterValue = true; - continue; - } - if ($header[$offset] === '"' && $inParameterValue) { - if (isset($match[2][$parameterIndex])) { - throw new InvalidArgumentException(sprintf( - 'The double quote (") at position %d must be the first in a parameter‘s value.', - $offset, - )); - } - - $match[2][$parameterIndex] = ''; - $inQuotedString = true; - continue; - } - - if (isset(Charset::RFC7230_OWS[$header[$offset]])) { - if ($inKeyword && isset($match[0])) { - $inKeyword = false; - } elseif ($inParameterName && isset($match[1][$parameterIndex])) { - $inParameterName = false; - } elseif ($inParameterValue && isset($match[2][$parameterIndex])) { - $inParameterValue = false; - } - - continue; - } + if ($header[$offset] === ',' && !($cursor & $inQuotedString)) { + $cursor = $inIdentifier; + $value++; + $param = -1; + continue; } - - /** @phpstan-ignore-next-line */ - if ($inQuotedString && !$isQuotedChar) { - if ($header[$offset] === '\\') { - $isQuotedChar = true; - continue; - } - if ($header[$offset] === '"') { - $inQuotedString = false; - $inParameterValue = false; - continue; - } + if ($header[$offset] === ';' && !($cursor & $inQuotedString)) { + $cursor = $inParameterName; + $param++; + continue; } - - if ($inKeyword) { - $match[0] ??= ''; - $match[0] .= $header[$offset]; + if ($header[$offset] === '=' && ($cursor & $inParameterName)) { + $cursor = $inParameterValue; continue; } - if ($inParameterName && isset(Charset::RFC7230_TOKEN[$header[$offset]])) { - $match[1][$parameterIndex] ??= ''; - $match[1][$parameterIndex] .= $header[$offset]; + if ($header[$offset] === '"' && ($cursor & $inParameterValue) && !($cursor & $inQuotedPair)) { + $cursor ^= $inQuotedString; continue; } - if ($inParameterValue && (isset(Charset::RFC7230_TOKEN[$header[$offset]]) || $inQuotedString)) { - $match[2][$parameterIndex] ??= ''; - $match[2][$parameterIndex] .= $header[$offset]; - $isQuotedChar = false; + if ($header[$offset] === '\\' && ($cursor & $inQuotedString) && !($cursor & $inQuotedPair)) { + $cursor |= $inQuotedPair; continue; } - throw new InvalidArgumentException(sprintf( - 'Unexpected character "%s" at position %d.', - $header[$offset], - $offset, - )); + if ($cursor & $inIdentifier) { + $values[$value][0] ??= ''; + $values[$value][0] .= $header[$offset]; + continue; + } + if ($cursor & $inParameterName) { + $values[$value][1][$param][0] ??= ''; + $values[$value][1][$param][0] .= $header[$offset]; + continue; + } + if ($cursor & $inParameterValue) { + $values[$value][1][$param][1] ??= ''; + $values[$value][1][$param][1] .= $header[$offset]; + $cursor &= ~$inQuotedPair; + continue; + } } - if (isset($match[0])) { - yield $match; + $result = []; + foreach ($values as $index => $value) { + unset($values[$index]); + + $value[0] = trim($value[0] ?? ''); + if ($value[0] === '') { + continue; + } + + $params = []; + foreach ($value[1] ?? [] as $param) { + $param[0] = trim($param[0] ?? ''); + if ($param[0] === '') { + continue; + } + + $params[$param[0]] = trim($param[1] ?? ''); + } + + $result[$index] = [$value[0], $params]; } + + return $result; } } diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index 36f09798..e3e0f010 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -13,46 +13,73 @@ namespace Sunrise\Http\Router\Helper; +use BackedEnum; use InvalidArgumentException; use Stringable; +use function is_int; +use function is_string; +use function sprintf; use function str_replace; +use function substr; /** - * Internal route builder - * * @since 3.0.0 */ final class RouteBuilder { - /** - * Builds the given route with the given variables - * - * @param string $route - * @param array $variables - * - * @return string - * * @throws InvalidArgumentException + * If the route isn't valid, + * or any of the values are unsupported, + * or any of the required values are missing. */ - public static function buildRoute(string $route, array $variables = []): string + public static function buildRoute(string $route, array $values = []): string { - $matches = RouteParser::parseRoute($route); + $variables = RouteParser::parseRoute($route); $search = []; $replace = []; - foreach ($matches as $match) { - $replacement = $variables[$match['name']] ?? $match['value'] ?? null; + foreach ($variables as $variable) { + $statement = substr($route, $variable['offset'], $variable['length']); + + if (isset($values[$variable['name']])) { + $value = $values[$variable['name']]; + + if (is_int($value)) { + $value = (string) $value; + } elseif ($value instanceof BackedEnum) { + $value = (string) $value->value; + } elseif ($value instanceof Stringable) { + $value = $value->__toString(); + } + + if (is_string($value)) { + $search[] = $statement; + $replace[] = $value; + continue; + } + + throw new InvalidArgumentException(sprintf( + 'The route %s could not be built with an unsupported value for the variable %s.', + $route, + $variable['name'], + )); + } - if (!isset($replacement) && !isset($match['isOptional'])) { - throw new InvalidArgumentException(); + if (isset($variable['optional'])) { + $search[] = '(' . ($variable['left'] ?? '') . $statement . ($variable['right'] ?? '') . ')'; + $replace[] = ''; + continue; } - $search[] = $match['replaceable']; - $replace[] = (string) $replacement; + throw new InvalidArgumentException(sprintf( + 'The route %s could not be built without a required value for the variable %s.', + $route, + $variable['name'], + )); } - return str_replace($search, $replace, $route); + return str_replace([...$search, '(', ')'], $replace, $route); } } diff --git a/src/Helper/RouteCompiler.php b/src/Helper/RouteCompiler.php index 009ba00f..720da18e 100644 --- a/src/Helper/RouteCompiler.php +++ b/src/Helper/RouteCompiler.php @@ -13,35 +13,35 @@ namespace Sunrise\Http\Router\Helper; -use Sunrise\Http\Router\Router; +use BackedEnum; +use InvalidArgumentException; +use Stringable; use function addcslashes; +use function is_string; +use function sprintf; use function str_replace; +use function substr; /** - * Internal route compiler - * * @since 3.0.0 */ final class RouteCompiler { - /** - * Compiles a regular expression from the given route - * - * @param string $route + * @return non-empty-string * - * @return string + * @throws InvalidArgumentException If the route isn't valid or any of the patterns are unsupported. */ - public static function compileRegex(string $route): string + public static function compileRoute(string $route, array $patterns = []): string { - $matches = RouteParser::parseRoute($route); + $variables = RouteParser::parseRoute($route); $search = []; $replace = []; - foreach ($matches as $match) { - $search[] = $match['variable']; - $replace[] = '{' . $match['name'] . '}'; + foreach ($variables as $variable) { + $search[] = substr($route, $variable['offset'], $variable['length']); + $replace[] = '{' . $variable['name'] . '}'; } $route = str_replace($search, $replace, $route); @@ -50,14 +50,26 @@ public static function compileRegex(string $route): string $search = []; $replace = []; - foreach ($matches as $match) { - $pattern = $match['pattern'] ?? '[^/]+'; - if (isset(Router::$patterns[$pattern])) { - $pattern = Router::$patterns[$pattern]; + foreach ($variables as $variable) { + $pattern = $patterns[$variable['name']] ?? $variable['pattern'] ?? '[^/]+'; + + if ($pattern instanceof BackedEnum) { + $pattern = $pattern->value; + } elseif ($pattern instanceof Stringable) { + $pattern = $pattern->__toString(); + } + + if (is_string($pattern)) { + $search[] = '{' . $variable['name'] . '}'; + $replace[] = '(?<' . $variable['name'] . '>' . $pattern . ')'; + continue; } - $search[] = '{' . $match['name'] . '}'; - $replace[] = '(?<' . $match['name'] . '>' . $pattern . ')'; + throw new InvalidArgumentException(sprintf( + 'The route %s could not be compiled with an unsupported pattern for the variable %s.', + $route, + $variable['name'], + )); } $route = str_replace($search, $replace, $route); diff --git a/src/Helper/RouteMatcher.php b/src/Helper/RouteMatcher.php new file mode 100644 index 00000000..bc63da31 --- /dev/null +++ b/src/Helper/RouteMatcher.php @@ -0,0 +1,79 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Helper; + +use ErrorException; +use InvalidArgumentException; + +use function is_int; +use function preg_last_error; +use function preg_last_error_msg; +use function preg_match; +use function sprintf; + +use const E_WARNING; +use const PREG_UNMATCHED_AS_NULL; + +/** + * @since 3.0.0 + */ +final class RouteMatcher +{ + /** + * @param-out array $matches + * + * @throws InvalidArgumentException If the route isn't valid or any of the patterns are unsupported. + */ + public static function matchRoute(string $route, array $patterns, string $subject, ?array &$matches = null): bool + { + $pattern = RouteCompiler::compileRoute($route, $patterns); + + return self::matchPattern($route, $pattern, $subject, $matches); + } + + /** + * @param non-empty-string $pattern + * @param-out array $matches + * + * @throws InvalidArgumentException If the pattern (read: route) isn't valid. + */ + public static function matchPattern(string $route, string $pattern, string $subject, ?array &$matches = null): bool + { + try { + if (($result = @preg_match($pattern, $subject, $matches, PREG_UNMATCHED_AS_NULL)) === false) { + throw new ErrorException(preg_last_error_msg(), preg_last_error(), E_WARNING); + } + } catch (ErrorException $e) { + throw new InvalidArgumentException(sprintf( + 'The route %s could not be matched due to a syntax error in one of variable patterns.', + $route, + ), previous: $e); + } + + foreach ($matches as $key => $match) { + if (is_int($key)) { + unset($matches[$key]); + continue; + } + if ($match === null) { + unset($matches[$key]); + continue; + } + } + + /** @var array $matches */ + + return $result === 1; + } +} diff --git a/src/Helper/RouteParser.php b/src/Helper/RouteParser.php index 10feda2b..5992cdc8 100644 --- a/src/Helper/RouteParser.php +++ b/src/Helper/RouteParser.php @@ -19,224 +19,197 @@ use function sprintf; /** - * Internal route parser - * * @since 3.0.0 */ final class RouteParser { - /** * Parses the given route and returns its variables * - * @param string $route - * * @return list * * @throws InvalidArgumentException If the route isn't valid. */ public static function parseRoute(string $route): array { - static $digits = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]; + $digits = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]; - // phpcs:ignore Generic.Files.LineLength - /** @var list $matches */ - $matches = []; + $inVariable = 1; + $inVariableName = 2; + $inVariablePattern = 8; + $inOptionalPart = 16; + $inOccupiedPart = 32; - $index = -1; - $inVariable = false; - $inVariableName = false; - $inVariableValue = false; - $inVariablePattern = false; + $cursor = 0; + $variable = -1; + $variables = []; - $inOptionalPart = false; - $optionalPartIsOccupied = false; - $optionalPartBeforeVariable = null; - $optionalPartAfterVariable = null; + $left = $right = ''; - $offset = -1; - while (isset($route[++$offset])) { - // control chars... - if ($route[$offset] === '(' && !$inVariable) { - if ($inOptionalPart) { + for ($offset = 0; isset($route[$offset]); $offset++) { + if ($route[$offset] === '(' && !($cursor & $inVariable)) { + if (($cursor & $inOptionalPart)) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to open an optional part at position %d has failed, ' . - 'because nested optional parts are not supported.' . + 'An attempt to open an optional part at position %d has failed ' . + 'because nested optional parts are not supported.', $route, $offset, )); } - $inOptionalPart = true; + $cursor |= $inOptionalPart; continue; } - if ($route[$offset] === ')' && !$inVariable) { - if (!$inOptionalPart) { + if ($route[$offset] === ')' && !($cursor & $inVariable)) { + if (!($cursor & $inOptionalPart)) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to close an optional part at position %d has failed, ' . + 'An attempt to close an optional part at position %d has failed ' . 'because an open optional part was not found.', $route, $offset, )); } - if ($optionalPartIsOccupied) { - $matches[$index]['isOptional'] = true; - $matches[$index]['before'] = $optionalPartBeforeVariable; - $matches[$index]['after'] = $optionalPartAfterVariable; + if (($cursor & $inOccupiedPart)) { + $cursor &= ~$inOccupiedPart; + $variables[$variable]['optional'] = true; + $variables[$variable]['left'] = $left; + $variables[$variable]['right'] = $right; } - $inOptionalPart = false; - $optionalPartIsOccupied = false; - $optionalPartBeforeVariable = null; - $optionalPartAfterVariable = null; + $cursor &= ~$inOptionalPart; + $left = $right = ''; continue; } - if ($route[$offset] === '{' && !$inVariablePattern) { - if ($inVariable) { + + if ($route[$offset] === '{' && !($cursor & $inVariablePattern)) { + if (($cursor & $inVariable)) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to open a variable at position %d has failed, ' . + 'An attempt to open a variable at position %d has failed ' . 'because nested variables are not supported.', $route, $offset, )); } - if ($inOptionalPart && $optionalPartIsOccupied) { + if (($cursor & $inOccupiedPart)) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to open a variable at position %d has failed, ' . - 'because more than one variable inside an optional part is not allowed.', + 'An attempt to open a variable at position %d has failed ' . + 'because more than one variable inside an optional part is not supported.', $route, $offset, )); } - if ($inOptionalPart) { - $optionalPartIsOccupied = true; + if (($cursor & $inOptionalPart)) { + $cursor |= $inOccupiedPart; } - $index++; - $inVariable = true; - $inVariableName = true; + $cursor |= $inVariable | $inVariableName; + $variables[++$variable]['offset'] = $offset; continue; } - if ($route[$offset] === '}' && !$inVariablePattern) { - if (!$inVariable) { + if ($route[$offset] === '}' && !($cursor & $inVariablePattern)) { + if (!($cursor & $inVariable)) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to close a variable at position %d has failed, ' . + 'An attempt to close a variable at position %d has failed ' . 'because an open variable was not found.', $route, $offset, )); } - if (!isset($matches[$index]['name'])) { + if (!isset($variables[$variable]['name'])) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to close a variable at position %d has failed, ' . + 'An attempt to close a variable at position %d has failed ' . 'because its name is required for its declaration.', $route, $offset, )); } - if (isset($matches[$index]['value']) && $matches[$index]['value'] === '') { - throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to close a variable at position %d has failed, ' . - 'because its value cannot be empty.', - $route, - $offset, - )); - } - $inVariable = false; - $inVariableName = false; - $inVariableValue = false; + $cursor &= ~($inVariable | $inVariableName); + /** @psalm-suppress PossiblyUndefinedArrayOffset */ + $variables[$variable]['length'] = $offset - $variables[$variable]['offset'] + 1; continue; } - if ($route[$offset] === '<' && $inVariable) { - if ($inVariablePattern) { + + if ($route[$offset] === '<' && ($cursor & $inVariable)) { + if (($cursor & $inVariablePattern)) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to open a pattern at position %d has failed, ' . + 'An attempt to open a variable pattern at position %d has failed ' . 'because nested patterns are not supported.', $route, $offset, )); } - if (!$inVariableName && !$inVariableValue) { + if (!($cursor & $inVariableName)) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to open a pattern at position %d has failed, ' . - 'because a variable pattern must be preceded by its name or value.', + 'An attempt to open a variable pattern at position %d has failed ' . + 'because the pattern must be preceded by the variable name.', $route, $offset, )); } - $inVariableName = false; - $inVariableValue = false; - $inVariablePattern = true; + $cursor = ($cursor | $inVariablePattern) & ~$inVariableName; continue; } - if ($route[$offset] === '>' && $inVariable) { - if (!$inVariablePattern) { + if ($route[$offset] === '>' && ($cursor & $inVariable)) { + if (!($cursor & $inVariablePattern)) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to close a pattern at position %d has failed, ' . + 'An attempt to close a variable pattern at position %d has failed ' . 'because an open pattern was not found.', $route, $offset, )); } - if (!isset($matches[$index]['pattern'])) { + if (!isset($variables[$variable]['pattern'])) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to close a pattern at position %d has failed, ' . + 'An attempt to close a variable pattern at position %d has failed ' . 'because its content is required for its declaration.', $route, $offset, )); } - $inVariablePattern = false; + $cursor &= ~$inVariablePattern; continue; } - if ($route[$offset] === '=' && $inVariable && !$inVariablePattern) { - if (!$inVariableName) { - throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to assign a value at position %d has failed, ' . - 'because a variable value must be preceded by its name.', - $route, - $offset, - )); - } - $matches[$index]['value'] = ''; + if (($cursor & $inOptionalPart) && !($cursor & $inVariable)) { + if (!($cursor & $inOccupiedPart)) { + $left .= $route[$offset]; + } else { + $right .= $route[$offset]; + } - $inVariableName = false; - $inVariableValue = true; continue; } - if ($inVariableName) { - /** @psalm-suppress InvalidArrayOffset */ - if (!isset($matches[$index]['name']) && isset($digits[$route[$offset]])) { + // https://www.pcre.org/original/doc/html/pcrepattern.html#SEC16 + if (($cursor & $inVariableName)) { + if (isset($variables[$variable]['name'][31])) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An invalid character was found at position %d. ' . - 'Please note that variable names cannot start with digits.', + 'An extra character was found at position %d. ' . + 'Please note that variable names must not exceed 32 characters.', $route, $offset, )); @@ -250,27 +223,23 @@ public static function parseRoute(string $route): array $offset, )); } - if (isset($matches[$index]['name'][31])) { + /** @psalm-suppress InvalidArrayOffset */ + if (!isset($variables[$variable]['name']) && isset($digits[$route[$offset]])) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An extra character was found at position %d. ' . - 'Please note that variable names must not exceed 32 characters.', + 'An invalid character was found at position %d. ' . + 'Please note that variable names cannot start with digits.', $route, $offset, )); } - $matches[$index]['name'] ??= ''; - $matches[$index]['name'] .= $route[$offset]; - continue; - } - if ($inVariableValue) { - $matches[$index]['value'] ??= ''; - $matches[$index]['value'] .= $route[$offset]; + $variables[$variable]['name'] ??= ''; + $variables[$variable]['name'] .= $route[$offset]; continue; } - if ($inVariablePattern) { - // the char is reserved as a route regex delimiter... + + if (($cursor & $inVariablePattern)) { if ($route[$offset] === '#') { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . @@ -282,14 +251,14 @@ public static function parseRoute(string $route): array )); } - $matches[$index]['pattern'] ??= ''; - $matches[$index]['pattern'] .= $route[$offset]; + $variables[$variable]['pattern'] ??= ''; + $variables[$variable]['pattern'] .= $route[$offset]; continue; } - // {foo<\w+>xxx} - // ~~~~~~~~~^^^~ - if ($inVariable) { + // {foo<\w+>x} + // ~~~~~~~~~^~ + if (($cursor & $inVariable)) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An unexpected character was found at position %d; ' . @@ -298,53 +267,28 @@ public static function parseRoute(string $route): array $offset, )); } - - if ($inOptionalPart) { - if (!$optionalPartIsOccupied) { - $optionalPartBeforeVariable ??= ''; - $optionalPartBeforeVariable .= $route[$offset]; - } else { - $optionalPartAfterVariable ??= ''; - $optionalPartAfterVariable .= $route[$offset]; - } - } } - if ($inVariable || $inOptionalPart) { + if (($cursor & $inVariable) || ($cursor & $inOptionalPart)) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to parse the route has failed, ' . + 'An attempt to parse the route has failed ' . 'because it contains an unclosed optional part or variable.', $route, )); } - // phpcs:ignore Generic.Files.LineLength - /** @var list $matches */ - - foreach ($matches as $index => $match) { - $matches[$index]['variable'] = '{' . $match['name']; - - if (isset($match['value'])) { - $matches[$index]['variable'] .= '=' . $match['value']; - } - if (isset($match['pattern'])) { - $matches[$index]['variable'] .= '<' . $match['pattern'] . '>'; - } - - $matches[$index]['variable'] .= '}'; - - $matches[$index]['replaceable'] = $matches[$index]['variable']; - - if (isset($match['isOptional'])) { - // phpcs:ignore Generic.Files.LineLength - $matches[$index]['replaceable'] = '(' . ($match['before'] ?? '') . $matches[$index]['variable'] . ($match['after'] ?? '') . ')'; - } - } - - // phpcs:ignore Generic.Files.LineLength - /** @var list $matches */ - - return $matches; + /** + * @var list + */ + return $variables; } } diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php index 40304228..1a178ce3 100644 --- a/src/Loader/ConfigLoader.php +++ b/src/Loader/ConfigLoader.php @@ -13,7 +13,7 @@ namespace Sunrise\Http\Router\Loader; -use Sunrise\Http\Router\Exception\InvalidArgumentException; +use InvalidArgumentException; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; use Sunrise\Http\Router\RouteCollectionFactory; @@ -26,97 +26,51 @@ use function glob; use function is_dir; use function is_file; -use function is_string; use function sprintf; -/** - * ConfigLoader - */ final class ConfigLoader implements LoaderInterface { - /** - * List of files - * * @var list */ private array $resources = []; /** - * Constructor of the class - * - * @param RouteCollectionFactoryInterface|null $collectionFactory - * @param RouteFactoryInterface|null $routeFactory - * @param ReferenceResolverInterface|null $referenceResolver + * @throws InvalidArgumentException If one of the resources isn't valid. */ - public function __construct( - private ?RouteCollectionFactoryInterface $collectionFactory = null, - private ?RouteFactoryInterface $routeFactory = null, - private ?ReferenceResolverInterface $referenceResolver = null, - ) { - $this->collectionFactory ??= new RouteCollectionFactory(); - $this->routeFactory ??= new RouteFactory(); - $this->referenceResolver ??= new ReferenceResolver(); - } - - /** - * @inheritDoc - * - * @throws InvalidArgumentException If the resource isn't valid. - */ - public function attach(mixed $resource): void + public function attach(string ...$resources): void { - if (!is_string($resource)) { - throw new InvalidArgumentException( - 'The config route loader only handles string resources.' - ); - } - - if (is_file($resource)) { - $this->resources[] = $resource; - return; - } - - if (is_dir($resource)) { - /** @var list $filenames */ - $filenames = glob($resource . '/*.php'); - foreach ($filenames as $filename) { - $this->resources[] = $filename; + foreach ($resources as $resource) { + if (is_file($resource)) { + $this->resources[] = $resource; + continue; } - return; - } + if (is_dir($resource)) { + /** @var list $filenames */ + $filenames = glob($resource . '/*.php'); + foreach ($filenames as $filename) { + $this->resources[] = $filename; + } - throw new InvalidArgumentException(sprintf( - 'The config route loader only handles file or directory paths, ' . - 'however the given resource "%s" is not one of them.', - $resource, - )); - } + continue; + } - /** - * @inheritDoc - * - * @throws InvalidArgumentException If one of the given resources isn't valid. - */ - public function attachArray(array $resources): void - { - /** @psalm-suppress MixedAssignment */ - foreach ($resources as $resource) { - $this->attach($resource); + throw new InvalidArgumentException(sprintf( + 'The method %s only accepts file or directory names; ' . + 'however, the resource %s is not one of them.', + __METHOD__, + $resource, + )); } } /** * @inheritDoc */ - public function load(): RouteCollectionInterface + public function load(): array { - $collector = new RouteCollector( - $this->collectionFactory, - $this->routeFactory, - $this->referenceResolver, - ); + $collector = new RouteCollector(); foreach ($this->resources as $resource) { (function (string $filename): void { @@ -125,6 +79,6 @@ public function load(): RouteCollectionInterface })->call($collector, $resource); } - return $collector->getCollection(); + return $collector->getRoutes(); } } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index e86b4e7e..71039f26 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -13,201 +13,124 @@ namespace Sunrise\Http\Router\Loader; -use FilesystemIterator; use Generator; +use InvalidArgumentException; use Psr\Http\Server\RequestHandlerInterface; use Psr\SimpleCache\CacheInterface; -use RecursiveDirectoryIterator; -use RecursiveIteratorIterator; use ReflectionAttribute; use ReflectionClass; use ReflectionMethod; -use RegexIterator; -use Sunrise\Http\Router\Annotation\Consumes; +use Sunrise\Http\Router\Annotation\Constraint; +use Sunrise\Http\Router\Annotation\ConsumesEncoding; +use Sunrise\Http\Router\Annotation\ConsumesMediaType; +use Sunrise\Http\Router\Annotation\DefaultAttribute; use Sunrise\Http\Router\Annotation\Deprecated; use Sunrise\Http\Router\Annotation\Description; use Sunrise\Http\Router\Annotation\Method; use Sunrise\Http\Router\Annotation\Middleware; use Sunrise\Http\Router\Annotation\Postfix; use Sunrise\Http\Router\Annotation\Prefix; -use Sunrise\Http\Router\Annotation\Produces; -use Sunrise\Http\Router\Annotation\Route; +use Sunrise\Http\Router\Annotation\ProducesEncoding; +use Sunrise\Http\Router\Annotation\ProducesMediaType; +use Sunrise\Http\Router\Annotation\Route as Descriptor; use Sunrise\Http\Router\Annotation\Summary; use Sunrise\Http\Router\Annotation\Tag; -use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Exception\InvalidArgumentException; -use Sunrise\Http\Router\ReferenceResolver; -use Sunrise\Http\Router\ReferenceResolverInterface; -use Sunrise\Http\Router\RouteCollectionFactory; -use Sunrise\Http\Router\RouteCollectionFactoryInterface; -use Sunrise\Http\Router\RouteCollectionInterface; -use Sunrise\Http\Router\RouteFactory; -use Sunrise\Http\Router\RouteFactoryInterface; +use Sunrise\Http\Router\Helper\FilesystemHelper; +use Sunrise\Http\Router\Helper\RouteCompiler; +use Sunrise\Http\Router\Route; use function class_exists; -use function get_declared_classes; use function hash; use function is_dir; -use function is_string; -use function iterator_to_array; +use function join; use function sprintf; use function usort; -/** - * DescriptorLoader - */ final class DescriptorLoader implements LoaderInterface { - /** - * List of classes or directories - * * @var list */ private array $resources = []; - /** - * @var string|null - */ - private ?string $cacheKey = null; - - /** - * Constructor of the class - * - * @param RouteCollectionFactoryInterface|null $collectionFactory - * @param RouteFactoryInterface|null $routeFactory - * @param ReferenceResolverInterface|null $referenceResolver - * @param CacheInterface|null $cache - */ public function __construct( - private ?RouteCollectionFactoryInterface $collectionFactory = null, - private ?RouteFactoryInterface $routeFactory = null, - private ?ReferenceResolverInterface $referenceResolver = null, - private ?CacheInterface $cache = null, + private readonly ?CacheInterface $cache = null, + private readonly ?string $cacheKey = null, ) { - $this->collectionFactory ??= new RouteCollectionFactory(); - $this->routeFactory ??= new RouteFactory(); - $this->referenceResolver ??= new ReferenceResolver(); - } - - /** - * Sets the given cache key to the loader - * - * @param string|null $cacheKey - * - * @return void - * - * @since 2.10.0 - */ - public function setCacheKey(?string $cacheKey): void - { - $this->cacheKey = $cacheKey; } /** - * Gets the loader cache key - * - * @return string - * - * @since 2.10.0 + * @throws InvalidArgumentException If one of the resources isn't valid. */ - public function getCacheKey(): string + public function attach(string ...$resources): void { - return $this->cacheKey ??= hash('md5', $this::class); - } - - /** - * @inheritDoc - * - * @throws InvalidArgumentException If the resource isn't valid. - */ - public function attach(mixed $resource): void - { - if (!is_string($resource)) { - throw new InvalidArgumentException( - 'The descriptor route loader only handles string resources.' - ); - } + foreach ($resources as $resource) { + if (is_dir($resource) || class_exists($resource)) { + $this->resources[] = $resource; + continue; + } - if (!class_exists($resource) && !is_dir($resource)) { throw new InvalidArgumentException(sprintf( - 'The descriptor route loader only handles class names or directory paths, ' . - 'however the given resource "%s" is not one of them.', + 'The method %s only accepts class or directory names; ' . + 'however, the resource %s is not one of them.', + __METHOD__, $resource, )); } - - $this->resources[] = $resource; } /** * @inheritDoc - * - * @throws InvalidArgumentException If one of the given resources isn't valid. */ - public function attachArray(array $resources): void + public function load(): Generator { - /** @psalm-suppress MixedAssignment */ - foreach ($resources as $resource) { - $this->attach($resource); - } - } - - /** - * @inheritDoc - */ - public function load(): RouteCollectionInterface - { - $routes = $this->collectionFactory->createCollection(); - $descriptors = $this->getDescriptors(); - foreach ($descriptors as $descriptor) { - $route = $this->routeFactory->createRoute( + foreach ($this->getDescriptors() as $descriptor) { + $route = new Route( $descriptor->name, $descriptor->path, $descriptor->methods, - $this->referenceResolver->resolveRequestHandler($descriptor->holder), - [...$this->referenceResolver->resolveMiddlewares($descriptor->middlewares)], - $descriptor->attributes, + $descriptor->holder, ); - $route->setConsumesMediaTypes(...$descriptor->consumes); - $route->setProducesMediaTypes(...$descriptor->produces); + $route->setMiddlewares(...$descriptor->middlewares); + $route->setAttributes($descriptor->attributes); + $route->setConstraints($descriptor->constraints); + $route->setConsumesEncodings(...$descriptor->consumesEncodings); + $route->setProducesEncodings(...$descriptor->producesEncodings); + $route->setConsumesMediaTypes(...$descriptor->consumesMediaTypes); + $route->setProducesMediaTypes(...$descriptor->producesMediaTypes); $route->setSummary($descriptor->summary); $route->setDescription($descriptor->description); $route->setTags(...$descriptor->tags); $route->setDeprecation($descriptor->isDeprecated); + $route->setPattern($descriptor->pattern); - $routes->add($route); + yield $route; } - - return $routes; } /** - * Gets descriptors from the cache if they are stored in it, - * otherwise collects them from the loader resources, - * then tries to cache and return them. - * - * @return list + * @return list */ private function getDescriptors(): array { - $cacheKey = $this->getCacheKey(); + $cacheKey = $this->cacheKey ?? hash('md5', __METHOD__); if (isset($this->cache) && $this->cache->has($cacheKey)) { - /** @var list */ + /** @var list */ return $this->cache->get($cacheKey); } $result = []; foreach ($this->resources as $resource) { - $descriptors = $this->getResourceDescriptors($resource); - foreach ($descriptors as $descriptor) { + foreach ($this->getResourceDescriptors($resource) as $descriptor) { + $descriptor->path = join($descriptor->prefixes) . $descriptor->path; + $descriptor->pattern = RouteCompiler::compileRoute($descriptor->path, $descriptor->constraints); $result[] = $descriptor; } } - usort($result, static fn(Route $a, Route $b): int => $b->priority <=> $a->priority); + usort($result, static fn(Descriptor $a, Descriptor $b): int => $b->priority <=> $a->priority); if (isset($this->cache)) { $this->cache->set($cacheKey, $result); @@ -217,11 +140,7 @@ private function getDescriptors(): array } /** - * Gets descriptors from the given resource - * - * @param string $resource - * - * @return Generator + * @return Generator */ private function getResourceDescriptors(string $resource): Generator { @@ -230,18 +149,14 @@ private function getResourceDescriptors(string $resource): Generator } if (is_dir($resource)) { - foreach ($this->getDirectoryClasses($resource) as $class) { + foreach (FilesystemHelper::getDirectoryClasses($resource) as $class) { yield from $this->getClassDescriptors($class); } } } /** - * Gets descriptors from the given class - * - * @param ReflectionClass $class - * - * @return Generator + * @return Generator */ private function getClassDescriptors(ReflectionClass $class): Generator { @@ -250,8 +165,8 @@ private function getClassDescriptors(ReflectionClass $class): Generator } if ($class->isSubclassOf(RequestHandlerInterface::class)) { - /** @var list> $annotations */ - $annotations = $class->getAttributes(Route::class); + /** @var list> $annotations */ + $annotations = $class->getAttributes(Descriptor::class); if (isset($annotations[0])) { $descriptor = $annotations[0]->newInstance(); $descriptor->holder = $class->getName(); @@ -261,14 +176,15 @@ private function getClassDescriptors(ReflectionClass $class): Generator } } - foreach ($class->getMethods(ReflectionMethod::IS_PUBLIC) as $method) { - // Statical methods must be ignored... + $methods = $class->getMethods(ReflectionMethod::IS_PUBLIC); + foreach ($methods as $method) { + // Static methods aren't supported... if ($method->isStatic()) { continue; } - /** @var list> $annotations */ - $annotations = $method->getAttributes(Route::class); + /** @var list> $annotations */ + $annotations = $method->getAttributes(Descriptor::class); if (isset($annotations[0])) { $descriptor = $annotations[0]->newInstance(); $descriptor->holder = [$class->getName(), $method->getName()]; @@ -280,15 +196,7 @@ private function getClassDescriptors(ReflectionClass $class): Generator } } - /** - * Supplements the given descriptor from parent classes of the given class - * - * @param Route $descriptor - * @param ReflectionClass $child - * - * @return void - */ - private function supplementDescriptorFromParentClasses(Route $descriptor, ReflectionClass $child): void + private function supplementDescriptorFromParentClasses(Descriptor $descriptor, ReflectionClass $child): void { $parents = []; while ($child = $child->getParentClass()) { @@ -300,22 +208,14 @@ private function supplementDescriptorFromParentClasses(Route $descriptor, Reflec } } - /** - * Supplements the given descriptor from the given class or method - * - * @param Route $descriptor - * @param ReflectionClass|ReflectionMethod $holder - * - * @return void - */ // phpcs:ignore Generic.Files.LineLength - private function supplementDescriptorFromClassOrMethod(Route $descriptor, ReflectionClass|ReflectionMethod $holder): void + private function supplementDescriptorFromClassOrMethod(Descriptor $descriptor, ReflectionClass|ReflectionMethod $holder): void { /** @var list> $annotations */ $annotations = $holder->getAttributes(Prefix::class); if (isset($annotations[0])) { $annotation = $annotations[0]->newInstance(); - $descriptor->path = $annotation->value . $descriptor->path; + $descriptor->prefixes[] = $annotation->value; } /** @var list> $annotations */ @@ -332,32 +232,60 @@ private function supplementDescriptorFromClassOrMethod(Route $descriptor, Reflec $descriptor->methods[] = $annotation->value; } - /** @var list> $annotations */ - $annotations = $holder->getAttributes(Consumes::class); + /** @var list> $annotations */ + $annotations = $holder->getAttributes(Middleware::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->consumes[] = new MediaType($annotation->type, $annotation->subtype); + $descriptor->middlewares[] = $annotation->value; } - /** @var list> $annotations */ - $annotations = $holder->getAttributes(Produces::class); + /** @var list> $annotations */ + $annotations = $holder->getAttributes(DefaultAttribute::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->produces[] = new MediaType($annotation->type, $annotation->subtype, $annotation->parameters); + $descriptor->attributes[$annotation->name] = $annotation->value; } - /** @var list> $annotations */ - $annotations = $holder->getAttributes(Middleware::class); + /** @var list> $annotations */ + $annotations = $holder->getAttributes(Constraint::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->middlewares[] = $annotation->value; + $descriptor->constraints[$annotation->name] = $annotation->value; + } + + /** @var list> $annotations */ + $annotations = $holder->getAttributes(ConsumesEncoding::class); + foreach ($annotations as $annotation) { + $annotation = $annotation->newInstance(); + $descriptor->consumesEncodings[] = $annotation->value; + } + + /** @var list> $annotations */ + $annotations = $holder->getAttributes(ProducesEncoding::class); + foreach ($annotations as $annotation) { + $annotation = $annotation->newInstance(); + $descriptor->producesEncodings[] = $annotation->value; + } + + /** @var list> $annotations */ + $annotations = $holder->getAttributes(ConsumesMediaType::class); + foreach ($annotations as $annotation) { + $annotation = $annotation->newInstance(); + $descriptor->consumesMediaTypes[] = $annotation->value; + } + + /** @var list> $annotations */ + $annotations = $holder->getAttributes(ProducesMediaType::class); + foreach ($annotations as $annotation) { + $annotation = $annotation->newInstance(); + $descriptor->producesMediaTypes[] = $annotation->value; } /** @var list> $annotations */ $annotations = $holder->getAttributes(Summary::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - /** @psalm-suppress PossiblyNullOperand */ + $descriptor->summary ??= ''; $descriptor->summary .= $annotation->value; } @@ -365,7 +293,7 @@ private function supplementDescriptorFromClassOrMethod(Route $descriptor, Reflec $annotations = $holder->getAttributes(Description::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - /** @psalm-suppress PossiblyNullOperand */ + $descriptor->description ??= ''; $descriptor->description .= $annotation->value; } @@ -382,42 +310,4 @@ private function supplementDescriptorFromClassOrMethod(Route $descriptor, Reflec $descriptor->isDeprecated = true; } } - - /** - * Scans the given directory and returns the found classes - * - * @param string $dirname - * - * @return Generator - */ - private function getDirectoryClasses(string $dirname): Generator - { - /** @var array $filenames */ - $filenames = iterator_to_array( - new RegexIterator( - new RecursiveIteratorIterator( - new RecursiveDirectoryIterator( - $dirname, - FilesystemIterator::KEY_AS_PATHNAME | - FilesystemIterator::CURRENT_AS_PATHNAME, - ), - ), - '/\.php$/', - ), - ); - - foreach ($filenames as $filename) { - (static function (string $filename): void { - /** @psalm-suppress UnresolvableInclude */ - require_once $filename; - })($filename); - } - - foreach (get_declared_classes() as $className) { - $classReflection = new ReflectionClass($className); - if (isset($filenames[$classReflection->getFileName()])) { - yield $classReflection; - } - } - } } diff --git a/src/Loader/LoaderInterface.php b/src/Loader/LoaderInterface.php index 3659e862..e17222d5 100644 --- a/src/Loader/LoaderInterface.php +++ b/src/Loader/LoaderInterface.php @@ -13,36 +13,12 @@ namespace Sunrise\Http\Router\Loader; -use Sunrise\Http\Router\RouteCollectionInterface; +use Sunrise\Http\Router\RouteInterface; -/** - * LoaderInterface - */ interface LoaderInterface { - - /** - * Attaches the given resource to the loader - * - * @param mixed $resource - * - * @return void - */ - public function attach(mixed $resource): void; - - /** - * Attaches the given resources to the loader - * - * @param array $resources - * - * @return void - */ - public function attachArray(array $resources): void; - /** - * Loads routes from previously attached resources - * - * @return RouteCollectionInterface + * @return iterable */ - public function load(): RouteCollectionInterface; + public function load(): iterable; } diff --git a/src/Middleware/CallableMiddleware.php b/src/Middleware/CallableMiddleware.php index b05f696c..2311d771 100644 --- a/src/Middleware/CallableMiddleware.php +++ b/src/Middleware/CallableMiddleware.php @@ -19,25 +19,18 @@ use Psr\Http\Server\RequestHandlerInterface; /** - * CallableMiddleware - * * @since 2.8.0 * * @template T as callable(ServerRequestInterface=, RequestHandlerInterface=): ResponseInterface */ final class CallableMiddleware implements MiddlewareInterface { - /** - * The middleware's callback - * * @var T */ private $callback; /** - * Constructor of the class - * * @param T $callback */ public function __construct(callable $callback) diff --git a/src/Middleware/CallbackMiddleware.php b/src/Middleware/CallbackMiddleware.php index 8b50f06d..93089973 100644 --- a/src/Middleware/CallbackMiddleware.php +++ b/src/Middleware/CallbackMiddleware.php @@ -24,33 +24,20 @@ use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; /** - * CallbackMiddleware - * * @since 3.0.0 */ final class CallbackMiddleware implements MiddlewareInterface { - /** - * The middleware's callback - * * @var callable */ private $callback; - /** - * Constructor of the class - * - * @param callable $callback - * @param ReflectionFunction|ReflectionMethod $callbackReflection - * @param ParameterResolutionerInterface $parameterResolutioner - * @param ResponseResolutionerInterface $responseResolutioner - */ public function __construct( callable $callback, - private ReflectionFunction|ReflectionMethod $callbackReflection, - private ParameterResolutionerInterface $parameterResolutioner, - private ResponseResolutionerInterface $responseResolutioner, + private readonly ReflectionFunction|ReflectionMethod $callbackReflection, + private readonly ParameterResolutionerInterface $parameterResolutioner, + private readonly ResponseResolutionerInterface $responseResolutioner, ) { $this->callback = $callback; } diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 2f0204e5..58dbb9c6 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -35,13 +35,12 @@ */ final class JsonPayloadDecodingMiddleware implements MiddlewareInterface { - /** * @inheritDoc */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if (ServerRequest::from($request)->clientProducesMediaType(MediaType::json())) { + if (ServerRequest::create($request)->clientProducesMediaType(new MediaType('application', 'json'))) { $request = $request->withParsedBody($this->decodePayload($request->getBody()->__toString())); } @@ -49,12 +48,6 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface } /** - * Tries to decode the given JSON payload - * - * @param string $payload - * - * @return array - * * @throws HttpBadRequestException If the JSON payload couldn't be decoded. */ private function decodePayload(string $payload): array diff --git a/src/ParameterResolving/ParameterResolutioner.php b/src/ParameterResolving/ParameterResolutioner.php index 74c936e7..4a7e3356 100644 --- a/src/ParameterResolving/ParameterResolutioner.php +++ b/src/ParameterResolving/ParameterResolutioner.php @@ -14,9 +14,9 @@ namespace Sunrise\Http\Router\ParameterResolving; use Generator; +use LogicException; use ReflectionMethod; use ReflectionParameter; -use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ParameterResolverInterface; use function sprintf; diff --git a/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php b/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php index 3229fca7..b6864568 100644 --- a/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php @@ -14,12 +14,12 @@ namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; use Generator; +use LogicException; use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionParameter; use Sunrise\Http\Router\Annotation\PathVariable; use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; -use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; use Sunrise\Http\Router\RouteInterface; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; diff --git a/src/ParameterResolving/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestBodyParameterResolver.php index 0bff31a1..84a46139 100644 --- a/src/ParameterResolving/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/RequestBodyParameterResolver.php @@ -14,12 +14,12 @@ namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; use Generator; +use LogicException; use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestBody; use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; -use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; diff --git a/src/ParameterResolving/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestCookieParameterResolver.php index d065d649..073feddf 100644 --- a/src/ParameterResolving/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/RequestCookieParameterResolver.php @@ -14,12 +14,12 @@ namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; use Generator; +use LogicException; use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestCookie; use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; -use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; diff --git a/src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php index 4439b9e8..6ceaab58 100644 --- a/src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php @@ -14,12 +14,12 @@ namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; use Generator; +use LogicException; use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestHeader; use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; -use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; diff --git a/src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php index 99313148..f52fc78b 100644 --- a/src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php @@ -14,12 +14,12 @@ namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; use Generator; +use LogicException; use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestQuery; use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; -use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; diff --git a/src/ParameterResolving/ParameterResolver/RequestRouteParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestRouteParameterResolver.php index a70a4f46..79d47313 100644 --- a/src/ParameterResolving/ParameterResolver/RequestRouteParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/RequestRouteParameterResolver.php @@ -14,10 +14,10 @@ namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; use Generator; +use LogicException; use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; -use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; use Sunrise\Http\Router\RouteInterface; diff --git a/src/ParameterResolving/ParameterResolver/RequestStreamParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestStreamParameterResolver.php index 55479ab0..97bb8c7a 100644 --- a/src/ParameterResolving/ParameterResolver/RequestStreamParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/RequestStreamParameterResolver.php @@ -14,11 +14,11 @@ namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; use Generator; +use LogicException; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\StreamInterface; use ReflectionNamedType; use ReflectionParameter; -use Sunrise\Http\Router\Exception\LogicException; /** * RequestStreamParameterResolver diff --git a/src/ParameterResolving/ParameterResolver/RequestUriParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestUriParameterResolver.php index 8ac7c5b4..73edb212 100644 --- a/src/ParameterResolving/ParameterResolver/RequestUriParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/RequestUriParameterResolver.php @@ -14,11 +14,11 @@ namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; use Generator; +use LogicException; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\UriInterface; use ReflectionNamedType; use ReflectionParameter; -use Sunrise\Http\Router\Exception\LogicException; /** * RequestUriParameterResolver diff --git a/src/ParameterResolving/ParameterResolver/RouterParameterResolver.php b/src/ParameterResolving/ParameterResolver/RouterParameterResolver.php new file mode 100644 index 00000000..a58cfb86 --- /dev/null +++ b/src/ParameterResolving/ParameterResolver/RouterParameterResolver.php @@ -0,0 +1,54 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; + +use Generator; +use LogicException; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionNamedType; +use ReflectionParameter; +use Sunrise\Http\Router\Router; + +/** + * @since 3.0.0 + */ +final class RouterParameterResolver implements ParameterResolverInterface +{ + + /** + * @inheritDoc + * + * @throws LogicException If the resolver is used incorrectly. + */ + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + { + $type = $parameter->getType(); + if (! $type instanceof ReflectionNamedType || $type->getName() <> Router::class) { + return; + } + + if (! $context instanceof ServerRequestInterface) { + throw new LogicException( + 'At this level of the application, any operations with the request are not possible.' + ); + } + + $router = $context->getAttribute('@router'); + if (! $router instanceof Router) { + throw new LogicException(); + } + + yield $router; + } +} diff --git a/src/ParameterResolving/ParameterResolver/ServerRequestParameterResolver.php b/src/ParameterResolving/ParameterResolver/ServerRequestParameterResolver.php index 6fd3fd50..73a205b6 100644 --- a/src/ParameterResolving/ParameterResolver/ServerRequestParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/ServerRequestParameterResolver.php @@ -14,10 +14,10 @@ namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; use Generator; +use LogicException; use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; -use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ServerRequest; /** @@ -46,6 +46,6 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } - yield ServerRequest::from($context); + yield ServerRequest::create($context); } } diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index cd1beda2..e797c0c5 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -15,17 +15,15 @@ use Closure; use Generator; +use LogicException; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use ReflectionClass; use ReflectionFunction; use ReflectionMethod; -use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\Middleware\CallbackMiddleware; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; -use Sunrise\Http\Router\ResponseResolving\ResponseResolutioner; use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; use function class_exists; @@ -43,24 +41,15 @@ */ final class ReferenceResolver implements ReferenceResolverInterface { - /** * @var array */ private array $resolvedClasses = []; - /** - * Constructor of the class - * - * @param ParameterResolutionerInterface|null $parameterResolutioner - * @param ResponseResolutionerInterface|null $responseResolutioner - */ public function __construct( - private ?ParameterResolutionerInterface $parameterResolutioner = null, - private ?ResponseResolutionerInterface $responseResolutioner = null, + private readonly ParameterResolutionerInterface $parameterResolutioner, + private readonly ResponseResolutionerInterface $responseResolutioner, ) { - $this->parameterResolutioner ??= new ParameterResolutioner(); - $this->responseResolutioner ??= new ResponseResolutioner(); } /** diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index 265a57a3..785d3730 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -18,23 +18,16 @@ use Psr\Http\Server\RequestHandlerInterface; /** - * CallableRequestHandler - * * @template T as callable(ServerRequestInterface=): ResponseInterface */ final class CallableRequestHandler implements RequestHandlerInterface { - /** - * The request handler's callback - * * @var T */ private $callback; /** - * Constructor of the class - * * @param T $callback */ public function __construct(callable $callback) diff --git a/src/RequestHandler/CallbackRequestHandler.php b/src/RequestHandler/CallbackRequestHandler.php index 2fab897b..304b1f3a 100644 --- a/src/RequestHandler/CallbackRequestHandler.php +++ b/src/RequestHandler/CallbackRequestHandler.php @@ -23,33 +23,20 @@ use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; /** - * CallbackRequestHandler - * * @since 3.0.0 */ final class CallbackRequestHandler implements RequestHandlerInterface { - /** - * The request handler's callback - * * @var callable */ private $callback; - /** - * Constructor of the class - * - * @param callable $callback - * @param ReflectionFunction|ReflectionMethod $callbackReflection - * @param ParameterResolutionerInterface $parameterResolutioner - * @param ResponseResolutionerInterface $responseResolutioner - */ public function __construct( callable $callback, - private ReflectionFunction|ReflectionMethod $callbackReflection, - private ParameterResolutionerInterface $parameterResolutioner, - private ResponseResolutionerInterface $responseResolutioner, + private readonly ReflectionFunction|ReflectionMethod $callbackReflection, + private readonly ParameterResolutionerInterface $parameterResolutioner, + private readonly ResponseResolutionerInterface $responseResolutioner, ) { $this->callback = $callback; } diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index 08f795f1..c591ba60 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -20,22 +20,16 @@ use SplQueue; /** - * QueueableRequestHandler - * * @extends SplQueue */ final class QueueableRequestHandler extends SplQueue implements RequestHandlerInterface { - /** - * Constructor of the class - * - * @param RequestHandlerInterface $requestHandler - * @param MiddlewareInterface ...$middlewares + * @param array $middlewares */ public function __construct( - private RequestHandlerInterface $requestHandler, - MiddlewareInterface ...$middlewares, + private readonly RequestHandlerInterface $requestHandler, + array $middlewares, ) { foreach ($middlewares as $middleware) { $this->enqueue($middleware); @@ -47,10 +41,8 @@ public function __construct( */ public function handle(ServerRequestInterface $request): ResponseInterface { - if ($this->isEmpty()) { - return $this->requestHandler->handle($request); - } - - return ($clone = clone $this)->dequeue()->process($request, $clone); + return ! $this->isEmpty() ? + ($clone = clone $this)->dequeue()->process($request, $clone) : + $this->requestHandler->handle($request); } } diff --git a/src/ResponseResolving/ResponseResolutioner.php b/src/ResponseResolving/ResponseResolutioner.php index cb92218a..e3686b33 100644 --- a/src/ResponseResolving/ResponseResolutioner.php +++ b/src/ResponseResolving/ResponseResolutioner.php @@ -13,7 +13,7 @@ namespace Sunrise\Http\Router\ResponseResolving; -use Psr\EventDispatcher\EventDispatcherInterface; +use LogicException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; @@ -21,8 +21,6 @@ use ReflectionMethod; use Sunrise\Http\Router\Annotation\ResponseHeader; use Sunrise\Http\Router\Annotation\ResponseStatus; -use Sunrise\Http\Router\Event\ResponseResolvedEvent; -use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ResponseResolving\ResponseResolver\ResponseResolverInterface; use function sprintf; @@ -40,15 +38,6 @@ final class ResponseResolutioner implements ResponseResolutionerInterface */ private array $resolvers = []; - /** - * Constructor of the class - * - * @param EventDispatcherInterface|null $eventDispatcher - */ - public function __construct(private ?EventDispatcherInterface $eventDispatcher = null) - { - } - /** * @inheritDoc */ @@ -114,12 +103,6 @@ private function handleResponse( $response = $response->withHeader($header->name, $header->value); } - if (isset($this->eventDispatcher)) { - $event = new ResponseResolvedEvent($request, $response, $responder); - $this->eventDispatcher->dispatch($event); - $response = $event->getResponse(); - } - return $response; } diff --git a/src/ResponseResolving/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolving/ResponseResolver/JsonResponseResolver.php index 2f4a2131..c061c9cf 100644 --- a/src/ResponseResolving/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolving/ResponseResolver/JsonResponseResolver.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router\ResponseResolving\ResponseResolver; use JsonException; +use LogicException; use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; @@ -21,7 +22,6 @@ use ReflectionFunction; use ReflectionMethod; use Sunrise\Http\Router\Annotation\JsonResponse; -use Sunrise\Http\Router\Exception\LogicException; use Sunrise\Http\Router\ResponseResolving\ResponseResolutioner; use function json_encode; diff --git a/src/ResponseResolving/ResponseResolver/RouteResponseResolver.php b/src/ResponseResolving/ResponseResolver/RouteResponseResolver.php index 5440ba03..ca74f829 100644 --- a/src/ResponseResolving/ResponseResolver/RouteResponseResolver.php +++ b/src/ResponseResolving/ResponseResolver/RouteResponseResolver.php @@ -13,11 +13,13 @@ namespace Sunrise\Http\Router\ResponseResolving\ResponseResolver; +use LogicException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use ReflectionFunction; use ReflectionMethod; use Sunrise\Http\Router\RouteInterface; +use Sunrise\Http\Router\Router; /** * RouteResponseResolver @@ -39,6 +41,11 @@ public function resolveResponse( return null; } - return $response->handle($request); + $router = $request->getAttribute('@router'); + if (! $router instanceof Router) { + throw new LogicException(); + } + + return $router->runRoute($response, $request); } } diff --git a/src/Route.php b/src/Route.php index b364ce3c..b17e71be 100644 --- a/src/Route.php +++ b/src/Route.php @@ -13,13 +13,6 @@ namespace Sunrise\Http\Router; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; - use function rtrim; use function strtoupper; @@ -53,30 +46,30 @@ class Route implements RouteInterface private array $methods = []; /** - * The route's consumes media types + * The route's consumed media types * - * @var list + * @var list */ - private array $consumesMediaTypes = []; + private array $consumedMediaTypes = []; /** - * The route's produces media types + * The route's produced media types * - * @var list + * @var list */ - private array $producesMediaTypes = []; + private array $producedMediaTypes = []; /** * The route's request handler * - * @var RequestHandlerInterface + * @var mixed */ - private RequestHandlerInterface $requestHandler; + private mixed $requestHandler; /** * The route middlewares * - * @var list + * @var list */ private array $middlewares = []; @@ -115,21 +108,25 @@ class Route implements RouteInterface */ private bool $isDeprecated = false; + private array $constraints = []; + + private ?string $pattern = null; + /** * Constructor of the class * * @param string $name * @param string $path * @param list $methods - * @param RequestHandlerInterface $requestHandler - * @param list $middlewares + * @param mixed $requestHandler + * @param list $middlewares * @param array $attributes */ public function __construct( string $name, string $path, array $methods, - RequestHandlerInterface $requestHandler, + mixed $requestHandler, array $middlewares = [], array $attributes = [], ) { @@ -168,23 +165,23 @@ public function getMethods(): array /** * @inheritDoc */ - public function getConsumesMediaTypes(): array + public function getConsumedMediaTypes(): array { - return $this->consumesMediaTypes; + return $this->consumedMediaTypes; } /** * @inheritDoc */ - public function getProducesMediaTypes(): array + public function getProducedMediaTypes(): array { - return $this->producesMediaTypes; + return $this->producedMediaTypes; } /** * @inheritDoc */ - public function getRequestHandler(): RequestHandlerInterface + public function getRequestHandler(): mixed { return $this->requestHandler; } @@ -281,11 +278,11 @@ public function setMethods(string ...$methods): static /** * @inheritDoc */ - public function setConsumesMediaTypes(MediaType ...$mediaTypes): static + public function setConsumesMediaTypes(string ...$mediaTypes): static { - $this->consumesMediaTypes = []; + $this->consumedMediaTypes = []; foreach ($mediaTypes as $mediaType) { - $this->consumesMediaTypes[] = $mediaType; + $this->consumedMediaTypes[] = $mediaType; } return $this; @@ -294,11 +291,11 @@ public function setConsumesMediaTypes(MediaType ...$mediaTypes): static /** * @inheritDoc */ - public function setProducesMediaTypes(MediaType ...$mediaTypes): static + public function setProducesMediaTypes(string ...$mediaTypes): static { - $this->producesMediaTypes = []; + $this->producedMediaTypes = []; foreach ($mediaTypes as $mediaType) { - $this->producesMediaTypes[] = $mediaType; + $this->producedMediaTypes[] = $mediaType; } return $this; @@ -307,7 +304,7 @@ public function setProducesMediaTypes(MediaType ...$mediaTypes): static /** * @inheritDoc */ - public function setRequestHandler(RequestHandlerInterface $requestHandler): static + public function setRequestHandler(mixed $requestHandler): static { $this->requestHandler = $requestHandler; @@ -317,7 +314,7 @@ public function setRequestHandler(RequestHandlerInterface $requestHandler): stat /** * @inheritDoc */ - public function setMiddlewares(MiddlewareInterface ...$middlewares): static + public function setMiddlewares(mixed ...$middlewares): static { $this->middlewares = []; foreach ($middlewares as $middleware) { @@ -428,10 +425,10 @@ public function addMethod(string ...$methods): static /** * @inheritDoc */ - public function addConsumesMediaType(MediaType ...$mediaTypes): static + public function addConsumedMediaType(string ...$mediaTypes): static { foreach ($mediaTypes as $mediaType) { - $this->consumesMediaTypes[] = $mediaType; + $this->consumedMediaTypes[] = $mediaType; } return $this; @@ -440,10 +437,10 @@ public function addConsumesMediaType(MediaType ...$mediaTypes): static /** * @inheritDoc */ - public function addProducesMediaType(MediaType ...$mediaTypes): static + public function addProducedMediaType(string ...$mediaTypes): static { foreach ($mediaTypes as $mediaType) { - $this->producesMediaTypes[] = $mediaType; + $this->producedMediaTypes[] = $mediaType; } return $this; @@ -452,7 +449,7 @@ public function addProducesMediaType(MediaType ...$mediaTypes): static /** * @inheritDoc */ - public function addMiddleware(MiddlewareInterface ...$middlewares): static + public function addMiddleware(mixed ...$middlewares): static { foreach ($middlewares as $middleware) { $this->middlewares[] = $middleware; @@ -488,25 +485,27 @@ public function withAddedAttributes(array $attributes): static return $clone; } - /** - * @inheritDoc - */ - public function handle(ServerRequestInterface $request): ResponseInterface + public function getConstraints(): array { - $request = $request->withAttribute(self::ATTR_ROUTE, $this); + return $this->constraints; + } - /** @psalm-suppress MixedAssignment */ - foreach ($this->attributes as $name => $value) { - $request = $request->withAttribute($name, $value); - } + public function setConstraints(array $constrains): static + { + $this->constraints = $constrains; - if (empty($this->middlewares)) { - return $this->requestHandler->handle($request); - } + return $this; + } + + public function getPattern(): ?string + { + return $this->pattern; + } - return (new QueueableRequestHandler( - $this->requestHandler, - ...$this->middlewares, - ))->handle($request); + public function setPattern(?string $pattern): static + { + $this->pattern = $pattern; + + return $this; } } diff --git a/src/RouteCollection.php b/src/RouteCollection.php deleted file mode 100644 index 9e5e46a1..00000000 --- a/src/RouteCollection.php +++ /dev/null @@ -1,213 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -use Generator; -use Psr\Http\Server\MiddlewareInterface; -use Sunrise\Http\Router\Entity\MediaType; -use Traversable; - -use function count; - -/** - * RouteCollection - * - * Use the {@see RouteCollectionFactory} factory to create this class. - */ -class RouteCollection implements RouteCollectionInterface -{ - - /** - * The collection routes - * - * @var array - */ - private array $routes = []; - - /** - * Constructor of the class - * - * @param RouteInterface ...$routes - */ - public function __construct(RouteInterface ...$routes) - { - $this->add(...$routes); - } - - /** - * @inheritDoc - */ - public function all(): Generator - { - foreach ($this->routes as $route) { - yield $route; - } - } - - /** - * @inheritDoc - */ - public function has(string $name): bool - { - return isset($this->routes[$name]); - } - - /** - * @inheritDoc - */ - public function get(string $name): ?RouteInterface - { - return $this->routes[$name] ?? null; - } - - /** - * @inheritDoc - */ - public function add(RouteInterface ...$routes): static - { - foreach ($routes as $route) { - $this->routes[$route->getName()] = $route; - } - - return $this; - } - - /** - * @inheritDoc - */ - public function addPrefix(string $prefix): static - { - foreach ($this->routes as $route) { - $route->addPrefix($prefix); - } - - return $this; - } - - /** - * @inheritDoc - */ - public function addSuffix(string $suffix): static - { - foreach ($this->routes as $route) { - $route->addSuffix($suffix); - } - - return $this; - } - - /** - * @inheritDoc - */ - public function addMethod(string ...$methods): static - { - foreach ($this->routes as $route) { - $route->addMethod(...$methods); - } - - return $this; - } - - /** - * @inheritDoc - */ - public function addConsumesMediaType(MediaType ...$mediaTypes): static - { - foreach ($this->routes as $route) { - $route->addConsumesMediaType(...$mediaTypes); - } - - return $this; - } - - /** - * @inheritDoc - */ - public function addProducesMediaType(MediaType ...$mediaTypes): static - { - foreach ($this->routes as $route) { - $route->addProducesMediaType(...$mediaTypes); - } - - return $this; - } - - /** - * @inheritDoc - */ - public function addPriorityMiddleware(MiddlewareInterface ...$middlewares): static - { - foreach ($this->routes as $route) { - $route->setMiddlewares(...$middlewares, ...$route->getMiddlewares()); - } - - return $this; - } - - /** - * @inheritDoc - */ - public function addMiddleware(MiddlewareInterface ...$middlewares): static - { - foreach ($this->routes as $route) { - $route->addMiddleware(...$middlewares); - } - - return $this; - } - - /** - * @inheritDoc - */ - public function addTag(string ...$tags): static - { - foreach ($this->routes as $route) { - $route->addTag(...$tags); - } - - return $this; - } - - /** - * @inheritDoc - */ - public function setDeprecation(bool $isDeprecated): static - { - foreach ($this->routes as $route) { - $route->setDeprecation($isDeprecated); - } - - return $this; - } - - /** - * @inheritDoc - * - * @since 3.0.0 - */ - public function count(): int - { - return count($this->routes); - } - - /** - * @inheritDoc - * - * @since 3.0.0 - */ - public function getIterator(): Traversable - { - yield from $this->all(); - } -} diff --git a/src/RouteCollectionFactory.php b/src/RouteCollectionFactory.php deleted file mode 100644 index 3d596070..00000000 --- a/src/RouteCollectionFactory.php +++ /dev/null @@ -1,29 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -/** - * RouteCollectionFactory - */ -class RouteCollectionFactory implements RouteCollectionFactoryInterface -{ - - /** - * @inheritDoc - */ - public function createCollection(RouteInterface ...$routes): RouteCollectionInterface - { - return new RouteCollection(...$routes); - } -} diff --git a/src/RouteCollectionFactoryInterface.php b/src/RouteCollectionFactoryInterface.php deleted file mode 100644 index 85a4a080..00000000 --- a/src/RouteCollectionFactoryInterface.php +++ /dev/null @@ -1,30 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -/** - * RouteCollectionFactoryInterface - */ -interface RouteCollectionFactoryInterface -{ - - /** - * Creates a new collection with the given route(s) - * - * @param RouteInterface ...$routes - * - * @return RouteCollectionInterface - */ - public function createCollection(RouteInterface ...$routes): RouteCollectionInterface; -} diff --git a/src/RouteCollectionInterface.php b/src/RouteCollectionInterface.php deleted file mode 100644 index b5621d5b..00000000 --- a/src/RouteCollectionInterface.php +++ /dev/null @@ -1,166 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -use Countable; -use Generator; -use IteratorAggregate; -use Psr\Http\Server\MiddlewareInterface; -use Sunrise\Http\Router\Entity\MediaType; - -/** - * RouteCollectionInterface - * - * @extends IteratorAggregate - */ -interface RouteCollectionInterface extends Countable, IteratorAggregate -{ - - /** - * Gets all routes from the collection - * - * @return Generator - */ - public function all(): Generator; - - /** - * Checks by the given name if a route exists in the collection - * - * @param string $name - * - * @return bool - * - * @since 2.10.0 - */ - public function has(string $name): bool; - - /** - * Gets a route by the given name - * - * @param string $name - * - * @return RouteInterface|null - * - * @since 2.10.0 - */ - public function get(string $name): ?RouteInterface; - - /** - * Adds the given route(s) to the collection - * - * @param RouteInterface ...$routes - * - * @return static - */ - public function add(RouteInterface ...$routes): static; - - /** - * Adds the given path prefix to all routes in the collection - * - * @param string $prefix - * - * @return static - * - * @since 2.9.0 - */ - public function addPrefix(string $prefix): static; - - /** - * Adds the given path suffix to all routes in the collection - * - * @param string $suffix - * - * @return static - * - * @since 2.9.0 - */ - public function addSuffix(string $suffix): static; - - /** - * Adds the given method(s) to all routes in the collection - * - * @param string ...$methods - * - * @return static - * - * @since 2.9.0 - */ - public function addMethod(string ...$methods): static; - - /** - * Adds the given consumes media type(s) to all routes in the collection - * - * @param MediaType ...$mediaTypes - * - * @return static - * - * @since 3.0.0 - */ - public function addConsumesMediaType(MediaType ...$mediaTypes): static; - - /** - * Adds the given produces media type(s) to all routes in the collection - * - * @param MediaType ...$mediaTypes - * - * @return static - * - * @since 3.0.0 - */ - public function addProducesMediaType(MediaType ...$mediaTypes): static; - - /** - * Adds the given priority middleware(s) to all routes in the collection - * - * @param MiddlewareInterface ...$middlewares - * - * @return static - * - * @since 3.0.0 - */ - public function addPriorityMiddleware(MiddlewareInterface ...$middlewares): static; - - /** - * Adds the given middleware(s) to all routes in the collection - * - * @param MiddlewareInterface ...$middlewares - * - * @return static - * - * @since 2.9.0 - */ - public function addMiddleware(MiddlewareInterface ...$middlewares): static; - - /** - * Adds the given tag(s) to all routes in the collection - * - * @param string ...$tags - * - * @return static - * - * @since 3.0.0 - */ - public function addTag(string ...$tags): static; - - /** - * Sets the given deprecation sign to all routes in the collection - * - * @param bool $isDeprecated - * - * @return static - * - * @since 3.0.0 - */ - public function setDeprecation(bool $isDeprecated): static; -} diff --git a/src/RouteCollector.php b/src/RouteCollector.php index 2efcda50..10bff11b 100644 --- a/src/RouteCollector.php +++ b/src/RouteCollector.php @@ -14,60 +14,26 @@ namespace Sunrise\Http\Router; use Fig\Http\Message\RequestMethodInterface; +use Psr\Http\Server\MiddlewareInterface; +use Sunrise\Http\Router\Entity\MediaType; +use Sunrise\Http\Router\Loader\LoaderInterface; /** * RouteCollector */ -class RouteCollector +class RouteCollector implements LoaderInterface { - /** - * @var RouteCollectionInterface + * @var list */ - private RouteCollectionInterface $collection; + private array $routes = []; /** - * @var RouteCollectionFactoryInterface + * @return list */ - private RouteCollectionFactoryInterface $collectionFactory; - - /** - * @var RouteFactoryInterface - */ - private RouteFactoryInterface $routeFactory; - - /** - * @var ReferenceResolverInterface - */ - private ReferenceResolverInterface $referenceResolver; - - /** - * Constructor of the class - * - * @param RouteCollectionFactoryInterface|null $collectionFactory - * @param RouteFactoryInterface|null $routeFactory - * @param ReferenceResolverInterface|null $referenceResolver - */ - public function __construct( - ?RouteCollectionFactoryInterface $collectionFactory = null, - ?RouteFactoryInterface $routeFactory = null, - ?ReferenceResolverInterface $referenceResolver = null, - ) { - $this->collectionFactory = $collectionFactory ?? new RouteCollectionFactory(); - $this->routeFactory = $routeFactory ?? new RouteFactory(); - $this->referenceResolver = $referenceResolver ?? new ReferenceResolver(); - - $this->collection = $this->collectionFactory->createCollection(); - } - - /** - * Gets the collector's route collection - * - * @return RouteCollectionInterface - */ - public function getCollection(): RouteCollectionInterface + public function getRoutes(): array { - return $this->collection; + return $this->routes; } /** @@ -90,16 +56,16 @@ public function route( array $middlewares = [], array $attributes = [], ) : RouteInterface { - $route = $this->routeFactory->createRoute( + $route = new Route( $name, $path, $methods, - $this->referenceResolver->resolveRequestHandler($requestHandler), - [...$this->referenceResolver->resolveMiddlewares($middlewares)], + $requestHandler, + $middlewares, $attributes, ); - $this->collection->add($route); + $this->routes[] = $route; return $route; } @@ -300,30 +266,107 @@ public function purge( ); } - /** - * Route grouping logic - * - * @param callable $callback - * @param list $middlewares - * - * @return RouteCollectionInterface - */ - public function group(callable $callback, array $middlewares = []): RouteCollectionInterface + public function group(callable $callback, array $middlewares = []): static { - $collector = new self( - $this->collectionFactory, - $this->routeFactory, - $this->referenceResolver, - ); + $collector = new self(); $callback($collector); - $collector->collection->addPriorityMiddleware( - ...$this->referenceResolver->resolveMiddlewares($middlewares) - ); + $collector->addPriorityMiddleware(...$middlewares); + + foreach ($collector->routes as $route) { + $this->routes[] = $route; + } + + return $collector; + } + + public function addPrefix(string $prefix): static + { + foreach ($this->routes as $route) { + $route->addPrefix($prefix); + } + + return $this; + } + + public function addSuffix(string $suffix): static + { + foreach ($this->routes as $route) { + $route->addSuffix($suffix); + } - $this->collection->add(...$collector->collection->all()); + return $this; + } - return $collector->collection; + public function addMethod(string ...$methods): static + { + foreach ($this->routes as $route) { + $route->addMethod(...$methods); + } + + return $this; + } + + public function addConsumesMediaType(MediaType ...$mediaTypes): static + { + foreach ($this->routes as $route) { + $route->addConsumedMediaType(...$mediaTypes); + } + + return $this; + } + + public function addProducesMediaType(MediaType ...$mediaTypes): static + { + foreach ($this->routes as $route) { + $route->addProducedMediaType(...$mediaTypes); + } + + return $this; + } + + public function addPriorityMiddleware(MiddlewareInterface ...$middlewares): static + { + foreach ($this->routes as $route) { + $route->setMiddlewares(...$middlewares, ...$route->getMiddlewares()); + } + + return $this; + } + + public function addMiddleware(MiddlewareInterface ...$middlewares): static + { + foreach ($this->routes as $route) { + $route->addMiddleware(...$middlewares); + } + + return $this; + } + + public function addTag(string ...$tags): static + { + foreach ($this->routes as $route) { + $route->addTag(...$tags); + } + + return $this; + } + + public function setDeprecation(bool $isDeprecated): static + { + foreach ($this->routes as $route) { + $route->setDeprecation($isDeprecated); + } + + return $this; + } + + /** + * @inheritDoc + */ + public function load(): iterable + { + return $this->routes; } } diff --git a/src/RouteInterface.php b/src/RouteInterface.php index 6056fe9e..ff937966 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -13,15 +13,9 @@ namespace Sunrise\Http\Router; -use Fig\Http\Message\RequestMethodInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Entity\MediaType; -/** - * RouteInterface - */ -interface RouteInterface extends RequestHandlerInterface, RequestMethodInterface +interface RouteInterface { /** @@ -33,6 +27,10 @@ interface RouteInterface extends RequestHandlerInterface, RequestMethodInterface */ public const ATTR_ROUTE = '@route'; + public function getConstraints(): array; + + public function setConstraints(array $constrains): static; + /** * Gets the route name * @@ -55,34 +53,34 @@ public function getPath(): string; public function getMethods(): array; /** - * Gets the route's consumes media types + * Gets the route's consumed media types * * @return list * * @since 3.0.0 */ - public function getConsumesMediaTypes(): array; + public function getConsumedMediaTypes(): array; /** - * Gets the route's produces media types + * Gets the route's produced media types * * @return list * * @since 3.0.0 */ - public function getProducesMediaTypes(): array; + public function getProducedMediaTypes(): array; /** * Gets the route's request handler * - * @return RequestHandlerInterface + * @return mixed */ - public function getRequestHandler(): RequestHandlerInterface; + public function getRequestHandler(): mixed; /** * Gets the route middlewares * - * @return list + * @return list */ public function getMiddlewares(): array; @@ -94,8 +92,8 @@ public function getMiddlewares(): array; public function getAttributes(): array; /** - * Gets the route's attribute value by its given name or - * returns the given default value if the parameter doesn't exist + * Gets the route's attribute value by its given name + * or returns the given default value if the parameter doesn't exist * * @param string $name * @param mixed $default @@ -168,7 +166,7 @@ public function setPath(string $path): static; public function setMethods(string ...$methods): static; /** - * Sets the given consumes media type(s) to the route + * Sets the given consumed media type(s) to the route * * @param MediaType ...$mediaTypes * @@ -176,10 +174,10 @@ public function setMethods(string ...$methods): static; * * @since 3.0.0 */ - public function setConsumesMediaTypes(MediaType ...$mediaTypes): static; + public function setConsumesMediaTypes(string ...$mediaTypes): static; /** - * Sets the given produces media type(s) to the route + * Sets the given produced media type(s) to the route * * @param MediaType ...$mediaTypes * @@ -187,25 +185,25 @@ public function setConsumesMediaTypes(MediaType ...$mediaTypes): static; * * @since 3.0.0 */ - public function setProducesMediaTypes(MediaType ...$mediaTypes): static; + public function setProducesMediaTypes(string ...$mediaTypes): static; /** * Sets the given request handler to the route * - * @param RequestHandlerInterface $requestHandler + * @param mixed $requestHandler * * @return static */ - public function setRequestHandler(RequestHandlerInterface $requestHandler): static; + public function setRequestHandler(mixed $requestHandler): static; /** * Sets the given middleware(s) to the route * - * @param MiddlewareInterface ...$middlewares + * @param mixed ...$middlewares * * @return static */ - public function setMiddlewares(MiddlewareInterface ...$middlewares): static; + public function setMiddlewares(mixed ...$middlewares): static; /** * Sets the given attributes to the route @@ -300,7 +298,7 @@ public function addSuffix(string $suffix): static; public function addMethod(string ...$methods): static; /** - * Adds the given consumes media type(s) to the route + * Adds the given consumed media type(s) to the route * * @param MediaType ...$mediaTypes * @@ -308,10 +306,10 @@ public function addMethod(string ...$methods): static; * * @since 3.0.0 */ - public function addConsumesMediaType(MediaType ...$mediaTypes): static; + public function addConsumedMediaType(string ...$mediaTypes): static; /** - * Adds the given produces media type(s) to the route + * Adds the given produced media type(s) to the route * * @param MediaType ...$mediaTypes * @@ -319,16 +317,16 @@ public function addConsumesMediaType(MediaType ...$mediaTypes): static; * * @since 3.0.0 */ - public function addProducesMediaType(MediaType ...$mediaTypes): static; + public function addProducedMediaType(string ...$mediaTypes): static; /** * Adds the given middleware(s) to the route * - * @param MiddlewareInterface ...$middlewares + * @param mixed ...$middlewares * * @return static */ - public function addMiddleware(MiddlewareInterface ...$middlewares): static; + public function addMiddleware(mixed ...$middlewares): static; /** * Adds the given tag(s) to the route diff --git a/src/Router.php b/src/Router.php index 09618495..c03551d9 100644 --- a/src/Router.php +++ b/src/Router.php @@ -13,54 +13,37 @@ namespace Sunrise\Http\Router; -use Fig\Http\Message\RequestMethodInterface; -use Psr\EventDispatcher\EventDispatcherInterface; +use InvalidArgumentException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Event\RouteMatchedEvent; use Sunrise\Http\Router\Exception\Http\HttpMethodNotAllowedException; use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; use Sunrise\Http\Router\Exception\Http\HttpUnsupportedMediaTypeException; -use Sunrise\Http\Router\Exception\InvalidArgumentException; use Sunrise\Http\Router\Helper\RouteBuilder; use Sunrise\Http\Router\Helper\RouteCompiler; +use Sunrise\Http\Router\Helper\RouteMatcher; use Sunrise\Http\Router\Loader\LoaderInterface; -use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; +use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; +use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; +use Sunrise\Http\Router\ResponseResolving\ResponseResolutioner; +use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; use function array_keys; -use function preg_match; +use function count; use function sprintf; -use const PREG_UNMATCHED_AS_NULL; - -/** - * Router - */ -class Router implements RequestHandlerInterface, RequestMethodInterface +class Router { + private readonly ReferenceResolver $referenceResolver; /** - * @var array - * - * @since 2.9.0 + * @var array */ - public static array $patterns = [ - '@slug' => '[0-9a-z-]+', - '@uuid' => '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}', - ]; - - /** - * @var RouteCollectionInterface - */ - private RouteCollectionInterface $routes; - - /** - * @var ReferenceResolverInterface - */ - private ReferenceResolverInterface $referenceResolver; + private array $routes = []; /** * @var list @@ -68,182 +51,61 @@ class Router implements RequestHandlerInterface, RequestMethodInterface private array $middlewares = []; /** - * @var list + * @var array */ - private array $routeAwareMiddlewares; + private array $requestHandlers = []; /** - * @var EventDispatcherInterface|null - */ - private ?EventDispatcherInterface $eventDispatcher = null; - - private array $routeRegex = []; - - /** - * Constructor of the class - * - * @param RouteCollectionFactoryInterface|null $collectionFactory - * @param ReferenceResolverInterface|null $referenceResolver - * * @since 3.0.0 */ public function __construct( - ?RouteCollectionFactoryInterface $collectionFactory = null, - ?ReferenceResolverInterface $referenceResolver = null, + ParameterResolutionerInterface $parameterResolutioner = new ParameterResolutioner(), + ResponseResolutionerInterface $responseResolutioner = new ResponseResolutioner(), ) { - $collectionFactory ??= new RouteCollectionFactory(); - $this->referenceResolver = $referenceResolver ?? new ReferenceResolver(); - $this->routes = $collectionFactory->createCollection(); - } - - /** - * Loads routes using the given loaders - * - * @param LoaderInterface ...$loaders - * - * @return void - */ - public function load(LoaderInterface ...$loaders): void - { - foreach ($loaders as $loader) { - $this->routes->add(...$loader->load()->all()); - } + $this->referenceResolver = new ReferenceResolver($parameterResolutioner, $responseResolutioner); } /** - * Gets the router's routes - * - * @return RouteCollectionInterface + * @return array */ - public function getRoutes(): RouteCollectionInterface + public function getRoutes(): array { return $this->routes; } /** - * Gets a route by its given name - * - * @param string $name - * - * @return RouteInterface - * * @throws InvalidArgumentException If the route doesn't exist. */ public function getRoute(string $name): RouteInterface { - return $this->routes->get($name) ?? - throw new InvalidArgumentException(sprintf('The route %s does not exist.', $name)); + return $this->routes[$name] ?? throw new InvalidArgumentException(sprintf( + 'The route %s does not exist.', + $name, + )); } - /** - * Gets the router's middlewares - * - * @return list - */ - public function getMiddlewares(): array - { - return $this->middlewares; - } - - /** - * Gets the router's event dispatcher - * - * @return EventDispatcherInterface|null - * - * @since 2.13.0 - */ - public function getEventDispatcher(): ?EventDispatcherInterface - { - return $this->eventDispatcher; - } - - /** - * Adds the given patterns to the router - * - * @param array $patterns - * - * @return void - * - * @since 2.11.0 - */ - public function addPatterns(array $patterns): void + public function addRoute(RouteInterface ...$routes) : void { - foreach ($patterns as $alias => $pattern) { - self::$patterns[$alias] = $pattern; + foreach ($routes as $route) { + $this->routes[$route->getName()] = $route; } } - /** - * Adds the given route(s) to the router - * - * @param RouteInterface ...$routes - * - * @return void - */ - public function addRoute(RouteInterface ...$routes) : void + public function load(LoaderInterface ...$loaders): void { - $this->routes->add(...$routes); + foreach ($loaders as $loader) { + foreach ($loader->load() as $route) { + $this->routes[$route->getName()] = $route; + } + } } - /** - * Adds the given middleware(s) to the router - * - * @param mixed ...$middlewares - * - * @return void - */ public function addMiddleware(mixed ...$middlewares): void { $middlewares = $this->referenceResolver->resolveMiddlewares($middlewares); - - $this->middlewares = [...$this->middlewares, ...$middlewares]; - } - - /** - * Adds the given route-aware middleware(s) to the router - * - * @param mixed ...$middlewares - * - * @return void - * - * @since 3.0.0 - */ - public function addRouteAwareMiddleware(mixed ...$middlewares): void - { - $middlewares = $this->referenceResolver->resolveMiddlewares($middlewares); - - $this->routeAwareMiddlewares = [...$this->middlewares, ...$middlewares]; - } - - /** - * Sets the given event dispatcher to the router - * - * @param EventDispatcherInterface|null $eventDispatcher - * - * @return void - * - * @since 2.13.0 - */ - public function setEventDispatcher(?EventDispatcherInterface $eventDispatcher): void - { - $this->eventDispatcher = $eventDispatcher; - } - - /** - * Generates a URI for the given named route - * - * @param string $name - * @param array $variables - * - * @return string - * - * @throws \InvalidArgumentException - */ - public function generateUri(string $name, array $variables = []): string - { - $route = $this->getRoute($name); - - return RouteBuilder::buildRoute($route->getPath(), $variables); + foreach ($middlewares as $middleware) { + $this->middlewares[] = $middleware; + } } /** @@ -264,16 +126,19 @@ public function generateUri(string $name, array $variables = []): string */ public function match(ServerRequestInterface $request): RouteInterface { - $requestPath = $request->getUri()->getPath(); - $requestMethod = $request->getMethod(); $allowedMethods = []; - foreach ($this->routes->all() as $route) { - $this->routeRegex[$route->getName()] ??= RouteCompiler::compileRegex($route->getPath()); + foreach ($this->routes as $route) { + $path = $route->getPath(); + $pattern = $route->getPattern(); + if ($pattern === null) { + $pattern = RouteCompiler::compileRoute($path, $route->getConstraints()); + $route->setPattern($pattern); + } // https://github.com/sunrise-php/http-router/issues/50 // https://tools.ietf.org/html/rfc7231#section-6.5.5 - if (!preg_match($this->routeRegex[$route->getName()], $requestPath, $matches, PREG_UNMATCHED_AS_NULL)) { + if (!RouteMatcher::matchPattern($path, $pattern, $request->getUri()->getPath(), $matches)) { continue; } @@ -283,25 +148,16 @@ public function match(ServerRequestInterface $request): RouteInterface $allowedMethods[$routeMethod] = true; } - if (!isset($routeMethods[$requestMethod])) { + if (!isset($routeMethods[$request->getMethod()])) { continue; } - $serverConsumesMediaTypes = $route->getConsumesMediaTypes(); - if (!empty($serverConsumesMediaTypes)) { - ServerRequest::from($request)->clientProducesMediaType(...$serverConsumesMediaTypes) or - throw new HttpUnsupportedMediaTypeException($serverConsumesMediaTypes); + $serverConsumedMediaTypes = $route->getConsumedMediaTypes(); + if (!ServerRequest::create($request)->clientProducesMediaType(...$serverConsumedMediaTypes)) { + throw new HttpUnsupportedMediaTypeException($serverConsumedMediaTypes); } - /** @var array $attributes */ - $attributes = []; - foreach ($matches as $key => $value) { - if (isset($value) && (string) $key === $key) { - $attributes[$key] = $value; - } - } - - return $route->withAddedAttributes($attributes); + return $route->withAddedAttributes($matches); } if (!empty($allowedMethods)) { @@ -314,63 +170,51 @@ public function match(ServerRequestInterface $request): RouteInterface } /** - * Runs the router - * - * @param ServerRequestInterface $request - * - * @return ResponseInterface - * * @since 2.8.0 */ public function run(ServerRequestInterface $request): ResponseInterface { - // lazy resolving of the given request... - $routing = new CallableRequestHandler( - function (ServerRequestInterface $request): ResponseInterface { - $route = $this->match($request); - - if (isset($this->eventDispatcher)) { - $event = new RouteMatchedEvent($route, $request); - $this->eventDispatcher->dispatch($event); - $request = $event->getRequest(); - } - - if (empty($this->routeAwareMiddlewares)) { - return $route->handle($request); - } - - return $route->handle($request); - } + $handler = new CallableRequestHandler( + fn(ServerRequestInterface $request): ResponseInterface => $this->runRoute($this->match($request), $request) ); - if (empty($this->middlewares)) { - return $routing->handle($request); + if (count($this->middlewares) > 0) { + $handler = new QueueableRequestHandler($handler, $this->middlewares); } - $handler = new QueueableRequestHandler($routing, ...$this->middlewares); - - return $handler->handle($request); + return $handler->handle($request->withAttribute('@router', $this)); } /** - * @inheritDoc + * @since 3.0.0 */ - public function handle(ServerRequestInterface $request): ResponseInterface + public function runRoute(RouteInterface|string $route, ServerRequestInterface $request): ResponseInterface { - $route = $this->match($request); - - if (isset($this->eventDispatcher)) { - $event = new RouteMatchedEvent($route, $request); - $this->eventDispatcher->dispatch($event); - $request = $event->getRequest(); + if (! $route instanceof RouteInterface) { + $route = $this->getRoute($route); } - if (empty($this->middlewares)) { - return $route->handle($request); + $request = $request->withAttribute('@route', $route); + foreach ($route->getAttributes() as $name => $value) { + $request = $request->withAttribute($name, $value); } - $handler = new QueueableRequestHandler($route, ...$this->middlewares); + $this->requestHandlers[$route->getName()] ??= new QueueableRequestHandler( + $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()), + [...$this->referenceResolver->resolveMiddlewares($route->getMiddlewares())], + ); + + return $this->requestHandlers[$route->getName()]->handle($request); + } + + /** + * @throws InvalidArgumentException + */ + public function generateUri(string $name, array $values = []): string + { + $route = $this->getRoute($name); + $values += $route->getAttributes(); - return $handler->handle($request); + return RouteBuilder::buildRoute($route->getPath(), $values); } } diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 1a753b77..cb66f54b 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -17,145 +17,87 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\StreamInterface; use Psr\Http\Message\UriInterface; +use Sunrise\Http\Router\Entity\Encoding; use Sunrise\Http\Router\Entity\Language; +use Sunrise\Http\Router\Entity\LanguageComparator; +use Sunrise\Http\Router\Entity\LanguageInterface; use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; -use Sunrise\Http\Router\Exception\LogicException; +use Sunrise\Http\Router\Entity\MediaTypeComparator; +use Sunrise\Http\Router\Entity\MediaTypeInterface; use Sunrise\Http\Router\Helper\HeaderParser; -use function sprintf; -use function usort; - /** - * Server Request Proxy - * * @since 3.0.0 */ final class ServerRequest implements ServerRequestInterface { + private ?LanguageComparator $languageComparator = null; + private ?MediaTypeComparator $mediaTypeComparator = null; - /** - * Constructor of the class - * - * @param ServerRequestInterface $request - */ public function __construct(private ServerRequestInterface $request) { } - /** - * Creates the proxy from the given request - * - * @param ServerRequestInterface $request - * - * @return self - */ - public static function from(ServerRequestInterface $request): self + public static function create(ServerRequestInterface $request): self { - if ($request instanceof self) { - return $request; - } - - return new self($request); + return ($request instanceof self) ? $request : new self($request); } - /** - * Gets the original request - * - * @return ServerRequestInterface - */ public function getOriginalRequest(): ServerRequestInterface { return $this->request; } - /** - * Gets a media type that the client produced - * - * @return MediaType|null - * - * @throws HttpBadRequestException If the "Content-Type" header isn't valid. - */ - public function getClientProducedMediaType(): ?MediaType + public function getLanguageComparator(): LanguageComparator { - $header = $this->request->getHeaderLine('Content-Type'); + return $this->languageComparator ??= new LanguageComparator(); + } - try { - return HeaderParser::parseAcceptHeader($header, allowRange: false)->current(); - } catch (\InvalidArgumentException $e) { - $message = sprintf('The "Content-Type" header is invalid: %s', $e->getMessage()); + public function getMediaTypeComparator(): MediaTypeComparator + { + return $this->mediaTypeComparator ??= new MediaTypeComparator(); + } - throw new HttpBadRequestException($message, previous: $e); - } + public function getClientProducedMediaType(): ?MediaType + { + return HeaderParser::parseContentTypeHeader($this->request->getHeaderLine('Content-Type')); } /** - * Gets media types that the client consumes - * - * @return Generator - * - * @throws HttpBadRequestException If the "Accept" header isn't valid. + * @return Generator, MediaType> */ - public function getClientConsumesMediaTypes(): Generator + public function getClientConsumedMediaTypes(): Generator { - $header = $this->request->getHeaderLine('Accept'); - - try { - yield from HeaderParser::parseAcceptHeader($header); - } catch (\InvalidArgumentException $e) { - $message = sprintf('The "Accept" header is invalid: %s', $e->getMessage()); - - throw new HttpBadRequestException($message, previous: $e); - } + yield from HeaderParser::parseAcceptHeader($this->request->getHeaderLine('Accept')); } /** - * Gets languages that the client consumes - * - * @return Generator - * - * @throws HttpBadRequestException If the "Accept-Language" header isn't valid. + * @return Generator, Encoding> */ - public function getClientConsumesLanguages(): Generator + public function getClientConsumedEncodings(): Generator { - $header = $this->request->getHeaderLine('Accept-Language'); - - try { - yield from HeaderParser::parseAcceptLanguageHeader($header); - } catch (\InvalidArgumentException $e) { - $message = sprintf('The "Accept-Language" header is invalid: %s', $e->getMessage()); - - throw new HttpBadRequestException($message, previous: $e); - } + yield from HeaderParser::parseAcceptEncodingHeader($this->request->getHeaderLine('Accept-Encoding')); } /** - * Gets the client's preferred media type - * - * @param MediaType ...$serverProducesMediaTypes - * - * @return MediaType|null + * @return Generator, Language> */ - public function getClientPreferredMediaType(MediaType ...$serverProducesMediaTypes): ?MediaType + public function getClientConsumedLanguages(): Generator { - if ($serverProducesMediaTypes === []) { - return null; - } + yield from HeaderParser::parseAcceptLanguageHeader($this->request->getHeaderLine('Accept-Language')); + } - /** @var list $clientConsumesMediaTypes */ - $clientConsumesMediaTypes = [...$this->getClientConsumesMediaTypes()]; - if ($clientConsumesMediaTypes === []) { + public function getClientPreferredMediaType(MediaTypeInterface ...$serverProducedMediaTypes): ?MediaType + { + if ($serverProducedMediaTypes === []) { return null; } - usort($clientConsumesMediaTypes, static fn(MediaType $a, MediaType $b): int => ( - $b->getParameter('q', '1.0') <=> $a->getParameter('q', '1.0') - )); - - foreach ($clientConsumesMediaTypes as $clientConsumesMediaType) { - foreach ($serverProducesMediaTypes as $serverProducesMediaType) { - if ($serverProducesMediaType->equals($clientConsumesMediaType)) { - return $serverProducesMediaType; + $mediaTypeComparator = $this->getMediaTypeComparator(); + foreach ($this->getClientConsumedMediaTypes() as $clientConsumedMediaType) { + foreach ($serverProducedMediaTypes as $serverProducedMediaType) { + if ($mediaTypeComparator->equals($clientConsumedMediaType, $serverProducedMediaType)) { + return $clientConsumedMediaType; } } } @@ -163,33 +105,17 @@ public function getClientPreferredMediaType(MediaType ...$serverProducesMediaTyp return null; } - /** - * Gets the client's preferred language - * - * @param Language ...$serverProducesLanguages - * - * @return Language|null - */ - public function getClientPreferredLanguage(Language ...$serverProducesLanguages): ?Language + public function getClientPreferredLanguage(LanguageInterface ...$serverProducedLanguages): ?Language { - if ($serverProducesLanguages === []) { - return null; - } - - /** @var list $clientConsumesLanguages */ - $clientConsumesLanguages = [...$this->getClientConsumesLanguages()]; - if ($clientConsumesLanguages === []) { + if ($serverProducedLanguages === []) { return null; } - usort($clientConsumesLanguages, static fn(Language $a, Language $b): int => ( - $b->getParameter('q', '1.0') <=> $a->getParameter('q', '1.0') - )); - - foreach ($clientConsumesLanguages as $clientConsumesLanguage) { - foreach ($serverProducesLanguages as $serverProducesLanguage) { - if ($serverProducesLanguage->equals($clientConsumesLanguage)) { - return $serverProducesLanguage; + $languageComparator = $this->getLanguageComparator(); + foreach ($this->getClientConsumedLanguages() as $clientConsumedLanguage) { + foreach ($serverProducedLanguages as $serverProducedLanguage) { + if ($languageComparator->equals($clientConsumedLanguage, $serverProducedLanguage)) { + return $clientConsumedLanguage; } } } @@ -197,17 +123,11 @@ public function getClientPreferredLanguage(Language ...$serverProducesLanguages) return null; } - /** - * Checks if the client produces one of the given media types - * - * @param MediaType ...$serverConsumesMediaTypes - * - * @return bool - */ - public function clientProducesMediaType(MediaType ...$serverConsumesMediaTypes): bool + public function clientProducesMediaType(MediaTypeInterface ...$serverConsumedMediaTypes): bool { - if ($serverConsumesMediaTypes === []) { - return false; + // This case is interpreted as follows: the server accepts any media type... + if ($serverConsumedMediaTypes === []) { + return true; } $clientProducedMediaType = $this->getClientProducedMediaType(); @@ -215,8 +135,9 @@ public function clientProducesMediaType(MediaType ...$serverConsumesMediaTypes): return false; } - foreach ($serverConsumesMediaTypes as $serverConsumesMediaType) { - if ($serverConsumesMediaType->equals($clientProducedMediaType)) { + $mediaTypeComparator = $this->getMediaTypeComparator(); + foreach ($serverConsumedMediaTypes as $serverConsumedMediaType) { + if ($mediaTypeComparator->equals($clientProducedMediaType, $serverConsumedMediaType)) { return true; } } @@ -224,25 +145,34 @@ public function clientProducesMediaType(MediaType ...$serverConsumesMediaTypes): return false; } - /** - * Checks if the client consumes one of the given media types - * - * @param MediaType ...$serverProducesMediaTypes - * - * @return bool - * - * @throws LogicException If the media types that the server produces were not provided. - */ - public function clientConsumesMediaType(MediaType ...$serverProducesMediaTypes): bool + public function clientConsumesMediaType(MediaTypeInterface ...$serverProducedMediaTypes): bool { - if ($serverProducesMediaTypes === []) { - throw new LogicException('The media types that the server produces must be provided.'); + if ($serverProducedMediaTypes === []) { + return false; + } + + $mediaTypeComparator = $this->getMediaTypeComparator(); + foreach ($this->getClientConsumedMediaTypes() as $clientConsumedMediaType) { + foreach ($serverProducedMediaTypes as $serverProducedMediaType) { + if ($mediaTypeComparator->equals($clientConsumedMediaType, $serverProducedMediaType)) { + return true; + } + } + } + + return false; + } + + public function clientConsumesLanguage(LanguageInterface ...$serverProducedLanguages): bool + { + if ($serverProducedLanguages === []) { + return false; } - $clientConsumesMediaTypes = $this->getClientConsumesMediaTypes(); - foreach ($clientConsumesMediaTypes as $clientConsumesMediaType) { - foreach ($serverProducesMediaTypes as $serverProducesMediaType) { - if ($serverProducesMediaType->equals($clientConsumesMediaType)) { + $languageComparator = $this->getLanguageComparator(); + foreach ($this->getClientConsumedLanguages() as $clientConsumedLanguage) { + foreach ($serverProducedLanguages as $serverProducedLanguage) { + if ($languageComparator->equals($clientConsumedLanguage, $serverProducedLanguage)) { return true; } } diff --git a/src/Validation/ConstraintViolation.php b/src/Validation/ConstraintViolation.php index 35220298..7be3a3c5 100644 --- a/src/Validation/ConstraintViolation.php +++ b/src/Validation/ConstraintViolation.php @@ -24,18 +24,18 @@ final class ConstraintViolation implements ConstraintViolationInterface * * @param string $message * @param string $messageTemplate - * @param array $messagePlaceholders + * @param array $messagePlaceholders * @param string $propertyPath */ public function __construct( - private string $message, - private string $messageTemplate, - private array $messagePlaceholders, - private string $propertyPath, + private readonly string $message, + private readonly string $messageTemplate, + private readonly array $messagePlaceholders, + private readonly string $propertyPath, ) { } - /** + /** readonly * @inheritDoc */ public function getMessage(): string diff --git a/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php b/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php index 5d8fc901..fb41c2af 100644 --- a/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php +++ b/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php @@ -67,7 +67,7 @@ public function getMessageTemplate(): string */ public function getMessagePlaceholders(): array { - /** @var array */ + /** @var array */ return $this->validatorConstraintViolation->getParameters(); } diff --git a/src/Validation/ConstraintViolationInterface.php b/src/Validation/ConstraintViolationInterface.php index b25ac0cc..b4d07249 100644 --- a/src/Validation/ConstraintViolationInterface.php +++ b/src/Validation/ConstraintViolationInterface.php @@ -36,7 +36,7 @@ public function getMessageTemplate(): string; /** * Gets the violation's message placeholders * - * @return array + * @return array */ public function getMessagePlaceholders(): array; diff --git a/functions/emit.php b/src/functions.php similarity index 90% rename from functions/emit.php rename to src/functions.php index 643229f9..31bb9bf2 100644 --- a/functions/emit.php +++ b/src/functions.php @@ -18,13 +18,6 @@ use function header; use function sprintf; -/** - * Sends the given response - * - * @param ResponseInterface $response - * - * @return void - */ function emit(ResponseInterface $response): void { header(sprintf( diff --git a/tests/RouteCollectorTest.php b/tests/RouteCollectorTest.php index 7fc18cbd..a559e654 100644 --- a/tests/RouteCollectorTest.php +++ b/tests/RouteCollectorTest.php @@ -65,8 +65,8 @@ public function testCreateRoute() : void $this->assertSame($handler, $route->getRequestHandler()); $this->assertSame($middlewares, $route->getMiddlewares()); $this->assertSame($attributes, $route->getAttributes()); - $this->assertTrue($collector->getCollection()->has($route->getName())); - $this->assertSame($route, $collector->getCollection()->get($route->getName())); + $this->assertTrue($collector->getRoutes()->has($route->getName())); + $this->assertSame($route, $collector->getRoutes()->get($route->getName())); } /** @@ -100,8 +100,8 @@ public function testCreateHeadRoute() : void $this->assertSame($handler, $route->getRequestHandler()); $this->assertSame($middlewares, $route->getMiddlewares()); $this->assertSame($attributes, $route->getAttributes()); - $this->assertTrue($collector->getCollection()->has($route->getName())); - $this->assertSame($route, $collector->getCollection()->get($route->getName())); + $this->assertTrue($collector->getRoutes()->has($route->getName())); + $this->assertSame($route, $collector->getRoutes()->get($route->getName())); } /** @@ -135,8 +135,8 @@ public function testCreateGetRoute() : void $this->assertSame($handler, $route->getRequestHandler()); $this->assertSame($middlewares, $route->getMiddlewares()); $this->assertSame($attributes, $route->getAttributes()); - $this->assertTrue($collector->getCollection()->has($route->getName())); - $this->assertSame($route, $collector->getCollection()->get($route->getName())); + $this->assertTrue($collector->getRoutes()->has($route->getName())); + $this->assertSame($route, $collector->getRoutes()->get($route->getName())); } /** @@ -170,8 +170,8 @@ public function testCreatePostRoute() : void $this->assertSame($handler, $route->getRequestHandler()); $this->assertSame($middlewares, $route->getMiddlewares()); $this->assertSame($attributes, $route->getAttributes()); - $this->assertTrue($collector->getCollection()->has($route->getName())); - $this->assertSame($route, $collector->getCollection()->get($route->getName())); + $this->assertTrue($collector->getRoutes()->has($route->getName())); + $this->assertSame($route, $collector->getRoutes()->get($route->getName())); } /** @@ -205,8 +205,8 @@ public function testCreatePutRoute() : void $this->assertSame($handler, $route->getRequestHandler()); $this->assertSame($middlewares, $route->getMiddlewares()); $this->assertSame($attributes, $route->getAttributes()); - $this->assertTrue($collector->getCollection()->has($route->getName())); - $this->assertSame($route, $collector->getCollection()->get($route->getName())); + $this->assertTrue($collector->getRoutes()->has($route->getName())); + $this->assertSame($route, $collector->getRoutes()->get($route->getName())); } /** @@ -240,8 +240,8 @@ public function testCreatePatchRoute() : void $this->assertSame($handler, $route->getRequestHandler()); $this->assertSame($middlewares, $route->getMiddlewares()); $this->assertSame($attributes, $route->getAttributes()); - $this->assertTrue($collector->getCollection()->has($route->getName())); - $this->assertSame($route, $collector->getCollection()->get($route->getName())); + $this->assertTrue($collector->getRoutes()->has($route->getName())); + $this->assertSame($route, $collector->getRoutes()->get($route->getName())); } /** @@ -275,8 +275,8 @@ public function testCreateDeleteRoute() : void $this->assertSame($handler, $route->getRequestHandler()); $this->assertSame($middlewares, $route->getMiddlewares()); $this->assertSame($attributes, $route->getAttributes()); - $this->assertTrue($collector->getCollection()->has($route->getName())); - $this->assertSame($route, $collector->getCollection()->get($route->getName())); + $this->assertTrue($collector->getRoutes()->has($route->getName())); + $this->assertSame($route, $collector->getRoutes()->get($route->getName())); } /** @@ -310,8 +310,8 @@ public function testCreatePurgeRoute() : void $this->assertSame($handler, $route->getRequestHandler()); $this->assertSame($middlewares, $route->getMiddlewares()); $this->assertSame($attributes, $route->getAttributes()); - $this->assertTrue($collector->getCollection()->has($route->getName())); - $this->assertSame($route, $collector->getCollection()->get($route->getName())); + $this->assertTrue($collector->getRoutes()->has($route->getName())); + $this->assertSame($route, $collector->getRoutes()->get($route->getName())); } /** @@ -340,11 +340,11 @@ public function testGrouping() : void }); $this->assertInstanceOf(RouteCollectionInterface::class, $groupCollection); - $this->assertTrue($collector->getCollection()->has('foo')); - $this->assertSame([], $collector->getCollection()->get('foo')->getMiddlewares()); - $this->assertTrue($collector->getCollection()->has('bar')); - $this->assertSame($middlewares, $collector->getCollection()->get('bar')->getMiddlewares()); - $this->assertTrue($collector->getCollection()->has('baz')); - $this->assertSame($middlewares, $collector->getCollection()->get('baz')->getMiddlewares()); + $this->assertTrue($collector->getRoutes()->has('foo')); + $this->assertSame([], $collector->getRoutes()->get('foo')->getMiddlewares()); + $this->assertTrue($collector->getRoutes()->has('bar')); + $this->assertSame($middlewares, $collector->getRoutes()->get('bar')->getMiddlewares()); + $this->assertTrue($collector->getRoutes()->has('baz')); + $this->assertSame($middlewares, $collector->getRoutes()->get('baz')->getMiddlewares()); } } From ea2d259ad6c4b9d4e607d5f825240609ebe6baa6 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 22 Feb 2024 12:19:12 +0100 Subject: [PATCH 099/180] v3 --- .../{DefaultAttribute.php => Attribute.php} | 6 +- src/Annotation/Constraint.php | 4 +- .../{ConsumesEncoding.php => Consumes.php} | 6 +- src/Annotation/Method.php | 3 +- src/Annotation/PathVariable.php | 2 +- .../{ConsumesMediaType.php => Produces.php} | 6 +- src/Annotation/ProducesEncoding.php | 29 -- src/Annotation/ProducesMediaType.php | 29 -- src/Annotation/Route.php | 21 +- .../NamedConstraint.php} | 10 +- src/Entity/EncodingComparator.php | 25 -- .../ClientLanguage.php} | 6 +- .../{ => Language}/LanguageComparator.php | 2 +- .../{ => Language}/LanguageInterface.php | 2 +- .../ClientMediaType.php} | 6 +- .../{ => MediaType}/MediaTypeComparator.php | 2 +- .../{ => MediaType}/MediaTypeInterface.php | 2 +- .../ServerMediaType.php} | 25 +- .../HttpUnsupportedMediaTypeException.php | 2 +- src/Helper/FilesystemHelper.php | 39 +- src/Helper/HeaderParser.php | 51 +-- src/Helper/RouteParser.php | 35 +- src/Loader/ConfigLoader.php | 84 ---- src/Loader/DescriptorLoader.php | 72 ++-- .../JsonPayloadDecodingMiddleware.php | 4 +- src/Route.php | 24 +- src/RouteCollector.php | 372 ------------------ src/RouteFactory.php | 44 --- src/RouteFactoryInterface.php | 45 --- src/RouteInterface.php | 22 +- src/ServerRequest.php | 31 +- 31 files changed, 182 insertions(+), 829 deletions(-) rename src/Annotation/{DefaultAttribute.php => Attribute.php} (79%) rename src/Annotation/{ConsumesEncoding.php => Consumes.php} (79%) rename src/Annotation/{ConsumesMediaType.php => Produces.php} (79%) delete mode 100644 src/Annotation/ProducesEncoding.php delete mode 100644 src/Annotation/ProducesMediaType.php rename src/{Entity/EncodingInterface.php => Constraint/NamedConstraint.php} (65%) delete mode 100644 src/Entity/EncodingComparator.php rename src/Entity/{Language.php => Language/ClientLanguage.php} (85%) rename src/Entity/{ => Language}/LanguageComparator.php (92%) rename src/Entity/{ => Language}/LanguageInterface.php (90%) rename src/Entity/{MediaType.php => MediaType/ClientMediaType.php} (84%) rename src/Entity/{ => MediaType}/MediaTypeComparator.php (93%) rename src/Entity/{ => MediaType}/MediaTypeInterface.php (90%) rename src/Entity/{Encoding.php => MediaType/ServerMediaType.php} (50%) delete mode 100644 src/Loader/ConfigLoader.php delete mode 100644 src/RouteCollector.php delete mode 100644 src/RouteFactory.php delete mode 100644 src/RouteFactoryInterface.php diff --git a/src/Annotation/DefaultAttribute.php b/src/Annotation/Attribute.php similarity index 79% rename from src/Annotation/DefaultAttribute.php rename to src/Annotation/Attribute.php index b55c0fe1..15ac98a4 100644 --- a/src/Annotation/DefaultAttribute.php +++ b/src/Annotation/Attribute.php @@ -13,13 +13,11 @@ namespace Sunrise\Http\Router\Annotation; -use Attribute; - /** * @since 3.0.0 */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class DefaultAttribute +#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)] +final class Attribute { public function __construct( public readonly string $name, diff --git a/src/Annotation/Constraint.php b/src/Annotation/Constraint.php index a62b69c0..3d71b876 100644 --- a/src/Annotation/Constraint.php +++ b/src/Annotation/Constraint.php @@ -18,11 +18,11 @@ /** * @since 3.0.0 */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +// phpcs:ignore Generic.Files.LineLength +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::TARGET_PARAMETER | Attribute::IS_REPEATABLE)] final class Constraint { public function __construct( - public readonly string $name, public readonly mixed $value, ) { } diff --git a/src/Annotation/ConsumesEncoding.php b/src/Annotation/Consumes.php similarity index 79% rename from src/Annotation/ConsumesEncoding.php rename to src/Annotation/Consumes.php index 36f82fce..f73b6d80 100644 --- a/src/Annotation/ConsumesEncoding.php +++ b/src/Annotation/Consumes.php @@ -14,16 +14,16 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\EncodingInterface; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class ConsumesEncoding +final class Consumes { public function __construct( - public readonly EncodingInterface $value, + public readonly MediaTypeInterface|string $value, ) { } } diff --git a/src/Annotation/Method.php b/src/Annotation/Method.php index 06b6969e..96929bc2 100644 --- a/src/Annotation/Method.php +++ b/src/Annotation/Method.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; +use BackedEnum; use Fig\Http\Message\RequestMethodInterface; /** @@ -23,7 +24,7 @@ final class Method implements RequestMethodInterface { public function __construct( - public readonly string $value, + public readonly BackedEnum|string $value, ) { } } diff --git a/src/Annotation/PathVariable.php b/src/Annotation/PathVariable.php index 78b5e32d..92d2a4a8 100644 --- a/src/Annotation/PathVariable.php +++ b/src/Annotation/PathVariable.php @@ -22,7 +22,7 @@ final class PathVariable { public function __construct( - public readonly ?string $name = null, + public readonly string|null $name = null, ) { } } diff --git a/src/Annotation/ConsumesMediaType.php b/src/Annotation/Produces.php similarity index 79% rename from src/Annotation/ConsumesMediaType.php rename to src/Annotation/Produces.php index c9a3a983..eaacb440 100644 --- a/src/Annotation/ConsumesMediaType.php +++ b/src/Annotation/Produces.php @@ -14,16 +14,16 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaTypeInterface; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class ConsumesMediaType +final class Produces { public function __construct( - public readonly MediaTypeInterface $value, + public readonly MediaTypeInterface|string $value, ) { } } diff --git a/src/Annotation/ProducesEncoding.php b/src/Annotation/ProducesEncoding.php deleted file mode 100644 index 7e50be27..00000000 --- a/src/Annotation/ProducesEncoding.php +++ /dev/null @@ -1,29 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation; - -use Attribute; -use Sunrise\Http\Router\Entity\EncodingInterface; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class ProducesEncoding -{ - public function __construct( - public readonly EncodingInterface $value, - ) { - } -} diff --git a/src/Annotation/ProducesMediaType.php b/src/Annotation/ProducesMediaType.php deleted file mode 100644 index 5dcd6767..00000000 --- a/src/Annotation/ProducesMediaType.php +++ /dev/null @@ -1,29 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation; - -use Attribute; -use Sunrise\Http\Router\Entity\MediaTypeInterface; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class ProducesMediaType -{ - public function __construct( - public readonly MediaTypeInterface $value, - ) { - } -} diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index 6627b39c..41ebe9a8 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -15,8 +15,7 @@ use Attribute; use Fig\Http\Message\RequestMethodInterface; -use Sunrise\Http\Router\Entity\EncodingInterface; -use Sunrise\Http\Router\Entity\MediaTypeInterface; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] final class Route implements RequestMethodInterface @@ -27,30 +26,26 @@ final class Route implements RequestMethodInterface public array $prefixes = []; /** @var non-empty-string|null */ - public ?string $pattern = null; + public string|null $pattern = null; public function __construct( public string $name, public string $path = '/', - ?string $method = null, + string|null $method = null, /** @var list */ public array $methods = [], /** @var list */ public array $middlewares = [], /** @var array */ public array $attributes = [], - /** @var array */ + /** @var list */ public array $constraints = [], - /** @var list */ - public array $consumesEncodings = [], - /** @var list */ - public array $producesEncodings = [], /** @var list */ - public array $consumesMediaTypes = [], + public array $consumes = [], /** @var list */ - public array $producesMediaTypes = [], - public ?string $summary = null, - public ?string $description = null, + public array $produces = [], + public string|null $summary = null, + public string|null $description = null, /** @var list */ public array $tags = [], public bool $isDeprecated = false, diff --git a/src/Entity/EncodingInterface.php b/src/Constraint/NamedConstraint.php similarity index 65% rename from src/Entity/EncodingInterface.php rename to src/Constraint/NamedConstraint.php index fb915d08..e584f4a0 100644 --- a/src/Entity/EncodingInterface.php +++ b/src/Constraint/NamedConstraint.php @@ -11,12 +11,16 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Entity; +namespace Sunrise\Http\Router\Constraint; /** * @since 3.0.0 */ -interface EncodingInterface +final class NamedConstraint { - public function getMethod(): string; + public function __construct( + public readonly string $name, + public readonly mixed $value, + ) { + } } diff --git a/src/Entity/EncodingComparator.php b/src/Entity/EncodingComparator.php deleted file mode 100644 index f5b2dfb4..00000000 --- a/src/Entity/EncodingComparator.php +++ /dev/null @@ -1,25 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Entity; - -/** - * @since 3.0.0 - */ -final class EncodingComparator -{ - public function equals(EncodingInterface $a, EncodingInterface $b): bool - { - return $a->getMethod() === $b->getMethod() || $a->getMethod() === '*' || $b->getMethod() === '*'; - } -} diff --git a/src/Entity/Language.php b/src/Entity/Language/ClientLanguage.php similarity index 85% rename from src/Entity/Language.php rename to src/Entity/Language/ClientLanguage.php index 1fb10d02..b1b22afd 100644 --- a/src/Entity/Language.php +++ b/src/Entity/Language/ClientLanguage.php @@ -11,18 +11,18 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Entity; +namespace Sunrise\Http\Router\Entity\Language; /** * @since 3.0.0 */ -final class Language implements LanguageInterface +final class ClientLanguage implements LanguageInterface { public function __construct( private readonly string $code, private readonly string $locale, /** @var array */ - private readonly array $parameters = [], + private readonly array $parameters, ) { } diff --git a/src/Entity/LanguageComparator.php b/src/Entity/Language/LanguageComparator.php similarity index 92% rename from src/Entity/LanguageComparator.php rename to src/Entity/Language/LanguageComparator.php index 9cde669a..d2e9ab4c 100644 --- a/src/Entity/LanguageComparator.php +++ b/src/Entity/Language/LanguageComparator.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Entity; +namespace Sunrise\Http\Router\Entity\Language; /** * @since 3.0.0 diff --git a/src/Entity/LanguageInterface.php b/src/Entity/Language/LanguageInterface.php similarity index 90% rename from src/Entity/LanguageInterface.php rename to src/Entity/Language/LanguageInterface.php index 8fc0ac80..3941bde7 100644 --- a/src/Entity/LanguageInterface.php +++ b/src/Entity/Language/LanguageInterface.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Entity; +namespace Sunrise\Http\Router\Entity\Language; /** * @since 3.0.0 diff --git a/src/Entity/MediaType.php b/src/Entity/MediaType/ClientMediaType.php similarity index 84% rename from src/Entity/MediaType.php rename to src/Entity/MediaType/ClientMediaType.php index af065d12..55498cca 100644 --- a/src/Entity/MediaType.php +++ b/src/Entity/MediaType/ClientMediaType.php @@ -11,18 +11,18 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Entity; +namespace Sunrise\Http\Router\Entity\MediaType; /** * @since 3.0.0 */ -final class MediaType implements MediaTypeInterface +final class ClientMediaType implements MediaTypeInterface { public function __construct( private readonly string $type, private readonly string $subtype, /** @var array */ - private readonly array $parameters = [], + private readonly array $parameters, ) { } diff --git a/src/Entity/MediaTypeComparator.php b/src/Entity/MediaType/MediaTypeComparator.php similarity index 93% rename from src/Entity/MediaTypeComparator.php rename to src/Entity/MediaType/MediaTypeComparator.php index 99a56e56..5b2e3246 100644 --- a/src/Entity/MediaTypeComparator.php +++ b/src/Entity/MediaType/MediaTypeComparator.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Entity; +namespace Sunrise\Http\Router\Entity\MediaType; /** * @since 3.0.0 diff --git a/src/Entity/MediaTypeInterface.php b/src/Entity/MediaType/MediaTypeInterface.php similarity index 90% rename from src/Entity/MediaTypeInterface.php rename to src/Entity/MediaType/MediaTypeInterface.php index 6e10732a..7677a09c 100644 --- a/src/Entity/MediaTypeInterface.php +++ b/src/Entity/MediaType/MediaTypeInterface.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Entity; +namespace Sunrise\Http\Router\Entity\MediaType; /** * @since 3.0.0 diff --git a/src/Entity/Encoding.php b/src/Entity/MediaType/ServerMediaType.php similarity index 50% rename from src/Entity/Encoding.php rename to src/Entity/MediaType/ServerMediaType.php index d1ef083c..169fad60 100644 --- a/src/Entity/Encoding.php +++ b/src/Entity/MediaType/ServerMediaType.php @@ -11,30 +11,31 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Entity; +namespace Sunrise\Http\Router\Entity\MediaType; /** * @since 3.0.0 */ -final class Encoding implements EncodingInterface +final class ServerMediaType implements MediaTypeInterface { public function __construct( - private readonly string $method, - /** @var array */ - private readonly array $parameters = [], + private readonly string $type, + private readonly string $subtype, ) { } - public function getMethod(): string + public static function json(): self { - return $this->method; + return new self('application', 'json'); } - /** - * @return array - */ - public function getParameters(): array + public function getType(): string { - return $this->parameters; + return $this->type; + } + + public function getSubtype(): string + { + return $this->subtype; } } diff --git a/src/Exception/Http/HttpUnsupportedMediaTypeException.php b/src/Exception/Http/HttpUnsupportedMediaTypeException.php index c1648cca..8340cb42 100644 --- a/src/Exception/Http/HttpUnsupportedMediaTypeException.php +++ b/src/Exception/Http/HttpUnsupportedMediaTypeException.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Exception\Http; use Stringable; -use Sunrise\Http\Router\Entity\MediaTypeInterface; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; use Sunrise\Http\Router\Exception\HttpException; use Throwable; diff --git a/src/Helper/FilesystemHelper.php b/src/Helper/FilesystemHelper.php index aa4e56a9..25170f74 100644 --- a/src/Helper/FilesystemHelper.php +++ b/src/Helper/FilesystemHelper.php @@ -23,6 +23,7 @@ use function get_declared_classes; use function is_dir; +use function is_file; use function sprintf; /** @@ -35,7 +36,7 @@ final class FilesystemHelper * * @throws InvalidArgumentException If the directory doesn't exist. */ - public static function getDirectoryClasses(string $dirname): Generator + public static function getDirClasses(string $dirname): Generator { if (!is_dir($dirname)) { throw new InvalidArgumentException(sprintf( @@ -44,12 +45,12 @@ public static function getDirectoryClasses(string $dirname): Generator )); } - /** @var iterable $iterator */ - $iterator = new RegexIterator( + /** @var iterable $filenames */ + $filenames = new RegexIterator( new RecursiveIteratorIterator( new RecursiveDirectoryIterator( $dirname, - FilesystemIterator::KEY_AS_PATHNAME + FilesystemIterator::KEY_AS_FILENAME | FilesystemIterator::CURRENT_AS_PATHNAME | FilesystemIterator::SKIP_DOTS, ), @@ -59,19 +60,33 @@ public static function getDirectoryClasses(string $dirname): Generator RegexIterator::MATCH, ); - /** @var array $filenames */ - $filenames = [...$iterator]; - foreach ($filenames as $filename) { - (static function (string $filename): void { - /** @psalm-suppress UnresolvableInclude */ - require_once $filename; - })($filename); + yield from self::getFileClasses($filename); + } + } + + /** + * @return Generator + * + * @throws InvalidArgumentException If the file doesn't exist. + */ + public static function getFileClasses(string $filename): Generator + { + if (!is_file($filename)) { + throw new InvalidArgumentException(sprintf( + 'The file %s could not be scanned because it does not exist.', + $filename, + )); } + (static function (string $filename): void { + /** @psalm-suppress UnresolvableInclude */ + require_once $filename; + })($filename); + foreach (get_declared_classes() as $className) { $classReflection = new ReflectionClass($className); - if (isset($filenames[$classReflection->getFileName()])) { + if ($classReflection->getFileName() === $filename) { yield $classReflection; } } diff --git a/src/Helper/HeaderParser.php b/src/Helper/HeaderParser.php index 42dd0f1a..2a9fb538 100644 --- a/src/Helper/HeaderParser.php +++ b/src/Helper/HeaderParser.php @@ -15,9 +15,8 @@ use Generator; use Sunrise\Http\Router\Dictionary\Charset; -use Sunrise\Http\Router\Entity\Encoding; -use Sunrise\Http\Router\Entity\Language; -use Sunrise\Http\Router\Entity\MediaType; +use Sunrise\Http\Router\Entity\Language\ClientLanguage; +use Sunrise\Http\Router\Entity\MediaType\ClientMediaType; use function preg_match; use function reset; @@ -29,22 +28,7 @@ */ final class HeaderParser { - /** - * @return Generator, Encoding> - */ - public static function parseContentEncodingHeader(string $header): Generator - { - $values = self::parseHeader($header); - if ($values === []) { - return; - } - - foreach ($values as $index => [$identifier]) { - yield $index => new Encoding($identifier); - } - } - - public static function parseContentTypeHeader(string $header): ?MediaType + public static function parseContentTypeHeader(string $header): ?ClientMediaType { $values = self::parseHeader($header); if ($values === []) { @@ -54,14 +38,14 @@ public static function parseContentTypeHeader(string $header): ?MediaType [$identifier, $parameters] = reset($values); if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier, $matches)) { - return new MediaType($matches[1], $matches[2], $parameters); + return new ClientMediaType($matches[1], $matches[2], $parameters); } return null; } /** - * @return Generator, MediaType> + * @return Generator, ClientMediaType> */ public static function parseAcceptHeader(string $header): Generator { @@ -76,32 +60,13 @@ public static function parseAcceptHeader(string $header): Generator foreach ($values as $index => [$identifier, $parameters]) { if (preg_match('|^([^/]+)/([^/]+)$|', $identifier, $matches)) { - yield $index => new MediaType($matches[1], $matches[2], $parameters); + yield $index => new ClientMediaType($matches[1], $matches[2], $parameters); } } } /** - * @return Generator, Encoding> - */ - public static function parseAcceptEncodingHeader(string $header): Generator - { - $values = self::parseHeader($header); - if ($values === []) { - return; - } - - usort($values, static fn(array $a, array $b): int => ( - (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') - )); - - foreach ($values as $index => [$identifier, $parameters]) { - yield $index => new Encoding($identifier, $parameters); - } - } - - /** - * @return Generator, Language> + * @return Generator, ClientLanguage> */ public static function parseAcceptLanguageHeader(string $header): Generator { @@ -116,7 +81,7 @@ public static function parseAcceptLanguageHeader(string $header): Generator foreach ($values as $index => [$identifier, $parameters]) { if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches)) { - yield $index => new Language($matches[1], $identifier, $parameters); + yield $index => new ClientLanguage($matches[1], $identifier, $parameters); } } } diff --git a/src/Helper/RouteParser.php b/src/Helper/RouteParser.php index 5992cdc8..534d465b 100644 --- a/src/Helper/RouteParser.php +++ b/src/Helper/RouteParser.php @@ -26,7 +26,11 @@ final class RouteParser /** * Parses the given route and returns its variables * - * @return list + * + * @throws InvalidArgumentException If the route isn't valid. + * + * @template TVariable as array{ * name: string, * pattern?: string, * optional?: true, @@ -34,9 +38,7 @@ final class RouteParser * right?: string, * offset: int, * length: int - * }> - * - * @throws InvalidArgumentException If the route isn't valid. + * } */ public static function parseRoute(string $route): array { @@ -117,7 +119,8 @@ public static function parseRoute(string $route): array } $cursor |= $inVariable | $inVariableName; - $variables[++$variable]['offset'] = $offset; + $variable++; + $variables[$variable]['offset'] = $offset; continue; } if ($route[$offset] === '}' && !($cursor & $inVariablePattern)) { @@ -193,6 +196,8 @@ public static function parseRoute(string $route): array continue; } + // (xxx{foo}xxx) + // ~^^^~~~~~^^^~ if (($cursor & $inOptionalPart) && !($cursor & $inVariable)) { if (!($cursor & $inOccupiedPart)) { $left .= $route[$offset]; @@ -256,13 +261,12 @@ public static function parseRoute(string $route): array continue; } - // {foo<\w+>x} - // ~~~~~~~~~^~ + // {foo<\w+>xxx} + // ~~~~~~~~~^^^~ if (($cursor & $inVariable)) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An unexpected character was found at position %d; ' . - 'a variable at this position must be closed.', + 'An unexpected character was found at position %d; a variable at this position must be closed.', $route, $offset, )); @@ -272,22 +276,13 @@ public static function parseRoute(string $route): array if (($cursor & $inVariable) || ($cursor & $inOptionalPart)) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to parse the route has failed ' . - 'because it contains an unclosed optional part or variable.', + 'An attempt to parse the route has failed because it contains an unclosed optional part or variable.', $route, )); } /** - * @var list + * @var list */ return $variables; } diff --git a/src/Loader/ConfigLoader.php b/src/Loader/ConfigLoader.php deleted file mode 100644 index 1a178ce3..00000000 --- a/src/Loader/ConfigLoader.php +++ /dev/null @@ -1,84 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Loader; - -use InvalidArgumentException; -use Sunrise\Http\Router\ReferenceResolver; -use Sunrise\Http\Router\ReferenceResolverInterface; -use Sunrise\Http\Router\RouteCollectionFactory; -use Sunrise\Http\Router\RouteCollectionFactoryInterface; -use Sunrise\Http\Router\RouteCollectionInterface; -use Sunrise\Http\Router\RouteCollector; -use Sunrise\Http\Router\RouteFactory; -use Sunrise\Http\Router\RouteFactoryInterface; - -use function glob; -use function is_dir; -use function is_file; -use function sprintf; - -final class ConfigLoader implements LoaderInterface -{ - /** - * @var list - */ - private array $resources = []; - - /** - * @throws InvalidArgumentException If one of the resources isn't valid. - */ - public function attach(string ...$resources): void - { - foreach ($resources as $resource) { - if (is_file($resource)) { - $this->resources[] = $resource; - continue; - } - - if (is_dir($resource)) { - /** @var list $filenames */ - $filenames = glob($resource . '/*.php'); - foreach ($filenames as $filename) { - $this->resources[] = $filename; - } - - continue; - } - - throw new InvalidArgumentException(sprintf( - 'The method %s only accepts file or directory names; ' . - 'however, the resource %s is not one of them.', - __METHOD__, - $resource, - )); - } - } - - /** - * @inheritDoc - */ - public function load(): array - { - $collector = new RouteCollector(); - - foreach ($this->resources as $resource) { - (function (string $filename): void { - /** @psalm-suppress UnresolvableInclude */ - require $filename; - })->call($collector, $resource); - } - - return $collector->getRoutes(); - } -} diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 71039f26..e8f7f542 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -13,6 +13,7 @@ namespace Sunrise\Http\Router\Loader; +use BackedEnum; use Generator; use InvalidArgumentException; use Psr\Http\Server\RequestHandlerInterface; @@ -20,27 +21,27 @@ use ReflectionAttribute; use ReflectionClass; use ReflectionMethod; +use Sunrise\Http\Router\Annotation\Attribute; use Sunrise\Http\Router\Annotation\Constraint; -use Sunrise\Http\Router\Annotation\ConsumesEncoding; -use Sunrise\Http\Router\Annotation\ConsumesMediaType; -use Sunrise\Http\Router\Annotation\DefaultAttribute; +use Sunrise\Http\Router\Annotation\Consumes; use Sunrise\Http\Router\Annotation\Deprecated; use Sunrise\Http\Router\Annotation\Description; use Sunrise\Http\Router\Annotation\Method; use Sunrise\Http\Router\Annotation\Middleware; use Sunrise\Http\Router\Annotation\Postfix; use Sunrise\Http\Router\Annotation\Prefix; -use Sunrise\Http\Router\Annotation\ProducesEncoding; -use Sunrise\Http\Router\Annotation\ProducesMediaType; +use Sunrise\Http\Router\Annotation\Produces; use Sunrise\Http\Router\Annotation\Route as Descriptor; use Sunrise\Http\Router\Annotation\Summary; use Sunrise\Http\Router\Annotation\Tag; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; use Sunrise\Http\Router\Helper\FilesystemHelper; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Route; use function class_exists; -use function hash; +use function explode; use function is_dir; use function join; use function sprintf; @@ -48,6 +49,8 @@ final class DescriptorLoader implements LoaderInterface { + public const DEFAULT_CACHE_KEY = 'router_descriptors'; + /** * @var list */ @@ -95,10 +98,8 @@ public function load(): Generator $route->setMiddlewares(...$descriptor->middlewares); $route->setAttributes($descriptor->attributes); $route->setConstraints($descriptor->constraints); - $route->setConsumesEncodings(...$descriptor->consumesEncodings); - $route->setProducesEncodings(...$descriptor->producesEncodings); - $route->setConsumesMediaTypes(...$descriptor->consumesMediaTypes); - $route->setProducesMediaTypes(...$descriptor->producesMediaTypes); + $route->setConsumesMediaTypes(...$descriptor->consumes); + $route->setProducesMediaTypes(...$descriptor->produces); $route->setSummary($descriptor->summary); $route->setDescription($descriptor->description); $route->setTags(...$descriptor->tags); @@ -114,7 +115,7 @@ public function load(): Generator */ private function getDescriptors(): array { - $cacheKey = $this->cacheKey ?? hash('md5', __METHOD__); + $cacheKey = $this->cacheKey ?? self::DEFAULT_CACHE_KEY; if (isset($this->cache) && $this->cache->has($cacheKey)) { /** @var list */ @@ -149,7 +150,7 @@ private function getResourceDescriptors(string $resource): Generator } if (is_dir($resource)) { - foreach (FilesystemHelper::getDirectoryClasses($resource) as $class) { + foreach (FilesystemHelper::getDirClasses($resource) as $class) { yield from $this->getClassDescriptors($class); } } @@ -229,6 +230,11 @@ private function supplementDescriptorFromClassOrMethod(Descriptor $descriptor, R $annotations = $holder->getAttributes(Method::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); + if ($annotation->value instanceof BackedEnum) { + $descriptor->methods[] = (string) $annotation->value->value; + continue; + } + $descriptor->methods[] = $annotation->value; } @@ -239,8 +245,8 @@ private function supplementDescriptorFromClassOrMethod(Descriptor $descriptor, R $descriptor->middlewares[] = $annotation->value; } - /** @var list> $annotations */ - $annotations = $holder->getAttributes(DefaultAttribute::class); + /** @var list> $annotations */ + $annotations = $holder->getAttributes(Attribute::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); $descriptor->attributes[$annotation->name] = $annotation->value; @@ -250,35 +256,35 @@ private function supplementDescriptorFromClassOrMethod(Descriptor $descriptor, R $annotations = $holder->getAttributes(Constraint::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->constraints[$annotation->name] = $annotation->value; + $descriptor->constraints[] = $annotation->value; } - /** @var list> $annotations */ - $annotations = $holder->getAttributes(ConsumesEncoding::class); + /** @var list> $annotations */ + $annotations = $holder->getAttributes(Consumes::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->consumesEncodings[] = $annotation->value; - } + if ($annotation->value instanceof MediaTypeInterface) { + $descriptor->consumes[] = $annotation->value; + continue; + } - /** @var list> $annotations */ - $annotations = $holder->getAttributes(ProducesEncoding::class); - foreach ($annotations as $annotation) { - $annotation = $annotation->newInstance(); - $descriptor->producesEncodings[] = $annotation->value; - } + $range = explode('/', $annotation->value, 2); - /** @var list> $annotations */ - $annotations = $holder->getAttributes(ConsumesMediaType::class); - foreach ($annotations as $annotation) { - $annotation = $annotation->newInstance(); - $descriptor->consumesMediaTypes[] = $annotation->value; + $descriptor->consumes[] = new ServerMediaType($range[0], $range[1] ?? '*'); } - /** @var list> $annotations */ - $annotations = $holder->getAttributes(ProducesMediaType::class); + /** @var list> $annotations */ + $annotations = $holder->getAttributes(Produces::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->producesMediaTypes[] = $annotation->value; + if ($annotation->value instanceof MediaTypeInterface) { + $descriptor->produces[] = $annotation->value; + continue; + } + + $range = explode('/', $annotation->value, 2); + + $descriptor->produces[] = new ServerMediaType($range[0], $range[1] ?? '*'); } /** @var list> $annotations */ diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 58dbb9c6..db453630 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -18,7 +18,7 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Entity\MediaType; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; use Sunrise\Http\Router\ServerRequest; @@ -40,7 +40,7 @@ final class JsonPayloadDecodingMiddleware implements MiddlewareInterface */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if (ServerRequest::create($request)->clientProducesMediaType(new MediaType('application', 'json'))) { + if (ServerRequest::create($request)->clientProducesMediaType(ServerMediaType::json())) { $request = $request->withParsedBody($this->decodePayload($request->getBody()->__toString())); } diff --git a/src/Route.php b/src/Route.php index b17e71be..bddef2ec 100644 --- a/src/Route.php +++ b/src/Route.php @@ -13,6 +13,9 @@ namespace Sunrise\Http\Router; +use Sunrise\Http\Router\Constraint\NamedConstraint; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; + use function rtrim; use function strtoupper; @@ -48,14 +51,14 @@ class Route implements RouteInterface /** * The route's consumed media types * - * @var list + * @var list */ private array $consumedMediaTypes = []; /** * The route's produced media types * - * @var list + * @var list */ private array $producedMediaTypes = []; @@ -278,7 +281,7 @@ public function setMethods(string ...$methods): static /** * @inheritDoc */ - public function setConsumesMediaTypes(string ...$mediaTypes): static + public function setConsumesMediaTypes(MediaTypeInterface ...$mediaTypes): static { $this->consumedMediaTypes = []; foreach ($mediaTypes as $mediaType) { @@ -291,7 +294,7 @@ public function setConsumesMediaTypes(string ...$mediaTypes): static /** * @inheritDoc */ - public function setProducesMediaTypes(string ...$mediaTypes): static + public function setProducesMediaTypes(MediaTypeInterface ...$mediaTypes): static { $this->producedMediaTypes = []; foreach ($mediaTypes as $mediaType) { @@ -425,7 +428,7 @@ public function addMethod(string ...$methods): static /** * @inheritDoc */ - public function addConsumedMediaType(string ...$mediaTypes): static + public function addConsumedMediaType(MediaTypeInterface ...$mediaTypes): static { foreach ($mediaTypes as $mediaType) { $this->consumedMediaTypes[] = $mediaType; @@ -437,7 +440,7 @@ public function addConsumedMediaType(string ...$mediaTypes): static /** * @inheritDoc */ - public function addProducedMediaType(string ...$mediaTypes): static + public function addProducedMediaType(MediaTypeInterface ...$mediaTypes): static { foreach ($mediaTypes as $mediaType) { $this->producedMediaTypes[] = $mediaType; @@ -492,7 +495,14 @@ public function getConstraints(): array public function setConstraints(array $constrains): static { - $this->constraints = $constrains; + foreach ($constrains as $constrain) { + if ($constrain instanceof NamedConstraint) { + $this->constraints[$constrain->name] = $constrain->value; + continue; + } + + $this->constraints[] = $constrains; + } return $this; } diff --git a/src/RouteCollector.php b/src/RouteCollector.php deleted file mode 100644 index 10bff11b..00000000 --- a/src/RouteCollector.php +++ /dev/null @@ -1,372 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -use Fig\Http\Message\RequestMethodInterface; -use Psr\Http\Server\MiddlewareInterface; -use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Loader\LoaderInterface; - -/** - * RouteCollector - */ -class RouteCollector implements LoaderInterface -{ - /** - * @var list - */ - private array $routes = []; - - /** - * @return list - */ - public function getRoutes(): array - { - return $this->routes; - } - - /** - * Makes a new route with the given parameters - * - * @param string $name - * @param string $path - * @param list $methods - * @param mixed $requestHandler - * @param list $middlewares - * @param array $attributes - * - * @return RouteInterface - */ - public function route( - string $name, - string $path, - array $methods, - mixed $requestHandler, - array $middlewares = [], - array $attributes = [], - ) : RouteInterface { - $route = new Route( - $name, - $path, - $methods, - $requestHandler, - $middlewares, - $attributes, - ); - - $this->routes[] = $route; - - return $route; - } - - /** - * Makes a new route that will respond to HEAD requests - * - * @param string $name - * @param string $path - * @param mixed $requestHandler - * @param list $middlewares - * @param array $attributes - * - * @return RouteInterface - */ - public function head( - string $name, - string $path, - mixed $requestHandler, - array $middlewares = [], - array $attributes = [], - ) : RouteInterface { - return $this->route( - $name, - $path, - [RequestMethodInterface::METHOD_HEAD], - $requestHandler, - $middlewares, - $attributes, - ); - } - - /** - * Makes a new route that will respond to GET requests - * - * @param string $name - * @param string $path - * @param mixed $requestHandler - * @param list $middlewares - * @param array $attributes - * - * @return RouteInterface - */ - public function get( - string $name, - string $path, - mixed $requestHandler, - array $middlewares = [], - array $attributes = [], - ) : RouteInterface { - return $this->route( - $name, - $path, - [RequestMethodInterface::METHOD_GET], - $requestHandler, - $middlewares, - $attributes, - ); - } - - /** - * Makes a new route that will respond to POST requests - * - * @param string $name - * @param string $path - * @param mixed $requestHandler - * @param list $middlewares - * @param array $attributes - * - * @return RouteInterface - */ - public function post( - string $name, - string $path, - mixed $requestHandler, - array $middlewares = [], - array $attributes = [], - ) : RouteInterface { - return $this->route( - $name, - $path, - [RequestMethodInterface::METHOD_POST], - $requestHandler, - $middlewares, - $attributes, - ); - } - - /** - * Makes a new route that will respond to PUT requests - * - * @param string $name - * @param string $path - * @param mixed $requestHandler - * @param list $middlewares - * @param array $attributes - * - * @return RouteInterface - */ - public function put( - string $name, - string $path, - mixed $requestHandler, - array $middlewares = [], - array $attributes = [], - ) : RouteInterface { - return $this->route( - $name, - $path, - [RequestMethodInterface::METHOD_PUT], - $requestHandler, - $middlewares, - $attributes, - ); - } - - /** - * Makes a new route that will respond to PATCH requests - * - * @param string $name - * @param string $path - * @param mixed $requestHandler - * @param list $middlewares - * @param array $attributes - * - * @return RouteInterface - */ - public function patch( - string $name, - string $path, - mixed $requestHandler, - array $middlewares = [], - array $attributes = [], - ) : RouteInterface { - return $this->route( - $name, - $path, - [RequestMethodInterface::METHOD_PATCH], - $requestHandler, - $middlewares, - $attributes, - ); - } - - /** - * Makes a new route that will respond to DELETE requests - * - * @param string $name - * @param string $path - * @param mixed $requestHandler - * @param list $middlewares - * @param array $attributes - * - * @return RouteInterface - */ - public function delete( - string $name, - string $path, - mixed $requestHandler, - array $middlewares = [], - array $attributes = [], - ) : RouteInterface { - return $this->route( - $name, - $path, - [RequestMethodInterface::METHOD_DELETE], - $requestHandler, - $middlewares, - $attributes, - ); - } - - /** - * Makes a new route that will respond to PURGE requests - * - * @param string $name - * @param string $path - * @param mixed $requestHandler - * @param list $middlewares - * @param array $attributes - * - * @return RouteInterface - */ - public function purge( - string $name, - string $path, - mixed $requestHandler, - array $middlewares = [], - array $attributes = [], - ) : RouteInterface { - return $this->route( - $name, - $path, - [RequestMethodInterface::METHOD_PURGE], - $requestHandler, - $middlewares, - $attributes, - ); - } - - public function group(callable $callback, array $middlewares = []): static - { - $collector = new self(); - - $callback($collector); - - $collector->addPriorityMiddleware(...$middlewares); - - foreach ($collector->routes as $route) { - $this->routes[] = $route; - } - - return $collector; - } - - public function addPrefix(string $prefix): static - { - foreach ($this->routes as $route) { - $route->addPrefix($prefix); - } - - return $this; - } - - public function addSuffix(string $suffix): static - { - foreach ($this->routes as $route) { - $route->addSuffix($suffix); - } - - return $this; - } - - public function addMethod(string ...$methods): static - { - foreach ($this->routes as $route) { - $route->addMethod(...$methods); - } - - return $this; - } - - public function addConsumesMediaType(MediaType ...$mediaTypes): static - { - foreach ($this->routes as $route) { - $route->addConsumedMediaType(...$mediaTypes); - } - - return $this; - } - - public function addProducesMediaType(MediaType ...$mediaTypes): static - { - foreach ($this->routes as $route) { - $route->addProducedMediaType(...$mediaTypes); - } - - return $this; - } - - public function addPriorityMiddleware(MiddlewareInterface ...$middlewares): static - { - foreach ($this->routes as $route) { - $route->setMiddlewares(...$middlewares, ...$route->getMiddlewares()); - } - - return $this; - } - - public function addMiddleware(MiddlewareInterface ...$middlewares): static - { - foreach ($this->routes as $route) { - $route->addMiddleware(...$middlewares); - } - - return $this; - } - - public function addTag(string ...$tags): static - { - foreach ($this->routes as $route) { - $route->addTag(...$tags); - } - - return $this; - } - - public function setDeprecation(bool $isDeprecated): static - { - foreach ($this->routes as $route) { - $route->setDeprecation($isDeprecated); - } - - return $this; - } - - /** - * @inheritDoc - */ - public function load(): iterable - { - return $this->routes; - } -} diff --git a/src/RouteFactory.php b/src/RouteFactory.php deleted file mode 100644 index 3f4fdc9f..00000000 --- a/src/RouteFactory.php +++ /dev/null @@ -1,44 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -use Psr\Http\Server\RequestHandlerInterface; - -/** - * RouteFactory - */ -class RouteFactory implements RouteFactoryInterface -{ - - /** - * @inheritDoc - */ - public function createRoute( - string $name, - string $path, - array $methods, - RequestHandlerInterface $requestHandler, - array $middlewares = [], - array $attributes = [], - ) : RouteInterface { - return new Route( - $name, - $path, - $methods, - $requestHandler, - $middlewares, - $attributes, - ); - } -} diff --git a/src/RouteFactoryInterface.php b/src/RouteFactoryInterface.php deleted file mode 100644 index 0d1e7677..00000000 --- a/src/RouteFactoryInterface.php +++ /dev/null @@ -1,45 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; - -/** - * RouteFactoryInterface - */ -interface RouteFactoryInterface -{ - - /** - * Creates a new route from with given parameters - * - * @param string $name - * @param string $path - * @param list $methods - * @param RequestHandlerInterface $requestHandler - * @param list $middlewares - * @param array $attributes - * - * @return RouteInterface - */ - public function createRoute( - string $name, - string $path, - array $methods, - RequestHandlerInterface $requestHandler, - array $middlewares, - array $attributes, - ) : RouteInterface; -} diff --git a/src/RouteInterface.php b/src/RouteInterface.php index ff937966..42a67b48 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -13,7 +13,7 @@ namespace Sunrise\Http\Router; -use Sunrise\Http\Router\Entity\MediaType; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; interface RouteInterface { @@ -55,7 +55,7 @@ public function getMethods(): array; /** * Gets the route's consumed media types * - * @return list + * @return list * * @since 3.0.0 */ @@ -64,7 +64,7 @@ public function getConsumedMediaTypes(): array; /** * Gets the route's produced media types * - * @return list + * @return list * * @since 3.0.0 */ @@ -168,24 +168,24 @@ public function setMethods(string ...$methods): static; /** * Sets the given consumed media type(s) to the route * - * @param MediaType ...$mediaTypes + * @param MediaTypeInterface ...$mediaTypes * * @return static * * @since 3.0.0 */ - public function setConsumesMediaTypes(string ...$mediaTypes): static; + public function setConsumesMediaTypes(MediaTypeInterface ...$mediaTypes): static; /** * Sets the given produced media type(s) to the route * - * @param MediaType ...$mediaTypes + * @param MediaTypeInterface ...$mediaTypes * * @return static * * @since 3.0.0 */ - public function setProducesMediaTypes(string ...$mediaTypes): static; + public function setProducesMediaTypes(MediaTypeInterface ...$mediaTypes): static; /** * Sets the given request handler to the route @@ -300,24 +300,24 @@ public function addMethod(string ...$methods): static; /** * Adds the given consumed media type(s) to the route * - * @param MediaType ...$mediaTypes + * @param MediaTypeInterface ...$mediaTypes * * @return static * * @since 3.0.0 */ - public function addConsumedMediaType(string ...$mediaTypes): static; + public function addConsumedMediaType(MediaTypeInterface ...$mediaTypes): static; /** * Adds the given produced media type(s) to the route * - * @param MediaType ...$mediaTypes + * @param MediaTypeInterface ...$mediaTypes * * @return static * * @since 3.0.0 */ - public function addProducedMediaType(string ...$mediaTypes): static; + public function addProducedMediaType(MediaTypeInterface ...$mediaTypes): static; /** * Adds the given middleware(s) to the route diff --git a/src/ServerRequest.php b/src/ServerRequest.php index cb66f54b..4d028cfc 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -17,13 +17,12 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\StreamInterface; use Psr\Http\Message\UriInterface; -use Sunrise\Http\Router\Entity\Encoding; -use Sunrise\Http\Router\Entity\Language; -use Sunrise\Http\Router\Entity\LanguageComparator; -use Sunrise\Http\Router\Entity\LanguageInterface; -use Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Entity\MediaTypeComparator; -use Sunrise\Http\Router\Entity\MediaTypeInterface; +use Sunrise\Http\Router\Entity\Language\ClientLanguage; +use Sunrise\Http\Router\Entity\Language\LanguageComparator; +use Sunrise\Http\Router\Entity\Language\LanguageInterface; +use Sunrise\Http\Router\Entity\MediaType\ClientMediaType; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; use Sunrise\Http\Router\Helper\HeaderParser; /** @@ -58,13 +57,13 @@ public function getMediaTypeComparator(): MediaTypeComparator return $this->mediaTypeComparator ??= new MediaTypeComparator(); } - public function getClientProducedMediaType(): ?MediaType + public function getClientProducedMediaType(): ?ClientMediaType { return HeaderParser::parseContentTypeHeader($this->request->getHeaderLine('Content-Type')); } /** - * @return Generator, MediaType> + * @return Generator, ClientMediaType> */ public function getClientConsumedMediaTypes(): Generator { @@ -72,22 +71,14 @@ public function getClientConsumedMediaTypes(): Generator } /** - * @return Generator, Encoding> - */ - public function getClientConsumedEncodings(): Generator - { - yield from HeaderParser::parseAcceptEncodingHeader($this->request->getHeaderLine('Accept-Encoding')); - } - - /** - * @return Generator, Language> + * @return Generator, ClientLanguage> */ public function getClientConsumedLanguages(): Generator { yield from HeaderParser::parseAcceptLanguageHeader($this->request->getHeaderLine('Accept-Language')); } - public function getClientPreferredMediaType(MediaTypeInterface ...$serverProducedMediaTypes): ?MediaType + public function getClientPreferredMediaType(MediaTypeInterface ...$serverProducedMediaTypes): ?ClientMediaType { if ($serverProducedMediaTypes === []) { return null; @@ -105,7 +96,7 @@ public function getClientPreferredMediaType(MediaTypeInterface ...$serverProduce return null; } - public function getClientPreferredLanguage(LanguageInterface ...$serverProducedLanguages): ?Language + public function getClientPreferredLanguage(LanguageInterface ...$serverProducedLanguages): ?ClientLanguage { if ($serverProducedLanguages === []) { return null; From 5ea9ed295aa434bc1f50449a4b495942ec1edda7 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 24 Feb 2024 03:30:11 +0100 Subject: [PATCH 100/180] v3 --- src/Annotation/Consumes.php | 2 +- src/Annotation/Method.php | 3 +- .../Pattern.php} | 9 +- src/Annotation/Produces.php | 2 +- src/Annotation/Route.php | 6 +- src/Dictionary/Charset.php | 2 + src/Entity/MediaType/ServerMediaType.php | 5 - src/Helper/HeaderParser.php | 2 +- src/Helper/RouteBuilder.php | 24 +- src/Helper/RouteCompiler.php | 29 +- src/Helper/RouteMatcher.php | 12 +- src/Helper/RouteParser.php | 46 ++- src/Loader/DescriptorLoader.php | 43 +-- src/Loader/LoaderInterface.php | 4 +- .../JsonPayloadDecodingMiddleware.php | 2 +- .../PathVariableParameterResolver.php | 4 +- .../RequestRouteParameterResolver.php | 8 +- .../RouteResponseResolver.php | 4 +- src/Route.php | 39 +- src/RouteInterface.php | 352 ------------------ src/Router.php | 18 +- 21 files changed, 118 insertions(+), 498 deletions(-) rename src/{Constraint/NamedConstraint.php => Annotation/Pattern.php} (68%) delete mode 100644 src/RouteInterface.php diff --git a/src/Annotation/Consumes.php b/src/Annotation/Consumes.php index f73b6d80..18f2fd8e 100644 --- a/src/Annotation/Consumes.php +++ b/src/Annotation/Consumes.php @@ -23,7 +23,7 @@ final class Consumes { public function __construct( - public readonly MediaTypeInterface|string $value, + public readonly MediaTypeInterface $value, ) { } } diff --git a/src/Annotation/Method.php b/src/Annotation/Method.php index 96929bc2..06b6969e 100644 --- a/src/Annotation/Method.php +++ b/src/Annotation/Method.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use BackedEnum; use Fig\Http\Message\RequestMethodInterface; /** @@ -24,7 +23,7 @@ final class Method implements RequestMethodInterface { public function __construct( - public readonly BackedEnum|string $value, + public readonly string $value, ) { } } diff --git a/src/Constraint/NamedConstraint.php b/src/Annotation/Pattern.php similarity index 68% rename from src/Constraint/NamedConstraint.php rename to src/Annotation/Pattern.php index e584f4a0..f4ef4d23 100644 --- a/src/Constraint/NamedConstraint.php +++ b/src/Annotation/Pattern.php @@ -11,16 +11,19 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Constraint; +namespace Sunrise\Http\Router\Annotation; + +use Attribute; /** * @since 3.0.0 */ -final class NamedConstraint +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class Pattern { public function __construct( public readonly string $name, - public readonly mixed $value, + public readonly string $value, ) { } } diff --git a/src/Annotation/Produces.php b/src/Annotation/Produces.php index eaacb440..c7aff81c 100644 --- a/src/Annotation/Produces.php +++ b/src/Annotation/Produces.php @@ -23,7 +23,7 @@ final class Produces { public function __construct( - public readonly MediaTypeInterface|string $value, + public readonly MediaTypeInterface $value, ) { } } diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index 41ebe9a8..586af373 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -34,11 +34,13 @@ public function __construct( string|null $method = null, /** @var list */ public array $methods = [], - /** @var list */ - public array $middlewares = [], + /** @var array */ + public array $patterns = [], /** @var array */ public array $attributes = [], /** @var list */ + public array $middlewares = [], + /** @var mixed */ public array $constraints = [], /** @var list */ public array $consumes = [], diff --git a/src/Dictionary/Charset.php b/src/Dictionary/Charset.php index 35d2f2e1..24c1baab 100644 --- a/src/Dictionary/Charset.php +++ b/src/Dictionary/Charset.php @@ -18,6 +18,8 @@ */ final class Charset { + public const DIGIT = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]; + /** * @link https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.3 */ diff --git a/src/Entity/MediaType/ServerMediaType.php b/src/Entity/MediaType/ServerMediaType.php index 169fad60..ea437658 100644 --- a/src/Entity/MediaType/ServerMediaType.php +++ b/src/Entity/MediaType/ServerMediaType.php @@ -24,11 +24,6 @@ public function __construct( ) { } - public static function json(): self - { - return new self('application', 'json'); - } - public function getType(): string { return $this->type; diff --git a/src/Helper/HeaderParser.php b/src/Helper/HeaderParser.php index 2a9fb538..ac03c831 100644 --- a/src/Helper/HeaderParser.php +++ b/src/Helper/HeaderParser.php @@ -89,7 +89,7 @@ public static function parseAcceptLanguageHeader(string $header): Generator /** * @return array, array{0: string, 1: array}> */ - private static function parseHeader(string $header): array + public static function parseHeader(string $header): array { $inIdentifier = 1; $inParameterName = 2; diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index e3e0f010..e705c349 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -29,9 +29,11 @@ final class RouteBuilder { /** + * @param array $values + * * @throws InvalidArgumentException - * If the route isn't valid, - * or any of the values are unsupported, + * If the route isn't valid; + * or any of the values are unsupported; * or any of the required values are missing. */ public static function buildRoute(string $route, array $values = []): string @@ -54,17 +56,17 @@ public static function buildRoute(string $route, array $values = []): string $value = $value->__toString(); } - if (is_string($value)) { - $search[] = $statement; - $replace[] = $value; - continue; + if (!is_string($value)) { + throw new InvalidArgumentException(sprintf( + 'The route %s could not be built with an unsupported value for the variable %s.', + $route, + $variable['name'], + )); } - throw new InvalidArgumentException(sprintf( - 'The route %s could not be built with an unsupported value for the variable %s.', - $route, - $variable['name'], - )); + $search[] = $statement; + $replace[] = $value; + continue; } if (isset($variable['optional'])) { diff --git a/src/Helper/RouteCompiler.php b/src/Helper/RouteCompiler.php index 720da18e..9d521852 100644 --- a/src/Helper/RouteCompiler.php +++ b/src/Helper/RouteCompiler.php @@ -13,13 +13,9 @@ namespace Sunrise\Http\Router\Helper; -use BackedEnum; use InvalidArgumentException; -use Stringable; use function addcslashes; -use function is_string; -use function sprintf; use function str_replace; use function substr; @@ -28,10 +24,14 @@ */ final class RouteCompiler { + public const PATTERN_DELIMITER = '#'; + /** + * @param array $patterns + * * @return non-empty-string * - * @throws InvalidArgumentException If the route isn't valid or any of the patterns are unsupported. + * @throws InvalidArgumentException If the route isn't valid. */ public static function compileRoute(string $route, array $patterns = []): string { @@ -53,23 +53,8 @@ public static function compileRoute(string $route, array $patterns = []): string foreach ($variables as $variable) { $pattern = $patterns[$variable['name']] ?? $variable['pattern'] ?? '[^/]+'; - if ($pattern instanceof BackedEnum) { - $pattern = $pattern->value; - } elseif ($pattern instanceof Stringable) { - $pattern = $pattern->__toString(); - } - - if (is_string($pattern)) { - $search[] = '{' . $variable['name'] . '}'; - $replace[] = '(?<' . $variable['name'] . '>' . $pattern . ')'; - continue; - } - - throw new InvalidArgumentException(sprintf( - 'The route %s could not be compiled with an unsupported pattern for the variable %s.', - $route, - $variable['name'], - )); + $search[] = '{' . $variable['name'] . '}'; + $replace[] = '(?<' . $variable['name'] . '>' . $pattern . ')'; } $route = str_replace($search, $replace, $route); diff --git a/src/Helper/RouteMatcher.php b/src/Helper/RouteMatcher.php index bc63da31..a786c4f6 100644 --- a/src/Helper/RouteMatcher.php +++ b/src/Helper/RouteMatcher.php @@ -31,9 +31,10 @@ final class RouteMatcher { /** + * @param array $patterns * @param-out array $matches * - * @throws InvalidArgumentException If the route isn't valid or any of the patterns are unsupported. + * @throws InvalidArgumentException If the route or one of the patterns isn't valid. */ public static function matchRoute(string $route, array $patterns, string $subject, ?array &$matches = null): bool { @@ -46,7 +47,7 @@ public static function matchRoute(string $route, array $patterns, string $subjec * @param non-empty-string $pattern * @param-out array $matches * - * @throws InvalidArgumentException If the pattern (read: route) isn't valid. + * @throws InvalidArgumentException If the pattern isn't valid. */ public static function matchPattern(string $route, string $pattern, string $subject, ?array &$matches = null): bool { @@ -62,13 +63,8 @@ public static function matchPattern(string $route, string $pattern, string $subj } foreach ($matches as $key => $match) { - if (is_int($key)) { + if (is_int($key) || $match === null) { unset($matches[$key]); - continue; - } - if ($match === null) { - unset($matches[$key]); - continue; } } diff --git a/src/Helper/RouteParser.php b/src/Helper/RouteParser.php index 534d465b..bd0cefd7 100644 --- a/src/Helper/RouteParser.php +++ b/src/Helper/RouteParser.php @@ -26,11 +26,7 @@ final class RouteParser /** * Parses the given route and returns its variables * - * @return list - * - * @throws InvalidArgumentException If the route isn't valid. - * - * @template TVariable as array{ + * @return list + * + * @throws InvalidArgumentException If the route isn't valid. */ public static function parseRoute(string $route): array { - $digits = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]; - $inVariable = 1; $inVariableName = 2; $inVariablePattern = 8; @@ -84,7 +80,6 @@ public static function parseRoute(string $route): array if (($cursor & $inOccupiedPart)) { $cursor &= ~$inOccupiedPart; - $variables[$variable]['optional'] = true; $variables[$variable]['left'] = $left; $variables[$variable]['right'] = $right; } @@ -114,12 +109,14 @@ public static function parseRoute(string $route): array )); } + $variable++; + if (($cursor & $inOptionalPart)) { $cursor |= $inOccupiedPart; + $variables[$variable]['optional'] = true; } $cursor |= $inVariable | $inVariableName; - $variable++; $variables[$variable]['offset'] = $offset; continue; } @@ -210,11 +207,12 @@ public static function parseRoute(string $route): array // https://www.pcre.org/original/doc/html/pcrepattern.html#SEC16 if (($cursor & $inVariableName)) { - if (isset($variables[$variable]['name'][31])) { + /** @psalm-suppress InvalidArrayOffset */ + if (!isset($variables[$variable]['name'][0]) && isset(Charset::DIGIT[$route[$offset]])) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An extra character was found at position %d. ' . - 'Please note that variable names must not exceed 32 characters.', + 'An invalid character was found at position %d. ' . + 'Please note that variable names cannot start with digits.', $route, $offset, )); @@ -228,12 +226,11 @@ public static function parseRoute(string $route): array $offset, )); } - /** @psalm-suppress InvalidArrayOffset */ - if (!isset($variables[$variable]['name']) && isset($digits[$route[$offset]])) { + if (isset($variables[$variable]['name'][31])) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An invalid character was found at position %d. ' . - 'Please note that variable names cannot start with digits.', + 'An extra character was found at position %d. ' . + 'Please note that variable names must not exceed 32 characters.', $route, $offset, )); @@ -245,14 +242,15 @@ public static function parseRoute(string $route): array } if (($cursor & $inVariablePattern)) { - if ($route[$offset] === '#') { + if ($route[$offset] === RouteCompiler::PATTERN_DELIMITER) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An invalid character was found at position %d. ' . - 'Please note that variable patterns cannot contain the hash character; ' . + 'Please note that variable patterns cannot contain the %s character; ' . 'use an octal or hexadecimal sequence instead.', $route, $offset, + RouteCompiler::PATTERN_DELIMITER, )); } @@ -282,7 +280,15 @@ public static function parseRoute(string $route): array } /** - * @var list + * @var list */ return $variables; } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index e8f7f542..bc2d3249 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -13,7 +13,6 @@ namespace Sunrise\Http\Router\Loader; -use BackedEnum; use Generator; use InvalidArgumentException; use Psr\Http\Server\RequestHandlerInterface; @@ -28,20 +27,18 @@ use Sunrise\Http\Router\Annotation\Description; use Sunrise\Http\Router\Annotation\Method; use Sunrise\Http\Router\Annotation\Middleware; +use Sunrise\Http\Router\Annotation\Pattern; use Sunrise\Http\Router\Annotation\Postfix; use Sunrise\Http\Router\Annotation\Prefix; use Sunrise\Http\Router\Annotation\Produces; use Sunrise\Http\Router\Annotation\Route as Descriptor; use Sunrise\Http\Router\Annotation\Summary; use Sunrise\Http\Router\Annotation\Tag; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; use Sunrise\Http\Router\Helper\FilesystemHelper; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Route; use function class_exists; -use function explode; use function is_dir; use function join; use function sprintf; @@ -126,7 +123,7 @@ private function getDescriptors(): array foreach ($this->resources as $resource) { foreach ($this->getResourceDescriptors($resource) as $descriptor) { $descriptor->path = join($descriptor->prefixes) . $descriptor->path; - $descriptor->pattern = RouteCompiler::compileRoute($descriptor->path, $descriptor->constraints); + $descriptor->pattern = RouteCompiler::compileRoute($descriptor->path, $descriptor->patterns); $result[] = $descriptor; } } @@ -230,19 +227,14 @@ private function supplementDescriptorFromClassOrMethod(Descriptor $descriptor, R $annotations = $holder->getAttributes(Method::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - if ($annotation->value instanceof BackedEnum) { - $descriptor->methods[] = (string) $annotation->value->value; - continue; - } - $descriptor->methods[] = $annotation->value; } - /** @var list> $annotations */ - $annotations = $holder->getAttributes(Middleware::class); + /** @var list> $annotations */ + $annotations = $holder->getAttributes(Pattern::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->middlewares[] = $annotation->value; + $descriptor->patterns[$annotation->name] = $annotation->value; } /** @var list> $annotations */ @@ -252,6 +244,13 @@ private function supplementDescriptorFromClassOrMethod(Descriptor $descriptor, R $descriptor->attributes[$annotation->name] = $annotation->value; } + /** @var list> $annotations */ + $annotations = $holder->getAttributes(Middleware::class); + foreach ($annotations as $annotation) { + $annotation = $annotation->newInstance(); + $descriptor->middlewares[] = $annotation->value; + } + /** @var list> $annotations */ $annotations = $holder->getAttributes(Constraint::class); foreach ($annotations as $annotation) { @@ -263,28 +262,14 @@ private function supplementDescriptorFromClassOrMethod(Descriptor $descriptor, R $annotations = $holder->getAttributes(Consumes::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - if ($annotation->value instanceof MediaTypeInterface) { - $descriptor->consumes[] = $annotation->value; - continue; - } - - $range = explode('/', $annotation->value, 2); - - $descriptor->consumes[] = new ServerMediaType($range[0], $range[1] ?? '*'); + $descriptor->consumes[] = $annotation->value; } /** @var list> $annotations */ $annotations = $holder->getAttributes(Produces::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - if ($annotation->value instanceof MediaTypeInterface) { - $descriptor->produces[] = $annotation->value; - continue; - } - - $range = explode('/', $annotation->value, 2); - - $descriptor->produces[] = new ServerMediaType($range[0], $range[1] ?? '*'); + $descriptor->produces[] = $annotation->value; } /** @var list> $annotations */ diff --git a/src/Loader/LoaderInterface.php b/src/Loader/LoaderInterface.php index e17222d5..5b4b7097 100644 --- a/src/Loader/LoaderInterface.php +++ b/src/Loader/LoaderInterface.php @@ -13,12 +13,12 @@ namespace Sunrise\Http\Router\Loader; -use Sunrise\Http\Router\RouteInterface; +use Sunrise\Http\Router\Route; interface LoaderInterface { /** - * @return iterable + * @return iterable */ public function load(): iterable; } diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index db453630..82df1e99 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -40,7 +40,7 @@ final class JsonPayloadDecodingMiddleware implements MiddlewareInterface */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if (ServerRequest::create($request)->clientProducesMediaType(ServerMediaType::json())) { + if (ServerRequest::create($request)->clientProducesMediaType(new ServerMediaType('application', 'json'))) { $request = $request->withParsedBody($this->decodePayload($request->getBody()->__toString())); } diff --git a/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php b/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php index b6864568..20bfc190 100644 --- a/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php @@ -21,7 +21,7 @@ use Sunrise\Http\Router\Annotation\PathVariable; use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; -use Sunrise\Http\Router\RouteInterface; +use Sunrise\Http\Router\Route; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; @@ -69,7 +69,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } $route = $context->getAttribute('@route'); - if (! $route instanceof RouteInterface) { + if (! $route instanceof Route) { throw new LogicException(sprintf( 'The #[PathVariable] attribute cannot be applied to the parameter {%s}, ' . 'because the request does not contain information about the requested route, ' . diff --git a/src/ParameterResolving/ParameterResolver/RequestRouteParameterResolver.php b/src/ParameterResolving/ParameterResolver/RequestRouteParameterResolver.php index 79d47313..06d60b3e 100644 --- a/src/ParameterResolving/ParameterResolver/RequestRouteParameterResolver.php +++ b/src/ParameterResolving/ParameterResolver/RequestRouteParameterResolver.php @@ -19,7 +19,7 @@ use ReflectionNamedType; use ReflectionParameter; use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; -use Sunrise\Http\Router\RouteInterface; +use Sunrise\Http\Router\Route; use function sprintf; @@ -39,7 +39,7 @@ final class RequestRouteParameterResolver implements ParameterResolverInterface public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { $type = $parameter->getType(); - if (! $type instanceof ReflectionNamedType || $type->getName() <> RouteInterface::class) { + if (! $type instanceof ReflectionNamedType || $type->getName() <> Route::class) { return; } @@ -49,9 +49,9 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } - /** @var RouteInterface|null $route */ + /** @var Route|null $route */ $route = $context->getAttribute('@route'); - if (! $route instanceof RouteInterface && !$parameter->allowsNull()) { + if (! $route instanceof Route && !$parameter->allowsNull()) { throw new LogicException(sprintf( 'At this level of the application, the current request does not contain a route. ' . 'To suppress this error, the parameter {%s} should be nullable.', diff --git a/src/ResponseResolving/ResponseResolver/RouteResponseResolver.php b/src/ResponseResolving/ResponseResolver/RouteResponseResolver.php index ca74f829..79cfea3c 100644 --- a/src/ResponseResolving/ResponseResolver/RouteResponseResolver.php +++ b/src/ResponseResolving/ResponseResolver/RouteResponseResolver.php @@ -18,7 +18,7 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionFunction; use ReflectionMethod; -use Sunrise\Http\Router\RouteInterface; +use Sunrise\Http\Router\Route; use Sunrise\Http\Router\Router; /** @@ -37,7 +37,7 @@ public function resolveResponse( mixed $response, ReflectionFunction|ReflectionMethod $responder, ) : ?ResponseInterface { - if (! $response instanceof RouteInterface) { + if (! $response instanceof Route) { return null; } diff --git a/src/Route.php b/src/Route.php index bddef2ec..f43b3652 100644 --- a/src/Route.php +++ b/src/Route.php @@ -13,18 +13,12 @@ namespace Sunrise\Http\Router; -use Sunrise\Http\Router\Constraint\NamedConstraint; use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; use function rtrim; use function strtoupper; -/** - * Route - * - * Use the {@see RouteFactory} factory to create this class. - */ -class Route implements RouteInterface +class Route { /** @@ -70,18 +64,18 @@ class Route implements RouteInterface private mixed $requestHandler; /** - * The route middlewares + * The route attributes * - * @var list + * @var array */ - private array $middlewares = []; + private array $attributes = []; /** - * The route attributes + * The route middlewares * - * @var array + * @var list */ - private array $attributes = []; + private array $middlewares = []; /** * The route summary @@ -113,6 +107,8 @@ class Route implements RouteInterface private array $constraints = []; + private array $patterns = []; + private ?string $pattern = null; /** @@ -495,14 +491,7 @@ public function getConstraints(): array public function setConstraints(array $constrains): static { - foreach ($constrains as $constrain) { - if ($constrain instanceof NamedConstraint) { - $this->constraints[$constrain->name] = $constrain->value; - continue; - } - - $this->constraints[] = $constrains; - } + $this->constraints = $constrains; return $this; } @@ -518,4 +507,12 @@ public function setPattern(?string $pattern): static return $this; } + + /** + * @return array + */ + public function getPatterns(): array + { + return $this->patterns; + } } diff --git a/src/RouteInterface.php b/src/RouteInterface.php deleted file mode 100644 index 42a67b48..00000000 --- a/src/RouteInterface.php +++ /dev/null @@ -1,352 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; - -interface RouteInterface -{ - - /** - * The server request's attribute name for a route instance - * - * @var string - * - * @since 2.11.0 - */ - public const ATTR_ROUTE = '@route'; - - public function getConstraints(): array; - - public function setConstraints(array $constrains): static; - - /** - * Gets the route name - * - * @return string - */ - public function getName(): string; - - /** - * Gets the route path - * - * @return string - */ - public function getPath(): string; - - /** - * Gets the route methods - * - * @return list - */ - public function getMethods(): array; - - /** - * Gets the route's consumed media types - * - * @return list - * - * @since 3.0.0 - */ - public function getConsumedMediaTypes(): array; - - /** - * Gets the route's produced media types - * - * @return list - * - * @since 3.0.0 - */ - public function getProducedMediaTypes(): array; - - /** - * Gets the route's request handler - * - * @return mixed - */ - public function getRequestHandler(): mixed; - - /** - * Gets the route middlewares - * - * @return list - */ - public function getMiddlewares(): array; - - /** - * Gets the route attributes - * - * @return array - */ - public function getAttributes(): array; - - /** - * Gets the route's attribute value by its given name - * or returns the given default value if the parameter doesn't exist - * - * @param string $name - * @param mixed $default - * - * @return mixed - */ - public function getAttribute(string $name, mixed $default = null): mixed; - - /** - * Gets the route summary - * - * @return string|null - * - * @since 2.4.0 - */ - public function getSummary(): ?string; - - /** - * Gets the route description - * - * @return string|null - * - * @since 2.4.0 - */ - public function getDescription(): ?string; - - /** - * Gets the route tags - * - * @return list - * - * @since 2.4.0 - */ - public function getTags(): array; - - /** - * Checks if the route is deprecated - * - * @return bool - * - * @since 3.0.0 - */ - public function isDeprecated(): bool; - - /** - * Sets the given name to the route - * - * @param string $name - * - * @return static - */ - public function setName(string $name): static; - - /** - * Sets the given path to the route - * - * @param string $path - * - * @return static - */ - public function setPath(string $path): static; - - /** - * Sets the given method(s) to the route - * - * @param string ...$methods - * - * @return static - */ - public function setMethods(string ...$methods): static; - - /** - * Sets the given consumed media type(s) to the route - * - * @param MediaTypeInterface ...$mediaTypes - * - * @return static - * - * @since 3.0.0 - */ - public function setConsumesMediaTypes(MediaTypeInterface ...$mediaTypes): static; - - /** - * Sets the given produced media type(s) to the route - * - * @param MediaTypeInterface ...$mediaTypes - * - * @return static - * - * @since 3.0.0 - */ - public function setProducesMediaTypes(MediaTypeInterface ...$mediaTypes): static; - - /** - * Sets the given request handler to the route - * - * @param mixed $requestHandler - * - * @return static - */ - public function setRequestHandler(mixed $requestHandler): static; - - /** - * Sets the given middleware(s) to the route - * - * @param mixed ...$middlewares - * - * @return static - */ - public function setMiddlewares(mixed ...$middlewares): static; - - /** - * Sets the given attributes to the route - * - * @param array $attributes - * - * @return static - */ - public function setAttributes(array $attributes): static; - - /** - * Sets the given attribute to the route - * - * @param string $name - * @param mixed $value - * - * @return static - * - * @since 3.0.0 - */ - public function setAttribute(string $name, mixed $value): static; - - /** - * Sets the given summary to the route - * - * @param string|null $summary - * - * @return static - * - * @since 2.4.0 - */ - public function setSummary(?string $summary): static; - - /** - * Sets the given description to the route - * - * @param string|null $description - * - * @return static - * - * @since 2.4.0 - */ - public function setDescription(?string $description): static; - - /** - * Sets the given tag(s) to the route - * - * @param string ...$tags - * - * @return static - * - * @since 2.4.0 - */ - public function setTags(string ...$tags): static; - - /** - * Sets the route's deprecation - * - * @param bool $isDeprecated - * - * @return static - * - * @since 3.0.0 - */ - public function setDeprecation(bool $isDeprecated): static; - - /** - * Adds the given prefix to the route path - * - * @param string $prefix - * - * @return static - */ - public function addPrefix(string $prefix): static; - - /** - * Adds the given suffix to the route path - * - * @param string $suffix - * - * @return static - */ - public function addSuffix(string $suffix): static; - - /** - * Adds the given method(s) to the route - * - * @param string ...$methods - * - * @return static - */ - public function addMethod(string ...$methods): static; - - /** - * Adds the given consumed media type(s) to the route - * - * @param MediaTypeInterface ...$mediaTypes - * - * @return static - * - * @since 3.0.0 - */ - public function addConsumedMediaType(MediaTypeInterface ...$mediaTypes): static; - - /** - * Adds the given produced media type(s) to the route - * - * @param MediaTypeInterface ...$mediaTypes - * - * @return static - * - * @since 3.0.0 - */ - public function addProducedMediaType(MediaTypeInterface ...$mediaTypes): static; - - /** - * Adds the given middleware(s) to the route - * - * @param mixed ...$middlewares - * - * @return static - */ - public function addMiddleware(mixed ...$middlewares): static; - - /** - * Adds the given tag(s) to the route - * - * @param string ...$tags - * - * @return static - * - * @since 3.0.0 - */ - public function addTag(string ...$tags): static; - - /** - * Returns the route's clone with the given attributes - * - * This method MUST NOT change the object state. - * - * @param array $attributes - * - * @return static - */ - public function withAddedAttributes(array $attributes): static; -} diff --git a/src/Router.php b/src/Router.php index c03551d9..f7c4b141 100644 --- a/src/Router.php +++ b/src/Router.php @@ -41,7 +41,7 @@ class Router private readonly ReferenceResolver $referenceResolver; /** - * @var array + * @var array */ private array $routes = []; @@ -66,7 +66,7 @@ public function __construct( } /** - * @return array + * @return array */ public function getRoutes(): array { @@ -76,7 +76,7 @@ public function getRoutes(): array /** * @throws InvalidArgumentException If the route doesn't exist. */ - public function getRoute(string $name): RouteInterface + public function getRoute(string $name): Route { return $this->routes[$name] ?? throw new InvalidArgumentException(sprintf( 'The route %s does not exist.', @@ -84,7 +84,7 @@ public function getRoute(string $name): RouteInterface )); } - public function addRoute(RouteInterface ...$routes) : void + public function addRoute(Route ...$routes) : void { foreach ($routes as $route) { $this->routes[$route->getName()] = $route; @@ -113,7 +113,7 @@ public function addMiddleware(mixed ...$middlewares): void * * @param ServerRequestInterface $request * - * @return RouteInterface + * @return Route * * @throws HttpNotFoundException * If the request URI isn't served. @@ -124,7 +124,7 @@ public function addMiddleware(mixed ...$middlewares): void * @throws HttpUnsupportedMediaTypeException * If the client not produces required media types. */ - public function match(ServerRequestInterface $request): RouteInterface + public function match(ServerRequestInterface $request): Route { $allowedMethods = []; @@ -132,7 +132,7 @@ public function match(ServerRequestInterface $request): RouteInterface $path = $route->getPath(); $pattern = $route->getPattern(); if ($pattern === null) { - $pattern = RouteCompiler::compileRoute($path, $route->getConstraints()); + $pattern = RouteCompiler::compileRoute($path, $route->getPatterns()); $route->setPattern($pattern); } @@ -188,9 +188,9 @@ public function run(ServerRequestInterface $request): ResponseInterface /** * @since 3.0.0 */ - public function runRoute(RouteInterface|string $route, ServerRequestInterface $request): ResponseInterface + public function runRoute(Route|string $route, ServerRequestInterface $request): ResponseInterface { - if (! $route instanceof RouteInterface) { + if (! $route instanceof Route) { $route = $this->getRoute($route); } From 50a48a1c3a8584b9b962c8e0a9fbff9f31400c2c Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Mon, 26 Feb 2024 06:20:00 +0100 Subject: [PATCH 101/180] v3 --- src/Annotation/Method.php | 6 +- src/Annotation/Pattern.php | 3 + .../{PathVariable.php => RequestVariable.php} | 2 +- src/Annotation/ResponseStatus.php | 3 +- src/Annotation/Route.php | 21 +- src/Command/RouteListCommand.php | 2 +- src/Dictionary/Charset.php | 2 - src/Dictionary/RequestMethod.php | 29 ++ src/Dictionary/VariablePattern.php | 29 ++ src/Entity/Language/ClientLanguage.php | 1 + src/Exception/HttpException.php | 2 +- src/Helper/FilesystemHelper.php | 40 +- src/Helper/HeaderParser.php | 22 +- src/Helper/RouteBuilder.php | 36 +- src/Helper/RouteParser.php | 3 +- src/Loader/DescriptorLoader.php | 170 ++++--- src/Middleware/CallbackMiddleware.php | 14 +- ...Resolutioner.php => ParameterResolver.php} | 8 +- .../DependencyInjectionParameterResolver.php | 2 +- .../ObjectInjectionParameterResolver.php | 2 +- .../ParameterResolverInterface.php | 2 +- .../RequestBodyParameterResolver.php | 35 +- .../RequestCookieParameterResolver.php | 40 +- .../RequestHeaderParameterResolver.php | 10 +- .../RequestQueryParameterResolver.php | 15 +- .../RequestRouteParameterResolver.php | 7 +- .../RequestStreamParameterResolver.php | 2 +- .../RequestUriParameterResolver.php | 2 +- .../RequestVariableParameterResolver.php} | 23 +- .../RouterParameterResolver.php | 2 +- .../ServerRequestParameterResolver.php | 2 +- .../ParameterResolutionerInterface.php | 67 --- src/ReferenceResolver.php | 42 +- src/ReferenceResolverInterface.php | 60 --- src/RequestHandler/CallbackRequestHandler.php | 14 +- .../QueueableRequestHandler.php | 15 +- ...eResolutioner.php => ResponseResolver.php} | 12 +- .../EmptyResponseResolver.php | 2 +- .../ResponseResolver/JsonResponseResolver.php | 10 +- .../ResponseResolverInterface.php | 2 +- .../RouteResponseResolver.php | 2 +- .../StreamResponseResolver.php | 2 +- .../ResponseResolver/UriResponseResolver.php | 2 +- .../ResponseResolutionerInterface.php | 53 -- src/Route.php | 467 ++++-------------- src/Router.php | 86 ++-- src/RouterBuilder.php | 220 --------- ...lationProxy.php => HydratorErrorProxy.php} | 2 +- ...ationProxy.php => ValidatorErrorProxy.php} | 2 +- 49 files changed, 496 insertions(+), 1101 deletions(-) rename src/Annotation/{PathVariable.php => RequestVariable.php} (95%) create mode 100644 src/Dictionary/RequestMethod.php create mode 100644 src/Dictionary/VariablePattern.php rename src/{ParameterResolving/ParameterResolutioner.php => ParameterResolver.php} (93%) rename src/{ParameterResolving => }/ParameterResolver/DependencyInjectionParameterResolver.php (94%) rename src/{ParameterResolving => }/ParameterResolver/ObjectInjectionParameterResolver.php (94%) rename src/{ParameterResolving => }/ParameterResolver/ParameterResolverInterface.php (91%) rename src/{ParameterResolving => }/ParameterResolver/RequestBodyParameterResolver.php (68%) rename src/{ParameterResolving => }/ParameterResolver/RequestCookieParameterResolver.php (63%) rename src/{ParameterResolving => }/ParameterResolver/RequestHeaderParameterResolver.php (85%) rename src/{ParameterResolving => }/ParameterResolver/RequestQueryParameterResolver.php (83%) rename src/{ParameterResolving => }/ParameterResolver/RequestRouteParameterResolver.php (89%) rename src/{ParameterResolving => }/ParameterResolver/RequestStreamParameterResolver.php (95%) rename src/{ParameterResolving => }/ParameterResolver/RequestUriParameterResolver.php (94%) rename src/{ParameterResolving/ParameterResolver/PathVariableParameterResolver.php => ParameterResolver/RequestVariableParameterResolver.php} (79%) rename src/{ParameterResolving => }/ParameterResolver/RouterParameterResolver.php (95%) rename src/{ParameterResolving => }/ParameterResolver/ServerRequestParameterResolver.php (95%) delete mode 100644 src/ParameterResolving/ParameterResolutionerInterface.php delete mode 100644 src/ReferenceResolverInterface.php rename src/{ResponseResolving/ResponseResolutioner.php => ResponseResolver.php} (89%) rename src/{ResponseResolving => }/ResponseResolver/EmptyResponseResolver.php (95%) rename src/{ResponseResolving => }/ResponseResolver/JsonResponseResolver.php (88%) rename src/{ResponseResolving => }/ResponseResolver/ResponseResolverInterface.php (93%) rename src/{ResponseResolving => }/ResponseResolver/RouteResponseResolver.php (94%) rename src/{ResponseResolving => }/ResponseResolver/StreamResponseResolver.php (95%) rename src/{ResponseResolving => }/ResponseResolver/UriResponseResolver.php (95%) delete mode 100644 src/ResponseResolving/ResponseResolutionerInterface.php delete mode 100644 src/RouterBuilder.php rename src/Validation/ConstraintViolation/{HydratorConstraintViolationProxy.php => HydratorErrorProxy.php} (96%) rename src/Validation/ConstraintViolation/{ValidatorConstraintViolationProxy.php => ValidatorErrorProxy.php} (96%) diff --git a/src/Annotation/Method.php b/src/Annotation/Method.php index 06b6969e..b9769206 100644 --- a/src/Annotation/Method.php +++ b/src/Annotation/Method.php @@ -14,13 +14,15 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Fig\Http\Message\RequestMethodInterface; +use Sunrise\Http\Router\Dictionary\RequestMethod; /** + * Pay attention to the {@see RequestMethod} dictionary. + * * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Method implements RequestMethodInterface +final class Method { public function __construct( public readonly string $value, diff --git a/src/Annotation/Pattern.php b/src/Annotation/Pattern.php index f4ef4d23..74a5d1a7 100644 --- a/src/Annotation/Pattern.php +++ b/src/Annotation/Pattern.php @@ -14,8 +14,11 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; +use Sunrise\Http\Router\Dictionary\VariablePattern; /** + * Pay attention to the {@see VariablePattern} dictionary. + * * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] diff --git a/src/Annotation/PathVariable.php b/src/Annotation/RequestVariable.php similarity index 95% rename from src/Annotation/PathVariable.php rename to src/Annotation/RequestVariable.php index 92d2a4a8..13ccd5a5 100644 --- a/src/Annotation/PathVariable.php +++ b/src/Annotation/RequestVariable.php @@ -19,7 +19,7 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_PARAMETER)] -final class PathVariable +final class RequestVariable { public function __construct( public readonly string|null $name = null, diff --git a/src/Annotation/ResponseStatus.php b/src/Annotation/ResponseStatus.php index e3d4da89..bdccd7ed 100644 --- a/src/Annotation/ResponseStatus.php +++ b/src/Annotation/ResponseStatus.php @@ -14,13 +14,12 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Fig\Http\Message\StatusCodeInterface; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] -final class ResponseStatus implements StatusCodeInterface +final class ResponseStatus { public function __construct( /** @var int<100, 599> */ diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index 586af373..0b177ec1 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -14,11 +14,10 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Fig\Http\Message\RequestMethodInterface; use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] -final class Route implements RequestMethodInterface +final class Route { public mixed $holder; @@ -30,33 +29,27 @@ final class Route implements RequestMethodInterface public function __construct( public string $name, - public string $path = '/', - string|null $method = null, - /** @var list */ - public array $methods = [], + public string $path, /** @var array */ public array $patterns = [], + /** @var list */ + public array $methods = [], /** @var array */ public array $attributes = [], /** @var list */ public array $middlewares = [], - /** @var mixed */ + /** @var list */ public array $constraints = [], /** @var list */ public array $consumes = [], /** @var list */ public array $produces = [], - public string|null $summary = null, - public string|null $description = null, + public string $summary = '', + public string $description = '', /** @var list */ public array $tags = [], public bool $isDeprecated = false, public int $priority = 0, ) { - if (isset($method)) { - $this->methods[] = $method; - } elseif (empty($this->methods)) { - $this->methods[] = self::METHOD_GET; - } } } diff --git a/src/Command/RouteListCommand.php b/src/Command/RouteListCommand.php index 1bc6a72c..317ec46c 100644 --- a/src/Command/RouteListCommand.php +++ b/src/Command/RouteListCommand.php @@ -50,7 +50,7 @@ final protected function execute(InputInterface $input, OutputInterface $output) $table->addRow([ $route->getName(), $route->getPath(), - join(', ', $route->getMethods()), + $route->getMethods() === [] ? 'Any' : join(', ', $route->getMethods()), ]); } diff --git a/src/Dictionary/Charset.php b/src/Dictionary/Charset.php index 24c1baab..35d2f2e1 100644 --- a/src/Dictionary/Charset.php +++ b/src/Dictionary/Charset.php @@ -18,8 +18,6 @@ */ final class Charset { - public const DIGIT = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]; - /** * @link https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.3 */ diff --git a/src/Dictionary/RequestMethod.php b/src/Dictionary/RequestMethod.php new file mode 100644 index 00000000..335af52d --- /dev/null +++ b/src/Dictionary/RequestMethod.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Dictionary; + +/** + * @since 3.0.0 + */ +final class RequestMethod +{ + public const OPTIONS = 'OPTIONS'; + public const HEAD = 'HEAD'; + public const GET = 'GET'; + public const POST = 'POST'; + public const PUT = 'PUT'; + public const PATCH = 'PATCH'; + public const DELETE = 'DELETE'; + public const PURGE = 'PURGE'; +} diff --git a/src/Dictionary/VariablePattern.php b/src/Dictionary/VariablePattern.php new file mode 100644 index 00000000..3f142dcd --- /dev/null +++ b/src/Dictionary/VariablePattern.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Dictionary; + +/** + * @since 3.0.0 + */ +final class VariablePattern +{ + public const ALNUM = '[0-9A-Za-z]+'; + public const ALPHA = '[A-Za-z]+'; + public const DIGIT = '[0-9]+'; + public const LOWER = '[a-z]+'; + public const UPPER = '[A-Z]+'; + public const WORD = '[0-9A-Za-z_]+'; + public const SLUG = '[0-9A-Za-z-]+'; + public const UUID = '[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}'; +} diff --git a/src/Entity/Language/ClientLanguage.php b/src/Entity/Language/ClientLanguage.php index b1b22afd..98bc4ff9 100644 --- a/src/Entity/Language/ClientLanguage.php +++ b/src/Entity/Language/ClientLanguage.php @@ -20,6 +20,7 @@ final class ClientLanguage implements LanguageInterface { public function __construct( private readonly string $code, + // One of the Accept-Language header's identifiers private readonly string $locale, /** @var array */ private readonly array $parameters, diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index ca8c39c3..3b32632d 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -113,7 +113,7 @@ final public function addHeaderField(string $fieldName, Stringable|string ...$fi * * @return static */ - final public function addConstraintViolation(ConstraintViolationInterface ...$constraintViolations): static + final public function addError(ConstraintViolationInterface ...$constraintViolations): static { foreach ($constraintViolations as $constraintViolation) { $this->constraintViolations[] = $constraintViolation; diff --git a/src/Helper/FilesystemHelper.php b/src/Helper/FilesystemHelper.php index 25170f74..9ffff469 100644 --- a/src/Helper/FilesystemHelper.php +++ b/src/Helper/FilesystemHelper.php @@ -24,6 +24,8 @@ use function get_declared_classes; use function is_dir; use function is_file; +use function iterator_to_array; +use function realpath; use function sprintf; /** @@ -45,23 +47,33 @@ public static function getDirClasses(string $dirname): Generator )); } - /** @var iterable $filenames */ - $filenames = new RegexIterator( - new RecursiveIteratorIterator( - new RecursiveDirectoryIterator( - $dirname, - FilesystemIterator::KEY_AS_FILENAME - | FilesystemIterator::CURRENT_AS_PATHNAME - | FilesystemIterator::SKIP_DOTS, + /** @var array $filenames */ + $filenames = iterator_to_array( + new RegexIterator( + new RecursiveIteratorIterator( + new RecursiveDirectoryIterator( + $dirname, + FilesystemIterator::KEY_AS_PATHNAME + | FilesystemIterator::CURRENT_AS_PATHNAME + | FilesystemIterator::SKIP_DOTS, + ), ), - RecursiveIteratorIterator::LEAVES_ONLY, - ), - '/\.php$/', - RegexIterator::MATCH, + '/\.php$/', + ) ); foreach ($filenames as $filename) { - yield from self::getFileClasses($filename); + (static function (string $filename): void { + /** @psalm-suppress UnresolvableInclude */ + require_once $filename; + })($filename); + } + + foreach (get_declared_classes() as $className) { + $classReflection = new ReflectionClass($className); + if (isset($filenames[$classReflection->getFileName()])) { + yield $classReflection; + } } } @@ -79,6 +91,8 @@ public static function getFileClasses(string $filename): Generator )); } + $filename = realpath($filename); + (static function (string $filename): void { /** @psalm-suppress UnresolvableInclude */ require_once $filename; diff --git a/src/Helper/HeaderParser.php b/src/Helper/HeaderParser.php index ac03c831..12b31692 100644 --- a/src/Helper/HeaderParser.php +++ b/src/Helper/HeaderParser.php @@ -18,8 +18,8 @@ use Sunrise\Http\Router\Entity\Language\ClientLanguage; use Sunrise\Http\Router\Entity\MediaType\ClientMediaType; +use function current; use function preg_match; -use function reset; use function trim; use function usort; @@ -35,10 +35,14 @@ public static function parseContentTypeHeader(string $header): ?ClientMediaType return null; } - [$identifier, $parameters] = reset($values); + [$identifier, $parameters] = current($values); if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier, $matches)) { - return new ClientMediaType($matches[1], $matches[2], $parameters); + return new ClientMediaType( + type: $matches[1], + subtype: $matches[2], + parameters: $parameters, + ); } return null; @@ -60,7 +64,11 @@ public static function parseAcceptHeader(string $header): Generator foreach ($values as $index => [$identifier, $parameters]) { if (preg_match('|^([^/]+)/([^/]+)$|', $identifier, $matches)) { - yield $index => new ClientMediaType($matches[1], $matches[2], $parameters); + yield $index => new ClientMediaType( + type: $matches[1], + subtype: $matches[2], + parameters: $parameters, + ); } } } @@ -81,7 +89,11 @@ public static function parseAcceptLanguageHeader(string $header): Generator foreach ($values as $index => [$identifier, $parameters]) { if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches)) { - yield $index => new ClientLanguage($matches[1], $identifier, $parameters); + yield $index => new ClientLanguage( + code: $matches[1], + locale: $identifier, + parameters: $parameters, + ); } } } diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index e705c349..25ccf60e 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -13,12 +13,8 @@ namespace Sunrise\Http\Router\Helper; -use BackedEnum; use InvalidArgumentException; -use Stringable; -use function is_int; -use function is_string; use function sprintf; use function str_replace; use function substr; @@ -29,12 +25,9 @@ final class RouteBuilder { /** - * @param array $values + * @param array $values * - * @throws InvalidArgumentException - * If the route isn't valid; - * or any of the values are unsupported; - * or any of the required values are missing. + * @throws InvalidArgumentException If the route isn't valid or any of the required values are missing. */ public static function buildRoute(string $route, array $values = []): string { @@ -46,26 +39,8 @@ public static function buildRoute(string $route, array $values = []): string $statement = substr($route, $variable['offset'], $variable['length']); if (isset($values[$variable['name']])) { - $value = $values[$variable['name']]; - - if (is_int($value)) { - $value = (string) $value; - } elseif ($value instanceof BackedEnum) { - $value = (string) $value->value; - } elseif ($value instanceof Stringable) { - $value = $value->__toString(); - } - - if (!is_string($value)) { - throw new InvalidArgumentException(sprintf( - 'The route %s could not be built with an unsupported value for the variable %s.', - $route, - $variable['name'], - )); - } - $search[] = $statement; - $replace[] = $value; + $replace[] = $values[$variable['name']]; continue; } @@ -82,6 +57,9 @@ public static function buildRoute(string $route, array $values = []): string )); } - return str_replace([...$search, '(', ')'], $replace, $route); + $search[] = '('; + $search[] = ')'; + + return str_replace($search, $replace, $route); } } diff --git a/src/Helper/RouteParser.php b/src/Helper/RouteParser.php index bd0cefd7..71085d60 100644 --- a/src/Helper/RouteParser.php +++ b/src/Helper/RouteParser.php @@ -207,8 +207,7 @@ public static function parseRoute(string $route): array // https://www.pcre.org/original/doc/html/pcrepattern.html#SEC16 if (($cursor & $inVariableName)) { - /** @psalm-suppress InvalidArrayOffset */ - if (!isset($variables[$variable]['name'][0]) && isset(Charset::DIGIT[$route[$offset]])) { + if (!isset($variables[$variable]['name']) && $route[$offset] >= '0' && $route[$offset] <= '9') { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An invalid character was found at position %d. ' . diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index bc2d3249..f4fe99c1 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -14,12 +14,14 @@ namespace Sunrise\Http\Router\Loader; use Generator; -use InvalidArgumentException; +use LogicException; use Psr\Http\Server\RequestHandlerInterface; +use Psr\SimpleCache\CacheException; use Psr\SimpleCache\CacheInterface; use ReflectionAttribute; use ReflectionClass; use ReflectionMethod; +use SplStack; use Sunrise\Http\Router\Annotation\Attribute; use Sunrise\Http\Router\Annotation\Constraint; use Sunrise\Http\Router\Annotation\Consumes; @@ -38,10 +40,14 @@ use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Route; +use function array_map; use function class_exists; use function is_dir; +use function is_file; use function join; +use function rtrim; use function sprintf; +use function strtoupper; use function usort; final class DescriptorLoader implements LoaderInterface @@ -55,102 +61,116 @@ final class DescriptorLoader implements LoaderInterface public function __construct( private readonly ?CacheInterface $cache = null, - private readonly ?string $cacheKey = null, + private readonly string $cacheKey = self::DEFAULT_CACHE_KEY, ) { } - /** - * @throws InvalidArgumentException If one of the resources isn't valid. - */ public function attach(string ...$resources): void { foreach ($resources as $resource) { - if (is_dir($resource) || class_exists($resource)) { - $this->resources[] = $resource; - continue; - } - - throw new InvalidArgumentException(sprintf( - 'The method %s only accepts class or directory names; ' . - 'however, the resource %s is not one of them.', - __METHOD__, - $resource, - )); + $this->resources[] = $resource; } } /** * @inheritDoc + * + * @throws LogicException If one of the resources isn't supported. + * + * @throws CacheException If something went wrong while working with the cache. */ public function load(): Generator { foreach ($this->getDescriptors() as $descriptor) { - $route = new Route( + yield new Route( $descriptor->name, $descriptor->path, - $descriptor->methods, $descriptor->holder, + $descriptor->patterns, + $descriptor->methods, + $descriptor->attributes, + $descriptor->middlewares, + $descriptor->constraints, + $descriptor->consumes, + $descriptor->produces, + $descriptor->summary, + $descriptor->description, + $descriptor->tags, + $descriptor->isDeprecated, + $descriptor->pattern, ); - - $route->setMiddlewares(...$descriptor->middlewares); - $route->setAttributes($descriptor->attributes); - $route->setConstraints($descriptor->constraints); - $route->setConsumesMediaTypes(...$descriptor->consumes); - $route->setProducesMediaTypes(...$descriptor->produces); - $route->setSummary($descriptor->summary); - $route->setDescription($descriptor->description); - $route->setTags(...$descriptor->tags); - $route->setDeprecation($descriptor->isDeprecated); - $route->setPattern($descriptor->pattern); - - yield $route; } } /** * @return list + * + * @throws LogicException If one of the resources isn't supported. + * + * @throws CacheException If something went wrong while working with the cache. */ private function getDescriptors(): array { - $cacheKey = $this->cacheKey ?? self::DEFAULT_CACHE_KEY; - - if (isset($this->cache) && $this->cache->has($cacheKey)) { - /** @var list */ - return $this->cache->get($cacheKey); + /** @var list|null $descriptors */ + $descriptors = $this->cache?->get($this->cacheKey); + if (isset($descriptors)) { + return $descriptors; } - $result = []; + $descriptors = []; foreach ($this->resources as $resource) { foreach ($this->getResourceDescriptors($resource) as $descriptor) { $descriptor->path = join($descriptor->prefixes) . $descriptor->path; + $descriptor->methods = array_map(strtoupper(...), $descriptor->methods); $descriptor->pattern = RouteCompiler::compileRoute($descriptor->path, $descriptor->patterns); - $result[] = $descriptor; + $descriptors[] = $descriptor; } } - usort($result, static fn(Descriptor $a, Descriptor $b): int => $b->priority <=> $a->priority); + usort($descriptors, static fn(Descriptor $a, Descriptor $b): int => $b->priority <=> $a->priority); - if (isset($this->cache)) { - $this->cache->set($cacheKey, $result); - } + $this->cache?->set($this->cacheKey, $descriptors); - return $result; + return $descriptors; } /** * @return Generator + * + * @throws LogicException If the resource isn't supported. */ private function getResourceDescriptors(string $resource): Generator { - if (class_exists($resource)) { - return yield from $this->getClassDescriptors(new ReflectionClass($resource)); - } - if (is_dir($resource)) { foreach (FilesystemHelper::getDirClasses($resource) as $class) { yield from $this->getClassDescriptors($class); } + + return; + } + + if (is_file($resource)) { + foreach (FilesystemHelper::getFileClasses($resource) as $class) { + yield from $this->getClassDescriptors($class); + } + + return; + } + + if (class_exists($resource)) { + yield from $this->getClassDescriptors( + new ReflectionClass($resource) + ); + + return; } + + throw new LogicException(sprintf( + 'The loader %s only accepts directory, file or class names; ' . + 'however, the resource %s is not one of them.', + __CLASS__, + $resource, + )); } /** @@ -174,10 +194,8 @@ private function getClassDescriptors(ReflectionClass $class): Generator } } - $methods = $class->getMethods(ReflectionMethod::IS_PUBLIC); - foreach ($methods as $method) { - // Static methods aren't supported... - if ($method->isStatic()) { + foreach ($class->getMethods() as $method) { + if (!$method->isPublic() || $method->isStatic()) { continue; } @@ -194,11 +212,12 @@ private function getClassDescriptors(ReflectionClass $class): Generator } } - private function supplementDescriptorFromParentClasses(Descriptor $descriptor, ReflectionClass $child): void + private function supplementDescriptorFromParentClasses(Descriptor $descriptor, ReflectionClass $class): void { - $parents = []; - while ($child = $child->getParentClass()) { - $parents = [$child, ...$parents]; + /** @var SplStack $parents */ + $parents = new SplStack(); + while ($class = $class->getParentClass()) { + $parents->push($class); } foreach ($parents as $parent) { @@ -207,96 +226,95 @@ private function supplementDescriptorFromParentClasses(Descriptor $descriptor, R } // phpcs:ignore Generic.Files.LineLength - private function supplementDescriptorFromClassOrMethod(Descriptor $descriptor, ReflectionClass|ReflectionMethod $holder): void + private function supplementDescriptorFromClassOrMethod(Descriptor $descriptor, ReflectionClass|ReflectionMethod $classOrMethod): void { /** @var list> $annotations */ - $annotations = $holder->getAttributes(Prefix::class); + $annotations = $classOrMethod->getAttributes(Prefix::class); if (isset($annotations[0])) { $annotation = $annotations[0]->newInstance(); - $descriptor->prefixes[] = $annotation->value; + // https://github.com/sunrise-php/http-router/issues/26 + $descriptor->prefixes[] = rtrim($annotation->value, '/'); } /** @var list> $annotations */ - $annotations = $holder->getAttributes(Postfix::class); + $annotations = $classOrMethod->getAttributes(Postfix::class); if (isset($annotations[0])) { $annotation = $annotations[0]->newInstance(); $descriptor->path .= $annotation->value; } - /** @var list> $annotations */ - $annotations = $holder->getAttributes(Method::class); + /** @var list> $annotations */ + $annotations = $classOrMethod->getAttributes(Pattern::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->methods[] = $annotation->value; + $descriptor->patterns[$annotation->name] = $annotation->value; } - /** @var list> $annotations */ - $annotations = $holder->getAttributes(Pattern::class); + /** @var list> $annotations */ + $annotations = $classOrMethod->getAttributes(Method::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->patterns[$annotation->name] = $annotation->value; + $descriptor->methods[] = $annotation->value; } /** @var list> $annotations */ - $annotations = $holder->getAttributes(Attribute::class); + $annotations = $classOrMethod->getAttributes(Attribute::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); $descriptor->attributes[$annotation->name] = $annotation->value; } /** @var list> $annotations */ - $annotations = $holder->getAttributes(Middleware::class); + $annotations = $classOrMethod->getAttributes(Middleware::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); $descriptor->middlewares[] = $annotation->value; } /** @var list> $annotations */ - $annotations = $holder->getAttributes(Constraint::class); + $annotations = $classOrMethod->getAttributes(Constraint::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); $descriptor->constraints[] = $annotation->value; } /** @var list> $annotations */ - $annotations = $holder->getAttributes(Consumes::class); + $annotations = $classOrMethod->getAttributes(Consumes::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); $descriptor->consumes[] = $annotation->value; } /** @var list> $annotations */ - $annotations = $holder->getAttributes(Produces::class); + $annotations = $classOrMethod->getAttributes(Produces::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); $descriptor->produces[] = $annotation->value; } /** @var list> $annotations */ - $annotations = $holder->getAttributes(Summary::class); + $annotations = $classOrMethod->getAttributes(Summary::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->summary ??= ''; $descriptor->summary .= $annotation->value; } /** @var list> $annotations */ - $annotations = $holder->getAttributes(Description::class); + $annotations = $classOrMethod->getAttributes(Description::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->description ??= ''; $descriptor->description .= $annotation->value; } /** @var list> $annotations */ - $annotations = $holder->getAttributes(Tag::class); + $annotations = $classOrMethod->getAttributes(Tag::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); $descriptor->tags[] = $annotation->value; } /** @var list> $annotations */ - $annotations = $holder->getAttributes(Deprecated::class); + $annotations = $classOrMethod->getAttributes(Deprecated::class); if (isset($annotations[0])) { $descriptor->isDeprecated = true; } diff --git a/src/Middleware/CallbackMiddleware.php b/src/Middleware/CallbackMiddleware.php index 93089973..176f1b8a 100644 --- a/src/Middleware/CallbackMiddleware.php +++ b/src/Middleware/CallbackMiddleware.php @@ -19,9 +19,9 @@ use Psr\Http\Server\RequestHandlerInterface; use ReflectionFunction; use ReflectionMethod; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; -use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ObjectInjectionParameterResolver; -use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; +use Sunrise\Http\Router\ParameterResolver; +use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; +use Sunrise\Http\Router\ResponseResolver; /** * @since 3.0.0 @@ -36,8 +36,8 @@ final class CallbackMiddleware implements MiddlewareInterface public function __construct( callable $callback, private readonly ReflectionFunction|ReflectionMethod $callbackReflection, - private readonly ParameterResolutionerInterface $parameterResolutioner, - private readonly ResponseResolutionerInterface $responseResolutioner, + private readonly ParameterResolver $parameterResolver, + private readonly ResponseResolver $responseResolver, ) { $this->callback = $callback; } @@ -47,7 +47,7 @@ public function __construct( */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - $arguments = $this->parameterResolutioner + $arguments = $this->parameterResolver ->withContext($request) ->withPriorityResolver( new ObjectInjectionParameterResolver($request), @@ -56,6 +56,6 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface ->resolveParameters(...$this->callbackReflection->getParameters()); // phpcs:ignore Generic.Files.LineLength - return $this->responseResolutioner->resolveResponse($request, ($this->callback)(...$arguments), $this->callbackReflection); + return $this->responseResolver->resolveResponse($request, ($this->callback)(...$arguments), $this->callbackReflection); } } diff --git a/src/ParameterResolving/ParameterResolutioner.php b/src/ParameterResolver.php similarity index 93% rename from src/ParameterResolving/ParameterResolutioner.php rename to src/ParameterResolver.php index 4a7e3356..600cdb50 100644 --- a/src/ParameterResolving/ParameterResolutioner.php +++ b/src/ParameterResolver.php @@ -11,22 +11,20 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolving; +namespace Sunrise\Http\Router; use Generator; use LogicException; use ReflectionMethod; use ReflectionParameter; -use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ParameterResolverInterface; +use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; use function sprintf; /** - * ParameterResolutioner - * * @since 3.0.0 */ -final class ParameterResolutioner implements ParameterResolutionerInterface +final class ParameterResolver { /** diff --git a/src/ParameterResolving/ParameterResolver/DependencyInjectionParameterResolver.php b/src/ParameterResolver/DependencyInjectionParameterResolver.php similarity index 94% rename from src/ParameterResolving/ParameterResolver/DependencyInjectionParameterResolver.php rename to src/ParameterResolver/DependencyInjectionParameterResolver.php index 252b837d..ba6db34d 100644 --- a/src/ParameterResolving/ParameterResolver/DependencyInjectionParameterResolver.php +++ b/src/ParameterResolver/DependencyInjectionParameterResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolver; use Generator; use Psr\Container\ContainerInterface; diff --git a/src/ParameterResolving/ParameterResolver/ObjectInjectionParameterResolver.php b/src/ParameterResolver/ObjectInjectionParameterResolver.php similarity index 94% rename from src/ParameterResolving/ParameterResolver/ObjectInjectionParameterResolver.php rename to src/ParameterResolver/ObjectInjectionParameterResolver.php index f7692281..ecd89506 100644 --- a/src/ParameterResolving/ParameterResolver/ObjectInjectionParameterResolver.php +++ b/src/ParameterResolver/ObjectInjectionParameterResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolver; use Generator; use ReflectionNamedType; diff --git a/src/ParameterResolving/ParameterResolver/ParameterResolverInterface.php b/src/ParameterResolver/ParameterResolverInterface.php similarity index 91% rename from src/ParameterResolving/ParameterResolver/ParameterResolverInterface.php rename to src/ParameterResolver/ParameterResolverInterface.php index 05989698..b7ec1e65 100644 --- a/src/ParameterResolving/ParameterResolver/ParameterResolverInterface.php +++ b/src/ParameterResolver/ParameterResolverInterface.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolver; use Generator; use ReflectionParameter; diff --git a/src/ParameterResolving/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php similarity index 68% rename from src/ParameterResolving/ParameterResolver/RequestBodyParameterResolver.php rename to src/ParameterResolver/RequestBodyParameterResolver.php index 84a46139..64fbd56b 100644 --- a/src/ParameterResolving/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolver; use Generator; use LogicException; @@ -20,18 +20,17 @@ use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestBody; use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; +use Sunrise\Http\Router\ParameterResolver; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorErrorProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorErrorProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; +use function count; use function sprintf; /** - * RequestBodyParameterResolver - * * @link https://github.com/sunrise-php/hydrator * @link https://github.com/symfony/validator * @@ -39,16 +38,9 @@ */ final class RequestBodyParameterResolver implements ParameterResolverInterface { - - /** - * Constructor of the class - * - * @param HydratorInterface $hydrator - * @param ValidatorInterface|null $validator - */ public function __construct( - private HydratorInterface $hydrator, - private ?ValidatorInterface $validator = null, + private readonly HydratorInterface $hydrator, + private readonly ?ValidatorInterface $validator = null, ) { } @@ -69,7 +61,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { throw new LogicException(sprintf( 'To use the #[RequestBody] attribute, the parameter {%s} must be typed with an object.', - ParameterResolutioner::stringifyParameter($parameter), + ParameterResolver::stringifyParameter($parameter), )); } @@ -83,15 +75,12 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $object = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidDataException $e) { throw (new HttpUnprocessableEntityException) - ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); + ->addError(...HydratorErrorProxy::create(...$e->getExceptions())); } - if (isset($this->validator)) { - $violations = $this->validator->validate($object); - if ($violations->count() > 0) { - throw (new HttpUnprocessableEntityException) - ->addConstraintViolation(...ValidatorConstraintViolationProxy::create(...$violations)); - } + if (count($violations = $this->validator?->validate($object) ?? []) > 0) { + throw (new HttpUnprocessableEntityException) + ->addError(...ValidatorErrorProxy::create(...$violations)); } yield $object; diff --git a/src/ParameterResolving/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php similarity index 63% rename from src/ParameterResolving/ParameterResolver/RequestCookieParameterResolver.php rename to src/ParameterResolver/RequestCookieParameterResolver.php index 073feddf..8a56443d 100644 --- a/src/ParameterResolving/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -11,20 +11,25 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolver; use Generator; use LogicException; use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionParameter; +use Sunrise\Http\Router\Annotation\Constraint; use Sunrise\Http\Router\Annotation\RequestCookie; use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorErrorProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorErrorProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; use Sunrise\Hydrator\Type; +use Symfony\Component\Validator\Validator\ValidatorInterface; + +use function count; /** * RequestCookieParameterResolver @@ -38,9 +43,12 @@ final class RequestCookieParameterResolver implements ParameterResolverInterface * Constructor of the class * * @param HydratorInterface $hydrator + * @param ValidatorInterface|null $validator */ - public function __construct(private HydratorInterface $hydrator) - { + public function __construct( + private readonly HydratorInterface $hydrator, + private readonly ?ValidatorInterface $validator = null, + ) { } /** @@ -60,7 +68,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (! $context instanceof ServerRequestInterface) { throw new LogicException( - 'At this level of the application, any operations with the request are not possible.' + 'At this level of the application, any operations with the request are not possible.', ); } @@ -78,17 +86,33 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } try { - yield $this->hydrator->castValue( + $value = $this->hydrator->castValue( $cookies[$attribute->name], Type::fromParameter($parameter), path: [$attribute->name], ); } catch (InvalidDataException $e) { throw (new HttpBadRequestException(previous: $e)) - ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); + ->addError(...HydratorErrorProxy::create(...$e->getExceptions())); } catch (InvalidValueException $e) { throw (new HttpBadRequestException(previous: $e)) - ->addConstraintViolation(...HydratorConstraintViolationProxy::create($e)); + ->addError(...HydratorErrorProxy::create($e)); + } + + $constraints = []; + /** @var ReflectionAttribute $attribute */ + foreach ($parameter->getAttributes(Constraint::class) as $attribute) { + $attribute = $attribute->newInstance(); + if ($attribute->value instanceof \Symfony\Component\Validator\Constraint) { + $constraints[] = $attribute->value; + } + } + + if (count($constraints) > 0 && count($violations = $this->validator?->validate($value, $constraints) ?? []) > 0) { + throw (new HttpBadRequestException()) + ->addError(...ValidatorErrorProxy::create(...$violations)); } + + yield $value; } } diff --git a/src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php similarity index 85% rename from src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php rename to src/ParameterResolver/RequestHeaderParameterResolver.php index 6ceaab58..747b3b4e 100644 --- a/src/ParameterResolving/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolver; use Generator; use LogicException; @@ -20,7 +20,7 @@ use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestHeader; use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorErrorProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; @@ -52,7 +52,7 @@ public function __construct(private HydratorInterface $hydrator) */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - /** @var list> $attributes */ + /** @var ReflectionAttribute $attributes */ $attributes = $parameter->getAttributes(RequestHeader::class); if ($attributes === []) { return; @@ -84,10 +84,10 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } catch (InvalidDataException $e) { throw (new HttpBadRequestException(previous: $e)) - ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); + ->addError(...HydratorErrorProxy::create(...$e->getExceptions())); } catch (InvalidValueException $e) { throw (new HttpBadRequestException(previous: $e)) - ->addConstraintViolation(...HydratorConstraintViolationProxy::create($e)); + ->addError(...HydratorErrorProxy::create($e)); } } } diff --git a/src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php similarity index 83% rename from src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php rename to src/ParameterResolver/RequestQueryParameterResolver.php index f52fc78b..0af1d9fb 100644 --- a/src/ParameterResolving/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolver; use Generator; use LogicException; @@ -20,13 +20,12 @@ use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestQuery; use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; +use Sunrise\Http\Router\ParameterResolver; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorErrorProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorErrorProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; - use function sprintf; /** @@ -69,7 +68,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { throw new LogicException(sprintf( 'To use the #[RequestQuery] attribute, the parameter {%s} must be typed with an object.', - ParameterResolutioner::stringifyParameter($parameter), + ParameterResolver::stringifyParameter($parameter), )); } @@ -83,14 +82,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $object = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { throw (new HttpUnprocessableEntityException) - ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); + ->addError(...HydratorErrorProxy::create(...$e->getExceptions())); } if (isset($this->validator)) { $violations = $this->validator->validate($object); if ($violations->count() > 0) { throw (new HttpUnprocessableEntityException) - ->addConstraintViolation(...ValidatorConstraintViolationProxy::create(...$violations)); + ->addError(...ValidatorErrorProxy::create(...$violations)); } } diff --git a/src/ParameterResolving/ParameterResolver/RequestRouteParameterResolver.php b/src/ParameterResolver/RequestRouteParameterResolver.php similarity index 89% rename from src/ParameterResolving/ParameterResolver/RequestRouteParameterResolver.php rename to src/ParameterResolver/RequestRouteParameterResolver.php index 06d60b3e..412d5681 100644 --- a/src/ParameterResolving/ParameterResolver/RequestRouteParameterResolver.php +++ b/src/ParameterResolver/RequestRouteParameterResolver.php @@ -11,16 +11,15 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolver; use Generator; use LogicException; use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; +use Sunrise\Http\Router\ParameterResolver; use Sunrise\Http\Router\Route; - use function sprintf; /** @@ -55,7 +54,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) throw new LogicException(sprintf( 'At this level of the application, the current request does not contain a route. ' . 'To suppress this error, the parameter {%s} should be nullable.', - ParameterResolutioner::stringifyParameter($parameter), + ParameterResolver::stringifyParameter($parameter), )); } diff --git a/src/ParameterResolving/ParameterResolver/RequestStreamParameterResolver.php b/src/ParameterResolver/RequestStreamParameterResolver.php similarity index 95% rename from src/ParameterResolving/ParameterResolver/RequestStreamParameterResolver.php rename to src/ParameterResolver/RequestStreamParameterResolver.php index 97bb8c7a..b963f30b 100644 --- a/src/ParameterResolving/ParameterResolver/RequestStreamParameterResolver.php +++ b/src/ParameterResolver/RequestStreamParameterResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolver; use Generator; use LogicException; diff --git a/src/ParameterResolving/ParameterResolver/RequestUriParameterResolver.php b/src/ParameterResolver/RequestUriParameterResolver.php similarity index 94% rename from src/ParameterResolving/ParameterResolver/RequestUriParameterResolver.php rename to src/ParameterResolver/RequestUriParameterResolver.php index 73edb212..b4447576 100644 --- a/src/ParameterResolving/ParameterResolver/RequestUriParameterResolver.php +++ b/src/ParameterResolver/RequestUriParameterResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolver; use Generator; use LogicException; diff --git a/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php similarity index 79% rename from src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php rename to src/ParameterResolver/RequestVariableParameterResolver.php index 20bfc190..769fa805 100644 --- a/src/ParameterResolving/ParameterResolver/PathVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -11,23 +11,22 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolver; use Generator; use LogicException; use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionParameter; -use Sunrise\Http\Router\Annotation\PathVariable; +use Sunrise\Http\Router\Annotation\RequestVariable; use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; +use Sunrise\Http\Router\ParameterResolver; use Sunrise\Http\Router\Route; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorErrorProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; use Sunrise\Hydrator\Type; - use function sprintf; /** @@ -35,7 +34,7 @@ * * @since 3.0.0 */ -final class PathVariableParameterResolver implements ParameterResolverInterface +final class RequestVariableParameterResolver implements ParameterResolverInterface { /** @@ -56,8 +55,8 @@ public function __construct(private HydratorInterface $hydrator) */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - /** @var list> $attributes */ - $attributes = $parameter->getAttributes(PathVariable::class); + /** @var ReflectionAttribute $attributes */ + $attributes = $parameter->getAttributes(RequestVariable::class); if ($attributes === []) { return; } @@ -74,7 +73,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) 'The #[PathVariable] attribute cannot be applied to the parameter {%s}, ' . 'because the request does not contain information about the requested route, ' . 'at least at this level of the application.', - ParameterResolutioner::stringifyParameter($parameter), + ParameterResolver::stringifyParameter($parameter), )); } @@ -94,7 +93,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) 'The parameter {%1$s} expects the value of the variable {%3$s} from the route "%2$s", ' . 'which is not present in the request, most likely, because the variable is optional. ' . 'To resolve this issue, make this parameter nullable or assign it a default value.', - ParameterResolutioner::stringifyParameter($parameter), + ParameterResolver::stringifyParameter($parameter), $route->getName(), $variableName, )); @@ -108,10 +107,10 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } catch (InvalidDataException $e) { throw (new HttpNotFoundException(previous: $e)) - ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); + ->addError(...HydratorErrorProxy::create(...$e->getExceptions())); } catch (InvalidValueException $e) { throw (new HttpNotFoundException(previous: $e)) - ->addConstraintViolation(...HydratorConstraintViolationProxy::create($e)); + ->addError(...HydratorErrorProxy::create($e)); } } } diff --git a/src/ParameterResolving/ParameterResolver/RouterParameterResolver.php b/src/ParameterResolver/RouterParameterResolver.php similarity index 95% rename from src/ParameterResolving/ParameterResolver/RouterParameterResolver.php rename to src/ParameterResolver/RouterParameterResolver.php index a58cfb86..a77cc23b 100644 --- a/src/ParameterResolving/ParameterResolver/RouterParameterResolver.php +++ b/src/ParameterResolver/RouterParameterResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolver; use Generator; use LogicException; diff --git a/src/ParameterResolving/ParameterResolver/ServerRequestParameterResolver.php b/src/ParameterResolver/ServerRequestParameterResolver.php similarity index 95% rename from src/ParameterResolving/ParameterResolver/ServerRequestParameterResolver.php rename to src/ParameterResolver/ServerRequestParameterResolver.php index 73a205b6..36b4c22b 100644 --- a/src/ParameterResolving/ParameterResolver/ServerRequestParameterResolver.php +++ b/src/ParameterResolver/ServerRequestParameterResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolving\ParameterResolver; +namespace Sunrise\Http\Router\ParameterResolver; use Generator; use LogicException; diff --git a/src/ParameterResolving/ParameterResolutionerInterface.php b/src/ParameterResolving/ParameterResolutionerInterface.php deleted file mode 100644 index 97a0a1a6..00000000 --- a/src/ParameterResolving/ParameterResolutionerInterface.php +++ /dev/null @@ -1,67 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ParameterResolving; - -use Generator; -use ReflectionParameter; -use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ParameterResolverInterface; - -/** - * ParameterResolutionerInterface - * - * @since 3.0.0 - */ -interface ParameterResolutionerInterface -{ - - /** - * Creates a new instance of the resolutioner with the given context - * - * Please note that this method MUST NOT change the object state. - * - * @param mixed $context - * - * @return static - */ - public function withContext(mixed $context): static; - - /** - * Creates a new instance of the resolutioner with the given priority parameter resolver(s) - * - * Please note that this method MUST NOT change the object state. - * - * @param ParameterResolverInterface ...$resolvers - * - * @return static - */ - public function withPriorityResolver(ParameterResolverInterface ...$resolvers): static; - - /** - * Adds the given parameter resolver(s) to the resolutioner - * - * @param ParameterResolverInterface ...$resolvers - * - * @return void - */ - public function addResolver(ParameterResolverInterface ...$resolvers): void; - - /** - * Resolves the given parameter(s) to arguments - * - * @param ReflectionParameter ...$parameters - * - * @return Generator List of ready-to-pass arguments. - */ - public function resolveParameters(ReflectionParameter ...$parameters): Generator; -} diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index e797c0c5..a3e31dbe 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router; use Closure; -use Generator; use LogicException; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; @@ -22,9 +21,7 @@ use ReflectionFunction; use ReflectionMethod; use Sunrise\Http\Router\Middleware\CallbackMiddleware; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; -use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; use function class_exists; use function get_debug_type; @@ -35,11 +32,9 @@ use function sprintf; /** - * ReferenceResolver - * * @since 2.10.0 */ -final class ReferenceResolver implements ReferenceResolverInterface +final class ReferenceResolver { /** * @var array @@ -47,8 +42,8 @@ final class ReferenceResolver implements ReferenceResolverInterface private array $resolvedClasses = []; public function __construct( - private readonly ParameterResolutionerInterface $parameterResolutioner, - private readonly ResponseResolutionerInterface $responseResolutioner, + private readonly ParameterResolver $parameterResolver, + private readonly ResponseResolver $responseResolver, ) { } @@ -67,8 +62,8 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface return new CallbackRequestHandler( $reference, new ReflectionFunction($reference), - $this->parameterResolutioner, - $this->responseResolutioner, + $this->parameterResolver, + $this->responseResolver, ); } @@ -84,8 +79,8 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface return new CallbackRequestHandler( $reference, new ReflectionMethod($reference[0], $reference[1]), - $this->parameterResolutioner, - $this->responseResolutioner, + $this->parameterResolver, + $this->responseResolver, ); } } @@ -115,8 +110,8 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface return new CallbackMiddleware( $reference, new ReflectionFunction($reference), - $this->parameterResolutioner, - $this->responseResolutioner, + $this->parameterResolver, + $this->responseResolver, ); } @@ -136,8 +131,8 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface return new CallbackMiddleware( $reference, new ReflectionMethod($reference[0], $reference[1]), - $this->parameterResolutioner, - $this->responseResolutioner, + $this->parameterResolver, + $this->responseResolver, ); } } @@ -148,19 +143,6 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface )); } - /** - * @inheritDoc - * - * @throws LogicException If one of the references couldn't be resolved. - */ - public function resolveMiddlewares(array $references): Generator - { - /** @psalm-suppress MixedAssignment */ - foreach ($references as $reference) { - yield $this->resolveMiddleware($reference); - } - } - /** * Resolves the given named class * @@ -191,7 +173,7 @@ private function resolveClass(string $fqn): object $arguments = []; $constructor = $class->getConstructor(); if ($constructor?->getNumberOfParameters()) { - $arguments = $this->parameterResolutioner->resolveParameters(...$constructor->getParameters()); + $arguments = $this->parameterResolver->resolveParameters(...$constructor->getParameters()); } /** @var T */ diff --git a/src/ReferenceResolverInterface.php b/src/ReferenceResolverInterface.php deleted file mode 100644 index 904b1423..00000000 --- a/src/ReferenceResolverInterface.php +++ /dev/null @@ -1,60 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -use Generator; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; - -/** - * ReferenceResolverInterface - * - * @since 2.10.0 - */ -interface ReferenceResolverInterface -{ - - /** - * Resolves the given reference to a request handler - * - * @param mixed $reference - * - * @return RequestHandlerInterface - * - * @since 3.0.0 - */ - public function resolveRequestHandler(mixed $reference): RequestHandlerInterface; - - /** - * Resolves the given reference to a middleware - * - * @param mixed $reference - * - * @return MiddlewareInterface - * - * @since 3.0.0 - */ - public function resolveMiddleware(mixed $reference): MiddlewareInterface; - - /** - * Resolves the given references to middlewares - * - * @param array $references - * - * @return Generator - * - * @since 3.0.0 - */ - public function resolveMiddlewares(array $references): Generator; -} diff --git a/src/RequestHandler/CallbackRequestHandler.php b/src/RequestHandler/CallbackRequestHandler.php index 304b1f3a..7443cc34 100644 --- a/src/RequestHandler/CallbackRequestHandler.php +++ b/src/RequestHandler/CallbackRequestHandler.php @@ -18,9 +18,9 @@ use Psr\Http\Server\RequestHandlerInterface; use ReflectionFunction; use ReflectionMethod; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; -use Sunrise\Http\Router\ParameterResolving\ParameterResolver\ObjectInjectionParameterResolver; -use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; +use Sunrise\Http\Router\ParameterResolver; +use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; +use Sunrise\Http\Router\ResponseResolver; /** * @since 3.0.0 @@ -35,8 +35,8 @@ final class CallbackRequestHandler implements RequestHandlerInterface public function __construct( callable $callback, private readonly ReflectionFunction|ReflectionMethod $callbackReflection, - private readonly ParameterResolutionerInterface $parameterResolutioner, - private readonly ResponseResolutionerInterface $responseResolutioner, + private readonly ParameterResolver $parameterResolver, + private readonly ResponseResolver $responseResolver, ) { $this->callback = $callback; } @@ -56,7 +56,7 @@ public function getCallbackReflection(): ReflectionFunction|ReflectionMethod */ public function handle(ServerRequestInterface $request): ResponseInterface { - $arguments = $this->parameterResolutioner + $arguments = $this->parameterResolver ->withContext($request) ->withPriorityResolver( new ObjectInjectionParameterResolver($request), @@ -64,6 +64,6 @@ public function handle(ServerRequestInterface $request): ResponseInterface ->resolveParameters(...$this->callbackReflection->getParameters()); // phpcs:ignore Generic.Files.LineLength - return $this->responseResolutioner->resolveResponse($request, ($this->callback)(...$arguments), $this->callbackReflection); + return $this->responseResolver->resolveResponse($request, ($this->callback)(...$arguments), $this->callbackReflection); } } diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index c591ba60..b90416c3 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -24,16 +24,9 @@ */ final class QueueableRequestHandler extends SplQueue implements RequestHandlerInterface { - /** - * @param array $middlewares - */ public function __construct( - private readonly RequestHandlerInterface $requestHandler, - array $middlewares, + private readonly RequestHandlerInterface $endpoint, ) { - foreach ($middlewares as $middleware) { - $this->enqueue($middleware); - } } /** @@ -41,8 +34,8 @@ public function __construct( */ public function handle(ServerRequestInterface $request): ResponseInterface { - return ! $this->isEmpty() ? - ($clone = clone $this)->dequeue()->process($request, $clone) : - $this->requestHandler->handle($request); + return $this->isEmpty() ? + $this->endpoint->handle($request) : + ($queue = clone $this)->dequeue()->process($request, $queue); } } diff --git a/src/ResponseResolving/ResponseResolutioner.php b/src/ResponseResolver.php similarity index 89% rename from src/ResponseResolving/ResponseResolutioner.php rename to src/ResponseResolver.php index e3686b33..e12ccbc5 100644 --- a/src/ResponseResolving/ResponseResolutioner.php +++ b/src/ResponseResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ResponseResolving; +namespace Sunrise\Http\Router; use LogicException; use Psr\Http\Message\ResponseInterface; @@ -21,16 +21,14 @@ use ReflectionMethod; use Sunrise\Http\Router\Annotation\ResponseHeader; use Sunrise\Http\Router\Annotation\ResponseStatus; -use Sunrise\Http\Router\ResponseResolving\ResponseResolver\ResponseResolverInterface; +use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; use function sprintf; /** - * ResponseResolutioner - * * @since 3.0.0 */ -final class ResponseResolutioner implements ResponseResolutionerInterface +final class ResponseResolver { /** @@ -89,14 +87,14 @@ private function handleResponse( ResponseInterface $response, ReflectionFunction|ReflectionMethod $responder, ) : ResponseInterface { - /** @var list> $attributes */ + /** @var ReflectionAttribute $attributes */ $attributes = $responder->getAttributes(ResponseStatus::class); if (isset($attributes[0])) { $status = $attributes[0]->newInstance(); $response = $response->withStatus($status->code, $status->phrase); } - /** @var list> $attributes */ + /** @var ReflectionAttribute $attributes */ $attributes = $responder->getAttributes(ResponseHeader::class); foreach ($attributes as $attribute) { $header = $attribute->newInstance(); diff --git a/src/ResponseResolving/ResponseResolver/EmptyResponseResolver.php b/src/ResponseResolver/EmptyResponseResolver.php similarity index 95% rename from src/ResponseResolving/ResponseResolver/EmptyResponseResolver.php rename to src/ResponseResolver/EmptyResponseResolver.php index 921858af..130bd7d7 100644 --- a/src/ResponseResolving/ResponseResolver/EmptyResponseResolver.php +++ b/src/ResponseResolver/EmptyResponseResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ResponseResolving\ResponseResolver; +namespace Sunrise\Http\Router\ResponseResolver; use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; diff --git a/src/ResponseResolving/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php similarity index 88% rename from src/ResponseResolving/ResponseResolver/JsonResponseResolver.php rename to src/ResponseResolver/JsonResponseResolver.php index c061c9cf..0f2cee6a 100644 --- a/src/ResponseResolving/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ResponseResolving\ResponseResolver; +namespace Sunrise\Http\Router\ResponseResolver; use JsonException; use LogicException; @@ -22,11 +22,9 @@ use ReflectionFunction; use ReflectionMethod; use Sunrise\Http\Router\Annotation\JsonResponse; -use Sunrise\Http\Router\ResponseResolving\ResponseResolutioner; - +use Sunrise\Http\Router\ResponseResolver; use function json_encode; use function sprintf; - use const JSON_THROW_ON_ERROR; /** @@ -54,7 +52,7 @@ public function resolveResponse( mixed $response, ReflectionFunction|ReflectionMethod $responder, ) : ?ResponseInterface { - /** @var list> $attributes */ + /** @var ReflectionAttribute $attributes */ $attributes = $responder->getAttributes(JsonResponse::class); if ($attributes === []) { return null; @@ -72,7 +70,7 @@ public function resolveResponse( } catch (JsonException $e) { throw new LogicException(sprintf( 'The responder {%s} returned a response that could not be encoded to JSON due to: %s', - ResponseResolutioner::stringifyResponder($responder), + ResponseResolver::stringifyResponder($responder), $e->getMessage(), )); } diff --git a/src/ResponseResolving/ResponseResolver/ResponseResolverInterface.php b/src/ResponseResolver/ResponseResolverInterface.php similarity index 93% rename from src/ResponseResolving/ResponseResolver/ResponseResolverInterface.php rename to src/ResponseResolver/ResponseResolverInterface.php index 01986c88..65b42b55 100644 --- a/src/ResponseResolving/ResponseResolver/ResponseResolverInterface.php +++ b/src/ResponseResolver/ResponseResolverInterface.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ResponseResolving\ResponseResolver; +namespace Sunrise\Http\Router\ResponseResolver; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; diff --git a/src/ResponseResolving/ResponseResolver/RouteResponseResolver.php b/src/ResponseResolver/RouteResponseResolver.php similarity index 94% rename from src/ResponseResolving/ResponseResolver/RouteResponseResolver.php rename to src/ResponseResolver/RouteResponseResolver.php index 79cfea3c..75984223 100644 --- a/src/ResponseResolving/ResponseResolver/RouteResponseResolver.php +++ b/src/ResponseResolver/RouteResponseResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ResponseResolving\ResponseResolver; +namespace Sunrise\Http\Router\ResponseResolver; use LogicException; use Psr\Http\Message\ResponseInterface; diff --git a/src/ResponseResolving/ResponseResolver/StreamResponseResolver.php b/src/ResponseResolver/StreamResponseResolver.php similarity index 95% rename from src/ResponseResolving/ResponseResolver/StreamResponseResolver.php rename to src/ResponseResolver/StreamResponseResolver.php index 175b1a65..6aa271ad 100644 --- a/src/ResponseResolving/ResponseResolver/StreamResponseResolver.php +++ b/src/ResponseResolver/StreamResponseResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ResponseResolving\ResponseResolver; +namespace Sunrise\Http\Router\ResponseResolver; use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; diff --git a/src/ResponseResolving/ResponseResolver/UriResponseResolver.php b/src/ResponseResolver/UriResponseResolver.php similarity index 95% rename from src/ResponseResolving/ResponseResolver/UriResponseResolver.php rename to src/ResponseResolver/UriResponseResolver.php index a097088c..87dfe6ea 100644 --- a/src/ResponseResolving/ResponseResolver/UriResponseResolver.php +++ b/src/ResponseResolver/UriResponseResolver.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ResponseResolving\ResponseResolver; +namespace Sunrise\Http\Router\ResponseResolver; use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; diff --git a/src/ResponseResolving/ResponseResolutionerInterface.php b/src/ResponseResolving/ResponseResolutionerInterface.php deleted file mode 100644 index 02465509..00000000 --- a/src/ResponseResolving/ResponseResolutionerInterface.php +++ /dev/null @@ -1,53 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ResponseResolving; - -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use ReflectionFunction; -use ReflectionMethod; -use Sunrise\Http\Router\ResponseResolving\ResponseResolver\ResponseResolverInterface; - -/** - * ResponseResolutionerInterface - * - * @since 3.0.0 - */ -interface ResponseResolutionerInterface -{ - - /** - * Adds the given response resolver(s) to the resolutioner - * - * @param ResponseResolverInterface ...$resolvers - * - * @return void - */ - public function addResolver(ResponseResolverInterface ...$resolvers): void; - - /** - * Resolves the given response to PSR-7 response - * - * @param ServerRequestInterface $request - * @param mixed $response - * @param ReflectionFunction|ReflectionMethod $responder - * - * @return ResponseInterface - */ - public function resolveResponse( - ServerRequestInterface $request, - mixed $response, - ReflectionFunction|ReflectionMethod $responder, - ) : ResponseInterface; -} diff --git a/src/Route.php b/src/Route.php index f43b3652..6ea10048 100644 --- a/src/Route.php +++ b/src/Route.php @@ -15,504 +15,217 @@ use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; -use function rtrim; -use function strtoupper; - -class Route +final class Route { - - /** - * The route name - * - * @var string - */ - private string $name; - - /** - * The route path - * - * @var string - */ - private string $path; - - /** - * The route methods - * - * @var list - */ - private array $methods = []; - - /** - * The route's consumed media types - * - * @var list - */ - private array $consumedMediaTypes = []; - - /** - * The route's produced media types - * - * @var list - */ - private array $producedMediaTypes = []; - - /** - * The route's request handler - * - * @var mixed - */ - private mixed $requestHandler; - - /** - * The route attributes - * - * @var array - */ - private array $attributes = []; - - /** - * The route middlewares - * - * @var list - */ - private array $middlewares = []; - - /** - * The route summary - * - * @var string|null - */ - private ?string $summary = null; - - /** - * The route description - * - * @var string|null - */ - private ?string $description = null; - - /** - * The route tags - * - * @var list - */ - private array $tags = []; - - /** - * The route's deprecation sign - * - * @var bool - */ - private bool $isDeprecated = false; - - private array $constraints = []; - - private array $patterns = []; - - private ?string $pattern = null; - - /** - * Constructor of the class - * - * @param string $name - * @param string $path - * @param list $methods - * @param mixed $requestHandler - * @param list $middlewares - * @param array $attributes - */ public function __construct( - string $name, - string $path, - array $methods, - mixed $requestHandler, - array $middlewares = [], - array $attributes = [], + private readonly string $name, + private readonly string $path, + private readonly mixed $requestHandler, + /** @var array */ + private readonly array $patterns = [], + /** @var list */ + private readonly array $methods = [], + /** @var array */ + private array $attributes = [], + /** @var list */ + private array $middlewares = [], + /** @var list */ + private array $constraints = [], + /** @var list */ + private readonly array $consumes = [], + /** @var list */ + private readonly array $produces = [], + private readonly string $summary = '', + private readonly string $description = '', + /** @var list */ + private readonly array $tags = [], + private readonly bool $isDeprecated = false, + /** @var non-empty-string|null */ + private readonly ?string $pattern = null, ) { - $this->name = $name; - $this->path = $path; - $this->setMethods(...$methods); - $this->requestHandler = $requestHandler; - $this->setMiddlewares(...$middlewares); - $this->attributes = $attributes; } - /** - * @inheritDoc - */ public function getName(): string { return $this->name; } - /** - * @inheritDoc - */ public function getPath(): string { return $this->path; } - /** - * @inheritDoc - */ - public function getMethods(): array - { - return $this->methods; - } - - /** - * @inheritDoc - */ - public function getConsumedMediaTypes(): array - { - return $this->consumedMediaTypes; - } - - /** - * @inheritDoc - */ - public function getProducedMediaTypes(): array + public function getRequestHandler(): mixed { - return $this->producedMediaTypes; + return $this->requestHandler; } /** - * @inheritDoc + * @return array */ - public function getRequestHandler(): mixed + public function getPatterns(): array { - return $this->requestHandler; + return $this->patterns; } /** - * @inheritDoc + * @return list */ - public function getMiddlewares(): array + public function getMethods(): array { - return $this->middlewares; + return $this->methods; } /** - * @inheritDoc + * @return array */ public function getAttributes(): array { return $this->attributes; } - /** - * @inheritDoc - */ public function getAttribute(string $name, mixed $default = null): mixed { return $this->attributes[$name] ?? $default; } - /** - * @inheritDoc - */ - public function getSummary(): ?string + public function hasAttribute(string $name): bool { - return $this->summary; + return isset($this->attributes[$name]); } /** - * @inheritDoc - */ - public function getDescription(): ?string - { - return $this->description; - } - - /** - * @inheritDoc - */ - public function getTags(): array - { - return $this->tags; - } - - /** - * @inheritDoc - */ - public function isDeprecated(): bool - { - return $this->isDeprecated; - } - - /** - * @inheritDoc - */ - public function setName(string $name): static - { - $this->name = $name; - - return $this; - } - - /** - * @inheritDoc - */ - public function setPath(string $path): static - { - $this->path = $path; - - return $this; - } - - /** - * @inheritDoc + * @param array $attributes */ - public function setMethods(string ...$methods): static + public function withAttributes(array $attributes): self { - $this->methods = []; - foreach ($methods as $method) { - $this->methods[] = strtoupper($method); - } + $clone = clone $this; + $clone->attributes = $attributes; - return $this; + return $clone; } /** - * @inheritDoc + * @param array $attributes */ - public function setConsumesMediaTypes(MediaTypeInterface ...$mediaTypes): static + public function withAddedAttributes(array $attributes): self { - $this->consumedMediaTypes = []; - foreach ($mediaTypes as $mediaType) { - $this->consumedMediaTypes[] = $mediaType; + $clone = clone $this; + foreach ($attributes as $name => $value) { + $clone->attributes[$name] = $value; } - return $this; + return $clone; } /** - * @inheritDoc + * @return list */ - public function setProducesMediaTypes(MediaTypeInterface ...$mediaTypes): static + public function getMiddlewares(): array { - $this->producedMediaTypes = []; - foreach ($mediaTypes as $mediaType) { - $this->producedMediaTypes[] = $mediaType; - } - - return $this; + return $this->middlewares; } /** - * @inheritDoc + * @param list $middlewares */ - public function setRequestHandler(mixed $requestHandler): static + public function withMiddlewares(array $middlewares): self { - $this->requestHandler = $requestHandler; + $clone = clone $this; + $clone->middlewares = $middlewares; - return $this; + return $clone; } /** - * @inheritDoc + * @param list $middlewares */ - public function setMiddlewares(mixed ...$middlewares): static + public function withAddedMiddlewares(array $middlewares): self { - $this->middlewares = []; + $clone = clone $this; foreach ($middlewares as $middleware) { - $this->middlewares[] = $middleware; + $clone->middlewares[] = $middleware; } - return $this; - } - - /** - * @inheritDoc - */ - public function setAttributes(array $attributes): static - { - $this->attributes = $attributes; - - return $this; - } - - /** - * @inheritDoc - */ - public function setAttribute(string $name, mixed $value): static - { - $this->attributes[$name] = $value; - - return $this; + return $clone; } /** - * @inheritDoc + * @return list */ - public function setSummary(?string $summary): static + public function getConstraints(): array { - $this->summary = $summary; - - return $this; + return $this->constraints; } /** - * @inheritDoc + * @param list $constraints */ - public function setDescription(?string $description): static + public function withConstraints(array $constraints): self { - $this->description = $description; + $clone = clone $this; + $clone->constraints = $constraints; - return $this; + return $clone; } /** - * @inheritDoc + * @param list $constraints */ - public function setTags(string ...$tags): static + public function withAddedConstraints(array $constraints): self { - $this->tags = []; - foreach ($tags as $tag) { - $this->tags[] = $tag; + $clone = clone $this; + foreach ($constraints as $constraint) { + $clone->constraints[] = $constraint; } - return $this; - } - - /** - * @inheritDoc - */ - public function setDeprecation(bool $isDeprecated): static - { - $this->isDeprecated = $isDeprecated; - - return $this; - } - - /** - * @inheritDoc - */ - public function addPrefix(string $prefix): static - { - // https://github.com/sunrise-php/http-router/issues/26 - $prefix = rtrim($prefix, '/'); - - $this->path = $prefix . $this->path; - - return $this; + return $clone; } /** - * @inheritDoc + * @return list */ - public function addSuffix(string $suffix): static + public function getConsumedMediaTypes(): array { - $this->path .= $suffix; - - return $this; + return $this->consumes; } /** - * @inheritDoc + * @return list */ - public function addMethod(string ...$methods): static + public function getProducedMediaTypes(): array { - foreach ($methods as $method) { - $this->methods[] = strtoupper($method); - } - - return $this; + return $this->produces; } - /** - * @inheritDoc - */ - public function addConsumedMediaType(MediaTypeInterface ...$mediaTypes): static + public function getSummary(): string { - foreach ($mediaTypes as $mediaType) { - $this->consumedMediaTypes[] = $mediaType; - } - - return $this; + return $this->summary; } - /** - * @inheritDoc - */ - public function addProducedMediaType(MediaTypeInterface ...$mediaTypes): static + public function getDescription(): string { - foreach ($mediaTypes as $mediaType) { - $this->producedMediaTypes[] = $mediaType; - } - - return $this; + return $this->description; } /** - * @inheritDoc + * @return list */ - public function addMiddleware(mixed ...$middlewares): static + public function getTags(): array { - foreach ($middlewares as $middleware) { - $this->middlewares[] = $middleware; - } - - return $this; + return $this->tags; } - /** - * @inheritDoc - */ - public function addTag(string ...$tags): static + public function isDeprecated(): bool { - foreach ($tags as $tag) { - $this->tags[] = $tag; - } - - return $this; + return $this->isDeprecated; } /** - * @inheritDoc + * @return non-empty-string|null */ - public function withAddedAttributes(array $attributes): static - { - $clone = clone $this; - - /** @psalm-suppress MixedAssignment */ - foreach ($attributes as $name => $value) { - $clone->attributes[$name] = $value; - } - - return $clone; - } - - public function getConstraints(): array - { - return $this->constraints; - } - - public function setConstraints(array $constrains): static - { - $this->constraints = $constrains; - - return $this; - } - public function getPattern(): ?string { return $this->pattern; } - - public function setPattern(?string $pattern): static - { - $this->pattern = $pattern; - - return $this; - } - - /** - * @return array - */ - public function getPatterns(): array - { - return $this->patterns; - } } diff --git a/src/Router.php b/src/Router.php index f7c4b141..bc4a335e 100644 --- a/src/Router.php +++ b/src/Router.php @@ -25,12 +25,10 @@ use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Helper\RouteMatcher; use Sunrise\Http\Router\Loader\LoaderInterface; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutioner; -use Sunrise\Http\Router\ParameterResolving\ParameterResolutionerInterface; +use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; -use Sunrise\Http\Router\ResponseResolving\ResponseResolutioner; -use Sunrise\Http\Router\ResponseResolving\ResponseResolutionerInterface; +use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; use function array_keys; use function count; @@ -38,6 +36,8 @@ class Router { + private readonly ParameterResolver $parameterResolver; + private readonly ResponseResolver $responseResolver; private readonly ReferenceResolver $referenceResolver; /** @@ -55,14 +55,20 @@ class Router */ private array $requestHandlers = []; + /** + * @var array + */ + private array $routePatterns = []; + /** * @since 3.0.0 */ - public function __construct( - ParameterResolutionerInterface $parameterResolutioner = new ParameterResolutioner(), - ResponseResolutionerInterface $responseResolutioner = new ResponseResolutioner(), - ) { - $this->referenceResolver = new ReferenceResolver($parameterResolutioner, $responseResolutioner); + public function __construct() + { + $this->referenceResolver = new ReferenceResolver( + $this->parameterResolver = new ParameterResolver(), + $this->responseResolver = new ResponseResolver(), + ); } /** @@ -102,12 +108,21 @@ public function load(LoaderInterface ...$loaders): void public function addMiddleware(mixed ...$middlewares): void { - $middlewares = $this->referenceResolver->resolveMiddlewares($middlewares); foreach ($middlewares as $middleware) { - $this->middlewares[] = $middleware; + $this->middlewares[] = $this->referenceResolver->resolveMiddleware($middleware); } } + public function addParameterResolver(ParameterResolverInterface ...$resolvers): void + { + $this->parameterResolver->addResolver(...$resolvers); + } + + public function addResponseResolver(ResponseResolverInterface ...$resolvers): void + { + $this->responseResolver->addResolver(...$resolvers); + } + /** * Looks for a route that matches the given request * @@ -126,19 +141,19 @@ public function addMiddleware(mixed ...$middlewares): void */ public function match(ServerRequestInterface $request): Route { + $requestPath = $request->getUri()->getPath(); + $requestMethod = $request->getMethod(); $allowedMethods = []; foreach ($this->routes as $route) { - $path = $route->getPath(); - $pattern = $route->getPattern(); - if ($pattern === null) { - $pattern = RouteCompiler::compileRoute($path, $route->getPatterns()); - $route->setPattern($pattern); - } + $routeName = $route->getName(); + $routePath = $route->getPath(); + + $this->routePatterns[$routeName] ??= $route->getPattern() ?? RouteCompiler::compileRoute($routePath, $route->getPatterns()); // https://github.com/sunrise-php/http-router/issues/50 // https://tools.ietf.org/html/rfc7231#section-6.5.5 - if (!RouteMatcher::matchPattern($path, $pattern, $request->getUri()->getPath(), $matches)) { + if (!RouteMatcher::matchPattern($routePath, $this->routePatterns[$routeName], $requestPath, $matches)) { continue; } @@ -148,13 +163,12 @@ public function match(ServerRequestInterface $request): Route $allowedMethods[$routeMethod] = true; } - if (!isset($routeMethods[$request->getMethod()])) { + if (!empty($routeMethods) && !isset($routeMethods[$requestMethod])) { continue; } - $serverConsumedMediaTypes = $route->getConsumedMediaTypes(); - if (!ServerRequest::create($request)->clientProducesMediaType(...$serverConsumedMediaTypes)) { - throw new HttpUnsupportedMediaTypeException($serverConsumedMediaTypes); + if (!ServerRequest::create($request)->clientProducesMediaType(...$route->getConsumedMediaTypes())) { + throw new HttpUnsupportedMediaTypeException($route->getConsumedMediaTypes()); } return $route->withAddedAttributes($matches); @@ -179,10 +193,15 @@ public function run(ServerRequestInterface $request): ResponseInterface ); if (count($this->middlewares) > 0) { - $handler = new QueueableRequestHandler($handler, $this->middlewares); + $handler = new QueueableRequestHandler($handler); + foreach ($this->middlewares as $middleware) { + $handler->enqueue($middleware); + } } - return $handler->handle($request->withAttribute('@router', $this)); + return $handler->handle( + $request->withAttribute('@router', $this) + ); } /** @@ -199,15 +218,24 @@ public function runRoute(Route|string $route, ServerRequestInterface $request): $request = $request->withAttribute($name, $value); } - $this->requestHandlers[$route->getName()] ??= new QueueableRequestHandler( - $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()), - [...$this->referenceResolver->resolveMiddlewares($route->getMiddlewares())], - ); + $handler = &$this->requestHandlers[$route->getName()]; - return $this->requestHandlers[$route->getName()]->handle($request); + if (!isset($handler)) { + $handler = new QueueableRequestHandler( + $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()) + ); + + foreach ($route->getMiddlewares() as $middleware) { + $handler->enqueue($this->referenceResolver->resolveMiddleware($middleware)); + } + } + + return $handler->handle($request); } /** + * @param array $values + * * @throws InvalidArgumentException */ public function generateUri(string $name, array $values = []): string diff --git a/src/RouterBuilder.php b/src/RouterBuilder.php deleted file mode 100644 index 6337f9b4..00000000 --- a/src/RouterBuilder.php +++ /dev/null @@ -1,220 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -use Psr\EventDispatcher\EventDispatcherInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\SimpleCache\CacheInterface; - -/** - * RouterBuilder - * - * @since 2.9.0 - */ -final class RouterBuilder -{ - - /** - * @var EventDispatcherInterface|null - * - * @since 2.14.0 - */ - private $eventDispatcher = null; - - /** - * @var CacheInterface|null - */ - private $cache = null; - - /** - * @var string|null - */ - private $cacheKey = null; - - /** - * @var array|null - */ - private $patterns = null; - - /** - * @var MiddlewareInterface[]|null - */ - private $middlewares = null; - - /** - * @var Loader\ConfigLoader|null - */ - private $configLoader = null; - - /** - * @var Loader\DescriptorLoader|null - */ - private $descriptorLoader = null; - - /** - * Sets the given event dispatcher to the builder - * - * @param EventDispatcherInterface|null $eventDispatcher - * - * @return self - * - * @since 2.14.0 - */ - public function setEventDispatcher(?EventDispatcherInterface $eventDispatcher): self - { - $this->eventDispatcher = $eventDispatcher; - - return $this; - } - - /** - * Sets the given cache to the builder - * - * @param CacheInterface|null $cache - * - * @return self - */ - public function setCache(?CacheInterface $cache): self - { - $this->cache = $cache; - - return $this; - } - - /** - * Sets the given cache key to the builder - * - * @param string|null $cacheKey - * - * @return self - * - * @since 2.10.0 - */ - public function setCacheKey(?string $cacheKey): self - { - $this->cacheKey = $cacheKey; - - return $this; - } - - /** - * Uses the config loader when building - * - * @param string[] $resources - * - * @return self - */ - public function useConfigLoader(array $resources): self - { - $this->configLoader = new Loader\ConfigLoader(); - $this->configLoader->attachArray($resources); - - return $this; - } - - /** - * Uses the descriptor loader when building - * - * @param string[] $resources - * - * @return self - */ - public function useDescriptorLoader(array $resources): self - { - $this->descriptorLoader = new Loader\DescriptorLoader(); - $this->descriptorLoader->attachArray($resources); - - return $this; - } - - /** - * Uses the metadata loader when building - * - * Alias to the useDescriptorLoader method. - * - * @param string[] $resources - * - * @return self - */ - public function useMetadataLoader(array $resources): self - { - $this->useDescriptorLoader($resources); - - return $this; - } - - /** - * Sets the given patterns to the builder - * - * @param array|null $patterns - * - * @return self - * - * @since 2.11.0 - */ - public function setPatterns(?array $patterns): self - { - $this->patterns = $patterns; - - return $this; - } - - /** - * Sets the given middlewares to the builder - * - * @param MiddlewareInterface[]|null $middlewares - * - * @return self - */ - public function setMiddlewares(?array $middlewares): self - { - $this->middlewares = $middlewares; - - return $this; - } - - /** - * Builds the router - * - * @return Router - */ - public function build(): Router - { - $router = new Router(); - - if (isset($this->eventDispatcher)) { - $router->setEventDispatcher($this->eventDispatcher); - } - - if (isset($this->configLoader)) { - $router->load($this->configLoader); - } - - if (isset($this->descriptorLoader)) { - $this->descriptorLoader->setCache($this->cache); - $this->descriptorLoader->setCacheKey($this->cacheKey); - $router->load($this->descriptorLoader); - } - - if (!empty($this->patterns)) { - $router->addPatterns($this->patterns); - } - - if (!empty($this->middlewares)) { - $router->addMiddleware(...$this->middlewares); - } - - return $router; - } -} diff --git a/src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php b/src/Validation/ConstraintViolation/HydratorErrorProxy.php similarity index 96% rename from src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php rename to src/Validation/ConstraintViolation/HydratorErrorProxy.php index 0c1b47f7..f12e2c11 100644 --- a/src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php +++ b/src/Validation/ConstraintViolation/HydratorErrorProxy.php @@ -20,7 +20,7 @@ /** * @since 3.0.0 */ -final class HydratorConstraintViolationProxy implements ConstraintViolationInterface +final class HydratorErrorProxy implements ConstraintViolationInterface { /** diff --git a/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php b/src/Validation/ConstraintViolation/ValidatorErrorProxy.php similarity index 96% rename from src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php rename to src/Validation/ConstraintViolation/ValidatorErrorProxy.php index fb41c2af..e5c44a38 100644 --- a/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php +++ b/src/Validation/ConstraintViolation/ValidatorErrorProxy.php @@ -20,7 +20,7 @@ /** * @since 3.0.0 */ -final class ValidatorConstraintViolationProxy implements ConstraintViolationInterface +final class ValidatorErrorProxy implements ConstraintViolationInterface { /** From 930e2f21dc95e8c725e5ad9cb68cbbef87e11fa8 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Tue, 27 Feb 2024 08:21:13 +0100 Subject: [PATCH 102/180] v3 --- src/Command/RouteListCommand.php | 4 +- src/Dictionary/AttributeName.php | 23 +++ src/Dictionary/VariablePattern.php | 1 + src/Exception/HttpException.php | 17 +- src/Helper/RouteBuilder.php | 26 +++- src/Helper/RouteMatcher.php | 3 +- src/Loader/DescriptorLoader.php | 18 +-- src/Middleware/CallbackMiddleware.php | 7 +- .../DependencyInjectionParameterResolver.php | 22 ++- .../ObjectInjectionParameterResolver.php | 19 +-- .../ParameterResolverInterface.php | 11 +- .../RequestBodyParameterResolver.php | 17 +- .../RequestCookieParameterResolver.php | 16 +- .../RequestHeaderParameterResolver.php | 14 +- .../RequestQueryParameterResolver.php | 14 +- .../RequestRouteParameterResolver.php | 7 +- .../RequestStreamParameterResolver.php | 9 +- .../RequestUriParameterResolver.php | 6 +- .../RequestVariableParameterResolver.php | 12 +- .../RouterParameterResolver.php | 6 +- .../ServerRequestParameterResolver.php | 6 +- src/RequestHandler/CallbackRequestHandler.php | 9 +- .../QueueableRequestHandler.php | 5 +- .../ResponseResolverInterface.php | 12 +- .../RouteResponseResolver.php | 3 +- src/Route.php | 16 +- src/Router.php | 146 +++++++++++------- src/Validation/ConstraintViolation.php | 19 +-- ...p => HydratorConstraintViolationProxy.php} | 23 +-- ... => ValidatorConstraintViolationProxy.php} | 23 +-- .../ConstraintViolationInterface.php | 18 --- 31 files changed, 252 insertions(+), 280 deletions(-) create mode 100644 src/Dictionary/AttributeName.php rename src/Validation/ConstraintViolation/{HydratorErrorProxy.php => HydratorConstraintViolationProxy.php} (74%) rename src/Validation/ConstraintViolation/{ValidatorErrorProxy.php => ValidatorConstraintViolationProxy.php} (74%) diff --git a/src/Command/RouteListCommand.php b/src/Command/RouteListCommand.php index 317ec46c..3d36122e 100644 --- a/src/Command/RouteListCommand.php +++ b/src/Command/RouteListCommand.php @@ -26,7 +26,7 @@ * @since 2.9.0 */ #[AsCommand('router:route-list', 'Lists all routes.')] -class RouteListCommand extends Command +final class RouteListCommand extends Command { public function __construct(private readonly Router $router) { @@ -36,7 +36,7 @@ public function __construct(private readonly Router $router) /** * @inheritDoc */ - final protected function execute(InputInterface $input, OutputInterface $output): int + protected function execute(InputInterface $input, OutputInterface $output): int { $table = new Table($output); diff --git a/src/Dictionary/AttributeName.php b/src/Dictionary/AttributeName.php new file mode 100644 index 00000000..263a622b --- /dev/null +++ b/src/Dictionary/AttributeName.php @@ -0,0 +1,23 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Dictionary; + +/** + * @since 3.0.0 + */ +final class AttributeName +{ + public const ROUTE = '@route'; + public const ROUTER = '@router'; +} diff --git a/src/Dictionary/VariablePattern.php b/src/Dictionary/VariablePattern.php index 3f142dcd..b44c9033 100644 --- a/src/Dictionary/VariablePattern.php +++ b/src/Dictionary/VariablePattern.php @@ -25,5 +25,6 @@ final class VariablePattern public const UPPER = '[A-Z]+'; public const WORD = '[0-9A-Za-z_]+'; public const SLUG = '[0-9A-Za-z-]+'; + public const SLUG_UTF8 = '[\p{N}\p{L}-]+'; public const UUID = '[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}'; } diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index 3b32632d..1e114f70 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -88,14 +88,6 @@ final public function getConstraintViolations(): array return $this->constraintViolations; } - /** - * Adds the given HTTP header field that will be sent to the client - * - * @param string $fieldName - * @param Stringable|string ...$fieldValues - * - * @return static - */ final public function addHeaderField(string $fieldName, Stringable|string ...$fieldValues): static { // https://datatracker.ietf.org/doc/html/rfc7230#section-7 @@ -106,14 +98,7 @@ final public function addHeaderField(string $fieldName, Stringable|string ...$fi return $this; } - /** - * Adds the given constraint violation(s) to the error - * - * @param ConstraintViolationInterface ...$constraintViolations - * - * @return static - */ - final public function addError(ConstraintViolationInterface ...$constraintViolations): static + final public function addConstraintViolation(ConstraintViolationInterface ...$constraintViolations): static { foreach ($constraintViolations as $constraintViolation) { $this->constraintViolations[] = $constraintViolation; diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index 25ccf60e..ed2921b4 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -13,8 +13,12 @@ namespace Sunrise\Http\Router\Helper; +use BackedEnum; use InvalidArgumentException; +use Stringable; +use function is_int; +use function is_string; use function sprintf; use function str_replace; use function substr; @@ -25,7 +29,7 @@ final class RouteBuilder { /** - * @param array $values + * @param array $values * * @throws InvalidArgumentException If the route isn't valid or any of the required values are missing. */ @@ -39,8 +43,26 @@ public static function buildRoute(string $route, array $values = []): string $statement = substr($route, $variable['offset'], $variable['length']); if (isset($values[$variable['name']])) { + $value = $values[$variable['name']]; + + if (is_int($value)) { + $value = (string) $value; + } elseif ($value instanceof BackedEnum) { + $value = (string) $value->value; + } elseif ($value instanceof Stringable) { + $value = $value->__toString(); + } + + if (!is_string($value)) { + throw new InvalidArgumentException(sprintf( + 'The route %s could not be built with an unsupported value for the variable %s.', + $route, + $variable['name'], + )); + } + $search[] = $statement; - $replace[] = $values[$variable['name']]; + $replace[] = $value; continue; } diff --git a/src/Helper/RouteMatcher.php b/src/Helper/RouteMatcher.php index a786c4f6..79942646 100644 --- a/src/Helper/RouteMatcher.php +++ b/src/Helper/RouteMatcher.php @@ -57,8 +57,9 @@ public static function matchPattern(string $route, string $pattern, string $subj } } catch (ErrorException $e) { throw new InvalidArgumentException(sprintf( - 'The route %s could not be matched due to a syntax error in one of variable patterns.', + 'The route %s could not be matched due to a syntax error in one of variable patterns: %s', $route, + $e->getMessage(), ), previous: $e); } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index f4fe99c1..331d286c 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -45,7 +45,6 @@ use function is_dir; use function is_file; use function join; -use function rtrim; use function sprintf; use function strtoupper; use function usort; @@ -54,24 +53,14 @@ final class DescriptorLoader implements LoaderInterface { public const DEFAULT_CACHE_KEY = 'router_descriptors'; - /** - * @var list - */ - private array $resources = []; - public function __construct( + /** @var list */ + private readonly array $resources, private readonly ?CacheInterface $cache = null, private readonly string $cacheKey = self::DEFAULT_CACHE_KEY, ) { } - public function attach(string ...$resources): void - { - foreach ($resources as $resource) { - $this->resources[] = $resource; - } - } - /** * @inheritDoc * @@ -232,8 +221,7 @@ private function supplementDescriptorFromClassOrMethod(Descriptor $descriptor, R $annotations = $classOrMethod->getAttributes(Prefix::class); if (isset($annotations[0])) { $annotation = $annotations[0]->newInstance(); - // https://github.com/sunrise-php/http-router/issues/26 - $descriptor->prefixes[] = rtrim($annotation->value, '/'); + $descriptor->prefixes[] = $annotation->value; } /** @var list> $annotations */ diff --git a/src/Middleware/CallbackMiddleware.php b/src/Middleware/CallbackMiddleware.php index 176f1b8a..0a0b2a42 100644 --- a/src/Middleware/CallbackMiddleware.php +++ b/src/Middleware/CallbackMiddleware.php @@ -35,13 +35,18 @@ final class CallbackMiddleware implements MiddlewareInterface public function __construct( callable $callback, - private readonly ReflectionFunction|ReflectionMethod $callbackReflection, + private readonly ReflectionMethod|ReflectionFunction $callbackReflection, private readonly ParameterResolver $parameterResolver, private readonly ResponseResolver $responseResolver, ) { $this->callback = $callback; } + public function getCallbackReflection(): ReflectionMethod|ReflectionFunction + { + return $this->callbackReflection; + } + /** * @inheritDoc */ diff --git a/src/ParameterResolver/DependencyInjectionParameterResolver.php b/src/ParameterResolver/DependencyInjectionParameterResolver.php index ba6db34d..5bf3c6ec 100644 --- a/src/ParameterResolver/DependencyInjectionParameterResolver.php +++ b/src/ParameterResolver/DependencyInjectionParameterResolver.php @@ -14,40 +14,36 @@ namespace Sunrise\Http\Router\ParameterResolver; use Generator; +use Psr\Container\ContainerExceptionInterface; use Psr\Container\ContainerInterface; +use Psr\Http\Message\RequestInterface; use ReflectionNamedType; use ReflectionParameter; /** - * DependencyInjectionParameterResolver - * * @since 3.0.0 */ final class DependencyInjectionParameterResolver implements ParameterResolverInterface { - - /** - * Constructor of the class - * - * @param ContainerInterface $container - */ - public function __construct(private ContainerInterface $container) + public function __construct(private readonly ContainerInterface $container) { } /** * @inheritDoc + * + * @throws ContainerExceptionInterface If something went wrong while working with the container. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, ?RequestInterface $request): Generator { $type = $parameter->getType(); - if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { return; } - if ($this->container->has($type->getName())) { - yield $this->container->get($type->getName()); + $typeName = $type->getName(); + if ($this->container->has($typeName)) { + yield $this->container->get($typeName); } } } diff --git a/src/ParameterResolver/ObjectInjectionParameterResolver.php b/src/ParameterResolver/ObjectInjectionParameterResolver.php index ecd89506..d68be0a5 100644 --- a/src/ParameterResolver/ObjectInjectionParameterResolver.php +++ b/src/ParameterResolver/ObjectInjectionParameterResolver.php @@ -20,37 +20,26 @@ use function is_a; /** - * ObjectInjectionParameterResolver - * * @since 3.0.0 */ final class ObjectInjectionParameterResolver implements ParameterResolverInterface { - - /** - * Constructor of the class - * - * @param object $object - */ - public function __construct(private object $object) + public function __construct(private readonly object $object) { } /** * @inheritDoc */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator { $type = $parameter->getType(); - if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { return; } - if (!is_a($this->object, $type->getName())) { - return; + if (is_a($this->object, $type->getName())) { + yield $this->object; } - - yield $this->object; } } diff --git a/src/ParameterResolver/ParameterResolverInterface.php b/src/ParameterResolver/ParameterResolverInterface.php index b7ec1e65..00daee17 100644 --- a/src/ParameterResolver/ParameterResolverInterface.php +++ b/src/ParameterResolver/ParameterResolverInterface.php @@ -14,23 +14,16 @@ namespace Sunrise\Http\Router\ParameterResolver; use Generator; +use Psr\Http\Message\RequestInterface; use ReflectionParameter; /** - * ParameterResolverInterface - * * @since 3.0.0 */ interface ParameterResolverInterface { - /** - * Resolves the given parameter to an argument(s) - * - * @param ReflectionParameter $parameter - * @param mixed $context - * * @return Generator */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator; + public function resolveParameter(ReflectionParameter $parameter, ?RequestInterface $request): Generator; } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 64fbd56b..39f7baa8 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -21,8 +21,8 @@ use Sunrise\Http\Router\Annotation\RequestBody; use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; use Sunrise\Http\Router\ParameterResolver; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorErrorProxy; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorErrorProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; @@ -51,7 +51,7 @@ public function __construct( * * @throws HttpUnprocessableEntityException If the request's parsed body isn't valid. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator { if ($parameter->getAttributes(RequestBody::class) === []) { return; @@ -65,22 +65,23 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) )); } - if (! $context instanceof ServerRequestInterface) { + if (! $request instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.' ); } try { - $object = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); + $object = $this->hydrator->hydrate($type->getName(), (array) $request->getParsedBody()); } catch (InvalidDataException $e) { throw (new HttpUnprocessableEntityException) - ->addError(...HydratorErrorProxy::create(...$e->getExceptions())); + ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); } - if (count($violations = $this->validator?->validate($object) ?? []) > 0) { + $violations = $this->validator?->validate($object); + if (count($violations ?? []) > 0) { throw (new HttpUnprocessableEntityException) - ->addError(...ValidatorErrorProxy::create(...$violations)); + ->addConstraintViolation(...ValidatorConstraintViolationProxy::create(...$violations)); } yield $object; diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index 8a56443d..21b7d475 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -21,8 +21,8 @@ use Sunrise\Http\Router\Annotation\Constraint; use Sunrise\Http\Router\Annotation\RequestCookie; use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorErrorProxy; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorErrorProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; @@ -58,7 +58,7 @@ public function __construct( * * @throws HttpBadRequestException If a cookie was missed or invalid. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator { /** @var list> $attributes */ $attributes = $parameter->getAttributes(RequestCookie::class); @@ -66,13 +66,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return; } - if (! $context instanceof ServerRequestInterface) { + if (! $request instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.', ); } - $cookies = $context->getCookieParams(); + $cookies = $request->getCookieParams(); $attribute = $attributes[0]->newInstance(); if (!isset($cookies[$attribute->name])) { @@ -93,10 +93,10 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } catch (InvalidDataException $e) { throw (new HttpBadRequestException(previous: $e)) - ->addError(...HydratorErrorProxy::create(...$e->getExceptions())); + ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); } catch (InvalidValueException $e) { throw (new HttpBadRequestException(previous: $e)) - ->addError(...HydratorErrorProxy::create($e)); + ->addConstraintViolation(...HydratorConstraintViolationProxy::create($e)); } $constraints = []; @@ -110,7 +110,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (count($constraints) > 0 && count($violations = $this->validator?->validate($value, $constraints) ?? []) > 0) { throw (new HttpBadRequestException()) - ->addError(...ValidatorErrorProxy::create(...$violations)); + ->addConstraintViolation(...ValidatorConstraintViolationProxy::create(...$violations)); } yield $value; diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 747b3b4e..718b2bb4 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -20,7 +20,7 @@ use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestHeader; use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorErrorProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; @@ -50,7 +50,7 @@ public function __construct(private HydratorInterface $hydrator) * * @throws HttpBadRequestException If a header was missed or invalid. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator { /** @var ReflectionAttribute $attributes */ $attributes = $parameter->getAttributes(RequestHeader::class); @@ -58,7 +58,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return; } - if (! $context instanceof ServerRequestInterface) { + if (! $request instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.' ); @@ -66,7 +66,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $attribute = $attributes[0]->newInstance(); - if (!$context->hasHeader($attribute->name)) { + if (!$request->hasHeader($attribute->name)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } elseif ($parameter->allowsNull()) { @@ -78,16 +78,16 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) try { yield $this->hydrator->castValue( - $context->getHeaderLine($attribute->name), + $request->getHeaderLine($attribute->name), Type::fromParameter($parameter), path: [$attribute->name], ); } catch (InvalidDataException $e) { throw (new HttpBadRequestException(previous: $e)) - ->addError(...HydratorErrorProxy::create(...$e->getExceptions())); + ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); } catch (InvalidValueException $e) { throw (new HttpBadRequestException(previous: $e)) - ->addError(...HydratorErrorProxy::create($e)); + ->addConstraintViolation(...HydratorConstraintViolationProxy::create($e)); } } } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 0af1d9fb..2ec3d390 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -21,8 +21,8 @@ use Sunrise\Http\Router\Annotation\RequestQuery; use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; use Sunrise\Http\Router\ParameterResolver; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorErrorProxy; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorErrorProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; @@ -58,7 +58,7 @@ public function __construct( * * @throws HttpUnprocessableEntityException If the request's query parameters isn't valid. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator { if ($parameter->getAttributes(RequestQuery::class) === []) { return; @@ -72,24 +72,24 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) )); } - if (! $context instanceof ServerRequestInterface) { + if (! $request instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.' ); } try { - $object = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); + $object = $this->hydrator->hydrate($type->getName(), $request->getQueryParams()); } catch (InvalidDataException $e) { throw (new HttpUnprocessableEntityException) - ->addError(...HydratorErrorProxy::create(...$e->getExceptions())); + ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); } if (isset($this->validator)) { $violations = $this->validator->validate($object); if ($violations->count() > 0) { throw (new HttpUnprocessableEntityException) - ->addError(...ValidatorErrorProxy::create(...$violations)); + ->addConstraintViolation(...ValidatorConstraintViolationProxy::create(...$violations)); } } diff --git a/src/ParameterResolver/RequestRouteParameterResolver.php b/src/ParameterResolver/RequestRouteParameterResolver.php index 412d5681..439e1807 100644 --- a/src/ParameterResolver/RequestRouteParameterResolver.php +++ b/src/ParameterResolver/RequestRouteParameterResolver.php @@ -18,6 +18,7 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; +use Sunrise\Http\Router\Dictionary\AttributeName; use Sunrise\Http\Router\ParameterResolver; use Sunrise\Http\Router\Route; use function sprintf; @@ -35,21 +36,21 @@ final class RequestRouteParameterResolver implements ParameterResolverInterface * * @throws LogicException If the resolver is used incorrectly. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator { $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->getName() <> Route::class) { return; } - if (! $context instanceof ServerRequestInterface) { + if (! $request instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.' ); } /** @var Route|null $route */ - $route = $context->getAttribute('@route'); + $route = $request->getAttribute(AttributeName::ROUTE); if (! $route instanceof Route && !$parameter->allowsNull()) { throw new LogicException(sprintf( 'At this level of the application, the current request does not contain a route. ' . diff --git a/src/ParameterResolver/RequestStreamParameterResolver.php b/src/ParameterResolver/RequestStreamParameterResolver.php index b963f30b..f255f58d 100644 --- a/src/ParameterResolver/RequestStreamParameterResolver.php +++ b/src/ParameterResolver/RequestStreamParameterResolver.php @@ -21,31 +21,28 @@ use ReflectionParameter; /** - * RequestStreamParameterResolver - * * @since 3.0.0 */ final class RequestStreamParameterResolver implements ParameterResolverInterface { - /** * @inheritDoc * * @throws LogicException If the resolver is used incorrectly. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator { $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->getName() <> StreamInterface::class) { return; } - if (! $context instanceof ServerRequestInterface) { + if (! $request instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.' ); } - yield $context->getBody(); + yield $request->getBody(); } } diff --git a/src/ParameterResolver/RequestUriParameterResolver.php b/src/ParameterResolver/RequestUriParameterResolver.php index b4447576..3d33ce98 100644 --- a/src/ParameterResolver/RequestUriParameterResolver.php +++ b/src/ParameterResolver/RequestUriParameterResolver.php @@ -33,19 +33,19 @@ final class RequestUriParameterResolver implements ParameterResolverInterface * * @throws LogicException If the resolver is used incorrectly. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator { $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->getName() <> UriInterface::class) { return; } - if (! $context instanceof ServerRequestInterface) { + if (! $request instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.' ); } - yield $context->getUri(); + yield $request->getUri(); } } diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index 769fa805..ee94949b 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -22,7 +22,7 @@ use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; use Sunrise\Http\Router\ParameterResolver; use Sunrise\Http\Router\Route; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorErrorProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; @@ -53,7 +53,7 @@ public function __construct(private HydratorInterface $hydrator) * * @throws HttpNotFoundException If the request's path variable isn't valid. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator { /** @var ReflectionAttribute $attributes */ $attributes = $parameter->getAttributes(RequestVariable::class); @@ -61,13 +61,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return; } - if (! $context instanceof ServerRequestInterface) { + if (! $request instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.' ); } - $route = $context->getAttribute('@route'); + $route = $request->getAttribute('@route'); if (! $route instanceof Route) { throw new LogicException(sprintf( 'The #[PathVariable] attribute cannot be applied to the parameter {%s}, ' . @@ -107,10 +107,10 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } catch (InvalidDataException $e) { throw (new HttpNotFoundException(previous: $e)) - ->addError(...HydratorErrorProxy::create(...$e->getExceptions())); + ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); } catch (InvalidValueException $e) { throw (new HttpNotFoundException(previous: $e)) - ->addError(...HydratorErrorProxy::create($e)); + ->addConstraintViolation(...HydratorConstraintViolationProxy::create($e)); } } } diff --git a/src/ParameterResolver/RouterParameterResolver.php b/src/ParameterResolver/RouterParameterResolver.php index a77cc23b..787dddd1 100644 --- a/src/ParameterResolver/RouterParameterResolver.php +++ b/src/ParameterResolver/RouterParameterResolver.php @@ -31,20 +31,20 @@ final class RouterParameterResolver implements ParameterResolverInterface * * @throws LogicException If the resolver is used incorrectly. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator { $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->getName() <> Router::class) { return; } - if (! $context instanceof ServerRequestInterface) { + if (! $request instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.' ); } - $router = $context->getAttribute('@router'); + $router = $request->getAttribute('@router'); if (! $router instanceof Router) { throw new LogicException(); } diff --git a/src/ParameterResolver/ServerRequestParameterResolver.php b/src/ParameterResolver/ServerRequestParameterResolver.php index 36b4c22b..e7c6b6ff 100644 --- a/src/ParameterResolver/ServerRequestParameterResolver.php +++ b/src/ParameterResolver/ServerRequestParameterResolver.php @@ -33,19 +33,19 @@ final class ServerRequestParameterResolver implements ParameterResolverInterface * * @throws LogicException If the resolver is used incorrectly. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator { $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->getName() <> ServerRequest::class) { return; } - if (! $context instanceof ServerRequestInterface) { + if (! $request instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.' ); } - yield ServerRequest::create($context); + yield ServerRequest::create($request); } } diff --git a/src/RequestHandler/CallbackRequestHandler.php b/src/RequestHandler/CallbackRequestHandler.php index 7443cc34..4340add3 100644 --- a/src/RequestHandler/CallbackRequestHandler.php +++ b/src/RequestHandler/CallbackRequestHandler.php @@ -34,19 +34,14 @@ final class CallbackRequestHandler implements RequestHandlerInterface public function __construct( callable $callback, - private readonly ReflectionFunction|ReflectionMethod $callbackReflection, + private readonly ReflectionMethod|ReflectionFunction $callbackReflection, private readonly ParameterResolver $parameterResolver, private readonly ResponseResolver $responseResolver, ) { $this->callback = $callback; } - /** - * Gets the callback's reflection - * - * @return ReflectionFunction|ReflectionMethod - */ - public function getCallbackReflection(): ReflectionFunction|ReflectionMethod + public function getCallbackReflection(): ReflectionMethod|ReflectionFunction { return $this->callbackReflection; } diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index b90416c3..d6e6e68b 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -34,8 +34,7 @@ public function __construct( */ public function handle(ServerRequestInterface $request): ResponseInterface { - return $this->isEmpty() ? - $this->endpoint->handle($request) : - ($queue = clone $this)->dequeue()->process($request, $queue); + // phpcs:ignore Generic.Files.LineLength + return $this->isEmpty() ? $this->endpoint->handle($request) : ($clone = clone $this)->dequeue()->process($request, $clone); } } diff --git a/src/ResponseResolver/ResponseResolverInterface.php b/src/ResponseResolver/ResponseResolverInterface.php index 65b42b55..8a52cb7b 100644 --- a/src/ResponseResolver/ResponseResolverInterface.php +++ b/src/ResponseResolver/ResponseResolverInterface.php @@ -25,19 +25,9 @@ */ interface ResponseResolverInterface { - - /** - * Resolves the given response to PSR-7 response - * - * @param ServerRequestInterface $request - * @param mixed $response - * @param ReflectionFunction|ReflectionMethod $responder - * - * @return ResponseInterface|null - */ public function resolveResponse( ServerRequestInterface $request, mixed $response, - ReflectionFunction|ReflectionMethod $responder, + ReflectionMethod|ReflectionFunction $responder, ) : ?ResponseInterface; } diff --git a/src/ResponseResolver/RouteResponseResolver.php b/src/ResponseResolver/RouteResponseResolver.php index 75984223..5b0443b8 100644 --- a/src/ResponseResolver/RouteResponseResolver.php +++ b/src/ResponseResolver/RouteResponseResolver.php @@ -18,6 +18,7 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionFunction; use ReflectionMethod; +use Sunrise\Http\Router\Dictionary\AttributeName; use Sunrise\Http\Router\Route; use Sunrise\Http\Router\Router; @@ -41,7 +42,7 @@ public function resolveResponse( return null; } - $router = $request->getAttribute('@router'); + $router = $request->getAttribute(AttributeName::ROUTER); if (! $router instanceof Router) { throw new LogicException(); } diff --git a/src/Route.php b/src/Route.php index 6ea10048..0073647f 100644 --- a/src/Route.php +++ b/src/Route.php @@ -15,6 +15,9 @@ use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; +use function array_key_exists; +use function in_array; + final class Route { public function __construct( @@ -76,6 +79,15 @@ public function getMethods(): array return $this->methods; } + public function listensMethod(string $method): bool + { + if ($this->methods === []) { + return true; + } + + return in_array($method, $this->methods, true); + } + /** * @return array */ @@ -86,12 +98,12 @@ public function getAttributes(): array public function getAttribute(string $name, mixed $default = null): mixed { - return $this->attributes[$name] ?? $default; + return array_key_exists($name, $this->attributes) ? $this->attributes[$name] : $default; } public function hasAttribute(string $name): bool { - return isset($this->attributes[$name]); + return array_key_exists($name, $this->attributes); } /** diff --git a/src/Router.php b/src/Router.php index bc4a335e..bd7bc0a9 100644 --- a/src/Router.php +++ b/src/Router.php @@ -18,6 +18,7 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\Dictionary\AttributeName; use Sunrise\Http\Router\Exception\Http\HttpMethodNotAllowedException; use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; use Sunrise\Http\Router\Exception\Http\HttpUnsupportedMediaTypeException; @@ -30,8 +31,9 @@ use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; +use function array_flip; use function array_keys; -use function count; +use function rawurldecode; use function sprintf; class Router @@ -45,6 +47,11 @@ class Router */ private array $routes = []; + /** + * @var array + */ + private array $patterns = []; + /** * @var list */ @@ -53,12 +60,9 @@ class Router /** * @var array */ - private array $requestHandlers = []; + private array $routeRequestHandlers = []; - /** - * @var array - */ - private array $routePatterns = []; + private ?RequestHandlerInterface $routerRequestHandler = null; /** * @since 3.0.0 @@ -97,7 +101,7 @@ public function addRoute(Route ...$routes) : void } } - public function load(LoaderInterface ...$loaders): void + public function loadRoutes(LoaderInterface ...$loaders): void { foreach ($loaders as $loader) { foreach ($loader->load() as $route) { @@ -141,29 +145,19 @@ public function addResponseResolver(ResponseResolverInterface ...$resolvers): vo */ public function match(ServerRequestInterface $request): Route { - $requestPath = $request->getUri()->getPath(); - $requestMethod = $request->getMethod(); + $requestPath = rawurldecode($request->getUri()->getPath()); $allowedMethods = []; - foreach ($this->routes as $route) { - $routeName = $route->getName(); - $routePath = $route->getPath(); - - $this->routePatterns[$routeName] ??= $route->getPattern() ?? RouteCompiler::compileRoute($routePath, $route->getPatterns()); + $routePattern = $this->compileRoutePattern($route); // https://github.com/sunrise-php/http-router/issues/50 // https://tools.ietf.org/html/rfc7231#section-6.5.5 - if (!RouteMatcher::matchPattern($routePath, $this->routePatterns[$routeName], $requestPath, $matches)) { + if (!RouteMatcher::matchPattern($route->getPath(), $routePattern, $requestPath, $matches)) { continue; } - $routeMethods = []; - foreach ($route->getMethods() as $routeMethod) { - $routeMethods[$routeMethod] = true; - $allowedMethods[$routeMethod] = true; - } - - if (!empty($routeMethods) && !isset($routeMethods[$requestMethod])) { + if (!$route->listensMethod($request->getMethod())) { + $allowedMethods += array_flip($route->getMethods()); continue; } @@ -175,9 +169,7 @@ public function match(ServerRequestInterface $request): Route } if (!empty($allowedMethods)) { - $allowedMethods = array_keys($allowedMethods); - - throw new HttpMethodNotAllowedException($allowedMethods); + throw new HttpMethodNotAllowedException(array_keys($allowedMethods)); } throw new HttpNotFoundException(); @@ -188,19 +180,8 @@ public function match(ServerRequestInterface $request): Route */ public function run(ServerRequestInterface $request): ResponseInterface { - $handler = new CallableRequestHandler( - fn(ServerRequestInterface $request): ResponseInterface => $this->runRoute($this->match($request), $request) - ); - - if (count($this->middlewares) > 0) { - $handler = new QueueableRequestHandler($handler); - foreach ($this->middlewares as $middleware) { - $handler->enqueue($middleware); - } - } - - return $handler->handle( - $request->withAttribute('@router', $this) + return $this->getRouterRequestHandler()->handle( + $request->withAttribute(AttributeName::ROUTER, $this) ); } @@ -213,36 +194,97 @@ public function runRoute(Route|string $route, ServerRequestInterface $request): $route = $this->getRoute($route); } - $request = $request->withAttribute('@route', $route); foreach ($route->getAttributes() as $name => $value) { $request = $request->withAttribute($name, $value); } - $handler = &$this->requestHandlers[$route->getName()]; + return $this->getRouteRequestHandler($route)->handle( + $request->withAttribute(AttributeName::ROUTE, $route) + ); + } - if (!isset($handler)) { - $handler = new QueueableRequestHandler( - $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()) - ); + /** + * @since 3.0.0 + */ + public function getRouterRequestHandler(): RequestHandlerInterface + { + if (isset($this->routerRequestHandler)) { + return $this->routerRequestHandler; + } - foreach ($route->getMiddlewares() as $middleware) { - $handler->enqueue($this->referenceResolver->resolveMiddleware($middleware)); + $this->routerRequestHandler = new CallableRequestHandler( + function (ServerRequestInterface $request): ResponseInterface { + return $this->runRoute($this->match($request), $request); } + ); + + if ($this->middlewares === []) { + return $this->routerRequestHandler; + } + + $this->routerRequestHandler = new QueueableRequestHandler($this->routerRequestHandler); + foreach ($this->middlewares as $middleware) { + $this->routerRequestHandler->enqueue($middleware); + } + + return $this->routerRequestHandler; + } + + /** + * @since 3.0.0 + */ + public function getRouteRequestHandler(Route|string $route): RequestHandlerInterface + { + if (! $route instanceof Route) { + $route = $this->getRoute($route); + } + + $routeName = $route->getName(); + if (isset($this->routeRequestHandlers[$routeName])) { + return $this->routeRequestHandlers[$routeName]; + } + + // phpcs:ignore Generic.Files.LineLength + $this->routeRequestHandlers[$routeName] = $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()); + + $middlewares = $route->getMiddlewares(); + if ($middlewares === []) { + return $this->routeRequestHandlers[$routeName]; + } + + $this->routeRequestHandlers[$routeName] = new QueueableRequestHandler($this->routeRequestHandlers[$routeName]); + foreach ($middlewares as $middleware) { + $this->routeRequestHandlers[$routeName]->enqueue($this->referenceResolver->resolveMiddleware($middleware)); } - return $handler->handle($request); + return $this->routeRequestHandlers[$routeName]; } /** - * @param array $values + * @param array $values * * @throws InvalidArgumentException */ - public function generateUri(string $name, array $values = []): string + public function buildRoutePath(Route|string $route, array $values = []): string { - $route = $this->getRoute($name); - $values += $route->getAttributes(); + if (! $route instanceof Route) { + $route = $this->getRoute($route); + } + + return RouteBuilder::buildRoute($route->getPath(), $values + $route->getAttributes()); + } + + /** + * @return non-empty-string + * + * @throws InvalidArgumentException + */ + public function compileRoutePattern(Route|string $route): string + { + if (! $route instanceof Route) { + $route = $this->getRoute($route); + } - return RouteBuilder::buildRoute($route->getPath(), $values); + return $this->patterns[$route->getName()] ??= $route->getPattern() ?? RouteCompiler::compileRoute($route->getPath(), $route->getPatterns()); } } diff --git a/src/Validation/ConstraintViolation.php b/src/Validation/ConstraintViolation.php index 7be3a3c5..715b9f3e 100644 --- a/src/Validation/ConstraintViolation.php +++ b/src/Validation/ConstraintViolation.php @@ -18,34 +18,20 @@ */ final class ConstraintViolation implements ConstraintViolationInterface { - - /** - * Constructor of the class - * - * @param string $message - * @param string $messageTemplate - * @param array $messagePlaceholders - * @param string $propertyPath - */ public function __construct( private readonly string $message, private readonly string $messageTemplate, + /** @var array */ private readonly array $messagePlaceholders, private readonly string $propertyPath, ) { } - /** readonly - * @inheritDoc - */ public function getMessage(): string { return $this->message; } - /** - * @inheritDoc - */ public function getMessageTemplate(): string { return $this->messageTemplate; @@ -59,9 +45,6 @@ public function getMessagePlaceholders(): array return $this->messagePlaceholders; } - /** - * @inheritDoc - */ public function getPropertyPath(): string { return $this->propertyPath; diff --git a/src/Validation/ConstraintViolation/HydratorErrorProxy.php b/src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php similarity index 74% rename from src/Validation/ConstraintViolation/HydratorErrorProxy.php rename to src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php index f12e2c11..70811fc9 100644 --- a/src/Validation/ConstraintViolation/HydratorErrorProxy.php +++ b/src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php @@ -20,24 +20,16 @@ /** * @since 3.0.0 */ -final class HydratorErrorProxy implements ConstraintViolationInterface +final class HydratorConstraintViolationProxy implements ConstraintViolationInterface { - - /** - * Constructor of the class - * - * @param HydratorConstraintViolation $hydratorConstraintViolation - */ - public function __construct(private HydratorConstraintViolation $hydratorConstraintViolation) + public function __construct(private readonly HydratorConstraintViolation $hydratorConstraintViolation) { } /** * Creates the {@see ConstraintViolationInterface} object(s) from the given hydrator's constraint violation(s) * - * @param HydratorConstraintViolation ...$hydratorConstraintViolations - * - * @return Generator + * @return Generator */ public static function create(HydratorConstraintViolation ...$hydratorConstraintViolations): Generator { @@ -46,17 +38,11 @@ public static function create(HydratorConstraintViolation ...$hydratorConstraint } } - /** - * @inheritDoc - */ public function getMessage(): string { return $this->hydratorConstraintViolation->getMessage(); } - /** - * @inheritDoc - */ public function getMessageTemplate(): string { return $this->hydratorConstraintViolation->getMessageTemplate(); @@ -70,9 +56,6 @@ public function getMessagePlaceholders(): array return $this->hydratorConstraintViolation->getMessagePlaceholders(); } - /** - * @inheritDoc - */ public function getPropertyPath(): string { return $this->hydratorConstraintViolation->getPropertyPath(); diff --git a/src/Validation/ConstraintViolation/ValidatorErrorProxy.php b/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php similarity index 74% rename from src/Validation/ConstraintViolation/ValidatorErrorProxy.php rename to src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php index e5c44a38..609c9037 100644 --- a/src/Validation/ConstraintViolation/ValidatorErrorProxy.php +++ b/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php @@ -20,24 +20,16 @@ /** * @since 3.0.0 */ -final class ValidatorErrorProxy implements ConstraintViolationInterface +final class ValidatorConstraintViolationProxy implements ConstraintViolationInterface { - - /** - * Constructor of the class - * - * @param ValidatorConstraintViolation $validatorConstraintViolation - */ - public function __construct(private ValidatorConstraintViolation $validatorConstraintViolation) + public function __construct(private readonly ValidatorConstraintViolation $validatorConstraintViolation) { } /** * Creates the {@see ConstraintViolationInterface} object(s) from the given validator's constraint violation(s) * - * @param ValidatorConstraintViolation ...$validatorConstraintViolations - * - * @return Generator + * @return Generator */ public static function create(ValidatorConstraintViolation ...$validatorConstraintViolations): Generator { @@ -46,17 +38,11 @@ public static function create(ValidatorConstraintViolation ...$validatorConstrai } } - /** - * @inheritDoc - */ public function getMessage(): string { return $this->validatorConstraintViolation->getMessage(); } - /** - * @inheritDoc - */ public function getMessageTemplate(): string { return $this->validatorConstraintViolation->getMessageTemplate(); @@ -71,9 +57,6 @@ public function getMessagePlaceholders(): array return $this->validatorConstraintViolation->getParameters(); } - /** - * @inheritDoc - */ public function getPropertyPath(): string { return $this->validatorConstraintViolation->getPropertyPath(); diff --git a/src/Validation/ConstraintViolationInterface.php b/src/Validation/ConstraintViolationInterface.php index b4d07249..e49ad6d4 100644 --- a/src/Validation/ConstraintViolationInterface.php +++ b/src/Validation/ConstraintViolationInterface.php @@ -18,32 +18,14 @@ */ interface ConstraintViolationInterface { - - /** - * Gets the violation's interpolated message - * - * @return string - */ public function getMessage(): string; - /** - * Gets the violation's message template - * - * @return string - */ public function getMessageTemplate(): string; /** - * Gets the violation's message placeholders - * * @return array */ public function getMessagePlaceholders(): array; - /** - * Gets the violation's property path - * - * @return string - */ public function getPropertyPath(): string; } From 1dcc076077a4a3e798278d782143534566db1390 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 29 Feb 2024 06:24:31 +0100 Subject: [PATCH 103/180] v3 --- src/Dictionary/AttributeName.php | 23 --- src/Dictionary/VariablePattern.php | 1 - src/Helper/HeaderParser.php | 76 --------- src/Loader/DescriptorLoader.php | 5 +- src/ParameterResolver.php | 37 +---- .../DependencyInjectionParameterResolver.php | 3 +- .../ObjectInjectionParameterResolver.php | 5 +- .../ParameterResolverInterface.php | 3 +- .../RequestBodyParameterResolver.php | 6 +- .../RequestCookieParameterResolver.php | 6 +- .../RequestHeaderParameterResolver.php | 8 +- .../RequestQueryParameterResolver.php | 6 +- .../RequestRouteParameterResolver.php | 8 +- .../RequestStreamParameterResolver.php | 6 +- .../RequestUriParameterResolver.php | 6 +- .../RequestVariableParameterResolver.php | 6 +- .../RouterParameterResolver.php | 54 ------- .../ServerRequestParameterResolver.php | 6 +- src/ResponseResolver.php | 26 +-- .../EmptyResponseResolver.php | 2 +- src/ResponseResolver/JsonResponseResolver.php | 2 +- .../RouteResponseResolver.php | 6 +- .../StreamResponseResolver.php | 2 +- src/ResponseResolver/UriResponseResolver.php | 2 +- src/Route.php | 62 +------- src/Router.php | 148 +++++++++--------- src/ServerRequest.php | 82 +++++++--- 27 files changed, 196 insertions(+), 401 deletions(-) delete mode 100644 src/Dictionary/AttributeName.php delete mode 100644 src/ParameterResolver/RouterParameterResolver.php diff --git a/src/Dictionary/AttributeName.php b/src/Dictionary/AttributeName.php deleted file mode 100644 index 263a622b..00000000 --- a/src/Dictionary/AttributeName.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Dictionary; - -/** - * @since 3.0.0 - */ -final class AttributeName -{ - public const ROUTE = '@route'; - public const ROUTER = '@router'; -} diff --git a/src/Dictionary/VariablePattern.php b/src/Dictionary/VariablePattern.php index b44c9033..3f142dcd 100644 --- a/src/Dictionary/VariablePattern.php +++ b/src/Dictionary/VariablePattern.php @@ -25,6 +25,5 @@ final class VariablePattern public const UPPER = '[A-Z]+'; public const WORD = '[0-9A-Za-z_]+'; public const SLUG = '[0-9A-Za-z-]+'; - public const SLUG_UTF8 = '[\p{N}\p{L}-]+'; public const UUID = '[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}'; } diff --git a/src/Helper/HeaderParser.php b/src/Helper/HeaderParser.php index 12b31692..da6d241a 100644 --- a/src/Helper/HeaderParser.php +++ b/src/Helper/HeaderParser.php @@ -13,91 +13,15 @@ namespace Sunrise\Http\Router\Helper; -use Generator; use Sunrise\Http\Router\Dictionary\Charset; -use Sunrise\Http\Router\Entity\Language\ClientLanguage; -use Sunrise\Http\Router\Entity\MediaType\ClientMediaType; -use function current; -use function preg_match; use function trim; -use function usort; /** * @since 3.0.0 */ final class HeaderParser { - public static function parseContentTypeHeader(string $header): ?ClientMediaType - { - $values = self::parseHeader($header); - if ($values === []) { - return null; - } - - [$identifier, $parameters] = current($values); - - if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier, $matches)) { - return new ClientMediaType( - type: $matches[1], - subtype: $matches[2], - parameters: $parameters, - ); - } - - return null; - } - - /** - * @return Generator, ClientMediaType> - */ - public static function parseAcceptHeader(string $header): Generator - { - $values = self::parseHeader($header); - if ($values === []) { - return; - } - - usort($values, static fn(array $a, array $b): int => ( - (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') - )); - - foreach ($values as $index => [$identifier, $parameters]) { - if (preg_match('|^([^/]+)/([^/]+)$|', $identifier, $matches)) { - yield $index => new ClientMediaType( - type: $matches[1], - subtype: $matches[2], - parameters: $parameters, - ); - } - } - } - - /** - * @return Generator, ClientLanguage> - */ - public static function parseAcceptLanguageHeader(string $header): Generator - { - $values = self::parseHeader($header); - if ($values === []) { - return; - } - - usort($values, static fn(array $a, array $b): int => ( - (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') - )); - - foreach ($values as $index => [$identifier, $parameters]) { - if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches)) { - yield $index => new ClientLanguage( - code: $matches[1], - locale: $identifier, - parameters: $parameters, - ); - } - } - } - /** * @return array, array{0: string, 1: array}> */ diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 331d286c..88df4b2c 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -46,7 +46,6 @@ use function is_file; use function join; use function sprintf; -use function strtoupper; use function usort; final class DescriptorLoader implements LoaderInterface @@ -54,7 +53,7 @@ final class DescriptorLoader implements LoaderInterface public const DEFAULT_CACHE_KEY = 'router_descriptors'; public function __construct( - /** @var list */ + /** @var string[] */ private readonly array $resources, private readonly ?CacheInterface $cache = null, private readonly string $cacheKey = self::DEFAULT_CACHE_KEY, @@ -110,7 +109,7 @@ private function getDescriptors(): array foreach ($this->resources as $resource) { foreach ($this->getResourceDescriptors($resource) as $descriptor) { $descriptor->path = join($descriptor->prefixes) . $descriptor->path; - $descriptor->methods = array_map(strtoupper(...), $descriptor->methods); + $descriptor->methods = array_map(\strtoupper(...), $descriptor->methods); $descriptor->pattern = RouteCompiler::compileRoute($descriptor->path, $descriptor->patterns); $descriptors[] = $descriptor; } diff --git a/src/ParameterResolver.php b/src/ParameterResolver.php index 600cdb50..6de0e3c0 100644 --- a/src/ParameterResolver.php +++ b/src/ParameterResolver.php @@ -26,21 +26,15 @@ */ final class ParameterResolver { + private mixed $context; - /** - * @var mixed - */ - private mixed $context = null; - - /** - * @var list - */ - private array $resolvers = []; + public function __construct( + /** @var ParameterResolverInterface[] */ + private array $resolvers, + ) { + } - /** - * @inheritDoc - */ - public function withContext(mixed $context): static + public function withContext(mixed $context): self { $clone = clone $this; $clone->context = $context; @@ -48,10 +42,7 @@ public function withContext(mixed $context): static return $clone; } - /** - * @inheritDoc - */ - public function withPriorityResolver(ParameterResolverInterface ...$resolvers): static + public function withPriorityResolver(ParameterResolverInterface ...$resolvers): self { $clone = clone $this; $clone->resolvers = []; @@ -68,18 +59,6 @@ public function withPriorityResolver(ParameterResolverInterface ...$resolvers): } /** - * @inheritDoc - */ - public function addResolver(ParameterResolverInterface ...$resolvers): void - { - foreach ($resolvers as $resolver) { - $this->resolvers[] = $resolver; - } - } - - /** - * @inheritDoc - * * @throws LogicException If one of the parameters couldn't be resolved to an argument(s). */ public function resolveParameters(ReflectionParameter ...$parameters): Generator diff --git a/src/ParameterResolver/DependencyInjectionParameterResolver.php b/src/ParameterResolver/DependencyInjectionParameterResolver.php index 5bf3c6ec..d41aa8ea 100644 --- a/src/ParameterResolver/DependencyInjectionParameterResolver.php +++ b/src/ParameterResolver/DependencyInjectionParameterResolver.php @@ -16,7 +16,6 @@ use Generator; use Psr\Container\ContainerExceptionInterface; use Psr\Container\ContainerInterface; -use Psr\Http\Message\RequestInterface; use ReflectionNamedType; use ReflectionParameter; @@ -34,7 +33,7 @@ public function __construct(private readonly ContainerInterface $container) * * @throws ContainerExceptionInterface If something went wrong while working with the container. */ - public function resolveParameter(ReflectionParameter $parameter, ?RequestInterface $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { diff --git a/src/ParameterResolver/ObjectInjectionParameterResolver.php b/src/ParameterResolver/ObjectInjectionParameterResolver.php index d68be0a5..df388b8c 100644 --- a/src/ParameterResolver/ObjectInjectionParameterResolver.php +++ b/src/ParameterResolver/ObjectInjectionParameterResolver.php @@ -31,14 +31,15 @@ public function __construct(private readonly object $object) /** * @inheritDoc */ - public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { return; } - if (is_a($this->object, $type->getName())) { + $typeName = $type->getName(); + if (is_a($this->object, $typeName)) { yield $this->object; } } diff --git a/src/ParameterResolver/ParameterResolverInterface.php b/src/ParameterResolver/ParameterResolverInterface.php index 00daee17..231e59bb 100644 --- a/src/ParameterResolver/ParameterResolverInterface.php +++ b/src/ParameterResolver/ParameterResolverInterface.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router\ParameterResolver; use Generator; -use Psr\Http\Message\RequestInterface; use ReflectionParameter; /** @@ -25,5 +24,5 @@ interface ParameterResolverInterface /** * @return Generator */ - public function resolveParameter(ReflectionParameter $parameter, ?RequestInterface $request): Generator; + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator; } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 39f7baa8..31550a65 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -51,7 +51,7 @@ public function __construct( * * @throws HttpUnprocessableEntityException If the request's parsed body isn't valid. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { if ($parameter->getAttributes(RequestBody::class) === []) { return; @@ -65,14 +65,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $request) )); } - if (! $request instanceof ServerRequestInterface) { + if (! $context instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.' ); } try { - $object = $this->hydrator->hydrate($type->getName(), (array) $request->getParsedBody()); + $object = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidDataException $e) { throw (new HttpUnprocessableEntityException) ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index 21b7d475..845a0046 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -58,7 +58,7 @@ public function __construct( * * @throws HttpBadRequestException If a cookie was missed or invalid. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { /** @var list> $attributes */ $attributes = $parameter->getAttributes(RequestCookie::class); @@ -66,13 +66,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $request) return; } - if (! $request instanceof ServerRequestInterface) { + if (! $context instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.', ); } - $cookies = $request->getCookieParams(); + $cookies = $context->getCookieParams(); $attribute = $attributes[0]->newInstance(); if (!isset($cookies[$attribute->name])) { diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 718b2bb4..086dee1c 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -50,7 +50,7 @@ public function __construct(private HydratorInterface $hydrator) * * @throws HttpBadRequestException If a header was missed or invalid. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { /** @var ReflectionAttribute $attributes */ $attributes = $parameter->getAttributes(RequestHeader::class); @@ -58,7 +58,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $request) return; } - if (! $request instanceof ServerRequestInterface) { + if (! $context instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.' ); @@ -66,7 +66,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $request) $attribute = $attributes[0]->newInstance(); - if (!$request->hasHeader($attribute->name)) { + if (!$context->hasHeader($attribute->name)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } elseif ($parameter->allowsNull()) { @@ -78,7 +78,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $request) try { yield $this->hydrator->castValue( - $request->getHeaderLine($attribute->name), + $context->getHeaderLine($attribute->name), Type::fromParameter($parameter), path: [$attribute->name], ); diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 2ec3d390..5bdf90d1 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -58,7 +58,7 @@ public function __construct( * * @throws HttpUnprocessableEntityException If the request's query parameters isn't valid. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { if ($parameter->getAttributes(RequestQuery::class) === []) { return; @@ -72,14 +72,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $request) )); } - if (! $request instanceof ServerRequestInterface) { + if (! $context instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.' ); } try { - $object = $this->hydrator->hydrate($type->getName(), $request->getQueryParams()); + $object = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { throw (new HttpUnprocessableEntityException) ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); diff --git a/src/ParameterResolver/RequestRouteParameterResolver.php b/src/ParameterResolver/RequestRouteParameterResolver.php index 439e1807..59d182cd 100644 --- a/src/ParameterResolver/RequestRouteParameterResolver.php +++ b/src/ParameterResolver/RequestRouteParameterResolver.php @@ -18,9 +18,9 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; -use Sunrise\Http\Router\Dictionary\AttributeName; use Sunrise\Http\Router\ParameterResolver; use Sunrise\Http\Router\Route; + use function sprintf; /** @@ -36,21 +36,21 @@ final class RequestRouteParameterResolver implements ParameterResolverInterface * * @throws LogicException If the resolver is used incorrectly. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->getName() <> Route::class) { return; } - if (! $request instanceof ServerRequestInterface) { + if (! $context instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.' ); } /** @var Route|null $route */ - $route = $request->getAttribute(AttributeName::ROUTE); + $route = $context->getAttribute('@route'); if (! $route instanceof Route && !$parameter->allowsNull()) { throw new LogicException(sprintf( 'At this level of the application, the current request does not contain a route. ' . diff --git a/src/ParameterResolver/RequestStreamParameterResolver.php b/src/ParameterResolver/RequestStreamParameterResolver.php index f255f58d..27395b35 100644 --- a/src/ParameterResolver/RequestStreamParameterResolver.php +++ b/src/ParameterResolver/RequestStreamParameterResolver.php @@ -30,19 +30,19 @@ final class RequestStreamParameterResolver implements ParameterResolverInterface * * @throws LogicException If the resolver is used incorrectly. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->getName() <> StreamInterface::class) { return; } - if (! $request instanceof ServerRequestInterface) { + if (! $context instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.' ); } - yield $request->getBody(); + yield $context->getBody(); } } diff --git a/src/ParameterResolver/RequestUriParameterResolver.php b/src/ParameterResolver/RequestUriParameterResolver.php index 3d33ce98..b4447576 100644 --- a/src/ParameterResolver/RequestUriParameterResolver.php +++ b/src/ParameterResolver/RequestUriParameterResolver.php @@ -33,19 +33,19 @@ final class RequestUriParameterResolver implements ParameterResolverInterface * * @throws LogicException If the resolver is used incorrectly. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->getName() <> UriInterface::class) { return; } - if (! $request instanceof ServerRequestInterface) { + if (! $context instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.' ); } - yield $request->getUri(); + yield $context->getUri(); } } diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index ee94949b..9804d1c4 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -53,7 +53,7 @@ public function __construct(private HydratorInterface $hydrator) * * @throws HttpNotFoundException If the request's path variable isn't valid. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { /** @var ReflectionAttribute $attributes */ $attributes = $parameter->getAttributes(RequestVariable::class); @@ -61,13 +61,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $request) return; } - if (! $request instanceof ServerRequestInterface) { + if (! $context instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.' ); } - $route = $request->getAttribute('@route'); + $route = $context->getAttribute('@route'); if (! $route instanceof Route) { throw new LogicException(sprintf( 'The #[PathVariable] attribute cannot be applied to the parameter {%s}, ' . diff --git a/src/ParameterResolver/RouterParameterResolver.php b/src/ParameterResolver/RouterParameterResolver.php deleted file mode 100644 index 787dddd1..00000000 --- a/src/ParameterResolver/RouterParameterResolver.php +++ /dev/null @@ -1,54 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ParameterResolver; - -use Generator; -use LogicException; -use Psr\Http\Message\ServerRequestInterface; -use ReflectionNamedType; -use ReflectionParameter; -use Sunrise\Http\Router\Router; - -/** - * @since 3.0.0 - */ -final class RouterParameterResolver implements ParameterResolverInterface -{ - - /** - * @inheritDoc - * - * @throws LogicException If the resolver is used incorrectly. - */ - public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator - { - $type = $parameter->getType(); - if (! $type instanceof ReflectionNamedType || $type->getName() <> Router::class) { - return; - } - - if (! $request instanceof ServerRequestInterface) { - throw new LogicException( - 'At this level of the application, any operations with the request are not possible.' - ); - } - - $router = $request->getAttribute('@router'); - if (! $router instanceof Router) { - throw new LogicException(); - } - - yield $router; - } -} diff --git a/src/ParameterResolver/ServerRequestParameterResolver.php b/src/ParameterResolver/ServerRequestParameterResolver.php index e7c6b6ff..36b4c22b 100644 --- a/src/ParameterResolver/ServerRequestParameterResolver.php +++ b/src/ParameterResolver/ServerRequestParameterResolver.php @@ -33,19 +33,19 @@ final class ServerRequestParameterResolver implements ParameterResolverInterface * * @throws LogicException If the resolver is used incorrectly. */ - public function resolveParameter(ReflectionParameter $parameter, mixed $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->getName() <> ServerRequest::class) { return; } - if (! $request instanceof ServerRequestInterface) { + if (! $context instanceof ServerRequestInterface) { throw new LogicException( 'At this level of the application, any operations with the request are not possible.' ); } - yield ServerRequest::create($request); + yield ServerRequest::create($context); } } diff --git a/src/ResponseResolver.php b/src/ResponseResolver.php index e12ccbc5..883b405c 100644 --- a/src/ResponseResolver.php +++ b/src/ResponseResolver.php @@ -30,31 +30,19 @@ */ final class ResponseResolver { - - /** - * @var list - */ - private array $resolvers = []; - - /** - * @inheritDoc - */ - public function addResolver(ResponseResolverInterface ...$resolvers): void - { - foreach ($resolvers as $resolver) { - $this->resolvers[] = $resolver; - } + public function __construct( + /** @var ResponseResolverInterface[] */ + private readonly array $resolvers, + ) { } /** - * @inheritDoc - * * @throws LogicException If the response couldn't be resolved to PSR-7 response. */ public function resolveResponse( ServerRequestInterface $request, mixed $response, - ReflectionFunction|ReflectionMethod $responder, + ReflectionMethod|ReflectionFunction $responder, ) : ResponseInterface { if ($response instanceof ResponseInterface) { return $this->handleResponse($request, $response, $responder); @@ -85,7 +73,7 @@ public function resolveResponse( private function handleResponse( ServerRequestInterface $request, ResponseInterface $response, - ReflectionFunction|ReflectionMethod $responder, + ReflectionMethod|ReflectionFunction $responder, ) : ResponseInterface { /** @var ReflectionAttribute $attributes */ $attributes = $responder->getAttributes(ResponseStatus::class); @@ -111,7 +99,7 @@ private function handleResponse( * * @return string */ - public static function stringifyResponder(ReflectionFunction|ReflectionMethod $responder): string + public static function stringifyResponder(ReflectionMethod|ReflectionFunction $responder): string { if ($responder instanceof ReflectionMethod) { return sprintf('%s::%s(...)', $responder->getDeclaringClass()->getName(), $responder->getName()); diff --git a/src/ResponseResolver/EmptyResponseResolver.php b/src/ResponseResolver/EmptyResponseResolver.php index 130bd7d7..36630b11 100644 --- a/src/ResponseResolver/EmptyResponseResolver.php +++ b/src/ResponseResolver/EmptyResponseResolver.php @@ -43,7 +43,7 @@ public function __construct(private ResponseFactoryInterface $responseFactory) public function resolveResponse( ServerRequestInterface $request, mixed $response, - ReflectionFunction|ReflectionMethod $responder, + ReflectionMethod|ReflectionFunction $responder, ) : ?ResponseInterface { if ($responder->getAttributes(EmptyResponse::class) === []) { return null; diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index 0f2cee6a..0efe88c4 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -50,7 +50,7 @@ public function __construct(private ResponseFactoryInterface $responseFactory) public function resolveResponse( ServerRequestInterface $request, mixed $response, - ReflectionFunction|ReflectionMethod $responder, + ReflectionMethod|ReflectionFunction $responder, ) : ?ResponseInterface { /** @var ReflectionAttribute $attributes */ $attributes = $responder->getAttributes(JsonResponse::class); diff --git a/src/ResponseResolver/RouteResponseResolver.php b/src/ResponseResolver/RouteResponseResolver.php index 5b0443b8..29bb52aa 100644 --- a/src/ResponseResolver/RouteResponseResolver.php +++ b/src/ResponseResolver/RouteResponseResolver.php @@ -18,7 +18,6 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionFunction; use ReflectionMethod; -use Sunrise\Http\Router\Dictionary\AttributeName; use Sunrise\Http\Router\Route; use Sunrise\Http\Router\Router; @@ -29,20 +28,19 @@ */ final class RouteResponseResolver implements ResponseResolverInterface { - /** * @inheritDoc */ public function resolveResponse( ServerRequestInterface $request, mixed $response, - ReflectionFunction|ReflectionMethod $responder, + ReflectionMethod|ReflectionFunction $responder, ) : ?ResponseInterface { if (! $response instanceof Route) { return null; } - $router = $request->getAttribute(AttributeName::ROUTER); + $router = $request->getAttribute('@router'); if (! $router instanceof Router) { throw new LogicException(); } diff --git a/src/ResponseResolver/StreamResponseResolver.php b/src/ResponseResolver/StreamResponseResolver.php index 6aa271ad..1f8fb1dd 100644 --- a/src/ResponseResolver/StreamResponseResolver.php +++ b/src/ResponseResolver/StreamResponseResolver.php @@ -43,7 +43,7 @@ public function __construct(private ResponseFactoryInterface $responseFactory) public function resolveResponse( ServerRequestInterface $request, mixed $response, - ReflectionFunction|ReflectionMethod $responder, + ReflectionMethod|ReflectionFunction $responder, ) : ?ResponseInterface { if (! $response instanceof StreamInterface) { return null; diff --git a/src/ResponseResolver/UriResponseResolver.php b/src/ResponseResolver/UriResponseResolver.php index 87dfe6ea..93ee3618 100644 --- a/src/ResponseResolver/UriResponseResolver.php +++ b/src/ResponseResolver/UriResponseResolver.php @@ -43,7 +43,7 @@ public function __construct(private ResponseFactoryInterface $responseFactory) public function resolveResponse( ServerRequestInterface $request, mixed $response, - ReflectionFunction|ReflectionMethod $responder, + ReflectionMethod|ReflectionFunction $responder, ) : ?ResponseInterface { if (! $response instanceof UriInterface) { return null; diff --git a/src/Route.php b/src/Route.php index 0073647f..525a23d8 100644 --- a/src/Route.php +++ b/src/Route.php @@ -16,7 +16,6 @@ use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; use function array_key_exists; -use function in_array; final class Route { @@ -31,9 +30,9 @@ public function __construct( /** @var array */ private array $attributes = [], /** @var list */ - private array $middlewares = [], + private readonly array $middlewares = [], /** @var list */ - private array $constraints = [], + private readonly array $constraints = [], /** @var list */ private readonly array $consumes = [], /** @var list */ @@ -79,15 +78,6 @@ public function getMethods(): array return $this->methods; } - public function listensMethod(string $method): bool - { - if ($this->methods === []) { - return true; - } - - return in_array($method, $this->methods, true); - } - /** * @return array */ @@ -138,30 +128,6 @@ public function getMiddlewares(): array return $this->middlewares; } - /** - * @param list $middlewares - */ - public function withMiddlewares(array $middlewares): self - { - $clone = clone $this; - $clone->middlewares = $middlewares; - - return $clone; - } - - /** - * @param list $middlewares - */ - public function withAddedMiddlewares(array $middlewares): self - { - $clone = clone $this; - foreach ($middlewares as $middleware) { - $clone->middlewares[] = $middleware; - } - - return $clone; - } - /** * @return list */ @@ -170,30 +136,6 @@ public function getConstraints(): array return $this->constraints; } - /** - * @param list $constraints - */ - public function withConstraints(array $constraints): self - { - $clone = clone $this; - $clone->constraints = $constraints; - - return $clone; - } - - /** - * @param list $constraints - */ - public function withAddedConstraints(array $constraints): self - { - $clone = clone $this; - foreach ($constraints as $constraint) { - $clone->constraints[] = $constraint; - } - - return $clone; - } - /** * @return list */ diff --git a/src/Router.php b/src/Router.php index bd7bc0a9..13dd67c9 100644 --- a/src/Router.php +++ b/src/Router.php @@ -18,7 +18,6 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Dictionary\AttributeName; use Sunrise\Http\Router\Exception\Http\HttpMethodNotAllowedException; use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; use Sunrise\Http\Router\Exception\Http\HttpUnsupportedMediaTypeException; @@ -33,15 +32,16 @@ use function array_flip; use function array_keys; +use function in_array; use function rawurldecode; use function sprintf; class Router { - private readonly ParameterResolver $parameterResolver; - private readonly ResponseResolver $responseResolver; private readonly ReferenceResolver $referenceResolver; + private array $middlewares; + /** * @var array */ @@ -50,12 +50,7 @@ class Router /** * @var array */ - private array $patterns = []; - - /** - * @var list - */ - private array $middlewares = []; + private array $routePatterns = []; /** * @var array @@ -65,14 +60,26 @@ class Router private ?RequestHandlerInterface $routerRequestHandler = null; /** + * @param ParameterResolverInterface[] $parameterResolvers + * @param ResponseResolverInterface[] $responseResolvers + * @param list $loaders + * * @since 3.0.0 */ - public function __construct() - { + public function __construct( + array $middlewares = [], + array $parameterResolvers = [], + array $responseResolvers = [], + array $loaders = [], + ) { + $this->middlewares = $middlewares; + $this->referenceResolver = new ReferenceResolver( - $this->parameterResolver = new ParameterResolver(), - $this->responseResolver = new ResponseResolver(), + new ParameterResolver($parameterResolvers), + new ResponseResolver($responseResolvers), ); + + $this->load(...$loaders); } /** @@ -88,7 +95,11 @@ public function getRoutes(): array */ public function getRoute(string $name): Route { - return $this->routes[$name] ?? throw new InvalidArgumentException(sprintf( + if (isset($this->routes[$name])) { + return $this->routes[$name]; + } + + return throw new InvalidArgumentException(sprintf( 'The route %s does not exist.', $name, )); @@ -101,7 +112,7 @@ public function addRoute(Route ...$routes) : void } } - public function loadRoutes(LoaderInterface ...$loaders): void + public function load(LoaderInterface ...$loaders): void { foreach ($loaders as $loader) { foreach ($loader->load() as $route) { @@ -110,23 +121,6 @@ public function loadRoutes(LoaderInterface ...$loaders): void } } - public function addMiddleware(mixed ...$middlewares): void - { - foreach ($middlewares as $middleware) { - $this->middlewares[] = $this->referenceResolver->resolveMiddleware($middleware); - } - } - - public function addParameterResolver(ParameterResolverInterface ...$resolvers): void - { - $this->parameterResolver->addResolver(...$resolvers); - } - - public function addResponseResolver(ResponseResolverInterface ...$resolvers): void - { - $this->responseResolver->addResolver(...$resolvers); - } - /** * Looks for a route that matches the given request * @@ -148,7 +142,7 @@ public function match(ServerRequestInterface $request): Route $requestPath = rawurldecode($request->getUri()->getPath()); $allowedMethods = []; foreach ($this->routes as $route) { - $routePattern = $this->compileRoutePattern($route); + $routePattern = $this->compileRoute($route); // https://github.com/sunrise-php/http-router/issues/50 // https://tools.ietf.org/html/rfc7231#section-6.5.5 @@ -156,8 +150,9 @@ public function match(ServerRequestInterface $request): Route continue; } - if (!$route->listensMethod($request->getMethod())) { - $allowedMethods += array_flip($route->getMethods()); + $routeMethods = $route->getMethods(); + if (!empty($routeMethods) && !in_array($request->getMethod(), $routeMethods, true)) { + $allowedMethods += array_flip($routeMethods); continue; } @@ -181,7 +176,7 @@ public function match(ServerRequestInterface $request): Route public function run(ServerRequestInterface $request): ResponseInterface { return $this->getRouterRequestHandler()->handle( - $request->withAttribute(AttributeName::ROUTER, $this) + $request->withAttribute('@router', $this) ); } @@ -199,35 +194,37 @@ public function runRoute(Route|string $route, ServerRequestInterface $request): } return $this->getRouteRequestHandler($route)->handle( - $request->withAttribute(AttributeName::ROUTE, $route) + $request->withAttribute('@route', $route) ); } /** - * @since 3.0.0 + * @param array $values + * + * @throws InvalidArgumentException */ - public function getRouterRequestHandler(): RequestHandlerInterface + public function buildRoute(Route|string $route, array $values = []): string { - if (isset($this->routerRequestHandler)) { - return $this->routerRequestHandler; + if (! $route instanceof Route) { + $route = $this->getRoute($route); } - $this->routerRequestHandler = new CallableRequestHandler( - function (ServerRequestInterface $request): ResponseInterface { - return $this->runRoute($this->match($request), $request); - } - ); - - if ($this->middlewares === []) { - return $this->routerRequestHandler; - } + return RouteBuilder::buildRoute($route->getPath(), $values + $route->getAttributes()); + } - $this->routerRequestHandler = new QueueableRequestHandler($this->routerRequestHandler); - foreach ($this->middlewares as $middleware) { - $this->routerRequestHandler->enqueue($middleware); + /** + * @return non-empty-string + * + * @throws InvalidArgumentException + */ + public function compileRoute(Route|string $route): string + { + if (! $route instanceof Route) { + $route = $this->getRoute($route); } - return $this->routerRequestHandler; + // phpcs:ignore Generic.Files.LineLength + return $this->routePatterns[$route->getName()] ??= $route->getPattern() ?? RouteCompiler::compileRoute($route->getPath(), $route->getPatterns()); } /** @@ -254,37 +251,42 @@ public function getRouteRequestHandler(Route|string $route): RequestHandlerInter $this->routeRequestHandlers[$routeName] = new QueueableRequestHandler($this->routeRequestHandlers[$routeName]); foreach ($middlewares as $middleware) { - $this->routeRequestHandlers[$routeName]->enqueue($this->referenceResolver->resolveMiddleware($middleware)); + $this->routeRequestHandlers[$routeName]->enqueue( + $this->referenceResolver->resolveMiddleware($middleware) + ); } return $this->routeRequestHandlers[$routeName]; } /** - * @param array $values - * - * @throws InvalidArgumentException + * @since 3.0.0 */ - public function buildRoutePath(Route|string $route, array $values = []): string + public function getRouterRequestHandler(): RequestHandlerInterface { - if (! $route instanceof Route) { - $route = $this->getRoute($route); + if (isset($this->routerRequestHandler)) { + return $this->routerRequestHandler; } - return RouteBuilder::buildRoute($route->getPath(), $values + $route->getAttributes()); - } + $this->routerRequestHandler = new CallableRequestHandler( + function (ServerRequestInterface $request): ResponseInterface { + $route = $this->match($request); - /** - * @return non-empty-string - * - * @throws InvalidArgumentException - */ - public function compileRoutePattern(Route|string $route): string - { - if (! $route instanceof Route) { - $route = $this->getRoute($route); + return $this->runRoute($route, $request); + } + ); + + if ($this->middlewares === []) { + return $this->routerRequestHandler; } - return $this->patterns[$route->getName()] ??= $route->getPattern() ?? RouteCompiler::compileRoute($route->getPath(), $route->getPatterns()); + $this->routerRequestHandler = new QueueableRequestHandler($this->routerRequestHandler); + foreach ($this->middlewares as $middleware) { + $this->routerRequestHandler->enqueue( + $this->referenceResolver->resolveMiddleware($middleware) + ); + } + + return $this->routerRequestHandler; } } diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 4d028cfc..7fe09031 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -25,14 +25,15 @@ use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; use Sunrise\Http\Router\Helper\HeaderParser; +use function current; +use function preg_match; +use function usort; + /** * @since 3.0.0 */ final class ServerRequest implements ServerRequestInterface { - private ?LanguageComparator $languageComparator = null; - private ?MediaTypeComparator $mediaTypeComparator = null; - public function __construct(private ServerRequestInterface $request) { } @@ -47,19 +48,24 @@ public function getOriginalRequest(): ServerRequestInterface return $this->request; } - public function getLanguageComparator(): LanguageComparator + public function getClientProducedMediaType(): ?ClientMediaType { - return $this->languageComparator ??= new LanguageComparator(); - } + $header = $this->request->getHeaderLine('Content-Type'); + $values = HeaderParser::parseHeader($header); + if ($values === []) { + return null; + } - public function getMediaTypeComparator(): MediaTypeComparator - { - return $this->mediaTypeComparator ??= new MediaTypeComparator(); - } + [$identifier, $parameters] = current($values); + if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier, $matches)) { + return new ClientMediaType( + type: $matches[1], + subtype: $matches[2], + parameters: $parameters, + ); + } - public function getClientProducedMediaType(): ?ClientMediaType - { - return HeaderParser::parseContentTypeHeader($this->request->getHeaderLine('Content-Type')); + return null; } /** @@ -67,7 +73,25 @@ public function getClientProducedMediaType(): ?ClientMediaType */ public function getClientConsumedMediaTypes(): Generator { - yield from HeaderParser::parseAcceptHeader($this->request->getHeaderLine('Accept')); + $header = $this->request->getHeaderLine('Accept'); + $values = HeaderParser::parseHeader($header); + if ($values === []) { + return; + } + + usort($values, static fn(array $a, array $b): int => ( + (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') + )); + + foreach ($values as $index => [$identifier, $parameters]) { + if (preg_match('|^([^/]+)/([^/]+)$|', $identifier, $matches)) { + yield $index => new ClientMediaType( + type: $matches[1], + subtype: $matches[2], + parameters: $parameters, + ); + } + } } /** @@ -75,7 +99,25 @@ public function getClientConsumedMediaTypes(): Generator */ public function getClientConsumedLanguages(): Generator { - yield from HeaderParser::parseAcceptLanguageHeader($this->request->getHeaderLine('Accept-Language')); + $header = $this->request->getHeaderLine('Accept-Language'); + $values = HeaderParser::parseHeader($header); + if ($values === []) { + return; + } + + usort($values, static fn(array $a, array $b): int => ( + (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') + )); + + foreach ($values as $index => [$identifier, $parameters]) { + if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches)) { + yield $index => new ClientLanguage( + code: $matches[1], + locale: $identifier, + parameters: $parameters, + ); + } + } } public function getClientPreferredMediaType(MediaTypeInterface ...$serverProducedMediaTypes): ?ClientMediaType @@ -84,7 +126,7 @@ public function getClientPreferredMediaType(MediaTypeInterface ...$serverProduce return null; } - $mediaTypeComparator = $this->getMediaTypeComparator(); + $mediaTypeComparator = new MediaTypeComparator(); foreach ($this->getClientConsumedMediaTypes() as $clientConsumedMediaType) { foreach ($serverProducedMediaTypes as $serverProducedMediaType) { if ($mediaTypeComparator->equals($clientConsumedMediaType, $serverProducedMediaType)) { @@ -102,7 +144,7 @@ public function getClientPreferredLanguage(LanguageInterface ...$serverProducedL return null; } - $languageComparator = $this->getLanguageComparator(); + $languageComparator = new LanguageComparator(); foreach ($this->getClientConsumedLanguages() as $clientConsumedLanguage) { foreach ($serverProducedLanguages as $serverProducedLanguage) { if ($languageComparator->equals($clientConsumedLanguage, $serverProducedLanguage)) { @@ -126,7 +168,7 @@ public function clientProducesMediaType(MediaTypeInterface ...$serverConsumedMed return false; } - $mediaTypeComparator = $this->getMediaTypeComparator(); + $mediaTypeComparator = new MediaTypeComparator(); foreach ($serverConsumedMediaTypes as $serverConsumedMediaType) { if ($mediaTypeComparator->equals($clientProducedMediaType, $serverConsumedMediaType)) { return true; @@ -142,7 +184,7 @@ public function clientConsumesMediaType(MediaTypeInterface ...$serverProducedMed return false; } - $mediaTypeComparator = $this->getMediaTypeComparator(); + $mediaTypeComparator = new MediaTypeComparator(); foreach ($this->getClientConsumedMediaTypes() as $clientConsumedMediaType) { foreach ($serverProducedMediaTypes as $serverProducedMediaType) { if ($mediaTypeComparator->equals($clientConsumedMediaType, $serverProducedMediaType)) { @@ -160,7 +202,7 @@ public function clientConsumesLanguage(LanguageInterface ...$serverProducedLangu return false; } - $languageComparator = $this->getLanguageComparator(); + $languageComparator = new LanguageComparator(); foreach ($this->getClientConsumedLanguages() as $clientConsumedLanguage) { foreach ($serverProducedLanguages as $serverProducedLanguage) { if ($languageComparator->equals($clientConsumedLanguage, $serverProducedLanguage)) { From 3c2a506200bbc17ab35e745ce156a90772622d0c Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 2 Mar 2024 09:50:45 +0100 Subject: [PATCH 104/180] v3 --- src/Annotation/RequestBody.php | 6 + src/Annotation/RequestCookie.php | 3 + src/Annotation/RequestHeader.php | 3 + src/Annotation/RequestQuery.php | 6 + src/Annotation/RequestVariable.php | 3 + src/ConstraintViolation.php | 90 +++++++ .../ConstraintViolationInterface.php | 7 +- src/Dictionary/VariablePattern.php | 1 + .../Http/HttpBadRequestException.php | 13 - src/Exception/Http/HttpConflictException.php | 48 ---- .../Http/HttpFailedDependencyException.php | 48 ---- src/Exception/Http/HttpForbiddenException.php | 47 ---- .../Http/HttpInternalServerErrorException.php | 59 ----- src/Exception/Http/HttpLockedException.php | 48 ---- .../Http/HttpMethodNotAllowedException.php | 14 - src/Exception/Http/HttpNotFoundException.php | 13 - .../Http/HttpPayloadTooLargeException.php | 47 ---- .../Http/HttpServiceUnavailableException.php | 48 ---- .../Http/HttpTooManyRequestsException.php | 47 ---- .../Http/HttpUnauthorizedException.php | 48 ---- ...ttpUnavailableForLegalReasonsException.php | 48 ---- .../Http/HttpUnprocessableEntityException.php | 47 ---- .../HttpUnsupportedMediaTypeException.php | 11 - src/Exception/HttpException.php | 8 +- src/Exception/HttpExceptionInterface.php | 2 +- src/Helper/RouteBuilder.php | 2 - src/Helper/Stringifier.php | 64 +++++ src/InterceptorResolver.php | 240 ++++++++++++++++++ src/Loader/DescriptorLoader.php | 5 +- src/Middleware/CallbackMiddleware.php | 66 ----- src/ParameterResolver.php | 37 +-- .../ObjectInjectionParameterResolver.php | 3 +- .../RequestBodyParameterResolver.php | 36 +-- .../RequestCookieParameterResolver.php | 63 ++--- .../RequestHeaderParameterResolver.php | 68 +++-- .../RequestQueryParameterResolver.php | 43 ++-- .../RequestRouteParameterResolver.php | 9 +- .../RequestUriParameterResolver.php | 3 - .../RequestVariableParameterResolver.php | 73 +++--- .../ServerRequestParameterResolver.php | 3 - src/ReferenceResolver.php | 199 --------------- src/RequestHandler/CallbackRequestHandler.php | 64 ----- src/ResponseResolver.php | 30 +-- .../EmptyResponseResolver.php | 6 - src/ResponseResolver/JsonResponseResolver.php | 12 +- .../StreamResponseResolver.php | 6 - src/ResponseResolver/UriResponseResolver.php | 6 - src/Route.php | 10 + src/Router.php | 33 +-- src/Validation/ConstraintViolation.php | 52 ---- .../HydratorConstraintViolationProxy.php | 63 ----- .../ValidatorConstraintViolationProxy.php | 64 ----- 52 files changed, 609 insertions(+), 1366 deletions(-) create mode 100644 src/ConstraintViolation.php rename src/{Validation => }/ConstraintViolationInterface.php (86%) delete mode 100644 src/Exception/Http/HttpConflictException.php delete mode 100644 src/Exception/Http/HttpFailedDependencyException.php delete mode 100644 src/Exception/Http/HttpForbiddenException.php delete mode 100644 src/Exception/Http/HttpInternalServerErrorException.php delete mode 100644 src/Exception/Http/HttpLockedException.php delete mode 100644 src/Exception/Http/HttpPayloadTooLargeException.php delete mode 100644 src/Exception/Http/HttpServiceUnavailableException.php delete mode 100644 src/Exception/Http/HttpTooManyRequestsException.php delete mode 100644 src/Exception/Http/HttpUnauthorizedException.php delete mode 100644 src/Exception/Http/HttpUnavailableForLegalReasonsException.php delete mode 100644 src/Exception/Http/HttpUnprocessableEntityException.php create mode 100644 src/Helper/Stringifier.php create mode 100644 src/InterceptorResolver.php delete mode 100644 src/Middleware/CallbackMiddleware.php delete mode 100644 src/ReferenceResolver.php delete mode 100644 src/RequestHandler/CallbackRequestHandler.php delete mode 100644 src/Validation/ConstraintViolation.php delete mode 100644 src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php delete mode 100644 src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php diff --git a/src/Annotation/RequestBody.php b/src/Annotation/RequestBody.php index 149c5d8f..c7cf4d53 100644 --- a/src/Annotation/RequestBody.php +++ b/src/Annotation/RequestBody.php @@ -21,4 +21,10 @@ #[Attribute(Attribute::TARGET_PARAMETER)] final class RequestBody { + public function __construct( + /** @var int<100, 599> */ + public readonly int $errorStatusCode = 400, + public readonly ?string $errorMessage = null, + ) { + } } diff --git a/src/Annotation/RequestCookie.php b/src/Annotation/RequestCookie.php index 17517c29..9e028a2d 100644 --- a/src/Annotation/RequestCookie.php +++ b/src/Annotation/RequestCookie.php @@ -23,6 +23,9 @@ final class RequestCookie { public function __construct( public readonly string $name, + /** @var int<100, 599> */ + public readonly int $errorStatusCode = 400, + public readonly ?string $errorMessage = null, ) { } } diff --git a/src/Annotation/RequestHeader.php b/src/Annotation/RequestHeader.php index c87f9773..090cf5ff 100644 --- a/src/Annotation/RequestHeader.php +++ b/src/Annotation/RequestHeader.php @@ -23,6 +23,9 @@ final class RequestHeader { public function __construct( public readonly string $name, + /** @var int<100, 599> */ + public readonly int $errorStatusCode = 400, + public readonly ?string $errorMessage = null, ) { } } diff --git a/src/Annotation/RequestQuery.php b/src/Annotation/RequestQuery.php index a064389b..0b4ca274 100644 --- a/src/Annotation/RequestQuery.php +++ b/src/Annotation/RequestQuery.php @@ -21,4 +21,10 @@ #[Attribute(Attribute::TARGET_PARAMETER)] final class RequestQuery { + public function __construct( + /** @var int<100, 599> */ + public readonly int $errorStatusCode = 400, + public readonly ?string $errorMessage = null, + ) { + } } diff --git a/src/Annotation/RequestVariable.php b/src/Annotation/RequestVariable.php index 13ccd5a5..ec9374f2 100644 --- a/src/Annotation/RequestVariable.php +++ b/src/Annotation/RequestVariable.php @@ -23,6 +23,9 @@ final class RequestVariable { public function __construct( public readonly string|null $name = null, + /** @var int<100, 599> */ + public readonly int $errorStatusCode = 400, + public readonly ?string $errorMessage = null, ) { } } diff --git a/src/ConstraintViolation.php b/src/ConstraintViolation.php new file mode 100644 index 00000000..74630885 --- /dev/null +++ b/src/ConstraintViolation.php @@ -0,0 +1,90 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router; + +use Generator; +use Sunrise\Hydrator\Exception\InvalidValueException as HydratorConstraintViolation; +use Symfony\Component\Validator\ConstraintViolationInterface as ValidatorConstraintViolation; + +/** + * @since 3.0.0 + */ +final class ConstraintViolation implements ConstraintViolationInterface +{ + public function __construct( + private readonly string $message, + private readonly string $messageTemplate, + private readonly array $messagePlaceholders, + private readonly string $propertyPath, + private readonly ?string $code, + ) { + } + + public function getMessage(): string + { + return $this->message; + } + + public function getMessageTemplate(): string + { + return $this->messageTemplate; + } + + public function getMessagePlaceholders(): array + { + return $this->messagePlaceholders; + } + + public function getPropertyPath(): string + { + return $this->propertyPath; + } + + public function getCode(): ?string + { + return $this->code; + } + + /** + * @return Generator + */ + public static function fromHydrator(HydratorConstraintViolation ...$violations): Generator + { + foreach ($violations as $violation) { + yield new self( + $violation->getMessage(), + $violation->getMessageTemplate(), + $violation->getMessagePlaceholders(), + $violation->getPropertyPath(), + $violation->getErrorCode(), + ); + } + } + + /** + * @return Generator + */ + public static function fromValidator(ValidatorConstraintViolation ...$violations): Generator + { + foreach ($violations as $violation) { + yield new self( + (string) $violation->getMessage(), + $violation->getMessageTemplate(), + $violation->getParameters(), + $violation->getPropertyPath(), + $violation->getCode(), + ); + } + } +} diff --git a/src/Validation/ConstraintViolationInterface.php b/src/ConstraintViolationInterface.php similarity index 86% rename from src/Validation/ConstraintViolationInterface.php rename to src/ConstraintViolationInterface.php index e49ad6d4..8bff1d15 100644 --- a/src/Validation/ConstraintViolationInterface.php +++ b/src/ConstraintViolationInterface.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Validation; +namespace Sunrise\Http\Router; /** * @since 3.0.0 @@ -22,10 +22,9 @@ public function getMessage(): string; public function getMessageTemplate(): string; - /** - * @return array - */ public function getMessagePlaceholders(): array; public function getPropertyPath(): string; + + public function getCode(): ?string; } diff --git a/src/Dictionary/VariablePattern.php b/src/Dictionary/VariablePattern.php index 3f142dcd..ca3c4dd0 100644 --- a/src/Dictionary/VariablePattern.php +++ b/src/Dictionary/VariablePattern.php @@ -26,4 +26,5 @@ final class VariablePattern public const WORD = '[0-9A-Za-z_]+'; public const SLUG = '[0-9A-Za-z-]+'; public const UUID = '[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}'; + public const LANG = '[a-z]{2}'; } diff --git a/src/Exception/Http/HttpBadRequestException.php b/src/Exception/Http/HttpBadRequestException.php index 33d7bd6f..665cb5c5 100644 --- a/src/Exception/Http/HttpBadRequestException.php +++ b/src/Exception/Http/HttpBadRequestException.php @@ -25,21 +25,8 @@ */ class HttpBadRequestException extends HttpException { - - /** - * The error's default message - * - * @var string - */ public const DEFAULT_MESSAGE = 'The request could not be processed due to malformed syntax or invalid parameters.'; - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { parent::__construct(self::STATUS_BAD_REQUEST, $message ?? self::DEFAULT_MESSAGE, $code, $previous); diff --git a/src/Exception/Http/HttpConflictException.php b/src/Exception/Http/HttpConflictException.php deleted file mode 100644 index 59150575..00000000 --- a/src/Exception/Http/HttpConflictException.php +++ /dev/null @@ -1,48 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Conflict Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409 - * - * @since 3.0.0 - */ -class HttpConflictException extends HttpException -{ - - /** - * The error's default message - * - * @var string - */ - // phpcs:ignore Generic.Files.LineLength - public const DEFAULT_MESSAGE = 'The request could not be processed due to conflicts with the resource‘s current state.'; - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - parent::__construct(self::STATUS_CONFLICT, $message ?? self::DEFAULT_MESSAGE, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpFailedDependencyException.php b/src/Exception/Http/HttpFailedDependencyException.php deleted file mode 100644 index 3a20e7df..00000000 --- a/src/Exception/Http/HttpFailedDependencyException.php +++ /dev/null @@ -1,48 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Failed Dependency Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/424 - * - * @since 3.0.0 - */ -class HttpFailedDependencyException extends HttpException -{ - - /** - * The error's default message - * - * @var string - */ - // phpcs:ignore Generic.Files.LineLength - public const DEFAULT_MESSAGE = 'The request could not be processed due to failures with the resource‘s dependencies.'; - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - parent::__construct(self::STATUS_FAILED_DEPENDENCY, $message ?? self::DEFAULT_MESSAGE, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpForbiddenException.php b/src/Exception/Http/HttpForbiddenException.php deleted file mode 100644 index 865c182a..00000000 --- a/src/Exception/Http/HttpForbiddenException.php +++ /dev/null @@ -1,47 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Forbidden Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/403 - * - * @since 3.0.0 - */ -class HttpForbiddenException extends HttpException -{ - - /** - * The error's default message - * - * @var string - */ - public const DEFAULT_MESSAGE = 'The request could not be processed due to insufficient permissions.'; - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - parent::__construct(self::STATUS_FORBIDDEN, $message ?? self::DEFAULT_MESSAGE, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpInternalServerErrorException.php b/src/Exception/Http/HttpInternalServerErrorException.php deleted file mode 100644 index f6db02c6..00000000 --- a/src/Exception/Http/HttpInternalServerErrorException.php +++ /dev/null @@ -1,59 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Internal Server Error Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500 - * - * @since 3.0.0 - */ -class HttpInternalServerErrorException extends HttpException -{ - - /** - * The error's default message - * - * @var string - */ - // phpcs:ignore Generic.Files.LineLength - public const DEFAULT_MESSAGE = 'The server encountered an unexpected condition that prevented it from fulfilling the request.'; - - /** - * Constructor of the class - * - * @param Throwable $error - * @param string|null $message - * @param int $code - */ - public function __construct(Throwable $error, ?string $message = null, int $code = 0) - { - parent::__construct(self::STATUS_INTERNAL_SERVER_ERROR, $message ?? self::DEFAULT_MESSAGE, $code, $error); - } - - /** - * Gets the server error - * - * @return Throwable - */ - public function getServerError(): Throwable - { - /** @var Throwable */ - return $this->getPrevious(); - } -} diff --git a/src/Exception/Http/HttpLockedException.php b/src/Exception/Http/HttpLockedException.php deleted file mode 100644 index 68516237..00000000 --- a/src/Exception/Http/HttpLockedException.php +++ /dev/null @@ -1,48 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Locked Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/423 - * - * @since 3.0.0 - */ -class HttpLockedException extends HttpException -{ - - /** - * The error's default message - * - * @var string - */ - // phpcs:ignore Generic.Files.LineLength - public const DEFAULT_MESSAGE = 'The request could not be processed due to the resource‘s temporary lock and inaccessibility.'; - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - parent::__construct(self::STATUS_LOCKED, $message ?? self::DEFAULT_MESSAGE, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpMethodNotAllowedException.php b/src/Exception/Http/HttpMethodNotAllowedException.php index e6123cac..ef866411 100644 --- a/src/Exception/Http/HttpMethodNotAllowedException.php +++ b/src/Exception/Http/HttpMethodNotAllowedException.php @@ -26,22 +26,8 @@ */ class HttpMethodNotAllowedException extends HttpException { - - /** - * The error's default message - * - * @var string - */ public const DEFAULT_MESSAGE = 'The request could not be processed using the requested HTTP method.'; - /** - * Constructor of the class - * - * @param list $allowedMethods - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ // phpcs:ignore Generic.Files.LineLength public function __construct(private array $allowedMethods, ?string $message = null, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/Http/HttpNotFoundException.php b/src/Exception/Http/HttpNotFoundException.php index dc2d1103..e341fb8b 100644 --- a/src/Exception/Http/HttpNotFoundException.php +++ b/src/Exception/Http/HttpNotFoundException.php @@ -25,21 +25,8 @@ */ class HttpNotFoundException extends HttpException { - - /** - * The error's default message - * - * @var string - */ public const DEFAULT_MESSAGE = 'The requested page or resource could not be found.'; - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) { parent::__construct(self::STATUS_NOT_FOUND, $message ?? self::DEFAULT_MESSAGE, $code, $previous); diff --git a/src/Exception/Http/HttpPayloadTooLargeException.php b/src/Exception/Http/HttpPayloadTooLargeException.php deleted file mode 100644 index ab30cab9..00000000 --- a/src/Exception/Http/HttpPayloadTooLargeException.php +++ /dev/null @@ -1,47 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Payload Too Large Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/413 - * - * @since 3.0.0 - */ -class HttpPayloadTooLargeException extends HttpException -{ - - /** - * The error's default message - * - * @var string - */ - public const DEFAULT_MESSAGE = 'The request could not be processed due to the payload size exceeding limits.'; - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - parent::__construct(self::STATUS_PAYLOAD_TOO_LARGE, $message ?? self::DEFAULT_MESSAGE, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpServiceUnavailableException.php b/src/Exception/Http/HttpServiceUnavailableException.php deleted file mode 100644 index 0cc25725..00000000 --- a/src/Exception/Http/HttpServiceUnavailableException.php +++ /dev/null @@ -1,48 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Service Unavailable Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503 - * - * @since 3.0.0 - */ -class HttpServiceUnavailableException extends HttpException -{ - - /** - * The error's default message - * - * @var string - */ - // phpcs:ignore Generic.Files.LineLength - public const DEFAULT_MESSAGE = 'The server is currently unable to process the request due to temporary overloading or maintenance.'; - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - parent::__construct(self::STATUS_SERVICE_UNAVAILABLE, $message ?? self::DEFAULT_MESSAGE, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpTooManyRequestsException.php b/src/Exception/Http/HttpTooManyRequestsException.php deleted file mode 100644 index 61af43aa..00000000 --- a/src/Exception/Http/HttpTooManyRequestsException.php +++ /dev/null @@ -1,47 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Too Many Requests Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429 - * - * @since 3.0.0 - */ -class HttpTooManyRequestsException extends HttpException -{ - - /** - * The error's default message - * - * @var string - */ - public const DEFAULT_MESSAGE = 'The request could not be processed due to exceeding rate-limiting thresholds.'; - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - parent::__construct(self::STATUS_TOO_MANY_REQUESTS, $message ?? self::DEFAULT_MESSAGE, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpUnauthorizedException.php b/src/Exception/Http/HttpUnauthorizedException.php deleted file mode 100644 index 0b8c6351..00000000 --- a/src/Exception/Http/HttpUnauthorizedException.php +++ /dev/null @@ -1,48 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Unauthorized Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401 - * - * @since 3.0.0 - */ -class HttpUnauthorizedException extends HttpException -{ - - /** - * The error's default message - * - * @var string - */ - // phpcs:ignore Generic.Files.LineLength - public const DEFAULT_MESSAGE = 'The request could not processed due to insufficient or invalid authentication credentials.'; - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - parent::__construct(self::STATUS_UNAUTHORIZED, $message ?? self::DEFAULT_MESSAGE, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpUnavailableForLegalReasonsException.php b/src/Exception/Http/HttpUnavailableForLegalReasonsException.php deleted file mode 100644 index fe9ac5a4..00000000 --- a/src/Exception/Http/HttpUnavailableForLegalReasonsException.php +++ /dev/null @@ -1,48 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Unavailable For Legal Reasons Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/451 - * - * @since 3.0.0 - */ -class HttpUnavailableForLegalReasonsException extends HttpException -{ - - /** - * The error's default message - * - * @var string - */ - public const DEFAULT_MESSAGE = 'The request could not be processed due to legal restrictions.'; - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - // phpcs:ignore Generic.Files.LineLength - parent::__construct(self::STATUS_UNAVAILABLE_FOR_LEGAL_REASONS, $message ?? self::DEFAULT_MESSAGE, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpUnprocessableEntityException.php b/src/Exception/Http/HttpUnprocessableEntityException.php deleted file mode 100644 index 3f583b41..00000000 --- a/src/Exception/Http/HttpUnprocessableEntityException.php +++ /dev/null @@ -1,47 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Unprocessable Entity Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422 - * - * @since 3.0.0 - */ -class HttpUnprocessableEntityException extends HttpException -{ - - /** - * The error's default message - * - * @var string - */ - public const DEFAULT_MESSAGE = 'The request could not be processed due to semantic violations.'; - - /** - * Constructor of the class - * - * @param string|null $message - * @param int $code - * @param Throwable|null $previous - */ - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - parent::__construct(self::STATUS_UNPROCESSABLE_ENTITY, $message ?? self::DEFAULT_MESSAGE, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpUnsupportedMediaTypeException.php b/src/Exception/Http/HttpUnsupportedMediaTypeException.php index 8340cb42..b1ddddd1 100644 --- a/src/Exception/Http/HttpUnsupportedMediaTypeException.php +++ b/src/Exception/Http/HttpUnsupportedMediaTypeException.php @@ -27,22 +27,11 @@ */ class HttpUnsupportedMediaTypeException extends HttpException { - - /** - * The error's default message - * - * @var string - */ // phpcs:ignore Generic.Files.LineLength public const DEFAULT_MESSAGE = 'The request could not be processed due to an unsupported format of the request payload.'; /** - * Constructor of the class - * * @param list $supportedMediaTypes - * @param string|null $message - * @param int $code - * @param Throwable|null $previous */ // phpcs:ignore Generic.Files.LineLength public function __construct(private readonly array $supportedMediaTypes, ?string $message = null, int $code = 0, ?Throwable $previous = null) diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index 1e114f70..81c399d0 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -15,9 +15,8 @@ use RuntimeException; use Stringable; -use Sunrise\Http\Router\Validation\ConstraintViolationInterface; +use Sunrise\Http\Router\ConstraintViolationInterface; use Throwable; - use function join; /** @@ -50,12 +49,7 @@ class HttpException extends RuntimeException implements HttpExceptionInterface private array $constraintViolations = []; /** - * Constructor of the class - * * @param int<100, 599> $statusCode - * @param string $message - * @param int $code - * @param Throwable|null $previous */ public function __construct(int $statusCode, string $message, int $code = 0, ?Throwable $previous = null) { diff --git a/src/Exception/HttpExceptionInterface.php b/src/Exception/HttpExceptionInterface.php index 96eef599..b2884e0c 100644 --- a/src/Exception/HttpExceptionInterface.php +++ b/src/Exception/HttpExceptionInterface.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Exception; use Fig\Http\Message\StatusCodeInterface; -use Sunrise\Http\Router\Validation\ConstraintViolationInterface; +use Sunrise\Http\Router\ConstraintViolationInterface; /** * The package's base HTTP exception interface diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index ed2921b4..ffba66c2 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -29,8 +29,6 @@ final class RouteBuilder { /** - * @param array $values - * * @throws InvalidArgumentException If the route isn't valid or any of the required values are missing. */ public static function buildRoute(string $route, array $values = []): string diff --git a/src/Helper/Stringifier.php b/src/Helper/Stringifier.php new file mode 100644 index 00000000..59b57da9 --- /dev/null +++ b/src/Helper/Stringifier.php @@ -0,0 +1,64 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Helper; + +use ReflectionFunction; +use ReflectionMethod; +use ReflectionParameter; + +use function sprintf; + +/** + * @since 3.0.0 + */ +final class Stringifier +{ + public static function stringifyParameter(ReflectionParameter $parameter): string + { + $function = $parameter->getDeclaringFunction(); + + if ($function instanceof ReflectionMethod) { + return sprintf( + '%s::%s($%s[%d])', + $function->getDeclaringClass()->getName(), + $function->getName(), + $parameter->getName(), + $parameter->getPosition(), + ); + } + + return sprintf( + '%s($%s[%d])', + $function->getName(), + $parameter->getName(), + $parameter->getPosition(), + ); + } + + public static function stringifyFunction(ReflectionMethod|ReflectionFunction $function): string + { + if ($function instanceof ReflectionMethod) { + return sprintf( + '%s::%s()', + $function->getDeclaringClass()->getName(), + $function->getName(), + ); + } + + return sprintf( + '%s()', + $function->getName(), + ); + } +} diff --git a/src/InterceptorResolver.php b/src/InterceptorResolver.php new file mode 100644 index 00000000..4a4f6b60 --- /dev/null +++ b/src/InterceptorResolver.php @@ -0,0 +1,240 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router; + +use Closure; +use LogicException; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; +use ReflectionClass; +use ReflectionFunction; +use ReflectionMethod; +use Sunrise\Http\Router\Middleware\CallableMiddleware; +use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; +use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; + +use function class_exists; +use function get_debug_type; +use function is_array; +use function is_callable; +use function is_string; +use function is_subclass_of; +use function sprintf; + +/** + * @since 2.10.0 + */ +final class InterceptorResolver +{ + /** + * @var array + */ + private array $resolvedClasses = []; + + public function __construct( + private readonly ParameterResolver $parameterResolver, + private readonly ResponseResolver $responseResolver, + ) { + } + + /** + * @throws LogicException If the requst handler couldn't be resolved. + */ + public function resolveRequestHandler(mixed $requestHandler): RequestHandlerInterface + { + if ($requestHandler instanceof RequestHandlerInterface) { + return $requestHandler; + } + + if ($requestHandler instanceof Closure) { + return new CallableRequestHandler( + $this->createRequestHandlerCallback( + $requestHandler, + new ReflectionFunction($requestHandler), + ), + ); + } + + // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 + if (is_array($requestHandler) && is_callable($requestHandler, true)) { + /** @var array{0: class-string|object, 1: non-empty-string} $requestHandler */ + + if (is_string($requestHandler[0])) { + $requestHandler[0] = $this->resolveClass($requestHandler[0]); + } + + if (is_callable($requestHandler)) { + return new CallableRequestHandler( + $this->createRequestHandlerCallback( + $requestHandler, + new ReflectionMethod( + $requestHandler[0], + $requestHandler[1], + ), + ), + ); + } + } + + if (is_string($requestHandler) && is_subclass_of($requestHandler, RequestHandlerInterface::class)) { + return $this->resolveClass($requestHandler); + } + + throw new LogicException(sprintf( + 'The request handler {%s} could not be resolved.', + self::stringifyInterceptor($requestHandler), + )); + } + + /** + * @throws LogicException If the middleware couldn't be resolved. + */ + public function resolveMiddleware(mixed $middleware): MiddlewareInterface + { + if ($middleware instanceof MiddlewareInterface) { + return $middleware; + } + + if ($middleware instanceof Closure) { + return new CallableMiddleware( + $this->createMiddlewareCallback( + $middleware, + new ReflectionFunction($middleware), + ), + ); + } + + if (is_string($middleware) && is_subclass_of($middleware, MiddlewareInterface::class)) { + return $this->resolveClass($middleware); + } + + // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 + if (is_array($middleware) && is_callable($middleware, true)) { + /** @var array{0: class-string|object, 1: non-empty-string} $middleware */ + + if (is_string($middleware[0])) { + $middleware[0] = $this->resolveClass($middleware[0]); + } + + if (is_callable($middleware)) { + return new CallableMiddleware( + $this->createMiddlewareCallback( + $middleware, + new ReflectionMethod( + $middleware[0], + $middleware[1], + ), + ), + ); + } + } + + throw new LogicException(sprintf( + 'The middleware {%s} could not be resolved.', + self::stringifyInterceptor($middleware), + )); + } + + /** + * @return Closure(ServerRequestInterface=): ResponseInterface + */ + private function createRequestHandlerCallback( + callable $callback, + ReflectionMethod|ReflectionFunction $reflection, + ): Closure { + return fn(ServerRequestInterface $request): ResponseInterface => ( + $this->responseResolver->resolveResponse( + $request, + $callback(... + $this->parameterResolver + ->withContext($request) + ->withPriorityResolver(new ObjectInjectionParameterResolver($request)) + ->resolveParameters(...$reflection->getParameters()) + ), + $reflection, + ) + ); + } + + /** + * @return Closure(ServerRequestInterface=, RequestHandlerInterface=): ResponseInterface + */ + private function createMiddlewareCallback( + callable $callback, + ReflectionMethod|ReflectionFunction $reflection, + ): Closure { + return fn(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface => ( + $this->responseResolver->resolveResponse( + $request, + $callback(... + $this->parameterResolver + ->withContext($request) + ->withPriorityResolver(new ObjectInjectionParameterResolver($request)) + ->withPriorityResolver(new ObjectInjectionParameterResolver($handler)) + ->resolveParameters(...$reflection->getParameters()) + ), + $reflection, + ) + ); + } + + /** + * Resolves the given named class + * + * @param class-string $className + * + * @return T + * + * @template T of object + * + * @throws LogicException If the class couldn't be resolved. + */ + private function resolveClass(string $className): object + { + if (isset($this->resolvedClasses[$className])) { + /** @var T */ + return $this->resolvedClasses[$className]; + } + + if (!class_exists($className)) { + throw new LogicException(sprintf('The class {%s} does not exist.', $className)); + } + + $classReflection = new ReflectionClass($className); + if (!$classReflection->isInstantiable()) { + throw new LogicException(sprintf('The class {%s} is not instantiable.', $className)); + } + + $arguments = []; + $constructor = $classReflection->getConstructor(); + if (isset($constructor) && $constructor->getNumberOfParameters()) { + $arguments = $this->parameterResolver->resolveParameters(...$constructor->getParameters()); + } + + /** @var T */ + return $this->resolvedClasses[$className] = $classReflection->newInstance(...$arguments); + } + + private static function stringifyInterceptor(mixed $interceptor): string + { + // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 + if (is_callable($interceptor, true, $result)) { + return $result; + } + + return get_debug_type($interceptor); + } +} diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 88df4b2c..67e2e1fc 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -46,6 +46,7 @@ use function is_file; use function join; use function sprintf; +use function strtoupper; use function usort; final class DescriptorLoader implements LoaderInterface @@ -53,7 +54,7 @@ final class DescriptorLoader implements LoaderInterface public const DEFAULT_CACHE_KEY = 'router_descriptors'; public function __construct( - /** @var string[] */ + /** @var array */ private readonly array $resources, private readonly ?CacheInterface $cache = null, private readonly string $cacheKey = self::DEFAULT_CACHE_KEY, @@ -109,7 +110,7 @@ private function getDescriptors(): array foreach ($this->resources as $resource) { foreach ($this->getResourceDescriptors($resource) as $descriptor) { $descriptor->path = join($descriptor->prefixes) . $descriptor->path; - $descriptor->methods = array_map(\strtoupper(...), $descriptor->methods); + $descriptor->methods = array_map(strtoupper(...), $descriptor->methods); $descriptor->pattern = RouteCompiler::compileRoute($descriptor->path, $descriptor->patterns); $descriptors[] = $descriptor; } diff --git a/src/Middleware/CallbackMiddleware.php b/src/Middleware/CallbackMiddleware.php deleted file mode 100644 index 0a0b2a42..00000000 --- a/src/Middleware/CallbackMiddleware.php +++ /dev/null @@ -1,66 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Middleware; - -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; -use ReflectionFunction; -use ReflectionMethod; -use Sunrise\Http\Router\ParameterResolver; -use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; -use Sunrise\Http\Router\ResponseResolver; - -/** - * @since 3.0.0 - */ -final class CallbackMiddleware implements MiddlewareInterface -{ - /** - * @var callable - */ - private $callback; - - public function __construct( - callable $callback, - private readonly ReflectionMethod|ReflectionFunction $callbackReflection, - private readonly ParameterResolver $parameterResolver, - private readonly ResponseResolver $responseResolver, - ) { - $this->callback = $callback; - } - - public function getCallbackReflection(): ReflectionMethod|ReflectionFunction - { - return $this->callbackReflection; - } - - /** - * @inheritDoc - */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface - { - $arguments = $this->parameterResolver - ->withContext($request) - ->withPriorityResolver( - new ObjectInjectionParameterResolver($request), - new ObjectInjectionParameterResolver($handler), - ) - ->resolveParameters(...$this->callbackReflection->getParameters()); - - // phpcs:ignore Generic.Files.LineLength - return $this->responseResolver->resolveResponse($request, ($this->callback)(...$arguments), $this->callbackReflection); - } -} diff --git a/src/ParameterResolver.php b/src/ParameterResolver.php index 6de0e3c0..ee35205c 100644 --- a/src/ParameterResolver.php +++ b/src/ParameterResolver.php @@ -15,8 +15,8 @@ use Generator; use LogicException; -use ReflectionMethod; use ReflectionParameter; +use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; use function sprintf; @@ -29,7 +29,7 @@ final class ParameterResolver private mixed $context; public function __construct( - /** @var ParameterResolverInterface[] */ + /** @var array */ private array $resolvers, ) { } @@ -69,10 +69,6 @@ public function resolveParameters(ReflectionParameter ...$parameters): Generator } /** - * Tries to resolve the given parameter to an argument(s) - * - * @param ReflectionParameter $parameter - * * @return Generator * * @throws LogicException If the parameter couldn't be resolved to an argument(s). @@ -92,34 +88,7 @@ private function resolveParameter(ReflectionParameter $parameter): Generator throw new LogicException(sprintf( 'The parameter {%s} cannot be resolved.', - self::stringifyParameter($parameter) + Stringifier::stringifyParameter($parameter) )); } - - /** - * Stringifies the given parameter - * - * @param ReflectionParameter $parameter - * - * @return string - */ - public static function stringifyParameter(ReflectionParameter $parameter): string - { - if ($parameter->getDeclaringFunction() instanceof ReflectionMethod) { - return sprintf( - '%s::%s($%s[%d])', - $parameter->getDeclaringFunction()->getDeclaringClass()->getName(), - $parameter->getDeclaringFunction()->getName(), - $parameter->getName(), - $parameter->getPosition(), - ); - } - - return sprintf( - '%s($%s[%d])', - $parameter->getDeclaringFunction()->getName(), - $parameter->getName(), - $parameter->getPosition(), - ); - } } diff --git a/src/ParameterResolver/ObjectInjectionParameterResolver.php b/src/ParameterResolver/ObjectInjectionParameterResolver.php index df388b8c..0f9eb9bb 100644 --- a/src/ParameterResolver/ObjectInjectionParameterResolver.php +++ b/src/ParameterResolver/ObjectInjectionParameterResolver.php @@ -38,8 +38,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return; } - $typeName = $type->getName(); - if (is_a($this->object, $typeName)) { + if (is_a($this->object, $type->getName())) { yield $this->object; } } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 31550a65..e54c1de7 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -16,24 +16,20 @@ use Generator; use LogicException; use Psr\Http\Message\ServerRequestInterface; +use ReflectionAttribute; use ReflectionNamedType; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestBody; -use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; -use Sunrise\Http\Router\ParameterResolver; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; +use Sunrise\Http\Router\ConstraintViolation; +use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; -use function count; use function sprintf; /** - * @link https://github.com/sunrise-php/hydrator - * @link https://github.com/symfony/validator - * * @since 3.0.0 */ final class RequestBodyParameterResolver implements ParameterResolverInterface @@ -49,11 +45,13 @@ public function __construct( * * @throws LogicException If the resolver is used incorrectly or if an object isn't valid. * - * @throws HttpUnprocessableEntityException If the request's parsed body isn't valid. + * @throws HttpException If the request's parsed body isn't valid. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - if ($parameter->getAttributes(RequestBody::class) === []) { + /** @var list> $annotations */ + $annotations = $parameter->getAttributes(RequestBody::class); + if ($annotations === []) { return; } @@ -61,7 +59,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { throw new LogicException(sprintf( 'To use the #[RequestBody] attribute, the parameter {%s} must be typed with an object.', - ParameterResolver::stringifyParameter($parameter), + Stringifier::stringifyParameter($parameter), )); } @@ -71,17 +69,21 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } + $requestBody = $annotations[0]->newInstance(); + try { $object = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidDataException $e) { - throw (new HttpUnprocessableEntityException) - ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); + throw (new HttpException($requestBody->errorStatusCode, $requestBody->errorMessage, previous: $e)) + ->addConstraintViolation(...ConstraintViolation::fromHydrator(...$e->getExceptions())); } - $violations = $this->validator?->validate($object); - if (count($violations ?? []) > 0) { - throw (new HttpUnprocessableEntityException) - ->addConstraintViolation(...ValidatorConstraintViolationProxy::create(...$violations)); + if (isset($this->validator)) { + $violations = $this->validator->validate($object); + if ($violations->count() > 0) { + throw (new HttpException($requestBody->errorStatusCode, $requestBody->errorMessage)) + ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); + } } yield $object; diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index 845a0046..f5c2a0ae 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -20,9 +20,8 @@ use ReflectionParameter; use Sunrise\Http\Router\Annotation\Constraint; use Sunrise\Http\Router\Annotation\RequestCookie; -use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; +use Sunrise\Http\Router\ConstraintViolation; +use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; @@ -32,19 +31,10 @@ use function count; /** - * RequestCookieParameterResolver - * * @since 3.0.0 */ final class RequestCookieParameterResolver implements ParameterResolverInterface { - - /** - * Constructor of the class - * - * @param HydratorInterface $hydrator - * @param ValidatorInterface|null $validator - */ public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, @@ -56,13 +46,13 @@ public function __construct( * * @throws LogicException If the resolver is used incorrectly. * - * @throws HttpBadRequestException If a cookie was missed or invalid. + * @throws HttpException If a cookie was missed or invalid. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - /** @var list> $attributes */ - $attributes = $parameter->getAttributes(RequestCookie::class); - if ($attributes === []) { + /** @var list> $annotations */ + $annotations = $parameter->getAttributes(RequestCookie::class); + if ($annotations === []) { return; } @@ -72,45 +62,48 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } + $requestCookie = $annotations[0]->newInstance(); + $cookies = $context->getCookieParams(); - $attribute = $attributes[0]->newInstance(); - if (!isset($cookies[$attribute->name])) { + if (!isset($cookies[$requestCookie->name])) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } elseif ($parameter->allowsNull()) { return yield; } - throw new HttpBadRequestException("The cookie {$attribute->name} must be provided."); + throw new HttpException($requestCookie->errorStatusCode, $requestCookie->errorMessage); } try { $value = $this->hydrator->castValue( - $cookies[$attribute->name], + $cookies[$requestCookie->name], Type::fromParameter($parameter), - path: [$attribute->name], + path: [$requestCookie->name], ); } catch (InvalidDataException $e) { - throw (new HttpBadRequestException(previous: $e)) - ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); + throw (new HttpException($requestCookie->errorStatusCode, $requestCookie->errorMessage, previous: $e)) + ->addConstraintViolation(...ConstraintViolation::fromHydrator(...$e->getExceptions())); } catch (InvalidValueException $e) { - throw (new HttpBadRequestException(previous: $e)) - ->addConstraintViolation(...HydratorConstraintViolationProxy::create($e)); + throw (new HttpException($requestCookie->errorStatusCode, $requestCookie->errorMessage, previous: $e)) + ->addConstraintViolation(...ConstraintViolation::fromHydrator($e)); } - $constraints = []; - /** @var ReflectionAttribute $attribute */ - foreach ($parameter->getAttributes(Constraint::class) as $attribute) { - $attribute = $attribute->newInstance(); - if ($attribute->value instanceof \Symfony\Component\Validator\Constraint) { - $constraints[] = $attribute->value; + if (isset($this->validator)) { + $constraints = []; + /** @var ReflectionAttribute $annotation */ + foreach ($parameter->getAttributes(Constraint::class) as $annotation) { + $constraint = $annotation->newInstance(); + if ($constraint->value instanceof \Symfony\Component\Validator\Constraint) { + $constraints[] = $constraint->value; + } } - } - if (count($constraints) > 0 && count($violations = $this->validator?->validate($value, $constraints) ?? []) > 0) { - throw (new HttpBadRequestException()) - ->addConstraintViolation(...ValidatorConstraintViolationProxy::create(...$violations)); + if (count($constraints) > 0 && count($violations = $this->validator->validate($value, $constraints)) > 0) { + throw (new HttpException($requestCookie->errorStatusCode, $requestCookie->errorMessage)) + ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); + } } yield $value; diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 086dee1c..6083989d 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -18,29 +18,27 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionParameter; +use Sunrise\Http\Router\Annotation\Constraint; use Sunrise\Http\Router\Annotation\RequestHeader; -use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; +use Sunrise\Http\Router\ConstraintViolation; +use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; use Sunrise\Hydrator\Type; +use Symfony\Component\Validator\Validator\ValidatorInterface; + +use function count; /** - * RequestHeaderParameterResolver - * * @since 3.0.0 */ final class RequestHeaderParameterResolver implements ParameterResolverInterface { - - /** - * Constructor of the class - * - * @param HydratorInterface $hydrator - */ - public function __construct(private HydratorInterface $hydrator) - { + public function __construct( + private readonly HydratorInterface $hydrator, + private readonly ?ValidatorInterface $validator = null, + ) { } /** @@ -48,13 +46,13 @@ public function __construct(private HydratorInterface $hydrator) * * @throws LogicException If the resolver is used incorrectly. * - * @throws HttpBadRequestException If a header was missed or invalid. + * @throws HttpException If a header was missed or invalid. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - /** @var ReflectionAttribute $attributes */ - $attributes = $parameter->getAttributes(RequestHeader::class); - if ($attributes === []) { + /** @var list> $annotations */ + $annotations = $parameter->getAttributes(RequestHeader::class); + if ($annotations === []) { return; } @@ -64,30 +62,48 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } - $attribute = $attributes[0]->newInstance(); + $requestHeader = $annotations[0]->newInstance(); - if (!$context->hasHeader($attribute->name)) { + if (!$context->hasHeader($requestHeader->name)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } elseif ($parameter->allowsNull()) { return yield; } - throw new HttpBadRequestException("The header {$attribute->name} must be provided."); + throw new HttpException($requestHeader->errorStatusCode, $requestHeader->errorMessage); } try { - yield $this->hydrator->castValue( - $context->getHeaderLine($attribute->name), + $value = $this->hydrator->castValue( + $context->getHeaderLine($requestHeader->name), Type::fromParameter($parameter), - path: [$attribute->name], + path: [$requestHeader->name], ); } catch (InvalidDataException $e) { - throw (new HttpBadRequestException(previous: $e)) - ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); + throw (new HttpException($requestHeader->errorStatusCode, $requestHeader->errorMessage, previous: $e)) + ->addConstraintViolation(...ConstraintViolation::fromHydrator(...$e->getExceptions())); } catch (InvalidValueException $e) { - throw (new HttpBadRequestException(previous: $e)) - ->addConstraintViolation(...HydratorConstraintViolationProxy::create($e)); + throw (new HttpException($requestHeader->errorStatusCode, $requestHeader->errorMessage, previous: $e)) + ->addConstraintViolation(...ConstraintViolation::fromHydrator($e)); } + + if (isset($this->validator)) { + $constraints = []; + /** @var ReflectionAttribute $annotation */ + foreach ($parameter->getAttributes(Constraint::class) as $annotation) { + $constraint = $annotation->newInstance(); + if ($constraint->value instanceof \Symfony\Component\Validator\Constraint) { + $constraints[] = $constraint->value; + } + } + + if (count($constraints) > 0 && count($violations = $this->validator->validate($value, $constraints)) > 0) { + throw (new HttpException($requestHeader->errorStatusCode, $requestHeader->errorMessage)) + ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); + } + } + + yield $value; } } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 5bdf90d1..c0cf8bc3 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -16,38 +16,27 @@ use Generator; use LogicException; use Psr\Http\Message\ServerRequestInterface; +use ReflectionAttribute; use ReflectionNamedType; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestQuery; -use Sunrise\Http\Router\Exception\Http\HttpUnprocessableEntityException; -use Sunrise\Http\Router\ParameterResolver; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; +use Sunrise\Http\Router\ConstraintViolation; +use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; + use function sprintf; /** - * RequestQueryParameterResolver - * - * @link https://github.com/sunrise-php/hydrator - * @link https://github.com/symfony/validator - * * @since 3.0.0 */ final class RequestQueryParameterResolver implements ParameterResolverInterface { - - /** - * Constructor of the class - * - * @param HydratorInterface $hydrator - * @param ValidatorInterface|null $validator - */ public function __construct( - private HydratorInterface $hydrator, - private ?ValidatorInterface $validator = null, + private readonly HydratorInterface $hydrator, + private readonly ?ValidatorInterface $validator = null, ) { } @@ -56,11 +45,13 @@ public function __construct( * * @throws LogicException If the resolver is used incorrectly or if an object isn't valid. * - * @throws HttpUnprocessableEntityException If the request's query parameters isn't valid. + * @throws HttpException If the request's query parameters isn't valid. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - if ($parameter->getAttributes(RequestQuery::class) === []) { + /** @var list> $annotations */ + $annotations = $parameter->getAttributes(RequestQuery::class); + if ($annotations === []) { return; } @@ -68,7 +59,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { throw new LogicException(sprintf( 'To use the #[RequestQuery] attribute, the parameter {%s} must be typed with an object.', - ParameterResolver::stringifyParameter($parameter), + Stringifier::stringifyParameter($parameter), )); } @@ -78,18 +69,20 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } + $requestQuery = $annotations[0]->newInstance(); + try { $object = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { - throw (new HttpUnprocessableEntityException) - ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); + throw (new HttpException($requestQuery->errorStatusCode, $requestQuery->errorMessage, previous: $e)) + ->addConstraintViolation(...ConstraintViolation::fromHydrator(...$e->getExceptions())); } if (isset($this->validator)) { $violations = $this->validator->validate($object); if ($violations->count() > 0) { - throw (new HttpUnprocessableEntityException) - ->addConstraintViolation(...ValidatorConstraintViolationProxy::create(...$violations)); + throw (new HttpException($requestQuery->errorStatusCode, $requestQuery->errorMessage)) + ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); } } diff --git a/src/ParameterResolver/RequestRouteParameterResolver.php b/src/ParameterResolver/RequestRouteParameterResolver.php index 59d182cd..c31c8b33 100644 --- a/src/ParameterResolver/RequestRouteParameterResolver.php +++ b/src/ParameterResolver/RequestRouteParameterResolver.php @@ -18,19 +18,16 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; -use Sunrise\Http\Router\ParameterResolver; +use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Http\Router\Route; use function sprintf; /** - * RequestRouteParameterResolver - * * @since 3.0.0 */ final class RequestRouteParameterResolver implements ParameterResolverInterface { - /** * @inheritDoc * @@ -53,9 +50,9 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $route = $context->getAttribute('@route'); if (! $route instanceof Route && !$parameter->allowsNull()) { throw new LogicException(sprintf( - 'At this level of the application, the current request does not contain a route. ' . + 'At this level of the application, the request does not contain a route. ' . 'To suppress this error, the parameter {%s} should be nullable.', - ParameterResolver::stringifyParameter($parameter), + Stringifier::stringifyParameter($parameter), )); } diff --git a/src/ParameterResolver/RequestUriParameterResolver.php b/src/ParameterResolver/RequestUriParameterResolver.php index b4447576..1b9c21ba 100644 --- a/src/ParameterResolver/RequestUriParameterResolver.php +++ b/src/ParameterResolver/RequestUriParameterResolver.php @@ -21,13 +21,10 @@ use ReflectionParameter; /** - * RequestUriParameterResolver - * * @since 3.0.0 */ final class RequestUriParameterResolver implements ParameterResolverInterface { - /** * @inheritDoc * diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index 9804d1c4..0893662e 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -18,32 +18,30 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionParameter; +use Sunrise\Http\Router\Annotation\Constraint; use Sunrise\Http\Router\Annotation\RequestVariable; -use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; -use Sunrise\Http\Router\ParameterResolver; +use Sunrise\Http\Router\ConstraintViolation; +use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Http\Router\Route; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; use Sunrise\Hydrator\Type; +use Symfony\Component\Validator\Validator\ValidatorInterface; + +use function count; use function sprintf; /** - * PathVariableParameterResolver - * * @since 3.0.0 */ final class RequestVariableParameterResolver implements ParameterResolverInterface { - - /** - * Constructor of the class - * - * @param HydratorInterface $hydrator - */ - public function __construct(private HydratorInterface $hydrator) - { + public function __construct( + private readonly HydratorInterface $hydrator, + private readonly ?ValidatorInterface $validator = null, + ) { } /** @@ -51,13 +49,13 @@ public function __construct(private HydratorInterface $hydrator) * * @throws LogicException If the resolver is used incorrectly. * - * @throws HttpNotFoundException If the request's path variable isn't valid. + * @throws HttpException If the request's path variable isn't valid. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - /** @var ReflectionAttribute $attributes */ - $attributes = $parameter->getAttributes(RequestVariable::class); - if ($attributes === []) { + /** @var list> $annotations */ + $annotations = $parameter->getAttributes(RequestVariable::class); + if ($annotations === []) { return; } @@ -73,16 +71,15 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) 'The #[PathVariable] attribute cannot be applied to the parameter {%s}, ' . 'because the request does not contain information about the requested route, ' . 'at least at this level of the application.', - ParameterResolver::stringifyParameter($parameter), + Stringifier::stringifyParameter($parameter), )); } - $attribute = $attributes[0]->newInstance(); + $requestVariable = $annotations[0]->newInstance(); - $variableName = $attribute->name ?? $parameter->getName(); - $variableValue = $route->getAttribute($variableName); + $variableName = $requestVariable->name ?? $parameter->getName(); - if ($variableValue === null) { + if (!$route->hasAttribute($variableName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } elseif ($parameter->allowsNull()) { @@ -93,24 +90,42 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) 'The parameter {%1$s} expects the value of the variable {%3$s} from the route "%2$s", ' . 'which is not present in the request, most likely, because the variable is optional. ' . 'To resolve this issue, make this parameter nullable or assign it a default value.', - ParameterResolver::stringifyParameter($parameter), + Stringifier::stringifyParameter($parameter), $route->getName(), $variableName, )); } try { - yield $this->hydrator->castValue( - $variableValue, + $value = $this->hydrator->castValue( + $route->getAttribute($variableName), Type::fromParameter($parameter), path: [$variableName], ); } catch (InvalidDataException $e) { - throw (new HttpNotFoundException(previous: $e)) - ->addConstraintViolation(...HydratorConstraintViolationProxy::create(...$e->getExceptions())); + throw (new HttpException($requestVariable->errorStatusCode, $requestVariable->errorMessage, previous: $e)) + ->addConstraintViolation(...ConstraintViolation::fromHydrator(...$e->getExceptions())); } catch (InvalidValueException $e) { - throw (new HttpNotFoundException(previous: $e)) - ->addConstraintViolation(...HydratorConstraintViolationProxy::create($e)); + throw (new HttpException($requestVariable->errorStatusCode, $requestVariable->errorMessage, previous: $e)) + ->addConstraintViolation(...ConstraintViolation::fromHydrator($e)); } + + if (isset($this->validator)) { + $constraints = []; + /** @var ReflectionAttribute $annotation */ + foreach ($parameter->getAttributes(Constraint::class) as $annotation) { + $constraint = $annotation->newInstance(); + if ($constraint->value instanceof \Symfony\Component\Validator\Constraint) { + $constraints[] = $constraint->value; + } + } + + if (count($constraints) > 0 && count($violations = $this->validator->validate($value, $constraints)) > 0) { + throw (new HttpException($requestVariable->errorStatusCode, $requestVariable->errorMessage)) + ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); + } + } + + yield $value; } } diff --git a/src/ParameterResolver/ServerRequestParameterResolver.php b/src/ParameterResolver/ServerRequestParameterResolver.php index 36b4c22b..01473f56 100644 --- a/src/ParameterResolver/ServerRequestParameterResolver.php +++ b/src/ParameterResolver/ServerRequestParameterResolver.php @@ -21,13 +21,10 @@ use Sunrise\Http\Router\ServerRequest; /** - * ServerRequestParameterResolver - * * @since 3.0.0 */ final class ServerRequestParameterResolver implements ParameterResolverInterface { - /** * @inheritDoc * diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php deleted file mode 100644 index a3e31dbe..00000000 --- a/src/ReferenceResolver.php +++ /dev/null @@ -1,199 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -use Closure; -use LogicException; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; -use ReflectionClass; -use ReflectionFunction; -use ReflectionMethod; -use Sunrise\Http\Router\Middleware\CallbackMiddleware; -use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; - -use function class_exists; -use function get_debug_type; -use function is_array; -use function is_callable; -use function is_string; -use function is_subclass_of; -use function sprintf; - -/** - * @since 2.10.0 - */ -final class ReferenceResolver -{ - /** - * @var array - */ - private array $resolvedClasses = []; - - public function __construct( - private readonly ParameterResolver $parameterResolver, - private readonly ResponseResolver $responseResolver, - ) { - } - - /** - * @inheritDoc - * - * @throws LogicException If the reference couldn't be resolved. - */ - public function resolveRequestHandler(mixed $reference): RequestHandlerInterface - { - if ($reference instanceof RequestHandlerInterface) { - return $reference; - } - - if ($reference instanceof Closure) { - return new CallbackRequestHandler( - $reference, - new ReflectionFunction($reference), - $this->parameterResolver, - $this->responseResolver, - ); - } - - // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 - if (is_array($reference) && is_callable($reference, true)) { - /** @var array{0: class-string|object, 1: non-empty-string} $reference */ - - if (is_string($reference[0])) { - $reference[0] = $this->resolveClass($reference[0]); - } - - if (is_callable($reference)) { - return new CallbackRequestHandler( - $reference, - new ReflectionMethod($reference[0], $reference[1]), - $this->parameterResolver, - $this->responseResolver, - ); - } - } - - if (is_string($reference) && is_subclass_of($reference, RequestHandlerInterface::class)) { - return $this->resolveClass($reference); - } - - throw new LogicException(sprintf( - 'The reference {%s} cannot be resolved.', - self::stringifyReference($reference), - )); - } - - /** - * @inheritDoc - * - * @throws LogicException If the reference couldn't be resolved. - */ - public function resolveMiddleware(mixed $reference): MiddlewareInterface - { - if ($reference instanceof MiddlewareInterface) { - return $reference; - } - - if ($reference instanceof Closure) { - return new CallbackMiddleware( - $reference, - new ReflectionFunction($reference), - $this->parameterResolver, - $this->responseResolver, - ); - } - - if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { - return $this->resolveClass($reference); - } - - // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 - if (is_array($reference) && is_callable($reference, true)) { - /** @var array{0: class-string|object, 1: non-empty-string} $reference */ - - if (is_string($reference[0])) { - $reference[0] = $this->resolveClass($reference[0]); - } - - if (is_callable($reference)) { - return new CallbackMiddleware( - $reference, - new ReflectionMethod($reference[0], $reference[1]), - $this->parameterResolver, - $this->responseResolver, - ); - } - } - - throw new LogicException(sprintf( - 'The reference {%s} cannot be resolved.', - self::stringifyReference($reference), - )); - } - - /** - * Resolves the given named class - * - * @param class-string $fqn - * - * @return T - * - * @template T of object - * - * @throws LogicException If the class couldn't be resolved. - */ - private function resolveClass(string $fqn): object - { - if (isset($this->resolvedClasses[$fqn])) { - /** @var T */ - return $this->resolvedClasses[$fqn]; - } - - if (!class_exists($fqn)) { - throw new LogicException(sprintf('The class {%s} does not exist.', $fqn)); - } - - $class = new ReflectionClass($fqn); - if (!$class->isInstantiable()) { - throw new LogicException(sprintf('The class {%s} is not instantiable.', $fqn)); - } - - $arguments = []; - $constructor = $class->getConstructor(); - if ($constructor?->getNumberOfParameters()) { - $arguments = $this->parameterResolver->resolveParameters(...$constructor->getParameters()); - } - - /** @var T */ - return $this->resolvedClasses[$fqn] = $class->newInstance(...$arguments); - } - - /** - * Stringifies the given reference - * - * @param mixed $reference - * - * @return string - */ - public static function stringifyReference(mixed $reference): string - { - // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 - if (is_callable($reference, true, $result)) { - return $result; - } - - return get_debug_type($reference); - } -} diff --git a/src/RequestHandler/CallbackRequestHandler.php b/src/RequestHandler/CallbackRequestHandler.php deleted file mode 100644 index 4340add3..00000000 --- a/src/RequestHandler/CallbackRequestHandler.php +++ /dev/null @@ -1,64 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\RequestHandler; - -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\RequestHandlerInterface; -use ReflectionFunction; -use ReflectionMethod; -use Sunrise\Http\Router\ParameterResolver; -use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; -use Sunrise\Http\Router\ResponseResolver; - -/** - * @since 3.0.0 - */ -final class CallbackRequestHandler implements RequestHandlerInterface -{ - /** - * @var callable - */ - private $callback; - - public function __construct( - callable $callback, - private readonly ReflectionMethod|ReflectionFunction $callbackReflection, - private readonly ParameterResolver $parameterResolver, - private readonly ResponseResolver $responseResolver, - ) { - $this->callback = $callback; - } - - public function getCallbackReflection(): ReflectionMethod|ReflectionFunction - { - return $this->callbackReflection; - } - - /** - * @inheritDoc - */ - public function handle(ServerRequestInterface $request): ResponseInterface - { - $arguments = $this->parameterResolver - ->withContext($request) - ->withPriorityResolver( - new ObjectInjectionParameterResolver($request), - ) - ->resolveParameters(...$this->callbackReflection->getParameters()); - - // phpcs:ignore Generic.Files.LineLength - return $this->responseResolver->resolveResponse($request, ($this->callback)(...$arguments), $this->callbackReflection); - } -} diff --git a/src/ResponseResolver.php b/src/ResponseResolver.php index 883b405c..87a9a2e6 100644 --- a/src/ResponseResolver.php +++ b/src/ResponseResolver.php @@ -21,6 +21,7 @@ use ReflectionMethod; use Sunrise\Http\Router\Annotation\ResponseHeader; use Sunrise\Http\Router\Annotation\ResponseStatus; +use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; use function sprintf; @@ -31,7 +32,7 @@ final class ResponseResolver { public function __construct( - /** @var ResponseResolverInterface[] */ + /** @var array */ private readonly array $resolvers, ) { } @@ -57,19 +58,10 @@ public function resolveResponse( throw new LogicException(sprintf( 'The responder {%s} returned an unsupported response.', - self::stringifyResponder($responder), + Stringifier::stringifyFunction($responder), )); } - /** - * Handles the given response - * - * @param ServerRequestInterface $request - * @param ResponseInterface $response - * @param ReflectionFunction|ReflectionMethod $responder - * - * @return ResponseInterface - */ private function handleResponse( ServerRequestInterface $request, ResponseInterface $response, @@ -91,20 +83,4 @@ private function handleResponse( return $response; } - - /** - * Stringifies the given responder - * - * @param ReflectionFunction|ReflectionMethod $responder - * - * @return string - */ - public static function stringifyResponder(ReflectionMethod|ReflectionFunction $responder): string - { - if ($responder instanceof ReflectionMethod) { - return sprintf('%s::%s(...)', $responder->getDeclaringClass()->getName(), $responder->getName()); - } - - return sprintf('%s(...)', $responder->getName()); - } } diff --git a/src/ResponseResolver/EmptyResponseResolver.php b/src/ResponseResolver/EmptyResponseResolver.php index 36630b11..1f9b7050 100644 --- a/src/ResponseResolver/EmptyResponseResolver.php +++ b/src/ResponseResolver/EmptyResponseResolver.php @@ -27,12 +27,6 @@ */ final class EmptyResponseResolver implements ResponseResolverInterface { - - /** - * Constructor of the class - * - * @param ResponseFactoryInterface $responseFactory - */ public function __construct(private ResponseFactoryInterface $responseFactory) { } diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index 0efe88c4..21c2d93d 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -22,9 +22,11 @@ use ReflectionFunction; use ReflectionMethod; use Sunrise\Http\Router\Annotation\JsonResponse; -use Sunrise\Http\Router\ResponseResolver; +use Sunrise\Http\Router\Helper\Stringifier; + use function json_encode; use function sprintf; + use const JSON_THROW_ON_ERROR; /** @@ -34,12 +36,6 @@ */ final class JsonResponseResolver implements ResponseResolverInterface { - - /** - * Constructor of the class - * - * @param ResponseFactoryInterface $responseFactory - */ public function __construct(private ResponseFactoryInterface $responseFactory) { } @@ -70,7 +66,7 @@ public function resolveResponse( } catch (JsonException $e) { throw new LogicException(sprintf( 'The responder {%s} returned a response that could not be encoded to JSON due to: %s', - ResponseResolver::stringifyResponder($responder), + Stringifier::stringifyFunction($responder), $e->getMessage(), )); } diff --git a/src/ResponseResolver/StreamResponseResolver.php b/src/ResponseResolver/StreamResponseResolver.php index 1f8fb1dd..da0c4c86 100644 --- a/src/ResponseResolver/StreamResponseResolver.php +++ b/src/ResponseResolver/StreamResponseResolver.php @@ -27,12 +27,6 @@ */ final class StreamResponseResolver implements ResponseResolverInterface { - - /** - * Constructor of the class - * - * @param ResponseFactoryInterface $responseFactory - */ public function __construct(private ResponseFactoryInterface $responseFactory) { } diff --git a/src/ResponseResolver/UriResponseResolver.php b/src/ResponseResolver/UriResponseResolver.php index 93ee3618..fdea18f1 100644 --- a/src/ResponseResolver/UriResponseResolver.php +++ b/src/ResponseResolver/UriResponseResolver.php @@ -27,12 +27,6 @@ */ final class UriResponseResolver implements ResponseResolverInterface { - - /** - * Constructor of the class - * - * @param ResponseFactoryInterface $responseFactory - */ public function __construct(private ResponseFactoryInterface $responseFactory) { } diff --git a/src/Route.php b/src/Route.php index 525a23d8..44160c83 100644 --- a/src/Route.php +++ b/src/Route.php @@ -16,6 +16,7 @@ use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; use function array_key_exists; +use function in_array; final class Route { @@ -78,6 +79,15 @@ public function getMethods(): array return $this->methods; } + public function supportsMethod(string $method): bool + { + if ($this->methods === []) { + return true; + } + + return in_array($method, $this->methods, true); + } + /** * @return array */ diff --git a/src/Router.php b/src/Router.php index 13dd67c9..138cb82e 100644 --- a/src/Router.php +++ b/src/Router.php @@ -16,7 +16,6 @@ use InvalidArgumentException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Exception\Http\HttpMethodNotAllowedException; use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; @@ -32,13 +31,12 @@ use function array_flip; use function array_keys; -use function in_array; use function rawurldecode; use function sprintf; class Router { - private readonly ReferenceResolver $referenceResolver; + private readonly InterceptorResolver $interceptorResolver; private array $middlewares; @@ -60,8 +58,8 @@ class Router private ?RequestHandlerInterface $routerRequestHandler = null; /** - * @param ParameterResolverInterface[] $parameterResolvers - * @param ResponseResolverInterface[] $responseResolvers + * @param array $parameterResolvers + * @param array $responseResolvers * @param list $loaders * * @since 3.0.0 @@ -74,7 +72,7 @@ public function __construct( ) { $this->middlewares = $middlewares; - $this->referenceResolver = new ReferenceResolver( + $this->interceptorResolver = new InterceptorResolver( new ParameterResolver($parameterResolvers), new ResponseResolver($responseResolvers), ); @@ -122,12 +120,6 @@ public function load(LoaderInterface ...$loaders): void } /** - * Looks for a route that matches the given request - * - * @param ServerRequestInterface $request - * - * @return Route - * * @throws HttpNotFoundException * If the request URI isn't served. * @@ -150,9 +142,8 @@ public function match(ServerRequestInterface $request): Route continue; } - $routeMethods = $route->getMethods(); - if (!empty($routeMethods) && !in_array($request->getMethod(), $routeMethods, true)) { - $allowedMethods += array_flip($routeMethods); + if (!$route->supportsMethod($request->getMethod())) { + $allowedMethods += array_flip($route->getMethods()); continue; } @@ -199,8 +190,6 @@ public function runRoute(Route|string $route, ServerRequestInterface $request): } /** - * @param array $values - * * @throws InvalidArgumentException */ public function buildRoute(Route|string $route, array $values = []): string @@ -242,7 +231,7 @@ public function getRouteRequestHandler(Route|string $route): RequestHandlerInter } // phpcs:ignore Generic.Files.LineLength - $this->routeRequestHandlers[$routeName] = $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()); + $this->routeRequestHandlers[$routeName] = $this->interceptorResolver->resolveRequestHandler($route->getRequestHandler()); $middlewares = $route->getMiddlewares(); if ($middlewares === []) { @@ -252,7 +241,7 @@ public function getRouteRequestHandler(Route|string $route): RequestHandlerInter $this->routeRequestHandlers[$routeName] = new QueueableRequestHandler($this->routeRequestHandlers[$routeName]); foreach ($middlewares as $middleware) { $this->routeRequestHandlers[$routeName]->enqueue( - $this->referenceResolver->resolveMiddleware($middleware) + $this->interceptorResolver->resolveMiddleware($middleware) ); } @@ -270,9 +259,7 @@ public function getRouterRequestHandler(): RequestHandlerInterface $this->routerRequestHandler = new CallableRequestHandler( function (ServerRequestInterface $request): ResponseInterface { - $route = $this->match($request); - - return $this->runRoute($route, $request); + return $this->runRoute($this->match($request), $request); } ); @@ -283,7 +270,7 @@ function (ServerRequestInterface $request): ResponseInterface { $this->routerRequestHandler = new QueueableRequestHandler($this->routerRequestHandler); foreach ($this->middlewares as $middleware) { $this->routerRequestHandler->enqueue( - $this->referenceResolver->resolveMiddleware($middleware) + $this->interceptorResolver->resolveMiddleware($middleware) ); } diff --git a/src/Validation/ConstraintViolation.php b/src/Validation/ConstraintViolation.php deleted file mode 100644 index 715b9f3e..00000000 --- a/src/Validation/ConstraintViolation.php +++ /dev/null @@ -1,52 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Validation; - -/** - * @since 3.0.0 - */ -final class ConstraintViolation implements ConstraintViolationInterface -{ - public function __construct( - private readonly string $message, - private readonly string $messageTemplate, - /** @var array */ - private readonly array $messagePlaceholders, - private readonly string $propertyPath, - ) { - } - - public function getMessage(): string - { - return $this->message; - } - - public function getMessageTemplate(): string - { - return $this->messageTemplate; - } - - /** - * @inheritDoc - */ - public function getMessagePlaceholders(): array - { - return $this->messagePlaceholders; - } - - public function getPropertyPath(): string - { - return $this->propertyPath; - } -} diff --git a/src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php b/src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php deleted file mode 100644 index 70811fc9..00000000 --- a/src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php +++ /dev/null @@ -1,63 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Validation\ConstraintViolation; - -use Generator; -use Sunrise\Http\Router\Validation\ConstraintViolationInterface; -use Sunrise\Hydrator\Exception\InvalidValueException as HydratorConstraintViolation; - -/** - * @since 3.0.0 - */ -final class HydratorConstraintViolationProxy implements ConstraintViolationInterface -{ - public function __construct(private readonly HydratorConstraintViolation $hydratorConstraintViolation) - { - } - - /** - * Creates the {@see ConstraintViolationInterface} object(s) from the given hydrator's constraint violation(s) - * - * @return Generator - */ - public static function create(HydratorConstraintViolation ...$hydratorConstraintViolations): Generator - { - foreach ($hydratorConstraintViolations as $hydratorConstraintViolation) { - yield new self($hydratorConstraintViolation); - } - } - - public function getMessage(): string - { - return $this->hydratorConstraintViolation->getMessage(); - } - - public function getMessageTemplate(): string - { - return $this->hydratorConstraintViolation->getMessageTemplate(); - } - - /** - * @inheritDoc - */ - public function getMessagePlaceholders(): array - { - return $this->hydratorConstraintViolation->getMessagePlaceholders(); - } - - public function getPropertyPath(): string - { - return $this->hydratorConstraintViolation->getPropertyPath(); - } -} diff --git a/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php b/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php deleted file mode 100644 index 609c9037..00000000 --- a/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php +++ /dev/null @@ -1,64 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Validation\ConstraintViolation; - -use Generator; -use Sunrise\Http\Router\Validation\ConstraintViolationInterface; -use Symfony\Component\Validator\ConstraintViolationInterface as ValidatorConstraintViolation; - -/** - * @since 3.0.0 - */ -final class ValidatorConstraintViolationProxy implements ConstraintViolationInterface -{ - public function __construct(private readonly ValidatorConstraintViolation $validatorConstraintViolation) - { - } - - /** - * Creates the {@see ConstraintViolationInterface} object(s) from the given validator's constraint violation(s) - * - * @return Generator - */ - public static function create(ValidatorConstraintViolation ...$validatorConstraintViolations): Generator - { - foreach ($validatorConstraintViolations as $validatorConstraintViolation) { - yield new self($validatorConstraintViolation); - } - } - - public function getMessage(): string - { - return $this->validatorConstraintViolation->getMessage(); - } - - public function getMessageTemplate(): string - { - return $this->validatorConstraintViolation->getMessageTemplate(); - } - - /** - * @inheritDoc - */ - public function getMessagePlaceholders(): array - { - /** @var array */ - return $this->validatorConstraintViolation->getParameters(); - } - - public function getPropertyPath(): string - { - return $this->validatorConstraintViolation->getPropertyPath(); - } -} From 50c0b1a3326771a76537813d383ac43b31102746 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 2 Mar 2024 23:27:35 +0100 Subject: [PATCH 105/180] v3 --- src/Annotation/Constraint.php | 1 - src/Annotation/HtmlResponse.php | 24 ++++ src/Annotation/RequestBody.php | 3 +- src/Annotation/RequestCookie.php | 3 +- src/Annotation/RequestHeader.php | 3 +- src/Annotation/RequestQuery.php | 3 +- src/Annotation/RequestQueryParam.php | 30 +++++ src/Annotation/RequestVariable.php | 3 +- src/Annotation/ResponseStatus.php | 1 - src/ConstraintViolation.php | 15 ++- src/Dictionary/ErrorMessage.php | 33 ++++++ .../Http/HttpBadRequestException.php | 34 ------ .../Http/HttpMethodNotAllowedException.php | 1 - .../HttpUnsupportedMediaTypeException.php | 2 - src/Exception/HttpException.php | 97 ++++++++++++--- src/Exception/HttpExceptionInterface.php | 14 +-- src/Helper/RouteBuilder.php | 5 +- src/Helper/RouteParser.php | 22 +--- src/Helper/RouteSimplifier.php | 45 +++++++ src/Helper/Stringifier.php | 64 ---------- src/InterceptorResolver.php | 8 +- src/Loader/DescriptorLoader.php | 1 - .../JsonPayloadDecodingMiddleware.php | 10 +- src/ParameterResolver.php | 28 ++++- .../RequestBodyParameterResolver.php | 22 ++-- .../RequestCookieParameterResolver.php | 27 +++-- .../RequestHeaderParameterResolver.php | 21 ++-- .../RequestQueryParamParameterResolver.php | 112 ++++++++++++++++++ .../RequestQueryParameterResolver.php | 22 ++-- .../RequestRouteParameterResolver.php | 6 +- .../RequestVariableParameterResolver.php | 35 +++--- .../QueueableRequestHandler.php | 1 - src/ResponseResolver.php | 16 ++- .../EmptyResponseResolver.php | 11 +- src/ResponseResolver/HtmlResponseResolver.php | 64 ++++++++++ src/ResponseResolver/JsonResponseResolver.php | 39 +++--- .../ResponseResolverInterface.php | 6 +- .../RouteResponseResolver.php | 13 +- .../StreamResponseResolver.php | 11 +- src/ResponseResolver/UriResponseResolver.php | 11 +- src/Router.php | 2 - src/ServerRequest.php | 28 +++++ 42 files changed, 591 insertions(+), 306 deletions(-) create mode 100644 src/Annotation/HtmlResponse.php create mode 100644 src/Annotation/RequestQueryParam.php create mode 100644 src/Dictionary/ErrorMessage.php delete mode 100644 src/Exception/Http/HttpBadRequestException.php create mode 100644 src/Helper/RouteSimplifier.php delete mode 100644 src/Helper/Stringifier.php create mode 100644 src/ParameterResolver/RequestQueryParamParameterResolver.php create mode 100644 src/ResponseResolver/HtmlResponseResolver.php diff --git a/src/Annotation/Constraint.php b/src/Annotation/Constraint.php index 3d71b876..85f744c4 100644 --- a/src/Annotation/Constraint.php +++ b/src/Annotation/Constraint.php @@ -18,7 +18,6 @@ /** * @since 3.0.0 */ -// phpcs:ignore Generic.Files.LineLength #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::TARGET_PARAMETER | Attribute::IS_REPEATABLE)] final class Constraint { diff --git a/src/Annotation/HtmlResponse.php b/src/Annotation/HtmlResponse.php new file mode 100644 index 00000000..20f409b4 --- /dev/null +++ b/src/Annotation/HtmlResponse.php @@ -0,0 +1,24 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] +final class HtmlResponse +{ +} diff --git a/src/Annotation/RequestBody.php b/src/Annotation/RequestBody.php index c7cf4d53..a29a3fb8 100644 --- a/src/Annotation/RequestBody.php +++ b/src/Annotation/RequestBody.php @@ -22,8 +22,7 @@ final class RequestBody { public function __construct( - /** @var int<100, 599> */ - public readonly int $errorStatusCode = 400, + public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, ) { } diff --git a/src/Annotation/RequestCookie.php b/src/Annotation/RequestCookie.php index 9e028a2d..aa73328c 100644 --- a/src/Annotation/RequestCookie.php +++ b/src/Annotation/RequestCookie.php @@ -23,8 +23,7 @@ final class RequestCookie { public function __construct( public readonly string $name, - /** @var int<100, 599> */ - public readonly int $errorStatusCode = 400, + public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, ) { } diff --git a/src/Annotation/RequestHeader.php b/src/Annotation/RequestHeader.php index 090cf5ff..c088085a 100644 --- a/src/Annotation/RequestHeader.php +++ b/src/Annotation/RequestHeader.php @@ -23,8 +23,7 @@ final class RequestHeader { public function __construct( public readonly string $name, - /** @var int<100, 599> */ - public readonly int $errorStatusCode = 400, + public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, ) { } diff --git a/src/Annotation/RequestQuery.php b/src/Annotation/RequestQuery.php index 0b4ca274..0759e9c4 100644 --- a/src/Annotation/RequestQuery.php +++ b/src/Annotation/RequestQuery.php @@ -22,8 +22,7 @@ final class RequestQuery { public function __construct( - /** @var int<100, 599> */ - public readonly int $errorStatusCode = 400, + public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, ) { } diff --git a/src/Annotation/RequestQueryParam.php b/src/Annotation/RequestQueryParam.php new file mode 100644 index 00000000..278109cd --- /dev/null +++ b/src/Annotation/RequestQueryParam.php @@ -0,0 +1,30 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_PARAMETER)] +final class RequestQueryParam +{ + public function __construct( + public readonly string $name, + public readonly ?int $errorStatusCode = null, + public readonly ?string $errorMessage = null, + ) { + } +} diff --git a/src/Annotation/RequestVariable.php b/src/Annotation/RequestVariable.php index ec9374f2..de9db568 100644 --- a/src/Annotation/RequestVariable.php +++ b/src/Annotation/RequestVariable.php @@ -23,8 +23,7 @@ final class RequestVariable { public function __construct( public readonly string|null $name = null, - /** @var int<100, 599> */ - public readonly int $errorStatusCode = 400, + public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, ) { } diff --git a/src/Annotation/ResponseStatus.php b/src/Annotation/ResponseStatus.php index bdccd7ed..d8742e69 100644 --- a/src/Annotation/ResponseStatus.php +++ b/src/Annotation/ResponseStatus.php @@ -22,7 +22,6 @@ final class ResponseStatus { public function __construct( - /** @var int<100, 599> */ public readonly int $code, public readonly string $phrase = '', ) { diff --git a/src/ConstraintViolation.php b/src/ConstraintViolation.php index 74630885..e120f7c1 100644 --- a/src/ConstraintViolation.php +++ b/src/ConstraintViolation.php @@ -14,8 +14,9 @@ namespace Sunrise\Http\Router; use Generator; -use Sunrise\Hydrator\Exception\InvalidValueException as HydratorConstraintViolation; -use Symfony\Component\Validator\ConstraintViolationInterface as ValidatorConstraintViolation; +use Sunrise\Hydrator\Exception\InvalidDataException; +use Sunrise\Hydrator\Exception\InvalidValueException; +use Symfony\Component\Validator\ConstraintViolationInterface as ValidatorConstraintViolationInterface; /** * @since 3.0.0 @@ -59,8 +60,14 @@ public function getCode(): ?string /** * @return Generator */ - public static function fromHydrator(HydratorConstraintViolation ...$violations): Generator + public static function fromHydrator(InvalidDataException|InvalidValueException ...$violations): Generator { + foreach ($violations as $violation) { + if ($violation instanceof InvalidDataException) { + $violations = [...$violations, $violation->getExceptions()]; + } + } + foreach ($violations as $violation) { yield new self( $violation->getMessage(), @@ -75,7 +82,7 @@ public static function fromHydrator(HydratorConstraintViolation ...$violations): /** * @return Generator */ - public static function fromValidator(ValidatorConstraintViolation ...$violations): Generator + public static function fromValidator(ValidatorConstraintViolationInterface ...$violations): Generator { foreach ($violations as $violation) { yield new self( diff --git a/src/Dictionary/ErrorMessage.php b/src/Dictionary/ErrorMessage.php new file mode 100644 index 00000000..855d997d --- /dev/null +++ b/src/Dictionary/ErrorMessage.php @@ -0,0 +1,33 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Dictionary; + +/** + * @since 3.0.0 + */ +final class ErrorMessage +{ + public const JSON_PAYLOAD_EMPTY = 'JSON body cannot be empty.'; + public const JSON_PAYLOAD_INVALID = 'The JSON body is invalid and could not be decoded.'; + public const JSON_PAYLOAD_FORM_INVALID = 'The JSON body must be in the form of an array or an object.'; + public const BODY_INVALID = 'The request body is invalid.'; + public const COOKIE_INVALID = 'The cookie {{ cookie_name }} is invalid.'; + public const COOKIE_MISSED = 'The cookie {{ cookie_name }} must be provided.'; + public const HEADER_INVALID = 'The header {{ header_name }} is invalid.'; + public const HEADER_MISSED = 'The header {{ header_name }} must be provided.'; + public const QUERY_INVALID = 'The request query is invalid.'; + public const QUERY_PARAM_INVALID = 'The query parameter {{ param_name }} is invalid.'; + public const QUERY_PARAM_MISSED = 'The query parameter {{ param_name }} must be provided.'; + public const PATH_VARIABLE_INVALID = 'The variable {{{ variable_name }}} in the path {{ route_path }} is invalid.'; +} diff --git a/src/Exception/Http/HttpBadRequestException.php b/src/Exception/Http/HttpBadRequestException.php deleted file mode 100644 index 665cb5c5..00000000 --- a/src/Exception/Http/HttpBadRequestException.php +++ /dev/null @@ -1,34 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Bad Request Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400 - * - * @since 3.0.0 - */ -class HttpBadRequestException extends HttpException -{ - public const DEFAULT_MESSAGE = 'The request could not be processed due to malformed syntax or invalid parameters.'; - - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - parent::__construct(self::STATUS_BAD_REQUEST, $message ?? self::DEFAULT_MESSAGE, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpMethodNotAllowedException.php b/src/Exception/Http/HttpMethodNotAllowedException.php index ef866411..682efbc9 100644 --- a/src/Exception/Http/HttpMethodNotAllowedException.php +++ b/src/Exception/Http/HttpMethodNotAllowedException.php @@ -28,7 +28,6 @@ class HttpMethodNotAllowedException extends HttpException { public const DEFAULT_MESSAGE = 'The request could not be processed using the requested HTTP method.'; - // phpcs:ignore Generic.Files.LineLength public function __construct(private array $allowedMethods, ?string $message = null, int $code = 0, ?Throwable $previous = null) { parent::__construct(self::STATUS_METHOD_NOT_ALLOWED, $message ?? self::DEFAULT_MESSAGE, $code, $previous); diff --git a/src/Exception/Http/HttpUnsupportedMediaTypeException.php b/src/Exception/Http/HttpUnsupportedMediaTypeException.php index b1ddddd1..9aecb97a 100644 --- a/src/Exception/Http/HttpUnsupportedMediaTypeException.php +++ b/src/Exception/Http/HttpUnsupportedMediaTypeException.php @@ -27,13 +27,11 @@ */ class HttpUnsupportedMediaTypeException extends HttpException { - // phpcs:ignore Generic.Files.LineLength public const DEFAULT_MESSAGE = 'The request could not be processed due to an unsupported format of the request payload.'; /** * @param list $supportedMediaTypes */ - // phpcs:ignore Generic.Files.LineLength public function __construct(private readonly array $supportedMediaTypes, ?string $message = null, int $code = 0, ?Throwable $previous = null) { foreach ($supportedMediaTypes as $index => $supportedMediaType) { diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index 81c399d0..36c6bd3d 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -13,11 +13,15 @@ namespace Sunrise\Http\Router\Exception; +use Closure; use RuntimeException; use Stringable; use Sunrise\Http\Router\ConstraintViolationInterface; +use Sunrise\Http\Router\Dictionary\ErrorMessage; use Throwable; + use function join; +use function strtr; /** * The package's base HTTP exception @@ -26,36 +30,101 @@ */ class HttpException extends RuntimeException implements HttpExceptionInterface { + public const DEFAULT_ERROR_STATUS_CODE = 400; + + private string $messageTemplate; + + private array $messagePlaceholders; - /** - * HTTP status code that will be sent to the client - * - * @var int<100, 599> - */ private int $statusCode; /** - * HTTP header fields that will be sent to the client - * * @var list */ private array $headerFields = []; /** - * The list of constraint violations associated with the error - * * @var list */ private array $constraintViolations = []; - /** - * @param int<100, 599> $statusCode - */ - public function __construct(int $statusCode, string $message, int $code = 0, ?Throwable $previous = null) + public function __construct(int $statusCode, string $message, array $placeholders = [], ?Throwable $previous = null) { - parent::__construct($message, $code, $previous); + parent::__construct(strtr($message, $placeholders), 0, $previous); $this->statusCode = $statusCode; + $this->messageTemplate = $message; + $this->messagePlaceholders = $placeholders; + } + + final public static function jsonPayloadEmpty(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self + { + return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::JSON_PAYLOAD_EMPTY, $placeholders, $previous); + } + + final public static function jsonPayloadInvalid(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self + { + return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::JSON_PAYLOAD_INVALID, $placeholders, $previous); + } + + final public static function jsonPayloadFormInvalid(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self + { + return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::JSON_PAYLOAD_FORM_INVALID, $placeholders, $previous); + } + + final public static function bodyInvalid(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self + { + return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::BODY_INVALID, $placeholders, $previous); + } + + final public static function cookieMissed(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self + { + return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::COOKIE_MISSED, $placeholders, $previous); + } + + final public static function cookieInvalid(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self + { + return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::COOKIE_INVALID, $placeholders, $previous); + } + + final public static function headerMissed(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self + { + return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::HEADER_MISSED, $placeholders, $previous); + } + + final public static function headerInvalid(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self + { + return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::HEADER_INVALID, $placeholders, $previous); + } + + final public static function queryInvalid(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self + { + return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::QUERY_INVALID, $placeholders, $previous); + } + + final public static function queryParamMissed(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self + { + return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::QUERY_PARAM_MISSED, $placeholders, $previous); + } + + final public static function queryParamInvalid(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self + { + return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::QUERY_PARAM_INVALID, $placeholders, $previous); + } + + final public static function pathVariableInvalid(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self + { + return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::PATH_VARIABLE_INVALID, $placeholders, $previous); + } + + public function getMessageTemplate(): string + { + return $this->messageTemplate; + } + + public function getMessagePlaceholders(): array + { + return $this->messagePlaceholders; } /** diff --git a/src/Exception/HttpExceptionInterface.php b/src/Exception/HttpExceptionInterface.php index b2884e0c..01293aff 100644 --- a/src/Exception/HttpExceptionInterface.php +++ b/src/Exception/HttpExceptionInterface.php @@ -23,26 +23,18 @@ */ interface HttpExceptionInterface extends ExceptionInterface, StatusCodeInterface { + public function getMessageTemplate(): string; + + public function getMessagePlaceholders(): array; - /** - * Gets HTTP status code that will be sent to the client - * - * See the {@see StatusCodeInterface} dictionary. - * - * @return int<100, 599> - */ public function getStatusCode(): int; /** - * Gets HTTP header fields that will be sent to the client - * * @return list */ public function getHeaderFields(): array; /** - * Gets the list of constraint violations associated with the error - * * @return list */ public function getConstraintViolations(): array; diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index ffba66c2..530d8efe 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -65,7 +65,10 @@ public static function buildRoute(string $route, array $values = []): string } if (isset($variable['optional'])) { - $search[] = '(' . ($variable['left'] ?? '') . $statement . ($variable['right'] ?? '') . ')'; + $left = $variable['left'] ?? ''; + $right = $variable['right'] ?? ''; + + $search[] = '(' . $left . $statement . $right . ')'; $replace[] = ''; continue; } diff --git a/src/Helper/RouteParser.php b/src/Helper/RouteParser.php index 71085d60..cfc0123f 100644 --- a/src/Helper/RouteParser.php +++ b/src/Helper/RouteParser.php @@ -26,15 +26,7 @@ final class RouteParser /** * Parses the given route and returns its variables * - * @return list + * @return list * * @throws InvalidArgumentException If the route isn't valid. */ @@ -278,17 +270,7 @@ public static function parseRoute(string $route): array )); } - /** - * @var list - */ + /** @var list */ return $variables; } } diff --git a/src/Helper/RouteSimplifier.php b/src/Helper/RouteSimplifier.php new file mode 100644 index 00000000..947ee119 --- /dev/null +++ b/src/Helper/RouteSimplifier.php @@ -0,0 +1,45 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Helper; + +use InvalidArgumentException; + +use function str_replace; +use function substr; + +/** + * @since 3.0.0 + */ +final class RouteSimplifier +{ + /** + * @throws InvalidArgumentException If the route isn't valid. + */ + public static function simplifyRoute(string $route): string + { + $variables = RouteParser::parseRoute($route); + + $search = []; + $replace = []; + foreach ($variables as $variable) { + $search[] = substr($route, $variable['offset'], $variable['length']); + $replace[] = '{' . $variable['name'] . '}'; + } + + $search[] = '('; + $search[] = ')'; + + return str_replace($search, $replace, $route); + } +} diff --git a/src/Helper/Stringifier.php b/src/Helper/Stringifier.php deleted file mode 100644 index 59b57da9..00000000 --- a/src/Helper/Stringifier.php +++ /dev/null @@ -1,64 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Helper; - -use ReflectionFunction; -use ReflectionMethod; -use ReflectionParameter; - -use function sprintf; - -/** - * @since 3.0.0 - */ -final class Stringifier -{ - public static function stringifyParameter(ReflectionParameter $parameter): string - { - $function = $parameter->getDeclaringFunction(); - - if ($function instanceof ReflectionMethod) { - return sprintf( - '%s::%s($%s[%d])', - $function->getDeclaringClass()->getName(), - $function->getName(), - $parameter->getName(), - $parameter->getPosition(), - ); - } - - return sprintf( - '%s($%s[%d])', - $function->getName(), - $parameter->getName(), - $parameter->getPosition(), - ); - } - - public static function stringifyFunction(ReflectionMethod|ReflectionFunction $function): string - { - if ($function instanceof ReflectionMethod) { - return sprintf( - '%s::%s()', - $function->getDeclaringClass()->getName(), - $function->getName(), - ); - } - - return sprintf( - '%s()', - $function->getName(), - ); - } -} diff --git a/src/InterceptorResolver.php b/src/InterceptorResolver.php index 4a4f6b60..9b44fdc6 100644 --- a/src/InterceptorResolver.php +++ b/src/InterceptorResolver.php @@ -94,7 +94,7 @@ public function resolveRequestHandler(mixed $requestHandler): RequestHandlerInte } throw new LogicException(sprintf( - 'The request handler {%s} could not be resolved.', + 'The request handler %s could not be resolved.', self::stringifyInterceptor($requestHandler), )); } @@ -143,7 +143,7 @@ public function resolveMiddleware(mixed $middleware): MiddlewareInterface } throw new LogicException(sprintf( - 'The middleware {%s} could not be resolved.', + 'The middleware %s could not be resolved.', self::stringifyInterceptor($middleware), )); } @@ -210,12 +210,12 @@ private function resolveClass(string $className): object } if (!class_exists($className)) { - throw new LogicException(sprintf('The class {%s} does not exist.', $className)); + throw new LogicException(sprintf('The class %s does not exist.', $className)); } $classReflection = new ReflectionClass($className); if (!$classReflection->isInstantiable()) { - throw new LogicException(sprintf('The class {%s} is not instantiable.', $className)); + throw new LogicException(sprintf('The class %s is not instantiable.', $className)); } $arguments = []; diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 67e2e1fc..8aac20df 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -214,7 +214,6 @@ private function supplementDescriptorFromParentClasses(Descriptor $descriptor, R } } - // phpcs:ignore Generic.Files.LineLength private function supplementDescriptorFromClassOrMethod(Descriptor $descriptor, ReflectionClass|ReflectionMethod $classOrMethod): void { /** @var list> $annotations */ diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 82df1e99..911740c4 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -19,7 +19,7 @@ use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; -use Sunrise\Http\Router\Exception\Http\HttpBadRequestException; +use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\ServerRequest; use function is_array; @@ -48,22 +48,22 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface } /** - * @throws HttpBadRequestException If the JSON payload couldn't be decoded. + * @throws HttpException If the JSON payload couldn't be decoded. */ private function decodePayload(string $payload): array { if ($payload === '') { - throw new HttpBadRequestException('JSON payload cannot be empty.'); + throw HttpException::jsonPayloadEmpty(); } try { $data = json_decode($payload, true, flags: JSON_BIGINT_AS_STRING | JSON_THROW_ON_ERROR); } catch (JsonException $e) { - throw new HttpBadRequestException('The JSON payload is invalid and could not be decoded.', previous: $e); + throw HttpException::jsonPayloadInvalid(previous: $e); } if (is_array($data) === false) { - throw new HttpBadRequestException('The JSON payload must be in the form of an array or an object.'); + throw HttpException::jsonPayloadFormInvalid(); } return $data; diff --git a/src/ParameterResolver.php b/src/ParameterResolver.php index ee35205c..bb3d933e 100644 --- a/src/ParameterResolver.php +++ b/src/ParameterResolver.php @@ -15,8 +15,8 @@ use Generator; use LogicException; +use ReflectionMethod; use ReflectionParameter; -use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; use function sprintf; @@ -87,8 +87,30 @@ private function resolveParameter(ReflectionParameter $parameter): Generator } throw new LogicException(sprintf( - 'The parameter {%s} cannot be resolved.', - Stringifier::stringifyParameter($parameter) + 'The parameter %s cannot be resolved.', + self::stringifyParameter($parameter) )); } + + public static function stringifyParameter(ReflectionParameter $parameter): string + { + $function = $parameter->getDeclaringFunction(); + + if ($function instanceof ReflectionMethod) { + return sprintf( + '%s::%s($%s[%d])', + $function->getDeclaringClass()->getName(), + $function->getName(), + $parameter->getName(), + $parameter->getPosition(), + ); + } + + return sprintf( + '%s($%s[%d])', + $function->getName(), + $parameter->getName(), + $parameter->getPosition(), + ); + } } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index e54c1de7..31cbdd32 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -22,11 +22,12 @@ use Sunrise\Http\Router\Annotation\RequestBody; use Sunrise\Http\Router\ConstraintViolation; use Sunrise\Http\Router\Exception\HttpException; -use Sunrise\Http\Router\Helper\Stringifier; +use Sunrise\Http\Router\ParameterResolver; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; +use function count; use function sprintf; /** @@ -58,8 +59,8 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { throw new LogicException(sprintf( - 'To use the #[RequestBody] attribute, the parameter {%s} must be typed with an object.', - Stringifier::stringifyParameter($parameter), + 'To use the #[RequestBody] annotation, the parameter %s must be typed with an object.', + ParameterResolver::stringifyParameter($parameter), )); } @@ -72,20 +73,17 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $requestBody = $annotations[0]->newInstance(); try { - $object = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); + $argument = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidDataException $e) { - throw (new HttpException($requestBody->errorStatusCode, $requestBody->errorMessage, previous: $e)) + throw HttpException::bodyInvalid($requestBody->errorStatusCode, $requestBody->errorMessage, previous: $e) ->addConstraintViolation(...ConstraintViolation::fromHydrator(...$e->getExceptions())); } - if (isset($this->validator)) { - $violations = $this->validator->validate($object); - if ($violations->count() > 0) { - throw (new HttpException($requestBody->errorStatusCode, $requestBody->errorMessage)) - ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); - } + if (isset($this->validator) && count($violations = $this->validator->validate($argument)) > 0) { + throw HttpException::bodyInvalid($requestBody->errorStatusCode, $requestBody->errorMessage) + ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); } - yield $object; + yield $argument; } } diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index f5c2a0ae..71957447 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -22,6 +22,7 @@ use Sunrise\Http\Router\Annotation\RequestCookie; use Sunrise\Http\Router\ConstraintViolation; use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\ServerRequest; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; @@ -62,31 +63,31 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } + $request = ServerRequest::create($context); $requestCookie = $annotations[0]->newInstance(); - $cookies = $context->getCookieParams(); + $placeholders = [ + '{{ cookie_name }}' => $requestCookie->name, + ]; - if (!isset($cookies[$requestCookie->name])) { + if (!$request->hasCookieParam($requestCookie->name)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } elseif ($parameter->allowsNull()) { return yield; } - throw new HttpException($requestCookie->errorStatusCode, $requestCookie->errorMessage); + throw HttpException::cookieMissed($requestCookie->errorStatusCode, $requestCookie->errorMessage, $placeholders); } try { - $value = $this->hydrator->castValue( - $cookies[$requestCookie->name], + $argument = $this->hydrator->castValue( + $request->getCookieParam($requestCookie->name), Type::fromParameter($parameter), path: [$requestCookie->name], ); - } catch (InvalidDataException $e) { - throw (new HttpException($requestCookie->errorStatusCode, $requestCookie->errorMessage, previous: $e)) - ->addConstraintViolation(...ConstraintViolation::fromHydrator(...$e->getExceptions())); - } catch (InvalidValueException $e) { - throw (new HttpException($requestCookie->errorStatusCode, $requestCookie->errorMessage, previous: $e)) + } catch (InvalidDataException|InvalidValueException $e) { + throw HttpException::cookieInvalid($requestCookie->errorStatusCode, $requestCookie->errorMessage, $placeholders, previous: $e) ->addConstraintViolation(...ConstraintViolation::fromHydrator($e)); } @@ -100,12 +101,12 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } } - if (count($constraints) > 0 && count($violations = $this->validator->validate($value, $constraints)) > 0) { - throw (new HttpException($requestCookie->errorStatusCode, $requestCookie->errorMessage)) + if (count($constraints) > 0 && count($violations = $this->validator->validate($argument, $constraints)) > 0) { + throw HttpException::cookieInvalid($requestCookie->errorStatusCode, $requestCookie->errorMessage, $placeholders) ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); } } - yield $value; + yield $argument; } } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 6083989d..96ccb9e3 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -64,6 +64,10 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $requestHeader = $annotations[0]->newInstance(); + $placeholders = [ + '{{ header_name }}' => $requestHeader->name, + ]; + if (!$context->hasHeader($requestHeader->name)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); @@ -71,20 +75,17 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return yield; } - throw new HttpException($requestHeader->errorStatusCode, $requestHeader->errorMessage); + throw HttpException::headerMissed($requestHeader->errorStatusCode, $requestHeader->errorMessage, $placeholders); } try { - $value = $this->hydrator->castValue( + $argument = $this->hydrator->castValue( $context->getHeaderLine($requestHeader->name), Type::fromParameter($parameter), path: [$requestHeader->name], ); - } catch (InvalidDataException $e) { - throw (new HttpException($requestHeader->errorStatusCode, $requestHeader->errorMessage, previous: $e)) - ->addConstraintViolation(...ConstraintViolation::fromHydrator(...$e->getExceptions())); - } catch (InvalidValueException $e) { - throw (new HttpException($requestHeader->errorStatusCode, $requestHeader->errorMessage, previous: $e)) + } catch (InvalidDataException|InvalidValueException $e) { + throw HttpException::headerInvalid($requestHeader->errorStatusCode, $requestHeader->errorMessage, $placeholders, previous: $e) ->addConstraintViolation(...ConstraintViolation::fromHydrator($e)); } @@ -98,12 +99,12 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } } - if (count($constraints) > 0 && count($violations = $this->validator->validate($value, $constraints)) > 0) { - throw (new HttpException($requestHeader->errorStatusCode, $requestHeader->errorMessage)) + if (count($constraints) > 0 && count($violations = $this->validator->validate($argument, $constraints)) > 0) { + throw HttpException::headerInvalid($requestHeader->errorStatusCode, $requestHeader->errorMessage, $placeholders) ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); } } - yield $value; + yield $argument; } } diff --git a/src/ParameterResolver/RequestQueryParamParameterResolver.php b/src/ParameterResolver/RequestQueryParamParameterResolver.php new file mode 100644 index 00000000..988e044c --- /dev/null +++ b/src/ParameterResolver/RequestQueryParamParameterResolver.php @@ -0,0 +1,112 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ParameterResolver; + +use Generator; +use LogicException; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionAttribute; +use ReflectionParameter; +use Sunrise\Http\Router\Annotation\Constraint; +use Sunrise\Http\Router\Annotation\RequestQueryParam; +use Sunrise\Http\Router\ConstraintViolation; +use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\ServerRequest; +use Sunrise\Hydrator\Exception\InvalidDataException; +use Sunrise\Hydrator\Exception\InvalidValueException; +use Sunrise\Hydrator\HydratorInterface; +use Sunrise\Hydrator\Type; +use Symfony\Component\Validator\Validator\ValidatorInterface; + +use function count; + +/** + * @since 3.0.0 + */ +final class RequestQueryParamParameterResolver implements ParameterResolverInterface +{ + public function __construct( + private readonly HydratorInterface $hydrator, + private readonly ?ValidatorInterface $validator = null, + ) { + } + + /** + * @inheritDoc + * + * @throws LogicException If the resolver is used incorrectly. + * + * @throws HttpException If a param was missed or invalid. + */ + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + { + /** @var list> $annotations */ + $annotations = $parameter->getAttributes(RequestQueryParam::class); + if ($annotations === []) { + return; + } + + if (! $context instanceof ServerRequestInterface) { + throw new LogicException( + 'At this level of the application, any operations with the request are not possible.', + ); + } + + $request = ServerRequest::create($context); + $requestParam = $annotations[0]->newInstance(); + + $placeholders = [ + '{{ param_name }}' => $requestParam->name, + ]; + + if (!$request->hasQueryParam($requestParam->name)) { + if ($parameter->isDefaultValueAvailable()) { + return yield $parameter->getDefaultValue(); + } elseif ($parameter->allowsNull()) { + return yield; + } + + throw HttpException::queryParamMissed($requestParam->errorStatusCode, $requestParam->errorMessage, $placeholders); + } + + try { + $argument = $this->hydrator->castValue( + $request->getQueryParam($requestParam->name), + Type::fromParameter($parameter), + path: [$requestParam->name], + ); + } catch (InvalidDataException|InvalidValueException $e) { + throw HttpException::queryParamInvalid($requestParam->errorStatusCode, $requestParam->errorMessage, $placeholders, previous: $e) + ->addConstraintViolation(...ConstraintViolation::fromHydrator($e)); + } + + if (isset($this->validator)) { + $constraints = []; + /** @var ReflectionAttribute $annotation */ + foreach ($parameter->getAttributes(Constraint::class) as $annotation) { + $constraint = $annotation->newInstance(); + if ($constraint->value instanceof \Symfony\Component\Validator\Constraint) { + $constraints[] = $constraint->value; + } + } + + if (count($constraints) > 0 && count($violations = $this->validator->validate($argument, $constraints)) > 0) { + throw HttpException::queryParamInvalid($requestParam->errorStatusCode, $requestParam->errorMessage, $placeholders) + ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); + } + } + + yield $argument; + } +} diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index c0cf8bc3..e381f58c 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -22,11 +22,12 @@ use Sunrise\Http\Router\Annotation\RequestQuery; use Sunrise\Http\Router\ConstraintViolation; use Sunrise\Http\Router\Exception\HttpException; -use Sunrise\Http\Router\Helper\Stringifier; +use Sunrise\Http\Router\ParameterResolver; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; +use function count; use function sprintf; /** @@ -58,8 +59,8 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { throw new LogicException(sprintf( - 'To use the #[RequestQuery] attribute, the parameter {%s} must be typed with an object.', - Stringifier::stringifyParameter($parameter), + 'To use the #[RequestQuery] annotation, the parameter %s must be typed with an object.', + ParameterResolver::stringifyParameter($parameter), )); } @@ -72,20 +73,17 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $requestQuery = $annotations[0]->newInstance(); try { - $object = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); + $argument = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { - throw (new HttpException($requestQuery->errorStatusCode, $requestQuery->errorMessage, previous: $e)) + throw HttpException::queryInvalid($requestQuery->errorStatusCode, $requestQuery->errorMessage, previous: $e) ->addConstraintViolation(...ConstraintViolation::fromHydrator(...$e->getExceptions())); } - if (isset($this->validator)) { - $violations = $this->validator->validate($object); - if ($violations->count() > 0) { - throw (new HttpException($requestQuery->errorStatusCode, $requestQuery->errorMessage)) - ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); - } + if (isset($this->validator) && count($violations = $this->validator->validate($argument)) > 0) { + throw HttpException::queryInvalid($requestQuery->errorStatusCode, $requestQuery->errorMessage) + ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); } - yield $object; + yield $argument; } } diff --git a/src/ParameterResolver/RequestRouteParameterResolver.php b/src/ParameterResolver/RequestRouteParameterResolver.php index c31c8b33..6f28f603 100644 --- a/src/ParameterResolver/RequestRouteParameterResolver.php +++ b/src/ParameterResolver/RequestRouteParameterResolver.php @@ -18,7 +18,7 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; -use Sunrise\Http\Router\Helper\Stringifier; +use Sunrise\Http\Router\ParameterResolver; use Sunrise\Http\Router\Route; use function sprintf; @@ -51,8 +51,8 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (! $route instanceof Route && !$parameter->allowsNull()) { throw new LogicException(sprintf( 'At this level of the application, the request does not contain a route. ' . - 'To suppress this error, the parameter {%s} should be nullable.', - Stringifier::stringifyParameter($parameter), + 'To suppress this error, the parameter %s should be nullable.', + ParameterResolver::stringifyParameter($parameter), )); } diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index 0893662e..2057c501 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -22,7 +22,8 @@ use Sunrise\Http\Router\Annotation\RequestVariable; use Sunrise\Http\Router\ConstraintViolation; use Sunrise\Http\Router\Exception\HttpException; -use Sunrise\Http\Router\Helper\Stringifier; +use Sunrise\Http\Router\Helper\RouteSimplifier; +use Sunrise\Http\Router\ParameterResolver; use Sunrise\Http\Router\Route; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; @@ -68,15 +69,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $route = $context->getAttribute('@route'); if (! $route instanceof Route) { throw new LogicException(sprintf( - 'The #[PathVariable] attribute cannot be applied to the parameter {%s}, ' . + 'The #[RequestVariable] annotation cannot be applied to the parameter %s, ' . 'because the request does not contain information about the requested route, ' . 'at least at this level of the application.', - Stringifier::stringifyParameter($parameter), + ParameterResolver::stringifyParameter($parameter), )); } $requestVariable = $annotations[0]->newInstance(); - $variableName = $requestVariable->name ?? $parameter->getName(); if (!$route->hasAttribute($variableName)) { @@ -87,26 +87,29 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } throw new LogicException(sprintf( - 'The parameter {%1$s} expects the value of the variable {%3$s} from the route "%2$s", ' . + 'The parameter %1$s expects the value of the variable %3$s from the route %2$s, ' . 'which is not present in the request, most likely, because the variable is optional. ' . 'To resolve this issue, make this parameter nullable or assign it a default value.', - Stringifier::stringifyParameter($parameter), + ParameterResolver::stringifyParameter($parameter), $route->getName(), $variableName, )); } + $placeholders = [ + '{{ variable_name }}' => $variableName, + ]; + try { - $value = $this->hydrator->castValue( + $argument = $this->hydrator->castValue( $route->getAttribute($variableName), Type::fromParameter($parameter), path: [$variableName], ); - } catch (InvalidDataException $e) { - throw (new HttpException($requestVariable->errorStatusCode, $requestVariable->errorMessage, previous: $e)) - ->addConstraintViolation(...ConstraintViolation::fromHydrator(...$e->getExceptions())); - } catch (InvalidValueException $e) { - throw (new HttpException($requestVariable->errorStatusCode, $requestVariable->errorMessage, previous: $e)) + } catch (InvalidDataException|InvalidValueException $e) { + $placeholders['{{ route_path }}'] = RouteSimplifier::simplifyRoute($route->getPath()); + + throw HttpException::pathVariableInvalid($requestVariable->errorStatusCode, $requestVariable->errorMessage, $placeholders, previous: $e) ->addConstraintViolation(...ConstraintViolation::fromHydrator($e)); } @@ -120,12 +123,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } } - if (count($constraints) > 0 && count($violations = $this->validator->validate($value, $constraints)) > 0) { - throw (new HttpException($requestVariable->errorStatusCode, $requestVariable->errorMessage)) + if (count($constraints) > 0 && count($violations = $this->validator->validate($argument, $constraints)) > 0) { + $placeholders['{{ route_path }}'] = RouteSimplifier::simplifyRoute($route->getPath()); + + throw HttpException::pathVariableInvalid($requestVariable->errorStatusCode, $requestVariable->errorMessage, $placeholders) ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); } } - yield $value; + yield $argument; } } diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index d6e6e68b..9735bdbe 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -34,7 +34,6 @@ public function __construct( */ public function handle(ServerRequestInterface $request): ResponseInterface { - // phpcs:ignore Generic.Files.LineLength return $this->isEmpty() ? $this->endpoint->handle($request) : ($clone = clone $this)->dequeue()->process($request, $clone); } } diff --git a/src/ResponseResolver.php b/src/ResponseResolver.php index 87a9a2e6..dd03c1e3 100644 --- a/src/ResponseResolver.php +++ b/src/ResponseResolver.php @@ -21,7 +21,6 @@ use ReflectionMethod; use Sunrise\Http\Router\Annotation\ResponseHeader; use Sunrise\Http\Router\Annotation\ResponseStatus; -use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; use function sprintf; @@ -50,15 +49,15 @@ public function resolveResponse( } foreach ($this->resolvers as $resolver) { - $result = $resolver->resolveResponse($request, $response, $responder); + $result = $resolver->resolveResponse($response, $responder, $request); if ($result instanceof ResponseInterface) { return $this->handleResponse($request, $result, $responder); } } throw new LogicException(sprintf( - 'The responder {%s} returned an unsupported response.', - Stringifier::stringifyFunction($responder), + 'The responder %s returned an unsupported response.', + self::stringifyResponder($responder), )); } @@ -83,4 +82,13 @@ private function handleResponse( return $response; } + + public static function stringifyResponder(ReflectionMethod|ReflectionFunction $function): string + { + if ($function instanceof ReflectionMethod) { + return sprintf('%s::%s()', $function->getDeclaringClass()->getName(), $function->getName()); + } + + return sprintf('%s()', $function->getName()); + } } diff --git a/src/ResponseResolver/EmptyResponseResolver.php b/src/ResponseResolver/EmptyResponseResolver.php index 1f9b7050..a2d1ad3e 100644 --- a/src/ResponseResolver/EmptyResponseResolver.php +++ b/src/ResponseResolver/EmptyResponseResolver.php @@ -21,24 +21,19 @@ use Sunrise\Http\Router\Annotation\EmptyResponse; /** - * EmptyResponseResolver - * * @since 3.0.0 */ final class EmptyResponseResolver implements ResponseResolverInterface { - public function __construct(private ResponseFactoryInterface $responseFactory) + public function __construct(private readonly ResponseFactoryInterface $responseFactory) { } - /** - * @inheritDoc - */ public function resolveResponse( - ServerRequestInterface $request, mixed $response, ReflectionMethod|ReflectionFunction $responder, - ) : ?ResponseInterface { + ServerRequestInterface $request, + ): ?ResponseInterface { if ($responder->getAttributes(EmptyResponse::class) === []) { return null; } diff --git a/src/ResponseResolver/HtmlResponseResolver.php b/src/ResponseResolver/HtmlResponseResolver.php new file mode 100644 index 00000000..3cae034e --- /dev/null +++ b/src/ResponseResolver/HtmlResponseResolver.php @@ -0,0 +1,64 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ResponseResolver; + +use LogicException; +use Psr\Http\Message\ResponseFactoryInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionFunction; +use ReflectionMethod; +use Stringable; +use Sunrise\Http\Router\Annotation\HtmlResponse; +use Sunrise\Http\Router\ResponseResolver; + +use function is_string; +use function sprintf; + +/** + * @since 3.0.0 + */ +final class HtmlResponseResolver implements ResponseResolverInterface +{ + public function __construct(private readonly ResponseFactoryInterface $responseFactory) + { + } + + /** + * @throws LogicException If the resolver is used incorrectly. + */ + public function resolveResponse( + mixed $response, + ReflectionMethod|ReflectionFunction $responder, + ServerRequestInterface $request, + ): ?ResponseInterface { + if ($responder->getAttributes(HtmlResponse::class) === []) { + return null; + } + + if (!is_string($response) && !($response instanceof Stringable)) { + throw new LogicException(sprintf( + 'The responder %s returned a response that cannot be converted to a string.', + ResponseResolver::stringifyResponder($responder), + )); + } + + $result = $this->responseFactory->createResponse(200) + ->withHeader('Content-Type', 'text/html; charset=UTF-8'); + + $result->getBody()->write((string) $response); + + return $result; + } +} diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index 21c2d93d..58e55863 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -22,7 +22,7 @@ use ReflectionFunction; use ReflectionMethod; use Sunrise\Http\Router\Annotation\JsonResponse; -use Sunrise\Http\Router\Helper\Stringifier; +use Sunrise\Http\Router\ResponseResolver; use function json_encode; use function sprintf; @@ -30,49 +30,44 @@ use const JSON_THROW_ON_ERROR; /** - * JsonResponseResolver - * * @since 3.0.0 */ final class JsonResponseResolver implements ResponseResolverInterface { - public function __construct(private ResponseFactoryInterface $responseFactory) + public function __construct(private readonly ResponseFactoryInterface $responseFactory) { } /** - * @inheritDoc + * @throws LogicException If the resolver is used incorrectly. */ public function resolveResponse( - ServerRequestInterface $request, mixed $response, ReflectionMethod|ReflectionFunction $responder, - ) : ?ResponseInterface { - /** @var ReflectionAttribute $attributes */ - $attributes = $responder->getAttributes(JsonResponse::class); - if ($attributes === []) { + ServerRequestInterface $request, + ): ?ResponseInterface { + /** @var list> $annotations */ + $annotations = $responder->getAttributes(JsonResponse::class); + if ($annotations === []) { return null; } - $attribute = $attributes[0]->newInstance(); + $jsonResponse = $annotations[0]->newInstance(); try { - /** - * Ignores the depth... - * @psalm-suppress ArgumentTypeCoercion - * @phpstan-ignore-next-line - */ - $payload = json_encode($response, $attribute->flags | JSON_THROW_ON_ERROR, $attribute->depth); + /** @psalm-suppress ArgumentTypeCoercion */ + $payload = json_encode($response, $jsonResponse->flags | JSON_THROW_ON_ERROR, $jsonResponse->depth); } catch (JsonException $e) { throw new LogicException(sprintf( - 'The responder {%s} returned a response that could not be encoded to JSON due to: %s', - Stringifier::stringifyFunction($responder), + 'The responder %s returned a response that could not be encoded to JSON due to: %s', + ResponseResolver::stringifyResponder($responder), $e->getMessage(), - )); + ), previous: $e); } - $result = $this->responseFactory->createResponse(200); - $result = $result->withHeader('Content-Type', 'application/json; charset=UTF-8'); + $result = $this->responseFactory->createResponse(200) + ->withHeader('Content-Type', 'application/json; charset=UTF-8'); + $result->getBody()->write($payload); return $result; diff --git a/src/ResponseResolver/ResponseResolverInterface.php b/src/ResponseResolver/ResponseResolverInterface.php index 8a52cb7b..9bb74077 100644 --- a/src/ResponseResolver/ResponseResolverInterface.php +++ b/src/ResponseResolver/ResponseResolverInterface.php @@ -19,15 +19,13 @@ use ReflectionMethod; /** - * ResponseResolverInterface - * * @since 3.0.0 */ interface ResponseResolverInterface { public function resolveResponse( - ServerRequestInterface $request, mixed $response, ReflectionMethod|ReflectionFunction $responder, - ) : ?ResponseInterface; + ServerRequestInterface $request, + ): ?ResponseInterface; } diff --git a/src/ResponseResolver/RouteResponseResolver.php b/src/ResponseResolver/RouteResponseResolver.php index 29bb52aa..c1967c4f 100644 --- a/src/ResponseResolver/RouteResponseResolver.php +++ b/src/ResponseResolver/RouteResponseResolver.php @@ -22,27 +22,24 @@ use Sunrise\Http\Router\Router; /** - * RouteResponseResolver - * * @since 3.0.0 */ final class RouteResponseResolver implements ResponseResolverInterface { - /** - * @inheritDoc - */ public function resolveResponse( - ServerRequestInterface $request, mixed $response, ReflectionMethod|ReflectionFunction $responder, - ) : ?ResponseInterface { + ServerRequestInterface $request, + ): ?ResponseInterface { if (! $response instanceof Route) { return null; } $router = $request->getAttribute('@router'); if (! $router instanceof Router) { - throw new LogicException(); + throw new LogicException( + 'Something went wrong, the request must contain the @router attribute.' + ); } return $router->runRoute($response, $request); diff --git a/src/ResponseResolver/StreamResponseResolver.php b/src/ResponseResolver/StreamResponseResolver.php index da0c4c86..b9818339 100644 --- a/src/ResponseResolver/StreamResponseResolver.php +++ b/src/ResponseResolver/StreamResponseResolver.php @@ -21,24 +21,19 @@ use ReflectionMethod; /** - * StreamResponseResolver - * * @since 3.0.0 */ final class StreamResponseResolver implements ResponseResolverInterface { - public function __construct(private ResponseFactoryInterface $responseFactory) + public function __construct(private readonly ResponseFactoryInterface $responseFactory) { } - /** - * @inheritDoc - */ public function resolveResponse( - ServerRequestInterface $request, mixed $response, ReflectionMethod|ReflectionFunction $responder, - ) : ?ResponseInterface { + ServerRequestInterface $request, + ): ?ResponseInterface { if (! $response instanceof StreamInterface) { return null; } diff --git a/src/ResponseResolver/UriResponseResolver.php b/src/ResponseResolver/UriResponseResolver.php index fdea18f1..804764fa 100644 --- a/src/ResponseResolver/UriResponseResolver.php +++ b/src/ResponseResolver/UriResponseResolver.php @@ -21,24 +21,19 @@ use ReflectionMethod; /** - * UriResponseResolver - * * @since 3.0.0 */ final class UriResponseResolver implements ResponseResolverInterface { - public function __construct(private ResponseFactoryInterface $responseFactory) + public function __construct(private readonly ResponseFactoryInterface $responseFactory) { } - /** - * @inheritDoc - */ public function resolveResponse( - ServerRequestInterface $request, mixed $response, ReflectionMethod|ReflectionFunction $responder, - ) : ?ResponseInterface { + ServerRequestInterface $request, + ): ?ResponseInterface { if (! $response instanceof UriInterface) { return null; } diff --git a/src/Router.php b/src/Router.php index 138cb82e..959b5962 100644 --- a/src/Router.php +++ b/src/Router.php @@ -212,7 +212,6 @@ public function compileRoute(Route|string $route): string $route = $this->getRoute($route); } - // phpcs:ignore Generic.Files.LineLength return $this->routePatterns[$route->getName()] ??= $route->getPattern() ?? RouteCompiler::compileRoute($route->getPath(), $route->getPatterns()); } @@ -230,7 +229,6 @@ public function getRouteRequestHandler(Route|string $route): RequestHandlerInter return $this->routeRequestHandlers[$routeName]; } - // phpcs:ignore Generic.Files.LineLength $this->routeRequestHandlers[$routeName] = $this->interceptorResolver->resolveRequestHandler($route->getRequestHandler()); $middlewares = $route->getMiddlewares(); diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 7fe09031..4b64c494 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -390,6 +390,20 @@ public function getQueryParams(): array return $this->request->getQueryParams(); } + public function hasQueryParam(string $name): bool + { + $params = $this->request->getQueryParams(); + + return isset($params[$name]); + } + + public function getQueryParam(string $name, mixed $default = null): mixed + { + $params = $this->request->getQueryParams(); + + return $params[$name] ?? $default; + } + /** * @inheritDoc */ @@ -409,6 +423,20 @@ public function getCookieParams(): array return $this->request->getCookieParams(); } + public function hasCookieParam(string $name): bool + { + $params = $this->request->getCookieParams(); + + return isset($params[$name]); + } + + public function getCookieParam(string $name, mixed $default = null): mixed + { + $params = $this->request->getCookieParams(); + + return $params[$name] ?? $default; + } + /** * @inheritDoc */ From bf5e1243622b026d444c58469499e2a8eb588314 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 3 Mar 2024 04:44:42 +0100 Subject: [PATCH 106/180] v3 --- ...stVariable.php => RequestPathVariable.php} | 4 +- src/ConstraintViolation.php | 66 ++--- src/Dictionary/ErrorMessage.php | 5 +- src/Entity/MediaType/ClientMediaType.php | 8 + src/Entity/MediaType/MediaTypeInterface.php | 4 +- src/Entity/MediaType/ServerMediaType.php | 8 + src/Exception/Exception.php | 23 -- .../Http/HttpMethodNotAllowedException.php | 46 --- src/Exception/Http/HttpNotFoundException.php | 34 --- .../HttpUnsupportedMediaTypeException.php | 56 ---- src/Exception/HttpException.php | 270 +++++++++++++++--- src/Exception/HttpExceptionInterface.php | 8 +- src/InterceptorResolver.php | 4 +- .../RequestBodyParameterResolver.php | 5 +- .../RequestCookieParameterResolver.php | 5 +- .../RequestHeaderParameterResolver.php | 5 +- ... RequestPathVariableParameterResolver.php} | 26 +- .../RequestQueryParamParameterResolver.php | 7 +- .../RequestQueryParameterResolver.php | 5 +- .../RequestRouteParameterResolver.php | 2 +- .../RequestStreamParameterResolver.php | 2 +- .../RequestUriParameterResolver.php | 2 +- .../ServerRequestParameterResolver.php | 2 +- src/ResponseResolver.php | 7 +- .../RouteResponseResolver.php | 2 +- src/Router.php | 27 +- 26 files changed, 323 insertions(+), 310 deletions(-) rename src/Annotation/{RequestVariable.php => RequestPathVariable.php} (88%) delete mode 100644 src/Exception/Exception.php delete mode 100644 src/Exception/Http/HttpMethodNotAllowedException.php delete mode 100644 src/Exception/Http/HttpNotFoundException.php delete mode 100644 src/Exception/Http/HttpUnsupportedMediaTypeException.php rename src/ParameterResolver/{RequestVariableParameterResolver.php => RequestPathVariableParameterResolver.php} (80%) diff --git a/src/Annotation/RequestVariable.php b/src/Annotation/RequestPathVariable.php similarity index 88% rename from src/Annotation/RequestVariable.php rename to src/Annotation/RequestPathVariable.php index de9db568..9b0db93c 100644 --- a/src/Annotation/RequestVariable.php +++ b/src/Annotation/RequestPathVariable.php @@ -19,10 +19,10 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_PARAMETER)] -final class RequestVariable +final class RequestPathVariable { public function __construct( - public readonly string|null $name = null, + public readonly ?string $name = null, public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, ) { diff --git a/src/ConstraintViolation.php b/src/ConstraintViolation.php index e120f7c1..25737d6f 100644 --- a/src/ConstraintViolation.php +++ b/src/ConstraintViolation.php @@ -13,10 +13,8 @@ namespace Sunrise\Http\Router; -use Generator; -use Sunrise\Hydrator\Exception\InvalidDataException; -use Sunrise\Hydrator\Exception\InvalidValueException; -use Symfony\Component\Validator\ConstraintViolationInterface as ValidatorConstraintViolationInterface; +use Sunrise\Hydrator\Exception\InvalidValueException as HydratorConstraintViolation; +use Symfony\Component\Validator\ConstraintViolationInterface as ValidatorConstraintViolation; /** * @since 3.0.0 @@ -32,6 +30,28 @@ public function __construct( ) { } + public static function fromHydrator(HydratorConstraintViolation $hydratorConstraintViolation): self + { + return new self( + $hydratorConstraintViolation->getMessage(), + $hydratorConstraintViolation->getMessageTemplate(), + $hydratorConstraintViolation->getMessagePlaceholders(), + $hydratorConstraintViolation->getPropertyPath(), + $hydratorConstraintViolation->getErrorCode(), + ); + } + + public static function fromValidator(ValidatorConstraintViolation $validatorConstraintViolation): self + { + return new self( + (string) $validatorConstraintViolation->getMessage(), + $validatorConstraintViolation->getMessageTemplate(), + $validatorConstraintViolation->getParameters(), + $validatorConstraintViolation->getPropertyPath(), + $validatorConstraintViolation->getCode(), + ); + } + public function getMessage(): string { return $this->message; @@ -56,42 +76,4 @@ public function getCode(): ?string { return $this->code; } - - /** - * @return Generator - */ - public static function fromHydrator(InvalidDataException|InvalidValueException ...$violations): Generator - { - foreach ($violations as $violation) { - if ($violation instanceof InvalidDataException) { - $violations = [...$violations, $violation->getExceptions()]; - } - } - - foreach ($violations as $violation) { - yield new self( - $violation->getMessage(), - $violation->getMessageTemplate(), - $violation->getMessagePlaceholders(), - $violation->getPropertyPath(), - $violation->getErrorCode(), - ); - } - } - - /** - * @return Generator - */ - public static function fromValidator(ValidatorConstraintViolationInterface ...$violations): Generator - { - foreach ($violations as $violation) { - yield new self( - (string) $violation->getMessage(), - $violation->getMessageTemplate(), - $violation->getParameters(), - $violation->getPropertyPath(), - $violation->getCode(), - ); - } - } } diff --git a/src/Dictionary/ErrorMessage.php b/src/Dictionary/ErrorMessage.php index 855d997d..cd3c1765 100644 --- a/src/Dictionary/ErrorMessage.php +++ b/src/Dictionary/ErrorMessage.php @@ -18,6 +18,9 @@ */ final class ErrorMessage { + public const RESOURCE_NOT_FOUND = 'The resource {{ resource }} was not found.'; + public const METHOD_NOT_ALLOWED = 'The method {{ method }} is not allowed; please check the Allow header for allowed methods.'; + public const MEDIA_TYPE_NOT_SUPPORTED = 'The media type {{ media_type }} is not supported; please check the Accept header for supported media types.'; public const JSON_PAYLOAD_EMPTY = 'JSON body cannot be empty.'; public const JSON_PAYLOAD_INVALID = 'The JSON body is invalid and could not be decoded.'; public const JSON_PAYLOAD_FORM_INVALID = 'The JSON body must be in the form of an array or an object.'; @@ -29,5 +32,5 @@ final class ErrorMessage public const QUERY_INVALID = 'The request query is invalid.'; public const QUERY_PARAM_INVALID = 'The query parameter {{ param_name }} is invalid.'; public const QUERY_PARAM_MISSED = 'The query parameter {{ param_name }} must be provided.'; - public const PATH_VARIABLE_INVALID = 'The variable {{{ variable_name }}} in the path {{ route_path }} is invalid.'; + public const PATH_VARIABLE_INVALID = 'The variable {{{ variable_name }}} of the path {{ route_path }} is invalid.'; } diff --git a/src/Entity/MediaType/ClientMediaType.php b/src/Entity/MediaType/ClientMediaType.php index 55498cca..1504922a 100644 --- a/src/Entity/MediaType/ClientMediaType.php +++ b/src/Entity/MediaType/ClientMediaType.php @@ -43,4 +43,12 @@ public function getParameters(): array { return $this->parameters; } + + /** + * @inheritDoc + */ + public function __toString(): string + { + return $this->type . '/' . $this->subtype; + } } diff --git a/src/Entity/MediaType/MediaTypeInterface.php b/src/Entity/MediaType/MediaTypeInterface.php index 7677a09c..3f1a2bc4 100644 --- a/src/Entity/MediaType/MediaTypeInterface.php +++ b/src/Entity/MediaType/MediaTypeInterface.php @@ -13,10 +13,12 @@ namespace Sunrise\Http\Router\Entity\MediaType; +use Stringable; + /** * @since 3.0.0 */ -interface MediaTypeInterface +interface MediaTypeInterface extends Stringable { public function getType(): string; diff --git a/src/Entity/MediaType/ServerMediaType.php b/src/Entity/MediaType/ServerMediaType.php index ea437658..96697311 100644 --- a/src/Entity/MediaType/ServerMediaType.php +++ b/src/Entity/MediaType/ServerMediaType.php @@ -33,4 +33,12 @@ public function getSubtype(): string { return $this->subtype; } + + /** + * @inheritDoc + */ + public function __toString(): string + { + return $this->type . '/' . $this->subtype; + } } diff --git a/src/Exception/Exception.php b/src/Exception/Exception.php deleted file mode 100644 index 52d29dfb..00000000 --- a/src/Exception/Exception.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use Exception as BaseException; - -/** - * The package's base exception - */ -class Exception extends BaseException implements ExceptionInterface -{ -} diff --git a/src/Exception/Http/HttpMethodNotAllowedException.php b/src/Exception/Http/HttpMethodNotAllowedException.php deleted file mode 100644 index 682efbc9..00000000 --- a/src/Exception/Http/HttpMethodNotAllowedException.php +++ /dev/null @@ -1,46 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Stringable; -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Method Not Allowed Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/405 - * - * @since 3.0.0 - */ -class HttpMethodNotAllowedException extends HttpException -{ - public const DEFAULT_MESSAGE = 'The request could not be processed using the requested HTTP method.'; - - public function __construct(private array $allowedMethods, ?string $message = null, int $code = 0, ?Throwable $previous = null) - { - parent::__construct(self::STATUS_METHOD_NOT_ALLOWED, $message ?? self::DEFAULT_MESSAGE, $code, $previous); - - // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Allow - $this->addHeaderField('Allow', ...$allowedMethods); - } - - /** - * @return list - */ - public function getAllowedMethods(): array - { - return $this->allowedMethods; - } -} diff --git a/src/Exception/Http/HttpNotFoundException.php b/src/Exception/Http/HttpNotFoundException.php deleted file mode 100644 index e341fb8b..00000000 --- a/src/Exception/Http/HttpNotFoundException.php +++ /dev/null @@ -1,34 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Not Found Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404 - * - * @since 3.0.0 - */ -class HttpNotFoundException extends HttpException -{ - public const DEFAULT_MESSAGE = 'The requested page or resource could not be found.'; - - public function __construct(?string $message = null, int $code = 0, ?Throwable $previous = null) - { - parent::__construct(self::STATUS_NOT_FOUND, $message ?? self::DEFAULT_MESSAGE, $code, $previous); - } -} diff --git a/src/Exception/Http/HttpUnsupportedMediaTypeException.php b/src/Exception/Http/HttpUnsupportedMediaTypeException.php deleted file mode 100644 index 9aecb97a..00000000 --- a/src/Exception/Http/HttpUnsupportedMediaTypeException.php +++ /dev/null @@ -1,56 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception\Http; - -use Stringable; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; -use Sunrise\Http\Router\Exception\HttpException; -use Throwable; - -/** - * HTTP Unsupported Media Type Exception - * - * @link https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/415 - * - * @since 3.0.0 - */ -class HttpUnsupportedMediaTypeException extends HttpException -{ - public const DEFAULT_MESSAGE = 'The request could not be processed due to an unsupported format of the request payload.'; - - /** - * @param list $supportedMediaTypes - */ - public function __construct(private readonly array $supportedMediaTypes, ?string $message = null, int $code = 0, ?Throwable $previous = null) - { - foreach ($supportedMediaTypes as $index => $supportedMediaType) { - if ($supportedMediaType instanceof MediaTypeInterface) { - $supportedMediaTypes[$index] = $supportedMediaType->getType() . '/' . $supportedMediaType->getSubtype(); - } - } - - parent::__construct(self::STATUS_UNSUPPORTED_MEDIA_TYPE, $message ?? self::DEFAULT_MESSAGE, $code, $previous); - - // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept - $this->addHeaderField('Accept', ...$supportedMediaTypes); - } - - /** - * @return list - */ - public function getSupportedMediaTypes(): array - { - return $this->supportedMediaTypes; - } -} diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index 36c6bd3d..9254c3e3 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -13,11 +13,15 @@ namespace Sunrise\Http\Router\Exception; -use Closure; +use Fig\Http\Message\StatusCodeInterface; use RuntimeException; use Stringable; +use Sunrise\Http\Router\ConstraintViolation; use Sunrise\Http\Router\ConstraintViolationInterface; use Sunrise\Http\Router\Dictionary\ErrorMessage; +use Sunrise\Hydrator\Exception\InvalidDataException; +use Sunrise\Hydrator\Exception\InvalidValueException; +use Symfony\Component\Validator\ConstraintViolationInterface as ValidatorConstraintViolation; use Throwable; use function join; @@ -30,8 +34,6 @@ */ class HttpException extends RuntimeException implements HttpExceptionInterface { - public const DEFAULT_ERROR_STATUS_CODE = 400; - private string $messageTemplate; private array $messagePlaceholders; @@ -39,7 +41,10 @@ class HttpException extends RuntimeException implements HttpExceptionInterface private int $statusCode; /** - * @var list + * @var list + * + * @template TFieldName as string + * @template TFieldValue as string */ private array $headerFields = []; @@ -50,86 +55,235 @@ class HttpException extends RuntimeException implements HttpExceptionInterface public function __construct(int $statusCode, string $message, array $placeholders = [], ?Throwable $previous = null) { - parent::__construct(strtr($message, $placeholders), 0, $previous); + $interpolatedMessage = strtr($message, $placeholders); + + parent::__construct($interpolatedMessage, 0, $previous); $this->statusCode = $statusCode; $this->messageTemplate = $message; $this->messagePlaceholders = $placeholders; } - final public static function jsonPayloadEmpty(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self - { - return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::JSON_PAYLOAD_EMPTY, $placeholders, $previous); + final public static function resourceNotFound( + ?int $statusCode = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): self { + return new self( + statusCode: $statusCode ?? StatusCodeInterface::STATUS_NOT_FOUND, + message: $message ?? ErrorMessage::RESOURCE_NOT_FOUND, + placeholders: $placeholders, + previous: $previous, + ); } - final public static function jsonPayloadInvalid(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self - { - return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::JSON_PAYLOAD_INVALID, $placeholders, $previous); + final public static function methodNotAllowed( + ?int $statusCode = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): self { + return new self( + statusCode: $statusCode ?? StatusCodeInterface::STATUS_METHOD_NOT_ALLOWED, + message: $message ?? ErrorMessage::METHOD_NOT_ALLOWED, + placeholders: $placeholders, + previous: $previous, + ); } - final public static function jsonPayloadFormInvalid(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self - { - return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::JSON_PAYLOAD_FORM_INVALID, $placeholders, $previous); + final public static function mediaTypeNotSupported( + ?int $statusCode = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): self { + return new self( + statusCode: $statusCode ?? StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE, + message: $message ?? ErrorMessage::MEDIA_TYPE_NOT_SUPPORTED, + placeholders: $placeholders, + previous: $previous, + ); } - final public static function bodyInvalid(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self - { - return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::BODY_INVALID, $placeholders, $previous); + final public static function jsonPayloadEmpty( + ?int $statusCode = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): self { + return new self( + statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::JSON_PAYLOAD_EMPTY, + placeholders: $placeholders, + previous: $previous, + ); } - final public static function cookieMissed(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self - { - return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::COOKIE_MISSED, $placeholders, $previous); + final public static function jsonPayloadInvalid( + ?int $statusCode = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): self { + return new self( + statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::JSON_PAYLOAD_INVALID, + placeholders: $placeholders, + previous: $previous, + ); } - final public static function cookieInvalid(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self - { - return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::COOKIE_INVALID, $placeholders, $previous); + final public static function jsonPayloadFormInvalid( + ?int $statusCode = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): self { + return new self( + statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::JSON_PAYLOAD_FORM_INVALID, + placeholders: $placeholders, + previous: $previous, + ); } - final public static function headerMissed(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self - { - return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::HEADER_MISSED, $placeholders, $previous); + final public static function bodyInvalid( + ?int $statusCode = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): self { + return new self( + statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::BODY_INVALID, + placeholders: $placeholders, + previous: $previous, + ); } - final public static function headerInvalid(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self - { - return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::HEADER_INVALID, $placeholders, $previous); + final public static function cookieMissed( + ?int $statusCode = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): self { + return new self( + statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::COOKIE_MISSED, + placeholders: $placeholders, + previous: $previous, + ); } - final public static function queryInvalid(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self - { - return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::QUERY_INVALID, $placeholders, $previous); + final public static function cookieInvalid( + ?int $statusCode = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): self { + return new self( + statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::COOKIE_INVALID, + placeholders: $placeholders, + previous: $previous, + ); } - final public static function queryParamMissed(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self - { - return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::QUERY_PARAM_MISSED, $placeholders, $previous); + final public static function headerMissed( + ?int $statusCode = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): self { + return new self( + statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::HEADER_MISSED, + placeholders: $placeholders, + previous: $previous, + ); } - final public static function queryParamInvalid(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self - { - return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::QUERY_PARAM_INVALID, $placeholders, $previous); + final public static function headerInvalid( + ?int $statusCode = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): self { + return new self( + statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::HEADER_INVALID, + placeholders: $placeholders, + previous: $previous, + ); } - final public static function pathVariableInvalid(?int $statusCode = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null): self - { - return new self($statusCode ?? self::DEFAULT_ERROR_STATUS_CODE, $message ?? ErrorMessage::PATH_VARIABLE_INVALID, $placeholders, $previous); + final public static function queryInvalid( + ?int $statusCode = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): self { + return new self( + statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::QUERY_INVALID, + placeholders: $placeholders, + previous: $previous, + ); + } + + final public static function queryParamMissed( + ?int $statusCode = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): self { + return new self( + statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::QUERY_PARAM_MISSED, + placeholders: $placeholders, + previous: $previous, + ); + } + + final public static function queryParamInvalid( + ?int $statusCode = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): self { + return new self( + statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::QUERY_PARAM_INVALID, + placeholders: $placeholders, + previous: $previous, + ); + } + + final public static function pathVariableInvalid( + ?int $statusCode = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): self { + return new self( + statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::PATH_VARIABLE_INVALID, + placeholders: $placeholders, + previous: $previous, + ); } - public function getMessageTemplate(): string + final public function getMessageTemplate(): string { return $this->messageTemplate; } - public function getMessagePlaceholders(): array + final public function getMessagePlaceholders(): array { return $this->messagePlaceholders; } - /** - * @inheritDoc - */ final public function getStatusCode(): int { return $this->statusCode; @@ -169,4 +323,28 @@ final public function addConstraintViolation(ConstraintViolationInterface ...$co return $this; } + + final public function addHydratorConstraintViolation(InvalidDataException|InvalidValueException $hydratorConstraintViolation): static + { + if ($hydratorConstraintViolation instanceof InvalidValueException) { + $this->constraintViolations[] = ConstraintViolation::fromHydrator($hydratorConstraintViolation); + + return $this; + } + + foreach ($hydratorConstraintViolation->getExceptions() as $hydratorConstraintViolation) { + $this->constraintViolations[] = ConstraintViolation::fromHydrator($hydratorConstraintViolation); + } + + return $this; + } + + final public function addValidatorConstraintViolation(ValidatorConstraintViolation ...$validatorConstraintViolations): static + { + foreach ($validatorConstraintViolations as $validatorConstraintViolation) { + $this->constraintViolations[] = ConstraintViolation::fromValidator($validatorConstraintViolation); + } + + return $this; + } } diff --git a/src/Exception/HttpExceptionInterface.php b/src/Exception/HttpExceptionInterface.php index 01293aff..460983d8 100644 --- a/src/Exception/HttpExceptionInterface.php +++ b/src/Exception/HttpExceptionInterface.php @@ -13,7 +13,6 @@ namespace Sunrise\Http\Router\Exception; -use Fig\Http\Message\StatusCodeInterface; use Sunrise\Http\Router\ConstraintViolationInterface; /** @@ -21,7 +20,7 @@ * * @since 3.0.0 */ -interface HttpExceptionInterface extends ExceptionInterface, StatusCodeInterface +interface HttpExceptionInterface extends ExceptionInterface { public function getMessageTemplate(): string; @@ -30,7 +29,10 @@ public function getMessagePlaceholders(): array; public function getStatusCode(): int; /** - * @return list + * @return list + * + * @template TFieldName as string + * @template TFieldValue as string */ public function getHeaderFields(): array; diff --git a/src/InterceptorResolver.php b/src/InterceptorResolver.php index 9b44fdc6..a477b591 100644 --- a/src/InterceptorResolver.php +++ b/src/InterceptorResolver.php @@ -157,7 +157,6 @@ private function createRequestHandlerCallback( ): Closure { return fn(ServerRequestInterface $request): ResponseInterface => ( $this->responseResolver->resolveResponse( - $request, $callback(... $this->parameterResolver ->withContext($request) @@ -165,6 +164,7 @@ private function createRequestHandlerCallback( ->resolveParameters(...$reflection->getParameters()) ), $reflection, + $request, ) ); } @@ -178,7 +178,6 @@ private function createMiddlewareCallback( ): Closure { return fn(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface => ( $this->responseResolver->resolveResponse( - $request, $callback(... $this->parameterResolver ->withContext($request) @@ -187,6 +186,7 @@ private function createMiddlewareCallback( ->resolveParameters(...$reflection->getParameters()) ), $reflection, + $request, ) ); } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 31cbdd32..39936d95 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -20,7 +20,6 @@ use ReflectionNamedType; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestBody; -use Sunrise\Http\Router\ConstraintViolation; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\ParameterResolver; use Sunrise\Hydrator\Exception\InvalidDataException; @@ -76,12 +75,12 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidDataException $e) { throw HttpException::bodyInvalid($requestBody->errorStatusCode, $requestBody->errorMessage, previous: $e) - ->addConstraintViolation(...ConstraintViolation::fromHydrator(...$e->getExceptions())); + ->addHydratorConstraintViolation($e); } if (isset($this->validator) && count($violations = $this->validator->validate($argument)) > 0) { throw HttpException::bodyInvalid($requestBody->errorStatusCode, $requestBody->errorMessage) - ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); + ->addValidatorConstraintViolation(...$violations); } yield $argument; diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index 71957447..cdc2144f 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -20,7 +20,6 @@ use ReflectionParameter; use Sunrise\Http\Router\Annotation\Constraint; use Sunrise\Http\Router\Annotation\RequestCookie; -use Sunrise\Http\Router\ConstraintViolation; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\ServerRequest; use Sunrise\Hydrator\Exception\InvalidDataException; @@ -88,7 +87,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } catch (InvalidDataException|InvalidValueException $e) { throw HttpException::cookieInvalid($requestCookie->errorStatusCode, $requestCookie->errorMessage, $placeholders, previous: $e) - ->addConstraintViolation(...ConstraintViolation::fromHydrator($e)); + ->addHydratorConstraintViolation($e); } if (isset($this->validator)) { @@ -103,7 +102,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (count($constraints) > 0 && count($violations = $this->validator->validate($argument, $constraints)) > 0) { throw HttpException::cookieInvalid($requestCookie->errorStatusCode, $requestCookie->errorMessage, $placeholders) - ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); + ->addValidatorConstraintViolation(...$violations); } } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 96ccb9e3..93c90339 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -20,7 +20,6 @@ use ReflectionParameter; use Sunrise\Http\Router\Annotation\Constraint; use Sunrise\Http\Router\Annotation\RequestHeader; -use Sunrise\Http\Router\ConstraintViolation; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; @@ -86,7 +85,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } catch (InvalidDataException|InvalidValueException $e) { throw HttpException::headerInvalid($requestHeader->errorStatusCode, $requestHeader->errorMessage, $placeholders, previous: $e) - ->addConstraintViolation(...ConstraintViolation::fromHydrator($e)); + ->addHydratorConstraintViolation($e); } if (isset($this->validator)) { @@ -101,7 +100,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (count($constraints) > 0 && count($violations = $this->validator->validate($argument, $constraints)) > 0) { throw HttpException::headerInvalid($requestHeader->errorStatusCode, $requestHeader->errorMessage, $placeholders) - ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); + ->addValidatorConstraintViolation(...$violations); } } diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestPathVariableParameterResolver.php similarity index 80% rename from src/ParameterResolver/RequestVariableParameterResolver.php rename to src/ParameterResolver/RequestPathVariableParameterResolver.php index 2057c501..50776c09 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestPathVariableParameterResolver.php @@ -19,10 +19,8 @@ use ReflectionAttribute; use ReflectionParameter; use Sunrise\Http\Router\Annotation\Constraint; -use Sunrise\Http\Router\Annotation\RequestVariable; -use Sunrise\Http\Router\ConstraintViolation; +use Sunrise\Http\Router\Annotation\RequestPathVariable; use Sunrise\Http\Router\Exception\HttpException; -use Sunrise\Http\Router\Helper\RouteSimplifier; use Sunrise\Http\Router\ParameterResolver; use Sunrise\Http\Router\Route; use Sunrise\Hydrator\Exception\InvalidDataException; @@ -37,7 +35,7 @@ /** * @since 3.0.0 */ -final class RequestVariableParameterResolver implements ParameterResolverInterface +final class RequestPathVariableParameterResolver implements ParameterResolverInterface { public function __construct( private readonly HydratorInterface $hydrator, @@ -54,8 +52,8 @@ public function __construct( */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - /** @var list> $annotations */ - $annotations = $parameter->getAttributes(RequestVariable::class); + /** @var list> $annotations */ + $annotations = $parameter->getAttributes(RequestPathVariable::class); if ($annotations === []) { return; } @@ -69,7 +67,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $route = $context->getAttribute('@route'); if (! $route instanceof Route) { throw new LogicException(sprintf( - 'The #[RequestVariable] annotation cannot be applied to the parameter %s, ' . + 'The #[RequestPathVariable] annotation cannot be applied to the parameter %s, ' . 'because the request does not contain information about the requested route, ' . 'at least at this level of the application.', ParameterResolver::stringifyParameter($parameter), @@ -77,6 +75,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } $requestVariable = $annotations[0]->newInstance(); + $variableName = $requestVariable->name ?? $parameter->getName(); if (!$route->hasAttribute($variableName)) { @@ -87,9 +86,9 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } throw new LogicException(sprintf( - 'The parameter %1$s expects the value of the variable %3$s from the route %2$s, ' . + 'The parameter %1$s expects the value of the variable %3$s from the route %2$s ' . 'which is not present in the request, most likely, because the variable is optional. ' . - 'To resolve this issue, make this parameter nullable or assign it a default value.', + 'To resolve this issue, assign the default value to the parameter or make it nullable.', ParameterResolver::stringifyParameter($parameter), $route->getName(), $variableName, @@ -98,6 +97,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $placeholders = [ '{{ variable_name }}' => $variableName, + '{{ route_path }}' => $route->getPath(), ]; try { @@ -107,10 +107,8 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) path: [$variableName], ); } catch (InvalidDataException|InvalidValueException $e) { - $placeholders['{{ route_path }}'] = RouteSimplifier::simplifyRoute($route->getPath()); - throw HttpException::pathVariableInvalid($requestVariable->errorStatusCode, $requestVariable->errorMessage, $placeholders, previous: $e) - ->addConstraintViolation(...ConstraintViolation::fromHydrator($e)); + ->addHydratorConstraintViolation($e); } if (isset($this->validator)) { @@ -124,10 +122,8 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } if (count($constraints) > 0 && count($violations = $this->validator->validate($argument, $constraints)) > 0) { - $placeholders['{{ route_path }}'] = RouteSimplifier::simplifyRoute($route->getPath()); - throw HttpException::pathVariableInvalid($requestVariable->errorStatusCode, $requestVariable->errorMessage, $placeholders) - ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); + ->addValidatorConstraintViolation(...$violations); } } diff --git a/src/ParameterResolver/RequestQueryParamParameterResolver.php b/src/ParameterResolver/RequestQueryParamParameterResolver.php index 988e044c..98e8b8ec 100644 --- a/src/ParameterResolver/RequestQueryParamParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamParameterResolver.php @@ -20,7 +20,6 @@ use ReflectionParameter; use Sunrise\Http\Router\Annotation\Constraint; use Sunrise\Http\Router\Annotation\RequestQueryParam; -use Sunrise\Http\Router\ConstraintViolation; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\ServerRequest; use Sunrise\Hydrator\Exception\InvalidDataException; @@ -47,7 +46,7 @@ public function __construct( * * @throws LogicException If the resolver is used incorrectly. * - * @throws HttpException If a param was missed or invalid. + * @throws HttpException If a query parameter was missed or invalid. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -88,7 +87,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } catch (InvalidDataException|InvalidValueException $e) { throw HttpException::queryParamInvalid($requestParam->errorStatusCode, $requestParam->errorMessage, $placeholders, previous: $e) - ->addConstraintViolation(...ConstraintViolation::fromHydrator($e)); + ->addHydratorConstraintViolation($e); } if (isset($this->validator)) { @@ -103,7 +102,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (count($constraints) > 0 && count($violations = $this->validator->validate($argument, $constraints)) > 0) { throw HttpException::queryParamInvalid($requestParam->errorStatusCode, $requestParam->errorMessage, $placeholders) - ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); + ->addValidatorConstraintViolation(...$violations); } } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index e381f58c..18320387 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -20,7 +20,6 @@ use ReflectionNamedType; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestQuery; -use Sunrise\Http\Router\ConstraintViolation; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\ParameterResolver; use Sunrise\Hydrator\Exception\InvalidDataException; @@ -76,12 +75,12 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { throw HttpException::queryInvalid($requestQuery->errorStatusCode, $requestQuery->errorMessage, previous: $e) - ->addConstraintViolation(...ConstraintViolation::fromHydrator(...$e->getExceptions())); + ->addHydratorConstraintViolation($e); } if (isset($this->validator) && count($violations = $this->validator->validate($argument)) > 0) { throw HttpException::queryInvalid($requestQuery->errorStatusCode, $requestQuery->errorMessage) - ->addConstraintViolation(...ConstraintViolation::fromValidator(...$violations)); + ->addValidatorConstraintViolation(...$violations); } yield $argument; diff --git a/src/ParameterResolver/RequestRouteParameterResolver.php b/src/ParameterResolver/RequestRouteParameterResolver.php index 6f28f603..8fad4935 100644 --- a/src/ParameterResolver/RequestRouteParameterResolver.php +++ b/src/ParameterResolver/RequestRouteParameterResolver.php @@ -36,7 +36,7 @@ final class RequestRouteParameterResolver implements ParameterResolverInterface public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { $type = $parameter->getType(); - if (! $type instanceof ReflectionNamedType || $type->getName() <> Route::class) { + if (! $type instanceof ReflectionNamedType || $type->getName() !== Route::class) { return; } diff --git a/src/ParameterResolver/RequestStreamParameterResolver.php b/src/ParameterResolver/RequestStreamParameterResolver.php index 27395b35..1227a367 100644 --- a/src/ParameterResolver/RequestStreamParameterResolver.php +++ b/src/ParameterResolver/RequestStreamParameterResolver.php @@ -33,7 +33,7 @@ final class RequestStreamParameterResolver implements ParameterResolverInterface public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { $type = $parameter->getType(); - if (! $type instanceof ReflectionNamedType || $type->getName() <> StreamInterface::class) { + if (! $type instanceof ReflectionNamedType || $type->getName() !== StreamInterface::class) { return; } diff --git a/src/ParameterResolver/RequestUriParameterResolver.php b/src/ParameterResolver/RequestUriParameterResolver.php index 1b9c21ba..545b6fbe 100644 --- a/src/ParameterResolver/RequestUriParameterResolver.php +++ b/src/ParameterResolver/RequestUriParameterResolver.php @@ -33,7 +33,7 @@ final class RequestUriParameterResolver implements ParameterResolverInterface public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { $type = $parameter->getType(); - if (! $type instanceof ReflectionNamedType || $type->getName() <> UriInterface::class) { + if (! $type instanceof ReflectionNamedType || $type->getName() !== UriInterface::class) { return; } diff --git a/src/ParameterResolver/ServerRequestParameterResolver.php b/src/ParameterResolver/ServerRequestParameterResolver.php index 01473f56..376fbc5c 100644 --- a/src/ParameterResolver/ServerRequestParameterResolver.php +++ b/src/ParameterResolver/ServerRequestParameterResolver.php @@ -33,7 +33,7 @@ final class ServerRequestParameterResolver implements ParameterResolverInterface public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { $type = $parameter->getType(); - if (! $type instanceof ReflectionNamedType || $type->getName() <> ServerRequest::class) { + if (! $type instanceof ReflectionNamedType || $type->getName() !== ServerRequest::class) { return; } diff --git a/src/ResponseResolver.php b/src/ResponseResolver.php index dd03c1e3..ecc99fb2 100644 --- a/src/ResponseResolver.php +++ b/src/ResponseResolver.php @@ -40,18 +40,18 @@ public function __construct( * @throws LogicException If the response couldn't be resolved to PSR-7 response. */ public function resolveResponse( - ServerRequestInterface $request, mixed $response, ReflectionMethod|ReflectionFunction $responder, + ServerRequestInterface $request, ) : ResponseInterface { if ($response instanceof ResponseInterface) { - return $this->handleResponse($request, $response, $responder); + return $this->handleResponse($response, $responder); } foreach ($this->resolvers as $resolver) { $result = $resolver->resolveResponse($response, $responder, $request); if ($result instanceof ResponseInterface) { - return $this->handleResponse($request, $result, $responder); + return $this->handleResponse($result, $responder); } } @@ -62,7 +62,6 @@ public function resolveResponse( } private function handleResponse( - ServerRequestInterface $request, ResponseInterface $response, ReflectionMethod|ReflectionFunction $responder, ) : ResponseInterface { diff --git a/src/ResponseResolver/RouteResponseResolver.php b/src/ResponseResolver/RouteResponseResolver.php index c1967c4f..982af392 100644 --- a/src/ResponseResolver/RouteResponseResolver.php +++ b/src/ResponseResolver/RouteResponseResolver.php @@ -38,7 +38,7 @@ public function resolveResponse( $router = $request->getAttribute('@router'); if (! $router instanceof Router) { throw new LogicException( - 'Something went wrong, the request must contain the @router attribute.' + 'Something went wrong; the request must contain the @router attribute.' ); } diff --git a/src/Router.php b/src/Router.php index 959b5962..d5ae693b 100644 --- a/src/Router.php +++ b/src/Router.php @@ -17,9 +17,7 @@ use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\Http\HttpMethodNotAllowedException; -use Sunrise\Http\Router\Exception\Http\HttpNotFoundException; -use Sunrise\Http\Router\Exception\Http\HttpUnsupportedMediaTypeException; +use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Helper\RouteBuilder; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Helper\RouteMatcher; @@ -120,14 +118,7 @@ public function load(LoaderInterface ...$loaders): void } /** - * @throws HttpNotFoundException - * If the request URI isn't served. - * - * @throws HttpMethodNotAllowedException - * If the request method isn't allowed. - * - * @throws HttpUnsupportedMediaTypeException - * If the client not produces required media types. + * @throws HttpException */ public function match(ServerRequestInterface $request): Route { @@ -148,17 +139,25 @@ public function match(ServerRequestInterface $request): Route } if (!ServerRequest::create($request)->clientProducesMediaType(...$route->getConsumedMediaTypes())) { - throw new HttpUnsupportedMediaTypeException($route->getConsumedMediaTypes()); + throw HttpException::mediaTypeNotSupported(placeholders: [ + '{{ media_type }}' => ServerRequest::create($request)->getClientProducedMediaType(), + ]) + ->addHeaderField('Accept', ...$route->getConsumedMediaTypes()); } return $route->withAddedAttributes($matches); } if (!empty($allowedMethods)) { - throw new HttpMethodNotAllowedException(array_keys($allowedMethods)); + throw HttpException::methodNotAllowed(placeholders: [ + '{{ method }}' => $request->getMethod(), + ]) + ->addHeaderField('Allow', ...array_keys($allowedMethods)); } - throw new HttpNotFoundException(); + throw HttpException::resourceNotFound(placeholders: [ + '{{ resource }}' => $requestPath, + ]); } /** From e09d8e7f868b7442cd7142567dffde849adaaef4 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 3 Mar 2024 06:00:51 +0100 Subject: [PATCH 107/180] v3 --- ...tmlResponse.php => StringableResponse.php} | 2 +- src/ConstraintViolation.php | 25 -------- src/Entity/MediaType/ClientMediaType.php | 4 +- src/Entity/MediaType/ServerMediaType.php | 4 +- src/Exception/HttpException.php | 28 --------- src/Helper/HydratorHelper.php | 52 ++++++++++++++++ src/Helper/ValidatorHelper.php | 62 +++++++++++++++++++ .../RequestBodyParameterResolver.php | 12 ++-- .../RequestCookieParameterResolver.php | 26 +++----- .../RequestHeaderParameterResolver.php | 26 +++----- .../RequestPathVariableParameterResolver.php | 31 +++------- .../RequestQueryParamParameterResolver.php | 26 +++----- .../RequestQueryParameterResolver.php | 12 ++-- ...ver.php => StringableResponseResolver.php} | 10 ++- 14 files changed, 175 insertions(+), 145 deletions(-) rename src/Annotation/{HtmlResponse.php => StringableResponse.php} (94%) create mode 100644 src/Helper/HydratorHelper.php create mode 100644 src/Helper/ValidatorHelper.php rename src/ResponseResolver/{HtmlResponseResolver.php => StringableResponseResolver.php} (82%) diff --git a/src/Annotation/HtmlResponse.php b/src/Annotation/StringableResponse.php similarity index 94% rename from src/Annotation/HtmlResponse.php rename to src/Annotation/StringableResponse.php index 20f409b4..881a5963 100644 --- a/src/Annotation/HtmlResponse.php +++ b/src/Annotation/StringableResponse.php @@ -19,6 +19,6 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] -final class HtmlResponse +final class StringableResponse { } diff --git a/src/ConstraintViolation.php b/src/ConstraintViolation.php index 25737d6f..bd6c1d45 100644 --- a/src/ConstraintViolation.php +++ b/src/ConstraintViolation.php @@ -13,9 +13,6 @@ namespace Sunrise\Http\Router; -use Sunrise\Hydrator\Exception\InvalidValueException as HydratorConstraintViolation; -use Symfony\Component\Validator\ConstraintViolationInterface as ValidatorConstraintViolation; - /** * @since 3.0.0 */ @@ -30,28 +27,6 @@ public function __construct( ) { } - public static function fromHydrator(HydratorConstraintViolation $hydratorConstraintViolation): self - { - return new self( - $hydratorConstraintViolation->getMessage(), - $hydratorConstraintViolation->getMessageTemplate(), - $hydratorConstraintViolation->getMessagePlaceholders(), - $hydratorConstraintViolation->getPropertyPath(), - $hydratorConstraintViolation->getErrorCode(), - ); - } - - public static function fromValidator(ValidatorConstraintViolation $validatorConstraintViolation): self - { - return new self( - (string) $validatorConstraintViolation->getMessage(), - $validatorConstraintViolation->getMessageTemplate(), - $validatorConstraintViolation->getParameters(), - $validatorConstraintViolation->getPropertyPath(), - $validatorConstraintViolation->getCode(), - ); - } - public function getMessage(): string { return $this->message; diff --git a/src/Entity/MediaType/ClientMediaType.php b/src/Entity/MediaType/ClientMediaType.php index 1504922a..646405f3 100644 --- a/src/Entity/MediaType/ClientMediaType.php +++ b/src/Entity/MediaType/ClientMediaType.php @@ -13,6 +13,8 @@ namespace Sunrise\Http\Router\Entity\MediaType; +use function sprintf; + /** * @since 3.0.0 */ @@ -49,6 +51,6 @@ public function getParameters(): array */ public function __toString(): string { - return $this->type . '/' . $this->subtype; + return sprintf('%s/%s', $this->type, $this->subtype); } } diff --git a/src/Entity/MediaType/ServerMediaType.php b/src/Entity/MediaType/ServerMediaType.php index 96697311..500f79a0 100644 --- a/src/Entity/MediaType/ServerMediaType.php +++ b/src/Entity/MediaType/ServerMediaType.php @@ -13,6 +13,8 @@ namespace Sunrise\Http\Router\Entity\MediaType; +use function sprintf; + /** * @since 3.0.0 */ @@ -39,6 +41,6 @@ public function getSubtype(): string */ public function __toString(): string { - return $this->type . '/' . $this->subtype; + return sprintf('%s/%s', $this->type, $this->subtype); } } diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index 9254c3e3..67e1260e 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -16,12 +16,8 @@ use Fig\Http\Message\StatusCodeInterface; use RuntimeException; use Stringable; -use Sunrise\Http\Router\ConstraintViolation; use Sunrise\Http\Router\ConstraintViolationInterface; use Sunrise\Http\Router\Dictionary\ErrorMessage; -use Sunrise\Hydrator\Exception\InvalidDataException; -use Sunrise\Hydrator\Exception\InvalidValueException; -use Symfony\Component\Validator\ConstraintViolationInterface as ValidatorConstraintViolation; use Throwable; use function join; @@ -323,28 +319,4 @@ final public function addConstraintViolation(ConstraintViolationInterface ...$co return $this; } - - final public function addHydratorConstraintViolation(InvalidDataException|InvalidValueException $hydratorConstraintViolation): static - { - if ($hydratorConstraintViolation instanceof InvalidValueException) { - $this->constraintViolations[] = ConstraintViolation::fromHydrator($hydratorConstraintViolation); - - return $this; - } - - foreach ($hydratorConstraintViolation->getExceptions() as $hydratorConstraintViolation) { - $this->constraintViolations[] = ConstraintViolation::fromHydrator($hydratorConstraintViolation); - } - - return $this; - } - - final public function addValidatorConstraintViolation(ValidatorConstraintViolation ...$validatorConstraintViolations): static - { - foreach ($validatorConstraintViolations as $validatorConstraintViolation) { - $this->constraintViolations[] = ConstraintViolation::fromValidator($validatorConstraintViolation); - } - - return $this; - } } diff --git a/src/Helper/HydratorHelper.php b/src/Helper/HydratorHelper.php new file mode 100644 index 00000000..809639ec --- /dev/null +++ b/src/Helper/HydratorHelper.php @@ -0,0 +1,52 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Helper; + +use Generator; +use Sunrise\Http\Router\ConstraintViolation; +use Sunrise\Http\Router\ConstraintViolationInterface; +use Sunrise\Hydrator\Exception\InvalidDataException; +use Sunrise\Hydrator\Exception\InvalidValueException; + +/** + * @since 3.0.0 + */ +final class HydratorHelper +{ + /** + * @return Generator + */ + public static function adaptHydratorConstraintViolations(InvalidDataException|InvalidValueException $error): Generator + { + if ($error instanceof InvalidValueException) { + return yield new ConstraintViolation( + $error->getMessage(), + $error->getMessageTemplate(), + $error->getMessagePlaceholders(), + $error->getPropertyPath(), + $error->getErrorCode(), + ); + } + + foreach ($error->getExceptions() as $violation) { + yield new ConstraintViolation( + $violation->getMessage(), + $violation->getMessageTemplate(), + $violation->getMessagePlaceholders(), + $violation->getPropertyPath(), + $violation->getErrorCode(), + ); + } + } +} diff --git a/src/Helper/ValidatorHelper.php b/src/Helper/ValidatorHelper.php new file mode 100644 index 00000000..121e642a --- /dev/null +++ b/src/Helper/ValidatorHelper.php @@ -0,0 +1,62 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Helper; + +use Generator; +use ReflectionAttribute; +use ReflectionParameter; +use Sunrise\Http\Router\Annotation\Constraint as RouterConstraint; +use Sunrise\Http\Router\ConstraintViolation as RouterConstraintViolation; +use Sunrise\Http\Router\ConstraintViolationInterface as RouterConstraintViolationInterface; +use Symfony\Component\Validator\Constraint as ValidatorConstraint; +use Symfony\Component\Validator\ConstraintViolationInterface as ValidatorConstraintViolationInterface; + +/** + * @since 3.0.0 + */ +final class ValidatorHelper +{ + /** + * @return list + */ + public static function getParameterValidatorConstraints(ReflectionParameter $parameter): array + { + $validatorConstraints = []; + /** @var ReflectionAttribute $annotation */ + foreach ($parameter->getAttributes(RouterConstraint::class) as $annotation) { + $routerConstraint = $annotation->newInstance(); + if ($routerConstraint->value instanceof ValidatorConstraint) { + $validatorConstraints[] = $routerConstraint->value; + } + } + + return $validatorConstraints; + } + + /** + * @return Generator + */ + public static function adaptValidatorConstraintViolations(ValidatorConstraintViolationInterface ...$validatorConstraintViolations): Generator + { + foreach ($validatorConstraintViolations as $validatorConstraintViolation) { + yield new RouterConstraintViolation( + (string) $validatorConstraintViolation->getMessage(), + $validatorConstraintViolation->getMessageTemplate(), + $validatorConstraintViolation->getParameters(), + $validatorConstraintViolation->getPropertyPath(), + $validatorConstraintViolation->getCode(), + ); + } + } +} diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 39936d95..c3227070 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -21,6 +21,8 @@ use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestBody; use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Helper\HydratorHelper; +use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ParameterResolver; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\HydratorInterface; @@ -75,12 +77,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidDataException $e) { throw HttpException::bodyInvalid($requestBody->errorStatusCode, $requestBody->errorMessage, previous: $e) - ->addHydratorConstraintViolation($e); + ->addConstraintViolation(...HydratorHelper::adaptHydratorConstraintViolations($e)); } - if (isset($this->validator) && count($violations = $this->validator->validate($argument)) > 0) { - throw HttpException::bodyInvalid($requestBody->errorStatusCode, $requestBody->errorMessage) - ->addValidatorConstraintViolation(...$violations); + if (isset($this->validator)) { + if (count($violations = $this->validator->validate($argument)) > 0) { + throw HttpException::bodyInvalid($requestBody->errorStatusCode, $requestBody->errorMessage) + ->addConstraintViolation(...ValidatorHelper::adaptValidatorConstraintViolations(...$violations)); + } } yield $argument; diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index cdc2144f..3c5fe567 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -18,9 +18,10 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionParameter; -use Sunrise\Http\Router\Annotation\Constraint; use Sunrise\Http\Router\Annotation\RequestCookie; use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Helper\HydratorHelper; +use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ServerRequest; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; @@ -80,30 +81,19 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } try { - $argument = $this->hydrator->castValue( - $request->getCookieParam($requestCookie->name), - Type::fromParameter($parameter), - path: [$requestCookie->name], - ); + $argument = $this->hydrator->castValue($request->getCookieParam($requestCookie->name), Type::fromParameter($parameter), path: [$requestCookie->name]); } catch (InvalidDataException|InvalidValueException $e) { throw HttpException::cookieInvalid($requestCookie->errorStatusCode, $requestCookie->errorMessage, $placeholders, previous: $e) - ->addHydratorConstraintViolation($e); + ->addConstraintViolation(...HydratorHelper::adaptHydratorConstraintViolations($e)); } if (isset($this->validator)) { - $constraints = []; - /** @var ReflectionAttribute $annotation */ - foreach ($parameter->getAttributes(Constraint::class) as $annotation) { - $constraint = $annotation->newInstance(); - if ($constraint->value instanceof \Symfony\Component\Validator\Constraint) { - $constraints[] = $constraint->value; + if (count($constraints = ValidatorHelper::getParameterValidatorConstraints($parameter)) > 0) { + if (count($violations = $this->validator->validate($argument, $constraints)) > 0) { + throw HttpException::cookieInvalid($requestCookie->errorStatusCode, $requestCookie->errorMessage, $placeholders) + ->addConstraintViolation(...ValidatorHelper::adaptValidatorConstraintViolations(...$violations)); } } - - if (count($constraints) > 0 && count($violations = $this->validator->validate($argument, $constraints)) > 0) { - throw HttpException::cookieInvalid($requestCookie->errorStatusCode, $requestCookie->errorMessage, $placeholders) - ->addValidatorConstraintViolation(...$violations); - } } yield $argument; diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 93c90339..fd34c005 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -18,9 +18,10 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionParameter; -use Sunrise\Http\Router\Annotation\Constraint; use Sunrise\Http\Router\Annotation\RequestHeader; use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Helper\HydratorHelper; +use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; @@ -78,30 +79,19 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } try { - $argument = $this->hydrator->castValue( - $context->getHeaderLine($requestHeader->name), - Type::fromParameter($parameter), - path: [$requestHeader->name], - ); + $argument = $this->hydrator->castValue($context->getHeaderLine($requestHeader->name), Type::fromParameter($parameter), path: [$requestHeader->name]); } catch (InvalidDataException|InvalidValueException $e) { throw HttpException::headerInvalid($requestHeader->errorStatusCode, $requestHeader->errorMessage, $placeholders, previous: $e) - ->addHydratorConstraintViolation($e); + ->addConstraintViolation(...HydratorHelper::adaptHydratorConstraintViolations($e)); } if (isset($this->validator)) { - $constraints = []; - /** @var ReflectionAttribute $annotation */ - foreach ($parameter->getAttributes(Constraint::class) as $annotation) { - $constraint = $annotation->newInstance(); - if ($constraint->value instanceof \Symfony\Component\Validator\Constraint) { - $constraints[] = $constraint->value; + if (count($constraints = ValidatorHelper::getParameterValidatorConstraints($parameter)) > 0) { + if (count($violations = $this->validator->validate($argument, $constraints)) > 0) { + throw HttpException::headerInvalid($requestHeader->errorStatusCode, $requestHeader->errorMessage, $placeholders) + ->addConstraintViolation(...ValidatorHelper::adaptValidatorConstraintViolations(...$violations)); } } - - if (count($constraints) > 0 && count($violations = $this->validator->validate($argument, $constraints)) > 0) { - throw HttpException::headerInvalid($requestHeader->errorStatusCode, $requestHeader->errorMessage, $placeholders) - ->addValidatorConstraintViolation(...$violations); - } } yield $argument; diff --git a/src/ParameterResolver/RequestPathVariableParameterResolver.php b/src/ParameterResolver/RequestPathVariableParameterResolver.php index 50776c09..2da9dffc 100644 --- a/src/ParameterResolver/RequestPathVariableParameterResolver.php +++ b/src/ParameterResolver/RequestPathVariableParameterResolver.php @@ -18,9 +18,10 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionParameter; -use Sunrise\Http\Router\Annotation\Constraint; use Sunrise\Http\Router\Annotation\RequestPathVariable; use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Helper\HydratorHelper; +use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ParameterResolver; use Sunrise\Http\Router\Route; use Sunrise\Hydrator\Exception\InvalidDataException; @@ -67,9 +68,8 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $route = $context->getAttribute('@route'); if (! $route instanceof Route) { throw new LogicException(sprintf( - 'The #[RequestPathVariable] annotation cannot be applied to the parameter %s, ' . - 'because the request does not contain information about the requested route, ' . - 'at least at this level of the application.', + 'The #[RequestPathVariable] annotation cannot be applied to the parameter %s ' . + 'because the request does not contain information about the requested route.', ParameterResolver::stringifyParameter($parameter), )); } @@ -101,30 +101,19 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ]; try { - $argument = $this->hydrator->castValue( - $route->getAttribute($variableName), - Type::fromParameter($parameter), - path: [$variableName], - ); + $argument = $this->hydrator->castValue($route->getAttribute($variableName), Type::fromParameter($parameter), path: [$variableName]); } catch (InvalidDataException|InvalidValueException $e) { throw HttpException::pathVariableInvalid($requestVariable->errorStatusCode, $requestVariable->errorMessage, $placeholders, previous: $e) - ->addHydratorConstraintViolation($e); + ->addConstraintViolation(...HydratorHelper::adaptHydratorConstraintViolations($e)); } if (isset($this->validator)) { - $constraints = []; - /** @var ReflectionAttribute $annotation */ - foreach ($parameter->getAttributes(Constraint::class) as $annotation) { - $constraint = $annotation->newInstance(); - if ($constraint->value instanceof \Symfony\Component\Validator\Constraint) { - $constraints[] = $constraint->value; + if (count($constraints = ValidatorHelper::getParameterValidatorConstraints($parameter)) > 0) { + if (count($violations = $this->validator->validate($argument, $constraints)) > 0) { + throw HttpException::pathVariableInvalid($requestVariable->errorStatusCode, $requestVariable->errorMessage, $placeholders) + ->addConstraintViolation(...ValidatorHelper::adaptValidatorConstraintViolations(...$violations)); } } - - if (count($constraints) > 0 && count($violations = $this->validator->validate($argument, $constraints)) > 0) { - throw HttpException::pathVariableInvalid($requestVariable->errorStatusCode, $requestVariable->errorMessage, $placeholders) - ->addValidatorConstraintViolation(...$violations); - } } yield $argument; diff --git a/src/ParameterResolver/RequestQueryParamParameterResolver.php b/src/ParameterResolver/RequestQueryParamParameterResolver.php index 98e8b8ec..c93cb533 100644 --- a/src/ParameterResolver/RequestQueryParamParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamParameterResolver.php @@ -18,9 +18,10 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionParameter; -use Sunrise\Http\Router\Annotation\Constraint; use Sunrise\Http\Router\Annotation\RequestQueryParam; use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Helper\HydratorHelper; +use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ServerRequest; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; @@ -80,30 +81,19 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } try { - $argument = $this->hydrator->castValue( - $request->getQueryParam($requestParam->name), - Type::fromParameter($parameter), - path: [$requestParam->name], - ); + $argument = $this->hydrator->castValue($request->getQueryParam($requestParam->name), Type::fromParameter($parameter), path: [$requestParam->name]); } catch (InvalidDataException|InvalidValueException $e) { throw HttpException::queryParamInvalid($requestParam->errorStatusCode, $requestParam->errorMessage, $placeholders, previous: $e) - ->addHydratorConstraintViolation($e); + ->addConstraintViolation(...HydratorHelper::adaptHydratorConstraintViolations($e)); } if (isset($this->validator)) { - $constraints = []; - /** @var ReflectionAttribute $annotation */ - foreach ($parameter->getAttributes(Constraint::class) as $annotation) { - $constraint = $annotation->newInstance(); - if ($constraint->value instanceof \Symfony\Component\Validator\Constraint) { - $constraints[] = $constraint->value; + if (count($constraints = ValidatorHelper::getParameterValidatorConstraints($parameter)) > 0) { + if (count($violations = $this->validator->validate($argument, $constraints)) > 0) { + throw HttpException::queryParamInvalid($requestParam->errorStatusCode, $requestParam->errorMessage, $placeholders) + ->addConstraintViolation(...ValidatorHelper::adaptValidatorConstraintViolations(...$violations)); } } - - if (count($constraints) > 0 && count($violations = $this->validator->validate($argument, $constraints)) > 0) { - throw HttpException::queryParamInvalid($requestParam->errorStatusCode, $requestParam->errorMessage, $placeholders) - ->addValidatorConstraintViolation(...$violations); - } } yield $argument; diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 18320387..d464d8c7 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -21,6 +21,8 @@ use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestQuery; use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Helper\HydratorHelper; +use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ParameterResolver; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\HydratorInterface; @@ -75,12 +77,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { throw HttpException::queryInvalid($requestQuery->errorStatusCode, $requestQuery->errorMessage, previous: $e) - ->addHydratorConstraintViolation($e); + ->addConstraintViolation(...HydratorHelper::adaptHydratorConstraintViolations($e)); } - if (isset($this->validator) && count($violations = $this->validator->validate($argument)) > 0) { - throw HttpException::queryInvalid($requestQuery->errorStatusCode, $requestQuery->errorMessage) - ->addValidatorConstraintViolation(...$violations); + if (isset($this->validator)) { + if (count($violations = $this->validator->validate($argument)) > 0) { + throw HttpException::queryInvalid($requestQuery->errorStatusCode, $requestQuery->errorMessage) + ->addConstraintViolation(...ValidatorHelper::adaptValidatorConstraintViolations(...$violations)); + } } yield $argument; diff --git a/src/ResponseResolver/HtmlResponseResolver.php b/src/ResponseResolver/StringableResponseResolver.php similarity index 82% rename from src/ResponseResolver/HtmlResponseResolver.php rename to src/ResponseResolver/StringableResponseResolver.php index 3cae034e..895891aa 100644 --- a/src/ResponseResolver/HtmlResponseResolver.php +++ b/src/ResponseResolver/StringableResponseResolver.php @@ -20,7 +20,7 @@ use ReflectionFunction; use ReflectionMethod; use Stringable; -use Sunrise\Http\Router\Annotation\HtmlResponse; +use Sunrise\Http\Router\Annotation\StringableResponse; use Sunrise\Http\Router\ResponseResolver; use function is_string; @@ -29,7 +29,7 @@ /** * @since 3.0.0 */ -final class HtmlResponseResolver implements ResponseResolverInterface +final class StringableResponseResolver implements ResponseResolverInterface { public function __construct(private readonly ResponseFactoryInterface $responseFactory) { @@ -43,7 +43,7 @@ public function resolveResponse( ReflectionMethod|ReflectionFunction $responder, ServerRequestInterface $request, ): ?ResponseInterface { - if ($responder->getAttributes(HtmlResponse::class) === []) { + if ($responder->getAttributes(StringableResponse::class) === []) { return null; } @@ -54,9 +54,7 @@ public function resolveResponse( )); } - $result = $this->responseFactory->createResponse(200) - ->withHeader('Content-Type', 'text/html; charset=UTF-8'); - + $result = $this->responseFactory->createResponse(200); $result->getBody()->write((string) $response); return $result; From da3fb5e9acc3d29e9bad64c441ce8c43bb2be62e Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 3 Mar 2024 06:39:46 +0100 Subject: [PATCH 108/180] v3 --- src/Dictionary/ErrorMessage.php | 12 +++++------ src/Exception/HttpException.php | 20 +++++++++---------- src/Helper/HydratorHelper.php | 2 +- src/Helper/ValidatorHelper.php | 4 ++-- .../RequestBodyParameterResolver.php | 4 ++-- .../RequestCookieParameterResolver.php | 6 +++--- .../RequestHeaderParameterResolver.php | 6 +++--- .../RequestPathVariableParameterResolver.php | 6 +++--- .../RequestQueryParamParameterResolver.php | 6 +++--- .../RequestQueryParameterResolver.php | 4 ++-- src/Router.php | 2 +- 11 files changed, 36 insertions(+), 36 deletions(-) diff --git a/src/Dictionary/ErrorMessage.php b/src/Dictionary/ErrorMessage.php index cd3c1765..2c6c9de9 100644 --- a/src/Dictionary/ErrorMessage.php +++ b/src/Dictionary/ErrorMessage.php @@ -18,19 +18,19 @@ */ final class ErrorMessage { - public const RESOURCE_NOT_FOUND = 'The resource {{ resource }} was not found.'; + public const RESOURCE_NOT_FOUND = 'The resource {{ uri }} was not found.'; public const METHOD_NOT_ALLOWED = 'The method {{ method }} is not allowed; please check the Allow header for allowed methods.'; public const MEDIA_TYPE_NOT_SUPPORTED = 'The media type {{ media_type }} is not supported; please check the Accept header for supported media types.'; public const JSON_PAYLOAD_EMPTY = 'JSON body cannot be empty.'; public const JSON_PAYLOAD_INVALID = 'The JSON body is invalid and could not be decoded.'; public const JSON_PAYLOAD_FORM_INVALID = 'The JSON body must be in the form of an array or an object.'; public const BODY_INVALID = 'The request body is invalid.'; - public const COOKIE_INVALID = 'The cookie {{ cookie_name }} is invalid.'; + public const QUERY_INVALID = 'The request query is invalid.'; public const COOKIE_MISSED = 'The cookie {{ cookie_name }} must be provided.'; - public const HEADER_INVALID = 'The header {{ header_name }} is invalid.'; + public const COOKIE_INVALID = 'The cookie {{ cookie_name }} is invalid.'; public const HEADER_MISSED = 'The header {{ header_name }} must be provided.'; - public const QUERY_INVALID = 'The request query is invalid.'; - public const QUERY_PARAM_INVALID = 'The query parameter {{ param_name }} is invalid.'; + public const HEADER_INVALID = 'The header {{ header_name }} is invalid.'; public const QUERY_PARAM_MISSED = 'The query parameter {{ param_name }} must be provided.'; - public const PATH_VARIABLE_INVALID = 'The variable {{{ variable_name }}} of the path {{ route_path }} is invalid.'; + public const QUERY_PARAM_INVALID = 'The query parameter {{ param_name }} is invalid.'; + public const PATH_VARIABLE_INVALID = 'The variable {{{ variable_name }}} of the route {{ route_path }} is invalid.'; } diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index 67e1260e..a7586a4a 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -158,7 +158,7 @@ final public static function bodyInvalid( ); } - final public static function cookieMissed( + final public static function queryInvalid( ?int $statusCode = null, ?string $message = null, array $placeholders = [], @@ -166,13 +166,13 @@ final public static function cookieMissed( ): self { return new self( statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::COOKIE_MISSED, + message: $message ?? ErrorMessage::QUERY_INVALID, placeholders: $placeholders, previous: $previous, ); } - final public static function cookieInvalid( + final public static function cookieMissed( ?int $statusCode = null, ?string $message = null, array $placeholders = [], @@ -180,13 +180,13 @@ final public static function cookieInvalid( ): self { return new self( statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::COOKIE_INVALID, + message: $message ?? ErrorMessage::COOKIE_MISSED, placeholders: $placeholders, previous: $previous, ); } - final public static function headerMissed( + final public static function cookieInvalid( ?int $statusCode = null, ?string $message = null, array $placeholders = [], @@ -194,13 +194,13 @@ final public static function headerMissed( ): self { return new self( statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::HEADER_MISSED, + message: $message ?? ErrorMessage::COOKIE_INVALID, placeholders: $placeholders, previous: $previous, ); } - final public static function headerInvalid( + final public static function headerMissed( ?int $statusCode = null, ?string $message = null, array $placeholders = [], @@ -208,13 +208,13 @@ final public static function headerInvalid( ): self { return new self( statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::HEADER_INVALID, + message: $message ?? ErrorMessage::HEADER_MISSED, placeholders: $placeholders, previous: $previous, ); } - final public static function queryInvalid( + final public static function headerInvalid( ?int $statusCode = null, ?string $message = null, array $placeholders = [], @@ -222,7 +222,7 @@ final public static function queryInvalid( ): self { return new self( statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::QUERY_INVALID, + message: $message ?? ErrorMessage::HEADER_INVALID, placeholders: $placeholders, previous: $previous, ); diff --git a/src/Helper/HydratorHelper.php b/src/Helper/HydratorHelper.php index 809639ec..19431bb6 100644 --- a/src/Helper/HydratorHelper.php +++ b/src/Helper/HydratorHelper.php @@ -27,7 +27,7 @@ final class HydratorHelper /** * @return Generator */ - public static function adaptHydratorConstraintViolations(InvalidDataException|InvalidValueException $error): Generator + public static function adaptConstraintViolations(InvalidDataException|InvalidValueException $error): Generator { if ($error instanceof InvalidValueException) { return yield new ConstraintViolation( diff --git a/src/Helper/ValidatorHelper.php b/src/Helper/ValidatorHelper.php index 121e642a..e29634ad 100644 --- a/src/Helper/ValidatorHelper.php +++ b/src/Helper/ValidatorHelper.php @@ -30,7 +30,7 @@ final class ValidatorHelper /** * @return list */ - public static function getParameterValidatorConstraints(ReflectionParameter $parameter): array + public static function getParameterConstraints(ReflectionParameter $parameter): array { $validatorConstraints = []; /** @var ReflectionAttribute $annotation */ @@ -47,7 +47,7 @@ public static function getParameterValidatorConstraints(ReflectionParameter $par /** * @return Generator */ - public static function adaptValidatorConstraintViolations(ValidatorConstraintViolationInterface ...$validatorConstraintViolations): Generator + public static function adaptConstraintViolations(ValidatorConstraintViolationInterface ...$validatorConstraintViolations): Generator { foreach ($validatorConstraintViolations as $validatorConstraintViolation) { yield new RouterConstraintViolation( diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index c3227070..aa3cda88 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -77,13 +77,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidDataException $e) { throw HttpException::bodyInvalid($requestBody->errorStatusCode, $requestBody->errorMessage, previous: $e) - ->addConstraintViolation(...HydratorHelper::adaptHydratorConstraintViolations($e)); + ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { if (count($violations = $this->validator->validate($argument)) > 0) { throw HttpException::bodyInvalid($requestBody->errorStatusCode, $requestBody->errorMessage) - ->addConstraintViolation(...ValidatorHelper::adaptValidatorConstraintViolations(...$violations)); + ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index 3c5fe567..4f74ddb2 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -84,14 +84,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->castValue($request->getCookieParam($requestCookie->name), Type::fromParameter($parameter), path: [$requestCookie->name]); } catch (InvalidDataException|InvalidValueException $e) { throw HttpException::cookieInvalid($requestCookie->errorStatusCode, $requestCookie->errorMessage, $placeholders, previous: $e) - ->addConstraintViolation(...HydratorHelper::adaptHydratorConstraintViolations($e)); + ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { - if (count($constraints = ValidatorHelper::getParameterValidatorConstraints($parameter)) > 0) { + if (count($constraints = ValidatorHelper::getParameterConstraints($parameter)) > 0) { if (count($violations = $this->validator->validate($argument, $constraints)) > 0) { throw HttpException::cookieInvalid($requestCookie->errorStatusCode, $requestCookie->errorMessage, $placeholders) - ->addConstraintViolation(...ValidatorHelper::adaptValidatorConstraintViolations(...$violations)); + ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index fd34c005..a3f9f916 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -82,14 +82,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->castValue($context->getHeaderLine($requestHeader->name), Type::fromParameter($parameter), path: [$requestHeader->name]); } catch (InvalidDataException|InvalidValueException $e) { throw HttpException::headerInvalid($requestHeader->errorStatusCode, $requestHeader->errorMessage, $placeholders, previous: $e) - ->addConstraintViolation(...HydratorHelper::adaptHydratorConstraintViolations($e)); + ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { - if (count($constraints = ValidatorHelper::getParameterValidatorConstraints($parameter)) > 0) { + if (count($constraints = ValidatorHelper::getParameterConstraints($parameter)) > 0) { if (count($violations = $this->validator->validate($argument, $constraints)) > 0) { throw HttpException::headerInvalid($requestHeader->errorStatusCode, $requestHeader->errorMessage, $placeholders) - ->addConstraintViolation(...ValidatorHelper::adaptValidatorConstraintViolations(...$violations)); + ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } } diff --git a/src/ParameterResolver/RequestPathVariableParameterResolver.php b/src/ParameterResolver/RequestPathVariableParameterResolver.php index 2da9dffc..b9af73b3 100644 --- a/src/ParameterResolver/RequestPathVariableParameterResolver.php +++ b/src/ParameterResolver/RequestPathVariableParameterResolver.php @@ -104,14 +104,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->castValue($route->getAttribute($variableName), Type::fromParameter($parameter), path: [$variableName]); } catch (InvalidDataException|InvalidValueException $e) { throw HttpException::pathVariableInvalid($requestVariable->errorStatusCode, $requestVariable->errorMessage, $placeholders, previous: $e) - ->addConstraintViolation(...HydratorHelper::adaptHydratorConstraintViolations($e)); + ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { - if (count($constraints = ValidatorHelper::getParameterValidatorConstraints($parameter)) > 0) { + if (count($constraints = ValidatorHelper::getParameterConstraints($parameter)) > 0) { if (count($violations = $this->validator->validate($argument, $constraints)) > 0) { throw HttpException::pathVariableInvalid($requestVariable->errorStatusCode, $requestVariable->errorMessage, $placeholders) - ->addConstraintViolation(...ValidatorHelper::adaptValidatorConstraintViolations(...$violations)); + ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } } diff --git a/src/ParameterResolver/RequestQueryParamParameterResolver.php b/src/ParameterResolver/RequestQueryParamParameterResolver.php index c93cb533..ba13820a 100644 --- a/src/ParameterResolver/RequestQueryParamParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamParameterResolver.php @@ -84,14 +84,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->castValue($request->getQueryParam($requestParam->name), Type::fromParameter($parameter), path: [$requestParam->name]); } catch (InvalidDataException|InvalidValueException $e) { throw HttpException::queryParamInvalid($requestParam->errorStatusCode, $requestParam->errorMessage, $placeholders, previous: $e) - ->addConstraintViolation(...HydratorHelper::adaptHydratorConstraintViolations($e)); + ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { - if (count($constraints = ValidatorHelper::getParameterValidatorConstraints($parameter)) > 0) { + if (count($constraints = ValidatorHelper::getParameterConstraints($parameter)) > 0) { if (count($violations = $this->validator->validate($argument, $constraints)) > 0) { throw HttpException::queryParamInvalid($requestParam->errorStatusCode, $requestParam->errorMessage, $placeholders) - ->addConstraintViolation(...ValidatorHelper::adaptValidatorConstraintViolations(...$violations)); + ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index d464d8c7..1a0c5f51 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -77,13 +77,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { throw HttpException::queryInvalid($requestQuery->errorStatusCode, $requestQuery->errorMessage, previous: $e) - ->addConstraintViolation(...HydratorHelper::adaptHydratorConstraintViolations($e)); + ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { if (count($violations = $this->validator->validate($argument)) > 0) { throw HttpException::queryInvalid($requestQuery->errorStatusCode, $requestQuery->errorMessage) - ->addConstraintViolation(...ValidatorHelper::adaptValidatorConstraintViolations(...$violations)); + ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/Router.php b/src/Router.php index d5ae693b..875344dc 100644 --- a/src/Router.php +++ b/src/Router.php @@ -156,7 +156,7 @@ public function match(ServerRequestInterface $request): Route } throw HttpException::resourceNotFound(placeholders: [ - '{{ resource }}' => $requestPath, + '{{ uri }}' => $requestPath, ]); } From 94540505d175d5ef0a8696e855618312563171a9 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Mon, 4 Mar 2024 03:09:20 +0100 Subject: [PATCH 109/180] v3 --- src/Annotation/Priority.php | 28 ++++ ...equestQuery.php => RequestQueryParams.php} | 2 +- src/Annotation/Route.php | 52 +++--- src/Dictionary/ErrorMessage.php | 26 +-- src/Entity/Language/ServerLanguage.php | 30 ++++ src/Entity/MediaType/ClientMediaType.php | 7 +- src/Entity/MediaType/MediaTypeInterface.php | 2 + src/Entity/MediaType/ServerMediaType.php | 7 +- src/Exception/ExceptionInterface.php | 3 - src/Exception/HttpException.php | 158 +++++++++--------- src/Exception/HttpExceptionInterface.php | 15 +- src/Helper/HeaderParser.php | 76 +++++++++ src/Helper/HydratorHelper.php | 36 ++-- src/Helper/ValidatorHelper.php | 9 +- src/Loader/DescriptorLoader.php | 38 +++-- .../RequestBodyParameterResolver.php | 7 +- .../RequestCookieParameterResolver.php | 23 +-- .../RequestHeaderParameterResolver.php | 23 +-- .../RequestPathVariableParameterResolver.php | 23 ++- .../RequestQueryParamParameterResolver.php | 23 +-- ...> RequestQueryParamsParameterResolver.php} | 21 +-- src/Route.php | 32 ++-- src/Router.php | 36 ++-- src/ServerRequest.php | 85 +++------- 24 files changed, 429 insertions(+), 333 deletions(-) create mode 100644 src/Annotation/Priority.php rename src/Annotation/{RequestQuery.php => RequestQueryParams.php} (95%) create mode 100644 src/Entity/Language/ServerLanguage.php rename src/ParameterResolver/{RequestQueryParameterResolver.php => RequestQueryParamsParameterResolver.php} (72%) diff --git a/src/Annotation/Priority.php b/src/Annotation/Priority.php new file mode 100644 index 00000000..690db471 --- /dev/null +++ b/src/Annotation/Priority.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] +final class Priority +{ + public function __construct( + public readonly int $value, + ) { + } +} diff --git a/src/Annotation/RequestQuery.php b/src/Annotation/RequestQueryParams.php similarity index 95% rename from src/Annotation/RequestQuery.php rename to src/Annotation/RequestQueryParams.php index 0759e9c4..8710e1f7 100644 --- a/src/Annotation/RequestQuery.php +++ b/src/Annotation/RequestQueryParams.php @@ -19,7 +19,7 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_PARAMETER)] -final class RequestQuery +final class RequestQueryParams { public function __construct( public readonly ?int $errorStatusCode = null, diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index 0b177ec1..19fc6445 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -24,32 +24,44 @@ final class Route /** @var list */ public array $prefixes = []; + /** @var array */ + public array $patterns = []; + + /** @var list */ + public array $methods = []; + + /** @var array */ + public array $attributes = []; + + /** @var list */ + public array $middlewares = []; + + /** @var list */ + public array $constraints = []; + + /** @var list */ + public array $consumes = []; + + /** @var list */ + public array $produces = []; + + /** @var list */ + public array $tags = []; + + public string $summary = ''; + + public string $description = ''; + + public bool $isDeprecated = false; + /** @var non-empty-string|null */ public string|null $pattern = null; + public int $priority = 0; + public function __construct( public string $name, public string $path, - /** @var array */ - public array $patterns = [], - /** @var list */ - public array $methods = [], - /** @var array */ - public array $attributes = [], - /** @var list */ - public array $middlewares = [], - /** @var list */ - public array $constraints = [], - /** @var list */ - public array $consumes = [], - /** @var list */ - public array $produces = [], - public string $summary = '', - public string $description = '', - /** @var list */ - public array $tags = [], - public bool $isDeprecated = false, - public int $priority = 0, ) { } } diff --git a/src/Dictionary/ErrorMessage.php b/src/Dictionary/ErrorMessage.php index 2c6c9de9..8609f436 100644 --- a/src/Dictionary/ErrorMessage.php +++ b/src/Dictionary/ErrorMessage.php @@ -18,19 +18,19 @@ */ final class ErrorMessage { - public const RESOURCE_NOT_FOUND = 'The resource {{ uri }} was not found.'; - public const METHOD_NOT_ALLOWED = 'The method {{ method }} is not allowed; please check the Allow header for allowed methods.'; - public const MEDIA_TYPE_NOT_SUPPORTED = 'The media type {{ media_type }} is not supported; please check the Accept header for supported media types.'; - public const JSON_PAYLOAD_EMPTY = 'JSON body cannot be empty.'; - public const JSON_PAYLOAD_INVALID = 'The JSON body is invalid and could not be decoded.'; - public const JSON_PAYLOAD_FORM_INVALID = 'The JSON body must be in the form of an array or an object.'; - public const BODY_INVALID = 'The request body is invalid.'; - public const QUERY_INVALID = 'The request query is invalid.'; - public const COOKIE_MISSED = 'The cookie {{ cookie_name }} must be provided.'; - public const COOKIE_INVALID = 'The cookie {{ cookie_name }} is invalid.'; - public const HEADER_MISSED = 'The header {{ header_name }} must be provided.'; - public const HEADER_INVALID = 'The header {{ header_name }} is invalid.'; + public const RESOURCE_NOT_FOUND = 'The resource {{ resource }} was not found.'; + public const METHOD_NOT_ALLOWED = 'The method {{ method }} is not allowed; check the Allow response header for allowed methods.'; + public const MEDIA_TYPE_NOT_SUPPORTED = 'The media type {{ media_type }} is not supported; check the Accept response header for supported media types.'; + public const PATH_VARIABLE_INVALID = 'The variable {{ variable_name }} of the route {{ route_path }} is invalid.'; + public const QUERY_PARAMS_INVALID = 'The query parameters are invalid.'; public const QUERY_PARAM_MISSED = 'The query parameter {{ param_name }} must be provided.'; public const QUERY_PARAM_INVALID = 'The query parameter {{ param_name }} is invalid.'; - public const PATH_VARIABLE_INVALID = 'The variable {{{ variable_name }}} of the route {{ route_path }} is invalid.'; + public const HEADER_MISSED = 'The header {{ header_name }} must be provided.'; + public const HEADER_INVALID = 'The header {{ header_name }} is invalid.'; + public const COOKIE_MISSED = 'The cookie {{ cookie_name }} must be provided.'; + public const COOKIE_INVALID = 'The cookie {{ cookie_name }} is invalid.'; + public const BODY_INVALID = 'The request body is invalid.'; + public const JSON_PAYLOAD_EMPTY = 'The JSON payload cannot be empty.'; + public const JSON_PAYLOAD_INVALID = 'The JSON payload is invalid and could not be decoded.'; + public const JSON_PAYLOAD_FORM_INVALID = 'The JSON payload must be in the form of an array or an object.'; } diff --git a/src/Entity/Language/ServerLanguage.php b/src/Entity/Language/ServerLanguage.php new file mode 100644 index 00000000..ef184b41 --- /dev/null +++ b/src/Entity/Language/ServerLanguage.php @@ -0,0 +1,30 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Entity\Language; + +/** + * @since 3.0.0 + */ +final class ServerLanguage implements LanguageInterface +{ + public function __construct( + private readonly string $code, + ) { + } + + public function getCode(): string + { + return $this->code; + } +} diff --git a/src/Entity/MediaType/ClientMediaType.php b/src/Entity/MediaType/ClientMediaType.php index 646405f3..c1062ea4 100644 --- a/src/Entity/MediaType/ClientMediaType.php +++ b/src/Entity/MediaType/ClientMediaType.php @@ -13,8 +13,6 @@ namespace Sunrise\Http\Router\Entity\MediaType; -use function sprintf; - /** * @since 3.0.0 */ @@ -46,11 +44,8 @@ public function getParameters(): array return $this->parameters; } - /** - * @inheritDoc - */ public function __toString(): string { - return sprintf('%s/%s', $this->type, $this->subtype); + return $this->type . $this::SEPARATOR . $this->subtype; } } diff --git a/src/Entity/MediaType/MediaTypeInterface.php b/src/Entity/MediaType/MediaTypeInterface.php index 3f1a2bc4..01bb0ffc 100644 --- a/src/Entity/MediaType/MediaTypeInterface.php +++ b/src/Entity/MediaType/MediaTypeInterface.php @@ -20,6 +20,8 @@ */ interface MediaTypeInterface extends Stringable { + public const SEPARATOR = '/'; + public function getType(): string; public function getSubtype(): string; diff --git a/src/Entity/MediaType/ServerMediaType.php b/src/Entity/MediaType/ServerMediaType.php index 500f79a0..0e1f1b9e 100644 --- a/src/Entity/MediaType/ServerMediaType.php +++ b/src/Entity/MediaType/ServerMediaType.php @@ -13,8 +13,6 @@ namespace Sunrise\Http\Router\Entity\MediaType; -use function sprintf; - /** * @since 3.0.0 */ @@ -36,11 +34,8 @@ public function getSubtype(): string return $this->subtype; } - /** - * @inheritDoc - */ public function __toString(): string { - return sprintf('%s/%s', $this->type, $this->subtype); + return $this->type . $this::SEPARATOR . $this->subtype; } } diff --git a/src/Exception/ExceptionInterface.php b/src/Exception/ExceptionInterface.php index 8e8b28c8..fa81edd9 100644 --- a/src/Exception/ExceptionInterface.php +++ b/src/Exception/ExceptionInterface.php @@ -15,9 +15,6 @@ use Throwable; -/** - * The package's base exception interface - */ interface ExceptionInterface extends Throwable { } diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index a7586a4a..a960637b 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -24,23 +24,22 @@ use function strtr; /** - * The package's base HTTP exception - * * @since 3.0.0 */ class HttpException extends RuntimeException implements HttpExceptionInterface { + /** + * The exception's non-interpolated message. + */ private string $messageTemplate; - private array $messagePlaceholders; - - private int $statusCode; + /** + * Placeholders for interpolating the exception's non-interpolated message. + */ + private array $messagePlaceholders = []; /** - * @var list - * - * @template TFieldName as string - * @template TFieldValue as string + * @var list */ private array $headerFields = []; @@ -49,25 +48,24 @@ class HttpException extends RuntimeException implements HttpExceptionInterface */ private array $constraintViolations = []; - public function __construct(int $statusCode, string $message, array $placeholders = [], ?Throwable $previous = null) + public function __construct(int $code, string $message, array $placeholders = [], ?Throwable $previous = null) { - $interpolatedMessage = strtr($message, $placeholders); - - parent::__construct($interpolatedMessage, 0, $previous); - - $this->statusCode = $statusCode; $this->messageTemplate = $message; $this->messagePlaceholders = $placeholders; + + $interpolatedMessage = strtr($message, $placeholders); + + parent::__construct($interpolatedMessage, $code, $previous); } final public static function resourceNotFound( - ?int $statusCode = null, + ?int $code = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null, ): self { return new self( - statusCode: $statusCode ?? StatusCodeInterface::STATUS_NOT_FOUND, + code: $code ?? StatusCodeInterface::STATUS_NOT_FOUND, message: $message ?? ErrorMessage::RESOURCE_NOT_FOUND, placeholders: $placeholders, previous: $previous, @@ -75,13 +73,13 @@ final public static function resourceNotFound( } final public static function methodNotAllowed( - ?int $statusCode = null, + ?int $code = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null, ): self { return new self( - statusCode: $statusCode ?? StatusCodeInterface::STATUS_METHOD_NOT_ALLOWED, + code: $code ?? StatusCodeInterface::STATUS_METHOD_NOT_ALLOWED, message: $message ?? ErrorMessage::METHOD_NOT_ALLOWED, placeholders: $placeholders, previous: $previous, @@ -89,202 +87,203 @@ final public static function methodNotAllowed( } final public static function mediaTypeNotSupported( - ?int $statusCode = null, + ?int $code = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null, ): self { return new self( - statusCode: $statusCode ?? StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE, + code: $code ?? StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE, message: $message ?? ErrorMessage::MEDIA_TYPE_NOT_SUPPORTED, placeholders: $placeholders, previous: $previous, ); } - final public static function jsonPayloadEmpty( - ?int $statusCode = null, + final public static function pathVariableInvalid( + ?int $code = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null, ): self { return new self( - statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::JSON_PAYLOAD_EMPTY, + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::PATH_VARIABLE_INVALID, placeholders: $placeholders, previous: $previous, ); } - final public static function jsonPayloadInvalid( - ?int $statusCode = null, + final public static function queryParamsInvalid( + ?int $code = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null, ): self { return new self( - statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::JSON_PAYLOAD_INVALID, + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::QUERY_PARAMS_INVALID, placeholders: $placeholders, previous: $previous, ); } - final public static function jsonPayloadFormInvalid( - ?int $statusCode = null, + final public static function queryParamMissed( + ?int $code = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null, ): self { return new self( - statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::JSON_PAYLOAD_FORM_INVALID, + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::QUERY_PARAM_MISSED, placeholders: $placeholders, previous: $previous, ); } - final public static function bodyInvalid( - ?int $statusCode = null, + final public static function queryParamInvalid( + ?int $code = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null, ): self { return new self( - statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::BODY_INVALID, + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::QUERY_PARAM_INVALID, placeholders: $placeholders, previous: $previous, ); } - final public static function queryInvalid( - ?int $statusCode = null, + final public static function headerMissed( + ?int $code = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null, ): self { return new self( - statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::QUERY_INVALID, + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::HEADER_MISSED, placeholders: $placeholders, previous: $previous, ); } - final public static function cookieMissed( - ?int $statusCode = null, + final public static function headerInvalid( + ?int $code = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null, ): self { return new self( - statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::COOKIE_MISSED, + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::HEADER_INVALID, placeholders: $placeholders, previous: $previous, ); } - final public static function cookieInvalid( - ?int $statusCode = null, + final public static function cookieMissed( + ?int $code = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null, ): self { return new self( - statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::COOKIE_INVALID, + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::COOKIE_MISSED, placeholders: $placeholders, previous: $previous, ); } - final public static function headerMissed( - ?int $statusCode = null, + final public static function cookieInvalid( + ?int $code = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null, ): self { return new self( - statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::HEADER_MISSED, + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::COOKIE_INVALID, placeholders: $placeholders, previous: $previous, ); } - final public static function headerInvalid( - ?int $statusCode = null, + final public static function bodyInvalid( + ?int $code = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null, ): self { return new self( - statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::HEADER_INVALID, + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::BODY_INVALID, placeholders: $placeholders, previous: $previous, ); } - final public static function queryParamMissed( - ?int $statusCode = null, + final public static function jsonPayloadEmpty( + ?int $code = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null, ): self { return new self( - statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::QUERY_PARAM_MISSED, + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::JSON_PAYLOAD_EMPTY, placeholders: $placeholders, previous: $previous, ); } - final public static function queryParamInvalid( - ?int $statusCode = null, + final public static function jsonPayloadInvalid( + ?int $code = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null, ): self { return new self( - statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::QUERY_PARAM_INVALID, + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::JSON_PAYLOAD_INVALID, placeholders: $placeholders, previous: $previous, ); } - final public static function pathVariableInvalid( - ?int $statusCode = null, + final public static function jsonPayloadFormInvalid( + ?int $code = null, ?string $message = null, array $placeholders = [], ?Throwable $previous = null, ): self { return new self( - statusCode: $statusCode ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::PATH_VARIABLE_INVALID, + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::JSON_PAYLOAD_FORM_INVALID, placeholders: $placeholders, previous: $previous, ); } + /** + * @inheritDoc + */ final public function getMessageTemplate(): string { return $this->messageTemplate; } + /** + * @inheritDoc + */ final public function getMessagePlaceholders(): array { return $this->messagePlaceholders; } - final public function getStatusCode(): int - { - return $this->statusCode; - } - /** * @inheritDoc */ @@ -301,7 +300,16 @@ final public function getConstraintViolations(): array return $this->constraintViolations; } - final public function addHeaderField(string $fieldName, Stringable|string ...$fieldValues): static + final public function addMessagePlaceholder(string $placeholder, mixed $replacement): static + { + $this->messagePlaceholders[$placeholder] = $replacement; + + $this->message = strtr($this->messageTemplate, $this->messagePlaceholders); + + return $this; + } + + final public function addHeaderField(string $fieldName, string|Stringable ...$fieldValues): static { // https://datatracker.ietf.org/doc/html/rfc7230#section-7 $fieldValue = join(', ', $fieldValues); diff --git a/src/Exception/HttpExceptionInterface.php b/src/Exception/HttpExceptionInterface.php index 460983d8..b25f0562 100644 --- a/src/Exception/HttpExceptionInterface.php +++ b/src/Exception/HttpExceptionInterface.php @@ -16,23 +16,22 @@ use Sunrise\Http\Router\ConstraintViolationInterface; /** - * The package's base HTTP exception interface - * * @since 3.0.0 */ interface HttpExceptionInterface extends ExceptionInterface { + /** + * Returns the exception's non-interpolated message. + */ public function getMessageTemplate(): string; + /** + * Returns placeholders for interpolating the exception's non-interpolated message. + */ public function getMessagePlaceholders(): array; - public function getStatusCode(): int; - /** - * @return list - * - * @template TFieldName as string - * @template TFieldValue as string + * @return list */ public function getHeaderFields(): array; diff --git a/src/Helper/HeaderParser.php b/src/Helper/HeaderParser.php index da6d241a..12b31692 100644 --- a/src/Helper/HeaderParser.php +++ b/src/Helper/HeaderParser.php @@ -13,15 +13,91 @@ namespace Sunrise\Http\Router\Helper; +use Generator; use Sunrise\Http\Router\Dictionary\Charset; +use Sunrise\Http\Router\Entity\Language\ClientLanguage; +use Sunrise\Http\Router\Entity\MediaType\ClientMediaType; +use function current; +use function preg_match; use function trim; +use function usort; /** * @since 3.0.0 */ final class HeaderParser { + public static function parseContentTypeHeader(string $header): ?ClientMediaType + { + $values = self::parseHeader($header); + if ($values === []) { + return null; + } + + [$identifier, $parameters] = current($values); + + if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier, $matches)) { + return new ClientMediaType( + type: $matches[1], + subtype: $matches[2], + parameters: $parameters, + ); + } + + return null; + } + + /** + * @return Generator, ClientMediaType> + */ + public static function parseAcceptHeader(string $header): Generator + { + $values = self::parseHeader($header); + if ($values === []) { + return; + } + + usort($values, static fn(array $a, array $b): int => ( + (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') + )); + + foreach ($values as $index => [$identifier, $parameters]) { + if (preg_match('|^([^/]+)/([^/]+)$|', $identifier, $matches)) { + yield $index => new ClientMediaType( + type: $matches[1], + subtype: $matches[2], + parameters: $parameters, + ); + } + } + } + + /** + * @return Generator, ClientLanguage> + */ + public static function parseAcceptLanguageHeader(string $header): Generator + { + $values = self::parseHeader($header); + if ($values === []) { + return; + } + + usort($values, static fn(array $a, array $b): int => ( + (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') + )); + + foreach ($values as $index => [$identifier, $parameters]) { + if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches)) { + yield $index => new ClientLanguage( + code: $matches[1], + locale: $identifier, + parameters: $parameters, + ); + } + } + } + /** * @return array, array{0: string, 1: array}> */ diff --git a/src/Helper/HydratorHelper.php b/src/Helper/HydratorHelper.php index 19431bb6..9dc50589 100644 --- a/src/Helper/HydratorHelper.php +++ b/src/Helper/HydratorHelper.php @@ -29,24 +29,26 @@ final class HydratorHelper */ public static function adaptConstraintViolations(InvalidDataException|InvalidValueException $error): Generator { - if ($error instanceof InvalidValueException) { - return yield new ConstraintViolation( - $error->getMessage(), - $error->getMessageTemplate(), - $error->getMessagePlaceholders(), - $error->getPropertyPath(), - $error->getErrorCode(), - ); - } + if ($error instanceof InvalidDataException) { + foreach ($error->getExceptions() as $violation) { + yield new ConstraintViolation( + $violation->getMessage(), + $violation->getMessageTemplate(), + $violation->getMessagePlaceholders(), + $violation->getPropertyPath(), + $violation->getErrorCode(), + ); + } - foreach ($error->getExceptions() as $violation) { - yield new ConstraintViolation( - $violation->getMessage(), - $violation->getMessageTemplate(), - $violation->getMessagePlaceholders(), - $violation->getPropertyPath(), - $violation->getErrorCode(), - ); + return; } + + yield new ConstraintViolation( + $error->getMessage(), + $error->getMessageTemplate(), + $error->getMessagePlaceholders(), + $error->getPropertyPath(), + $error->getErrorCode(), + ); } } diff --git a/src/Helper/ValidatorHelper.php b/src/Helper/ValidatorHelper.php index e29634ad..70d43546 100644 --- a/src/Helper/ValidatorHelper.php +++ b/src/Helper/ValidatorHelper.php @@ -28,20 +28,17 @@ final class ValidatorHelper { /** - * @return list + * @return Generator */ - public static function getParameterConstraints(ReflectionParameter $parameter): array + public static function getParameterConstraints(ReflectionParameter $parameter): Generator { - $validatorConstraints = []; /** @var ReflectionAttribute $annotation */ foreach ($parameter->getAttributes(RouterConstraint::class) as $annotation) { $routerConstraint = $annotation->newInstance(); if ($routerConstraint->value instanceof ValidatorConstraint) { - $validatorConstraints[] = $routerConstraint->value; + yield $routerConstraint->value; } } - - return $validatorConstraints; } /** diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 8aac20df..cbd9b6b4 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -32,6 +32,7 @@ use Sunrise\Http\Router\Annotation\Pattern; use Sunrise\Http\Router\Annotation\Postfix; use Sunrise\Http\Router\Annotation\Prefix; +use Sunrise\Http\Router\Annotation\Priority; use Sunrise\Http\Router\Annotation\Produces; use Sunrise\Http\Router\Annotation\Route as Descriptor; use Sunrise\Http\Router\Annotation\Summary; @@ -82,9 +83,9 @@ public function load(): Generator $descriptor->constraints, $descriptor->consumes, $descriptor->produces, + $descriptor->tags, $descriptor->summary, $descriptor->description, - $descriptor->tags, $descriptor->isDeprecated, $descriptor->pattern, ); @@ -109,9 +110,6 @@ private function getDescriptors(): array $descriptors = []; foreach ($this->resources as $resource) { foreach ($this->getResourceDescriptors($resource) as $descriptor) { - $descriptor->path = join($descriptor->prefixes) . $descriptor->path; - $descriptor->methods = array_map(strtoupper(...), $descriptor->methods); - $descriptor->pattern = RouteCompiler::compileRoute($descriptor->path, $descriptor->patterns); $descriptors[] = $descriptor; } } @@ -179,6 +177,7 @@ private function getClassDescriptors(ReflectionClass $class): Generator $descriptor->holder = $class->getName(); $this->supplementDescriptorFromParentClasses($descriptor, $class); $this->supplementDescriptorFromClassOrMethod($descriptor, $class); + $this->completeDescriptor($descriptor); yield $descriptor; } } @@ -196,6 +195,7 @@ private function getClassDescriptors(ReflectionClass $class): Generator $this->supplementDescriptorFromParentClasses($descriptor, $class); $this->supplementDescriptorFromClassOrMethod($descriptor, $class); $this->supplementDescriptorFromClassOrMethod($descriptor, $method); + $this->completeDescriptor($descriptor); yield $descriptor; } } @@ -279,6 +279,13 @@ private function supplementDescriptorFromClassOrMethod(Descriptor $descriptor, R $descriptor->produces[] = $annotation->value; } + /** @var list> $annotations */ + $annotations = $classOrMethod->getAttributes(Tag::class); + foreach ($annotations as $annotation) { + $annotation = $annotation->newInstance(); + $descriptor->tags[] = $annotation->value; + } + /** @var list> $annotations */ $annotations = $classOrMethod->getAttributes(Summary::class); foreach ($annotations as $annotation) { @@ -293,17 +300,26 @@ private function supplementDescriptorFromClassOrMethod(Descriptor $descriptor, R $descriptor->description .= $annotation->value; } - /** @var list> $annotations */ - $annotations = $classOrMethod->getAttributes(Tag::class); - foreach ($annotations as $annotation) { - $annotation = $annotation->newInstance(); - $descriptor->tags[] = $annotation->value; - } - /** @var list> $annotations */ $annotations = $classOrMethod->getAttributes(Deprecated::class); if (isset($annotations[0])) { $descriptor->isDeprecated = true; } + + /** @var list> $annotations */ + $annotations = $classOrMethod->getAttributes(Priority::class); + if (isset($annotations[0])) { + $annotation = $annotations[0]->newInstance(); + $descriptor->priority = $annotation->value; + } + } + + private function completeDescriptor(Descriptor $descriptor): void + { + $descriptor->path = join($descriptor->prefixes) . $descriptor->path; + + $descriptor->methods = array_map(strtoupper(...), $descriptor->methods); + + $descriptor->pattern = RouteCompiler::compileRoute($descriptor->path, $descriptor->patterns); } } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index aa3cda88..78de1a4c 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -28,7 +28,6 @@ use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; -use function count; use function sprintf; /** @@ -66,9 +65,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } if (! $context instanceof ServerRequestInterface) { - throw new LogicException( - 'At this level of the application, any operations with the request are not possible.' - ); + throw new LogicException('At this level of the application, any operations with the request are not possible.'); } $requestBody = $annotations[0]->newInstance(); @@ -81,7 +78,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } if (isset($this->validator)) { - if (count($violations = $this->validator->validate($argument)) > 0) { + if (($violations = $this->validator->validate($argument))->count() > 0) { throw HttpException::bodyInvalid($requestBody->errorStatusCode, $requestBody->errorMessage) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index 4f74ddb2..b1a4bc76 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -29,8 +29,6 @@ use Sunrise\Hydrator\Type; use Symfony\Component\Validator\Validator\ValidatorInterface; -use function count; - /** * @since 3.0.0 */ @@ -58,18 +56,12 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } if (! $context instanceof ServerRequestInterface) { - throw new LogicException( - 'At this level of the application, any operations with the request are not possible.', - ); + throw new LogicException('At this level of the application, any operations with the request are not possible.'); } $request = ServerRequest::create($context); $requestCookie = $annotations[0]->newInstance(); - $placeholders = [ - '{{ cookie_name }}' => $requestCookie->name, - ]; - if (!$request->hasCookieParam($requestCookie->name)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); @@ -77,20 +69,23 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return yield; } - throw HttpException::cookieMissed($requestCookie->errorStatusCode, $requestCookie->errorMessage, $placeholders); + throw HttpException::cookieMissed($requestCookie->errorStatusCode, $requestCookie->errorMessage) + ->addMessagePlaceholder('{{ cookie_name }}', $requestCookie->name); } try { $argument = $this->hydrator->castValue($request->getCookieParam($requestCookie->name), Type::fromParameter($parameter), path: [$requestCookie->name]); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpException::cookieInvalid($requestCookie->errorStatusCode, $requestCookie->errorMessage, $placeholders, previous: $e) + throw HttpException::cookieInvalid($requestCookie->errorStatusCode, $requestCookie->errorMessage, previous: $e) + ->addMessagePlaceholder('{{ cookie_name }}', $requestCookie->name) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { - if (count($constraints = ValidatorHelper::getParameterConstraints($parameter)) > 0) { - if (count($violations = $this->validator->validate($argument, $constraints)) > 0) { - throw HttpException::cookieInvalid($requestCookie->errorStatusCode, $requestCookie->errorMessage, $placeholders) + if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { + if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { + throw HttpException::cookieInvalid($requestCookie->errorStatusCode, $requestCookie->errorMessage) + ->addMessagePlaceholder('{{ cookie_name }}', $requestCookie->name) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index a3f9f916..9a5c4392 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -28,8 +28,6 @@ use Sunrise\Hydrator\Type; use Symfony\Component\Validator\Validator\ValidatorInterface; -use function count; - /** * @since 3.0.0 */ @@ -57,17 +55,11 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } if (! $context instanceof ServerRequestInterface) { - throw new LogicException( - 'At this level of the application, any operations with the request are not possible.' - ); + throw new LogicException('At this level of the application, any operations with the request are not possible.'); } $requestHeader = $annotations[0]->newInstance(); - $placeholders = [ - '{{ header_name }}' => $requestHeader->name, - ]; - if (!$context->hasHeader($requestHeader->name)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); @@ -75,20 +67,23 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return yield; } - throw HttpException::headerMissed($requestHeader->errorStatusCode, $requestHeader->errorMessage, $placeholders); + throw HttpException::headerMissed($requestHeader->errorStatusCode, $requestHeader->errorMessage) + ->addMessagePlaceholder('{{ header_name }}', $requestHeader->name); } try { $argument = $this->hydrator->castValue($context->getHeaderLine($requestHeader->name), Type::fromParameter($parameter), path: [$requestHeader->name]); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpException::headerInvalid($requestHeader->errorStatusCode, $requestHeader->errorMessage, $placeholders, previous: $e) + throw HttpException::headerInvalid($requestHeader->errorStatusCode, $requestHeader->errorMessage, previous: $e) + ->addMessagePlaceholder('{{ header_name }}', $requestHeader->name) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { - if (count($constraints = ValidatorHelper::getParameterConstraints($parameter)) > 0) { - if (count($violations = $this->validator->validate($argument, $constraints)) > 0) { - throw HttpException::headerInvalid($requestHeader->errorStatusCode, $requestHeader->errorMessage, $placeholders) + if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { + if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { + throw HttpException::headerInvalid($requestHeader->errorStatusCode, $requestHeader->errorMessage) + ->addMessagePlaceholder('{{ header_name }}', $requestHeader->name) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/ParameterResolver/RequestPathVariableParameterResolver.php b/src/ParameterResolver/RequestPathVariableParameterResolver.php index b9af73b3..708ba714 100644 --- a/src/ParameterResolver/RequestPathVariableParameterResolver.php +++ b/src/ParameterResolver/RequestPathVariableParameterResolver.php @@ -21,6 +21,7 @@ use Sunrise\Http\Router\Annotation\RequestPathVariable; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Helper\HydratorHelper; +use Sunrise\Http\Router\Helper\RouteSimplifier; use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ParameterResolver; use Sunrise\Http\Router\Route; @@ -30,7 +31,6 @@ use Sunrise\Hydrator\Type; use Symfony\Component\Validator\Validator\ValidatorInterface; -use function count; use function sprintf; /** @@ -60,9 +60,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } if (! $context instanceof ServerRequestInterface) { - throw new LogicException( - 'At this level of the application, any operations with the request are not possible.' - ); + throw new LogicException('At this level of the application, any operations with the request are not possible.'); } $route = $context->getAttribute('@route'); @@ -95,22 +93,21 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) )); } - $placeholders = [ - '{{ variable_name }}' => $variableName, - '{{ route_path }}' => $route->getPath(), - ]; - try { $argument = $this->hydrator->castValue($route->getAttribute($variableName), Type::fromParameter($parameter), path: [$variableName]); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpException::pathVariableInvalid($requestVariable->errorStatusCode, $requestVariable->errorMessage, $placeholders, previous: $e) + throw HttpException::pathVariableInvalid($requestVariable->errorStatusCode, $requestVariable->errorMessage, previous: $e) + ->addMessagePlaceholder('{{ variable_name }}', $variableName) + ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { - if (count($constraints = ValidatorHelper::getParameterConstraints($parameter)) > 0) { - if (count($violations = $this->validator->validate($argument, $constraints)) > 0) { - throw HttpException::pathVariableInvalid($requestVariable->errorStatusCode, $requestVariable->errorMessage, $placeholders) + if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { + if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { + throw HttpException::pathVariableInvalid($requestVariable->errorStatusCode, $requestVariable->errorMessage) + ->addMessagePlaceholder('{{ variable_name }}', $variableName) + ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/ParameterResolver/RequestQueryParamParameterResolver.php b/src/ParameterResolver/RequestQueryParamParameterResolver.php index ba13820a..7f1e7b8e 100644 --- a/src/ParameterResolver/RequestQueryParamParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamParameterResolver.php @@ -29,8 +29,6 @@ use Sunrise\Hydrator\Type; use Symfony\Component\Validator\Validator\ValidatorInterface; -use function count; - /** * @since 3.0.0 */ @@ -58,18 +56,12 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } if (! $context instanceof ServerRequestInterface) { - throw new LogicException( - 'At this level of the application, any operations with the request are not possible.', - ); + throw new LogicException('At this level of the application, any operations with the request are not possible.'); } $request = ServerRequest::create($context); $requestParam = $annotations[0]->newInstance(); - $placeholders = [ - '{{ param_name }}' => $requestParam->name, - ]; - if (!$request->hasQueryParam($requestParam->name)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); @@ -77,20 +69,23 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return yield; } - throw HttpException::queryParamMissed($requestParam->errorStatusCode, $requestParam->errorMessage, $placeholders); + throw HttpException::queryParamMissed($requestParam->errorStatusCode, $requestParam->errorMessage) + ->addMessagePlaceholder('{{ param_name }}', $requestParam->name); } try { $argument = $this->hydrator->castValue($request->getQueryParam($requestParam->name), Type::fromParameter($parameter), path: [$requestParam->name]); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpException::queryParamInvalid($requestParam->errorStatusCode, $requestParam->errorMessage, $placeholders, previous: $e) + throw HttpException::queryParamInvalid($requestParam->errorStatusCode, $requestParam->errorMessage, previous: $e) + ->addMessagePlaceholder('{{ param_name }}', $requestParam->name) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { - if (count($constraints = ValidatorHelper::getParameterConstraints($parameter)) > 0) { - if (count($violations = $this->validator->validate($argument, $constraints)) > 0) { - throw HttpException::queryParamInvalid($requestParam->errorStatusCode, $requestParam->errorMessage, $placeholders) + if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { + if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { + throw HttpException::queryParamInvalid($requestParam->errorStatusCode, $requestParam->errorMessage) + ->addMessagePlaceholder('{{ param_name }}', $requestParam->name) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParamsParameterResolver.php similarity index 72% rename from src/ParameterResolver/RequestQueryParameterResolver.php rename to src/ParameterResolver/RequestQueryParamsParameterResolver.php index 1a0c5f51..6e2b18a7 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamsParameterResolver.php @@ -19,7 +19,7 @@ use ReflectionAttribute; use ReflectionNamedType; use ReflectionParameter; -use Sunrise\Http\Router\Annotation\RequestQuery; +use Sunrise\Http\Router\Annotation\RequestQueryParams; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Helper\HydratorHelper; use Sunrise\Http\Router\Helper\ValidatorHelper; @@ -28,13 +28,12 @@ use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; -use function count; use function sprintf; /** * @since 3.0.0 */ -final class RequestQueryParameterResolver implements ParameterResolverInterface +final class RequestQueryParamsParameterResolver implements ParameterResolverInterface { public function __construct( private readonly HydratorInterface $hydrator, @@ -51,8 +50,8 @@ public function __construct( */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - /** @var list> $annotations */ - $annotations = $parameter->getAttributes(RequestQuery::class); + /** @var list> $annotations */ + $annotations = $parameter->getAttributes(RequestQueryParams::class); if ($annotations === []) { return; } @@ -60,15 +59,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { throw new LogicException(sprintf( - 'To use the #[RequestQuery] annotation, the parameter %s must be typed with an object.', + 'To use the #[RequestQueryParams] annotation, the parameter %s must be typed with an object.', ParameterResolver::stringifyParameter($parameter), )); } if (! $context instanceof ServerRequestInterface) { - throw new LogicException( - 'At this level of the application, any operations with the request are not possible.' - ); + throw new LogicException('At this level of the application, any operations with the request are not possible.'); } $requestQuery = $annotations[0]->newInstance(); @@ -76,13 +73,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) try { $argument = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { - throw HttpException::queryInvalid($requestQuery->errorStatusCode, $requestQuery->errorMessage, previous: $e) + throw HttpException::queryParamsInvalid($requestQuery->errorStatusCode, $requestQuery->errorMessage, previous: $e) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { - if (count($violations = $this->validator->validate($argument)) > 0) { - throw HttpException::queryInvalid($requestQuery->errorStatusCode, $requestQuery->errorMessage) + if (($violations = $this->validator->validate($argument))->count() > 0) { + throw HttpException::queryParamsInvalid($requestQuery->errorStatusCode, $requestQuery->errorMessage) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/Route.php b/src/Route.php index 44160c83..c56c7cad 100644 --- a/src/Route.php +++ b/src/Route.php @@ -16,7 +16,6 @@ use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; use function array_key_exists; -use function in_array; final class Route { @@ -38,10 +37,10 @@ public function __construct( private readonly array $consumes = [], /** @var list */ private readonly array $produces = [], - private readonly string $summary = '', - private readonly string $description = '', /** @var list */ private readonly array $tags = [], + private readonly ?string $summary = null, + private readonly ?string $description = null, private readonly bool $isDeprecated = false, /** @var non-empty-string|null */ private readonly ?string $pattern = null, @@ -79,15 +78,6 @@ public function getMethods(): array return $this->methods; } - public function supportsMethod(string $method): bool - { - if ($this->methods === []) { - return true; - } - - return in_array($method, $this->methods, true); - } - /** * @return array */ @@ -162,22 +152,22 @@ public function getProducedMediaTypes(): array return $this->produces; } - public function getSummary(): string + /** + * @return list + */ + public function getTags(): array { - return $this->summary; + return $this->tags; } - public function getDescription(): string + public function getSummary(): ?string { - return $this->description; + return $this->summary; } - /** - * @return list - */ - public function getTags(): array + public function getDescription(): ?string { - return $this->tags; + return $this->description; } public function isDeprecated(): bool diff --git a/src/Router.php b/src/Router.php index 875344dc..f673e950 100644 --- a/src/Router.php +++ b/src/Router.php @@ -29,6 +29,8 @@ use function array_flip; use function array_keys; +use function count; +use function in_array; use function rawurldecode; use function sprintf; @@ -133,15 +135,14 @@ public function match(ServerRequestInterface $request): Route continue; } - if (!$route->supportsMethod($request->getMethod())) { + if (!$this->routeSupportsMethod($route, $request->getMethod())) { $allowedMethods += array_flip($route->getMethods()); continue; } if (!ServerRequest::create($request)->clientProducesMediaType(...$route->getConsumedMediaTypes())) { - throw HttpException::mediaTypeNotSupported(placeholders: [ - '{{ media_type }}' => ServerRequest::create($request)->getClientProducedMediaType(), - ]) + throw HttpException::mediaTypeNotSupported() + ->addMessagePlaceholder('{{ media_type }}', ServerRequest::create($request)->getClientProducedMediaType()) ->addHeaderField('Accept', ...$route->getConsumedMediaTypes()); } @@ -149,15 +150,13 @@ public function match(ServerRequestInterface $request): Route } if (!empty($allowedMethods)) { - throw HttpException::methodNotAllowed(placeholders: [ - '{{ method }}' => $request->getMethod(), - ]) + throw HttpException::methodNotAllowed() + ->addMessagePlaceholder('{{ method }}', $request->getMethod()) ->addHeaderField('Allow', ...array_keys($allowedMethods)); } - throw HttpException::resourceNotFound(placeholders: [ - '{{ uri }}' => $requestPath, - ]); + throw HttpException::resourceNotFound() + ->addMessagePlaceholder('{{ resource }}', $requestPath); } /** @@ -214,6 +213,23 @@ public function compileRoute(Route|string $route): string return $this->routePatterns[$route->getName()] ??= $route->getPattern() ?? RouteCompiler::compileRoute($route->getPath(), $route->getPatterns()); } + /** + * @since 3.0.0 + */ + public function routeSupportsMethod(Route|string $route, string $method): bool + { + if (! $route instanceof Route) { + $route = $this->getRoute($route); + } + + $methods = $route->getMethods(); + if ($methods === []) { + return true; + } + + return in_array($method, $methods, true); + } + /** * @since 3.0.0 */ diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 4b64c494..3edf1183 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -17,6 +17,7 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\StreamInterface; use Psr\Http\Message\UriInterface; +use Stringable; use Sunrise\Http\Router\Entity\Language\ClientLanguage; use Sunrise\Http\Router\Entity\Language\LanguageComparator; use Sunrise\Http\Router\Entity\Language\LanguageInterface; @@ -25,10 +26,6 @@ use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; use Sunrise\Http\Router\Helper\HeaderParser; -use function current; -use function preg_match; -use function usort; - /** * @since 3.0.0 */ @@ -50,22 +47,9 @@ public function getOriginalRequest(): ServerRequestInterface public function getClientProducedMediaType(): ?ClientMediaType { - $header = $this->request->getHeaderLine('Content-Type'); - $values = HeaderParser::parseHeader($header); - if ($values === []) { - return null; - } - - [$identifier, $parameters] = current($values); - if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier, $matches)) { - return new ClientMediaType( - type: $matches[1], - subtype: $matches[2], - parameters: $parameters, - ); - } - - return null; + return HeaderParser::parseContentTypeHeader( + $this->request->getHeaderLine('Content-Type') + ); } /** @@ -73,25 +57,9 @@ public function getClientProducedMediaType(): ?ClientMediaType */ public function getClientConsumedMediaTypes(): Generator { - $header = $this->request->getHeaderLine('Accept'); - $values = HeaderParser::parseHeader($header); - if ($values === []) { - return; - } - - usort($values, static fn(array $a, array $b): int => ( - (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') - )); - - foreach ($values as $index => [$identifier, $parameters]) { - if (preg_match('|^([^/]+)/([^/]+)$|', $identifier, $matches)) { - yield $index => new ClientMediaType( - type: $matches[1], - subtype: $matches[2], - parameters: $parameters, - ); - } - } + yield from HeaderParser::parseAcceptHeader( + $this->request->getHeaderLine('Accept') + ); } /** @@ -99,28 +67,12 @@ public function getClientConsumedMediaTypes(): Generator */ public function getClientConsumedLanguages(): Generator { - $header = $this->request->getHeaderLine('Accept-Language'); - $values = HeaderParser::parseHeader($header); - if ($values === []) { - return; - } - - usort($values, static fn(array $a, array $b): int => ( - (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') - )); - - foreach ($values as $index => [$identifier, $parameters]) { - if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches)) { - yield $index => new ClientLanguage( - code: $matches[1], - locale: $identifier, - parameters: $parameters, - ); - } - } + yield from HeaderParser::parseAcceptLanguageHeader( + $this->request->getHeaderLine('Accept-Language') + ); } - public function getClientPreferredMediaType(MediaTypeInterface ...$serverProducedMediaTypes): ?ClientMediaType + public function getClientPreferredMediaType(MediaTypeInterface|Stringable|string ...$serverProducedMediaTypes): ?ClientMediaType { if ($serverProducedMediaTypes === []) { return null; @@ -138,7 +90,7 @@ public function getClientPreferredMediaType(MediaTypeInterface ...$serverProduce return null; } - public function getClientPreferredLanguage(LanguageInterface ...$serverProducedLanguages): ?ClientLanguage + public function getClientPreferredLanguage(LanguageInterface|Stringable|string ...$serverProducedLanguages): ?ClientLanguage { if ($serverProducedLanguages === []) { return null; @@ -156,7 +108,7 @@ public function getClientPreferredLanguage(LanguageInterface ...$serverProducedL return null; } - public function clientProducesMediaType(MediaTypeInterface ...$serverConsumedMediaTypes): bool + public function clientProducesMediaType(MediaTypeInterface|Stringable|string ...$serverConsumedMediaTypes): bool { // This case is interpreted as follows: the server accepts any media type... if ($serverConsumedMediaTypes === []) { @@ -178,14 +130,19 @@ public function clientProducesMediaType(MediaTypeInterface ...$serverConsumedMed return false; } - public function clientConsumesMediaType(MediaTypeInterface ...$serverProducedMediaTypes): bool + public function clientConsumesMediaType(MediaTypeInterface|Stringable|string ...$serverProducedMediaTypes): bool { if ($serverProducedMediaTypes === []) { return false; } + $clientConsumedMediaTypes = $this->getClientConsumedMediaTypes(); + if (!$clientConsumedMediaTypes->valid()) { + return true; + } + $mediaTypeComparator = new MediaTypeComparator(); - foreach ($this->getClientConsumedMediaTypes() as $clientConsumedMediaType) { + foreach ($clientConsumedMediaTypes as $clientConsumedMediaType) { foreach ($serverProducedMediaTypes as $serverProducedMediaType) { if ($mediaTypeComparator->equals($clientConsumedMediaType, $serverProducedMediaType)) { return true; @@ -196,7 +153,7 @@ public function clientConsumesMediaType(MediaTypeInterface ...$serverProducedMed return false; } - public function clientConsumesLanguage(LanguageInterface ...$serverProducedLanguages): bool + public function clientConsumesLanguage(LanguageInterface|Stringable|string ...$serverProducedLanguages): bool { if ($serverProducedLanguages === []) { return false; From a85d54976c5279e8218736d5fe4a62827ae8cf30 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Mon, 4 Mar 2024 06:01:41 +0100 Subject: [PATCH 110/180] v3 --- src/Annotation/SerializableResponse.php | 28 ++++++ src/Exception/HttpException.php | 2 + src/Exception/HttpExceptionInterface.php | 2 + src/Helper/HeaderParser.php | 18 +--- src/InterceptorResolver.php | 26 +----- .../JsonPayloadDecodingMiddleware.php | 2 + .../RequestCookieParameterResolver.php | 2 - .../RequestHeaderParameterResolver.php | 2 - .../RequestPathVariableParameterResolver.php | 23 +++-- .../RequestQueryParamParameterResolver.php | 20 ++--- .../RequestQueryParamsParameterResolver.php | 6 +- .../RequestRouteParameterResolver.php | 4 +- .../RequestStreamParameterResolver.php | 4 +- .../RequestUriParameterResolver.php | 4 +- .../ServerRequestParameterResolver.php | 4 +- .../EmptyResponseResolver.php | 3 +- src/ResponseResolver/JsonResponseResolver.php | 3 +- .../RouteResponseResolver.php | 7 +- .../SerializableResponseResolver.php | 86 +++++++++++++++++++ .../StreamResponseResolver.php | 3 +- .../StringableResponseResolver.php | 8 +- src/ResponseResolver/UriResponseResolver.php | 3 +- 22 files changed, 171 insertions(+), 89 deletions(-) create mode 100644 src/Annotation/SerializableResponse.php create mode 100644 src/ResponseResolver/SerializableResponseResolver.php diff --git a/src/Annotation/SerializableResponse.php b/src/Annotation/SerializableResponse.php new file mode 100644 index 00000000..821c7d98 --- /dev/null +++ b/src/Annotation/SerializableResponse.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] +final class SerializableResponse +{ + public function __construct( + public array $context = [], + ) { + } +} diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index a960637b..01079fae 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -35,6 +35,8 @@ class HttpException extends RuntimeException implements HttpExceptionInterface /** * Placeholders for interpolating the exception's non-interpolated message. + * + * @var array */ private array $messagePlaceholders = []; diff --git a/src/Exception/HttpExceptionInterface.php b/src/Exception/HttpExceptionInterface.php index b25f0562..67fd02cb 100644 --- a/src/Exception/HttpExceptionInterface.php +++ b/src/Exception/HttpExceptionInterface.php @@ -27,6 +27,8 @@ public function getMessageTemplate(): string; /** * Returns placeholders for interpolating the exception's non-interpolated message. + * + * @return array */ public function getMessagePlaceholders(): array; diff --git a/src/Helper/HeaderParser.php b/src/Helper/HeaderParser.php index 12b31692..e3e0a72d 100644 --- a/src/Helper/HeaderParser.php +++ b/src/Helper/HeaderParser.php @@ -38,11 +38,7 @@ public static function parseContentTypeHeader(string $header): ?ClientMediaType [$identifier, $parameters] = current($values); if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier, $matches)) { - return new ClientMediaType( - type: $matches[1], - subtype: $matches[2], - parameters: $parameters, - ); + return new ClientMediaType($matches[1], $matches[2], $parameters); } return null; @@ -64,11 +60,7 @@ public static function parseAcceptHeader(string $header): Generator foreach ($values as $index => [$identifier, $parameters]) { if (preg_match('|^([^/]+)/([^/]+)$|', $identifier, $matches)) { - yield $index => new ClientMediaType( - type: $matches[1], - subtype: $matches[2], - parameters: $parameters, - ); + yield $index => new ClientMediaType($matches[1], $matches[2], $parameters); } } } @@ -89,11 +81,7 @@ public static function parseAcceptLanguageHeader(string $header): Generator foreach ($values as $index => [$identifier, $parameters]) { if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches)) { - yield $index => new ClientLanguage( - code: $matches[1], - locale: $identifier, - parameters: $parameters, - ); + yield $index => new ClientLanguage($matches[1], $identifier, $parameters); } } } diff --git a/src/InterceptorResolver.php b/src/InterceptorResolver.php index a477b591..ee8c8d88 100644 --- a/src/InterceptorResolver.php +++ b/src/InterceptorResolver.php @@ -61,10 +61,7 @@ public function resolveRequestHandler(mixed $requestHandler): RequestHandlerInte if ($requestHandler instanceof Closure) { return new CallableRequestHandler( - $this->createRequestHandlerCallback( - $requestHandler, - new ReflectionFunction($requestHandler), - ), + $this->createRequestHandlerCallback($requestHandler, new ReflectionFunction($requestHandler)), ); } @@ -78,13 +75,7 @@ public function resolveRequestHandler(mixed $requestHandler): RequestHandlerInte if (is_callable($requestHandler)) { return new CallableRequestHandler( - $this->createRequestHandlerCallback( - $requestHandler, - new ReflectionMethod( - $requestHandler[0], - $requestHandler[1], - ), - ), + $this->createRequestHandlerCallback($requestHandler, new ReflectionMethod($requestHandler[0], $requestHandler[1])), ); } } @@ -110,10 +101,7 @@ public function resolveMiddleware(mixed $middleware): MiddlewareInterface if ($middleware instanceof Closure) { return new CallableMiddleware( - $this->createMiddlewareCallback( - $middleware, - new ReflectionFunction($middleware), - ), + $this->createMiddlewareCallback($middleware, new ReflectionFunction($middleware)), ); } @@ -131,13 +119,7 @@ public function resolveMiddleware(mixed $middleware): MiddlewareInterface if (is_callable($middleware)) { return new CallableMiddleware( - $this->createMiddlewareCallback( - $middleware, - new ReflectionMethod( - $middleware[0], - $middleware[1], - ), - ), + $this->createMiddlewareCallback($middleware, new ReflectionMethod($middleware[0], $middleware[1])), ); } } diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 911740c4..95093bfe 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -48,6 +48,8 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface } /** + * @return array + * * @throws HttpException If the JSON payload couldn't be decoded. */ private function decodePayload(string $payload): array diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index b1a4bc76..faafdece 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -65,8 +65,6 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (!$request->hasCookieParam($requestCookie->name)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); - } elseif ($parameter->allowsNull()) { - return yield; } throw HttpException::cookieMissed($requestCookie->errorStatusCode, $requestCookie->errorMessage) diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 9a5c4392..9b35b892 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -63,8 +63,6 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (!$context->hasHeader($requestHeader->name)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); - } elseif ($parameter->allowsNull()) { - return yield; } throw HttpException::headerMissed($requestHeader->errorStatusCode, $requestHeader->errorMessage) diff --git a/src/ParameterResolver/RequestPathVariableParameterResolver.php b/src/ParameterResolver/RequestPathVariableParameterResolver.php index 708ba714..c665a59e 100644 --- a/src/ParameterResolver/RequestPathVariableParameterResolver.php +++ b/src/ParameterResolver/RequestPathVariableParameterResolver.php @@ -72,32 +72,29 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) )); } - $requestVariable = $annotations[0]->newInstance(); + $requestPathVariable = $annotations[0]->newInstance(); + $pathVariableName = $requestPathVariable->name ?? $parameter->getName(); - $variableName = $requestVariable->name ?? $parameter->getName(); - - if (!$route->hasAttribute($variableName)) { + if (!$route->hasAttribute($pathVariableName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); - } elseif ($parameter->allowsNull()) { - return yield; } throw new LogicException(sprintf( 'The parameter %1$s expects the value of the variable %3$s from the route %2$s ' . 'which is not present in the request, most likely, because the variable is optional. ' . - 'To resolve this issue, assign the default value to the parameter or make it nullable.', + 'To resolve this issue, assign the default value to the parameter, for example, null.', ParameterResolver::stringifyParameter($parameter), $route->getName(), - $variableName, + $pathVariableName, )); } try { - $argument = $this->hydrator->castValue($route->getAttribute($variableName), Type::fromParameter($parameter), path: [$variableName]); + $argument = $this->hydrator->castValue($route->getAttribute($pathVariableName), Type::fromParameter($parameter), path: [$pathVariableName]); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpException::pathVariableInvalid($requestVariable->errorStatusCode, $requestVariable->errorMessage, previous: $e) - ->addMessagePlaceholder('{{ variable_name }}', $variableName) + throw HttpException::pathVariableInvalid($requestPathVariable->errorStatusCode, $requestPathVariable->errorMessage, previous: $e) + ->addMessagePlaceholder('{{ variable_name }}', $pathVariableName) ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } @@ -105,8 +102,8 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpException::pathVariableInvalid($requestVariable->errorStatusCode, $requestVariable->errorMessage) - ->addMessagePlaceholder('{{ variable_name }}', $variableName) + throw HttpException::pathVariableInvalid($requestPathVariable->errorStatusCode, $requestPathVariable->errorMessage) + ->addMessagePlaceholder('{{ variable_name }}', $pathVariableName) ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } diff --git a/src/ParameterResolver/RequestQueryParamParameterResolver.php b/src/ParameterResolver/RequestQueryParamParameterResolver.php index 7f1e7b8e..4af43579 100644 --- a/src/ParameterResolver/RequestQueryParamParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamParameterResolver.php @@ -60,32 +60,30 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } $request = ServerRequest::create($context); - $requestParam = $annotations[0]->newInstance(); + $requestQueryParam = $annotations[0]->newInstance(); - if (!$request->hasQueryParam($requestParam->name)) { + if (!$request->hasQueryParam($requestQueryParam->name)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); - } elseif ($parameter->allowsNull()) { - return yield; } - throw HttpException::queryParamMissed($requestParam->errorStatusCode, $requestParam->errorMessage) - ->addMessagePlaceholder('{{ param_name }}', $requestParam->name); + throw HttpException::queryParamMissed($requestQueryParam->errorStatusCode, $requestQueryParam->errorMessage) + ->addMessagePlaceholder('{{ param_name }}', $requestQueryParam->name); } try { - $argument = $this->hydrator->castValue($request->getQueryParam($requestParam->name), Type::fromParameter($parameter), path: [$requestParam->name]); + $argument = $this->hydrator->castValue($request->getQueryParam($requestQueryParam->name), Type::fromParameter($parameter), path: [$requestQueryParam->name]); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpException::queryParamInvalid($requestParam->errorStatusCode, $requestParam->errorMessage, previous: $e) - ->addMessagePlaceholder('{{ param_name }}', $requestParam->name) + throw HttpException::queryParamInvalid($requestQueryParam->errorStatusCode, $requestQueryParam->errorMessage, previous: $e) + ->addMessagePlaceholder('{{ param_name }}', $requestQueryParam->name) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpException::queryParamInvalid($requestParam->errorStatusCode, $requestParam->errorMessage) - ->addMessagePlaceholder('{{ param_name }}', $requestParam->name) + throw HttpException::queryParamInvalid($requestQueryParam->errorStatusCode, $requestQueryParam->errorMessage) + ->addMessagePlaceholder('{{ param_name }}', $requestQueryParam->name) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/ParameterResolver/RequestQueryParamsParameterResolver.php b/src/ParameterResolver/RequestQueryParamsParameterResolver.php index 6e2b18a7..d65d436d 100644 --- a/src/ParameterResolver/RequestQueryParamsParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamsParameterResolver.php @@ -68,18 +68,18 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) throw new LogicException('At this level of the application, any operations with the request are not possible.'); } - $requestQuery = $annotations[0]->newInstance(); + $requestQueryParams = $annotations[0]->newInstance(); try { $argument = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { - throw HttpException::queryParamsInvalid($requestQuery->errorStatusCode, $requestQuery->errorMessage, previous: $e) + throw HttpException::queryParamsInvalid($requestQueryParams->errorStatusCode, $requestQueryParams->errorMessage, previous: $e) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { - throw HttpException::queryParamsInvalid($requestQuery->errorStatusCode, $requestQuery->errorMessage) + throw HttpException::queryParamsInvalid($requestQueryParams->errorStatusCode, $requestQueryParams->errorMessage) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/ParameterResolver/RequestRouteParameterResolver.php b/src/ParameterResolver/RequestRouteParameterResolver.php index 8fad4935..f1baf084 100644 --- a/src/ParameterResolver/RequestRouteParameterResolver.php +++ b/src/ParameterResolver/RequestRouteParameterResolver.php @@ -41,9 +41,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } if (! $context instanceof ServerRequestInterface) { - throw new LogicException( - 'At this level of the application, any operations with the request are not possible.' - ); + throw new LogicException('At this level of the application, any operations with the request are not possible.'); } /** @var Route|null $route */ diff --git a/src/ParameterResolver/RequestStreamParameterResolver.php b/src/ParameterResolver/RequestStreamParameterResolver.php index 1227a367..806d603f 100644 --- a/src/ParameterResolver/RequestStreamParameterResolver.php +++ b/src/ParameterResolver/RequestStreamParameterResolver.php @@ -38,9 +38,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } if (! $context instanceof ServerRequestInterface) { - throw new LogicException( - 'At this level of the application, any operations with the request are not possible.' - ); + throw new LogicException('At this level of the application, any operations with the request are not possible.'); } yield $context->getBody(); diff --git a/src/ParameterResolver/RequestUriParameterResolver.php b/src/ParameterResolver/RequestUriParameterResolver.php index 545b6fbe..1d92265c 100644 --- a/src/ParameterResolver/RequestUriParameterResolver.php +++ b/src/ParameterResolver/RequestUriParameterResolver.php @@ -38,9 +38,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } if (! $context instanceof ServerRequestInterface) { - throw new LogicException( - 'At this level of the application, any operations with the request are not possible.' - ); + throw new LogicException('At this level of the application, any operations with the request are not possible.'); } yield $context->getUri(); diff --git a/src/ParameterResolver/ServerRequestParameterResolver.php b/src/ParameterResolver/ServerRequestParameterResolver.php index 376fbc5c..6c898e66 100644 --- a/src/ParameterResolver/ServerRequestParameterResolver.php +++ b/src/ParameterResolver/ServerRequestParameterResolver.php @@ -38,9 +38,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } if (! $context instanceof ServerRequestInterface) { - throw new LogicException( - 'At this level of the application, any operations with the request are not possible.' - ); + throw new LogicException('At this level of the application, any operations with the request are not possible.'); } yield ServerRequest::create($context); diff --git a/src/ResponseResolver/EmptyResponseResolver.php b/src/ResponseResolver/EmptyResponseResolver.php index a2d1ad3e..3cd5e7ce 100644 --- a/src/ResponseResolver/EmptyResponseResolver.php +++ b/src/ResponseResolver/EmptyResponseResolver.php @@ -13,6 +13,7 @@ namespace Sunrise\Http\Router\ResponseResolver; +use Fig\Http\Message\StatusCodeInterface; use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; @@ -38,6 +39,6 @@ public function resolveResponse( return null; } - return $this->responseFactory->createResponse(204); + return $this->responseFactory->createResponse(StatusCodeInterface::STATUS_NO_CONTENT); } } diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index 58e55863..7574b984 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -13,6 +13,7 @@ namespace Sunrise\Http\Router\ResponseResolver; +use Fig\Http\Message\StatusCodeInterface; use JsonException; use LogicException; use Psr\Http\Message\ResponseFactoryInterface; @@ -65,7 +66,7 @@ public function resolveResponse( ), previous: $e); } - $result = $this->responseFactory->createResponse(200) + $result = $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK) ->withHeader('Content-Type', 'application/json; charset=UTF-8'); $result->getBody()->write($payload); diff --git a/src/ResponseResolver/RouteResponseResolver.php b/src/ResponseResolver/RouteResponseResolver.php index 982af392..918effc5 100644 --- a/src/ResponseResolver/RouteResponseResolver.php +++ b/src/ResponseResolver/RouteResponseResolver.php @@ -26,6 +26,9 @@ */ final class RouteResponseResolver implements ResponseResolverInterface { + /** + * @throws LogicException If the resolver is used incorrectly. + */ public function resolveResponse( mixed $response, ReflectionMethod|ReflectionFunction $responder, @@ -37,9 +40,7 @@ public function resolveResponse( $router = $request->getAttribute('@router'); if (! $router instanceof Router) { - throw new LogicException( - 'Something went wrong; the request must contain the @router attribute.' - ); + throw new LogicException('Something went wrong; the request must contain the @router attribute.'); } return $router->runRoute($response, $request); diff --git a/src/ResponseResolver/SerializableResponseResolver.php b/src/ResponseResolver/SerializableResponseResolver.php new file mode 100644 index 00000000..59692d0b --- /dev/null +++ b/src/ResponseResolver/SerializableResponseResolver.php @@ -0,0 +1,86 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ResponseResolver; + +use Fig\Http\Message\StatusCodeInterface; +use Psr\Http\Message\ResponseFactoryInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionAttribute; +use ReflectionFunction; +use ReflectionMethod; +use Sunrise\Http\Router\Annotation\SerializableResponse; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; +use Sunrise\Http\Router\ServerRequest; +use Symfony\Component\Serializer\Encoder\JsonEncoder; +use Symfony\Component\Serializer\Encoder\XmlEncoder; +use Symfony\Component\Serializer\SerializerInterface; + +/** + * @since 3.0.0 + */ +final class SerializableResponseResolver implements ResponseResolverInterface +{ + public function __construct( + private readonly ResponseFactoryInterface $responseFactory, + private readonly SerializerInterface $serializer, + private readonly array $context = [], + ) { + } + + public function resolveResponse( + mixed $response, + ReflectionMethod|ReflectionFunction $responder, + ServerRequestInterface $request + ): ?ResponseInterface { + /** @var list> $annotations */ + $annotations = $responder->getAttributes(SerializableResponse::class); + if ($annotations === []) { + return null; + } + + $serializableResponse = $annotations[0]->newInstance(); + + $serverProducesMediaTypes = [ + new ServerMediaType('application', 'json'), + new ServerMediaType('application', 'xml'), + new ServerMediaType('text', 'xml'), + ]; + + $clientPreferredMediaType = ServerRequest::create($request) + ->getClientPreferredMediaType(...$serverProducesMediaTypes) + ?? $serverProducesMediaTypes[0]; + + $mediaTypeComparator = new MediaTypeComparator(); + if ($serverProducesMediaTypes[0] === $clientPreferredMediaType || + $mediaTypeComparator->equals($serverProducesMediaTypes[0], $clientPreferredMediaType)) { + $format = JsonEncoder::FORMAT; + } elseif ($mediaTypeComparator->equals($serverProducesMediaTypes[1], $clientPreferredMediaType) || + $mediaTypeComparator->equals($serverProducesMediaTypes[2], $clientPreferredMediaType)) { + $format = XmlEncoder::FORMAT; + } + + $context = $serializableResponse->context + $this->context; + + $payload = $this->serializer->serialize($response, $format, $context); + + $result = $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK) + ->withHeader('Content-Type', $clientPreferredMediaType . '; charset=UTF-8'); + + $result->getBody()->write($payload); + + return $result; + } +} diff --git a/src/ResponseResolver/StreamResponseResolver.php b/src/ResponseResolver/StreamResponseResolver.php index b9818339..bfc2df43 100644 --- a/src/ResponseResolver/StreamResponseResolver.php +++ b/src/ResponseResolver/StreamResponseResolver.php @@ -13,6 +13,7 @@ namespace Sunrise\Http\Router\ResponseResolver; +use Fig\Http\Message\StatusCodeInterface; use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; @@ -38,7 +39,7 @@ public function resolveResponse( return null; } - return $this->responseFactory->createResponse(200) + return $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK) ->withBody($response); } } diff --git a/src/ResponseResolver/StringableResponseResolver.php b/src/ResponseResolver/StringableResponseResolver.php index 895891aa..ad4091d1 100644 --- a/src/ResponseResolver/StringableResponseResolver.php +++ b/src/ResponseResolver/StringableResponseResolver.php @@ -13,6 +13,7 @@ namespace Sunrise\Http\Router\ResponseResolver; +use Fig\Http\Message\StatusCodeInterface; use LogicException; use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; @@ -23,6 +24,7 @@ use Sunrise\Http\Router\Annotation\StringableResponse; use Sunrise\Http\Router\ResponseResolver; +use function get_debug_type; use function is_string; use function sprintf; @@ -49,12 +51,14 @@ public function resolveResponse( if (!is_string($response) && !($response instanceof Stringable)) { throw new LogicException(sprintf( - 'The responder %s returned a response that cannot be converted to a string.', + 'The responder %s returned the response %s that cannot be converted to a string.', ResponseResolver::stringifyResponder($responder), + get_debug_type($response), )); } - $result = $this->responseFactory->createResponse(200); + $result = $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK); + $result->getBody()->write((string) $response); return $result; diff --git a/src/ResponseResolver/UriResponseResolver.php b/src/ResponseResolver/UriResponseResolver.php index 804764fa..73d821d0 100644 --- a/src/ResponseResolver/UriResponseResolver.php +++ b/src/ResponseResolver/UriResponseResolver.php @@ -13,6 +13,7 @@ namespace Sunrise\Http\Router\ResponseResolver; +use Fig\Http\Message\StatusCodeInterface; use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; @@ -38,7 +39,7 @@ public function resolveResponse( return null; } - return $this->responseFactory->createResponse(302) + return $this->responseFactory->createResponse(StatusCodeInterface::STATUS_FOUND) ->withHeader('Location', $response->__toString()); } } From 597d64f8883f0b07827e3fe5a8fd0cc0d2d98359 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Mon, 4 Mar 2024 23:47:40 +0100 Subject: [PATCH 111/180] v3 --- src/Annotation/RequestCookie.php | 2 +- src/Annotation/RequestHeader.php | 2 +- src/Annotation/RequestPathVariable.php | 2 +- src/Annotation/RequestQueryParam.php | 2 +- src/Annotation/Route.php | 2 +- src/Annotation/SerializableResponse.php | 28 ---- src/Exception/HttpException.php | 2 +- src/Helper/HeaderParser.php | 18 ++- src/Helper/RouteBuilder.php | 41 +++-- src/ParameterResolver.php | 37 +---- .../RequestBodyParameterResolver.php | 6 +- .../RequestCookieParameterResolver.php | 20 +-- .../RequestHeaderParameterResolver.php | 18 +-- .../RequestPathVariableParameterResolver.php | 21 +-- .../RequestQueryParamParameterResolver.php | 20 +-- .../RequestQueryParamsParameterResolver.php | 6 +- ...esolver.php => RequestHandlerResolver.php} | 151 ++++++++---------- src/ResponseResolver.php | 44 ++--- src/ResponseResolver/JsonResponseResolver.php | 14 +- .../RouteResponseResolver.php | 48 ------ .../SerializableResponseResolver.php | 86 ---------- .../StringableResponseResolver.php | 8 +- src/Router.php | 56 +++++-- 23 files changed, 246 insertions(+), 388 deletions(-) delete mode 100644 src/Annotation/SerializableResponse.php rename src/{InterceptorResolver.php => RequestHandlerResolver.php} (75%) delete mode 100644 src/ResponseResolver/RouteResponseResolver.php delete mode 100644 src/ResponseResolver/SerializableResponseResolver.php diff --git a/src/Annotation/RequestCookie.php b/src/Annotation/RequestCookie.php index aa73328c..fdb2c667 100644 --- a/src/Annotation/RequestCookie.php +++ b/src/Annotation/RequestCookie.php @@ -22,7 +22,7 @@ final class RequestCookie { public function __construct( - public readonly string $name, + public readonly string $cookieName, public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, ) { diff --git a/src/Annotation/RequestHeader.php b/src/Annotation/RequestHeader.php index c088085a..cbe451ec 100644 --- a/src/Annotation/RequestHeader.php +++ b/src/Annotation/RequestHeader.php @@ -22,7 +22,7 @@ final class RequestHeader { public function __construct( - public readonly string $name, + public readonly string $headerName, public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, ) { diff --git a/src/Annotation/RequestPathVariable.php b/src/Annotation/RequestPathVariable.php index 9b0db93c..2014f3ab 100644 --- a/src/Annotation/RequestPathVariable.php +++ b/src/Annotation/RequestPathVariable.php @@ -22,7 +22,7 @@ final class RequestPathVariable { public function __construct( - public readonly ?string $name = null, + public readonly ?string $variableName = null, public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, ) { diff --git a/src/Annotation/RequestQueryParam.php b/src/Annotation/RequestQueryParam.php index 278109cd..9f7d34e8 100644 --- a/src/Annotation/RequestQueryParam.php +++ b/src/Annotation/RequestQueryParam.php @@ -22,7 +22,7 @@ final class RequestQueryParam { public function __construct( - public readonly string $name, + public readonly string $paramName, public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, ) { diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index 19fc6445..378598a3 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -19,7 +19,7 @@ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] final class Route { - public mixed $holder; + public mixed $holder = null; /** @var list */ public array $prefixes = []; diff --git a/src/Annotation/SerializableResponse.php b/src/Annotation/SerializableResponse.php deleted file mode 100644 index 821c7d98..00000000 --- a/src/Annotation/SerializableResponse.php +++ /dev/null @@ -1,28 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation; - -use Attribute; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] -final class SerializableResponse -{ - public function __construct( - public array $context = [], - ) { - } -} diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index 01079fae..1180a1ca 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -38,7 +38,7 @@ class HttpException extends RuntimeException implements HttpExceptionInterface * * @var array */ - private array $messagePlaceholders = []; + private array $messagePlaceholders; /** * @var list diff --git a/src/Helper/HeaderParser.php b/src/Helper/HeaderParser.php index e3e0a72d..12b31692 100644 --- a/src/Helper/HeaderParser.php +++ b/src/Helper/HeaderParser.php @@ -38,7 +38,11 @@ public static function parseContentTypeHeader(string $header): ?ClientMediaType [$identifier, $parameters] = current($values); if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier, $matches)) { - return new ClientMediaType($matches[1], $matches[2], $parameters); + return new ClientMediaType( + type: $matches[1], + subtype: $matches[2], + parameters: $parameters, + ); } return null; @@ -60,7 +64,11 @@ public static function parseAcceptHeader(string $header): Generator foreach ($values as $index => [$identifier, $parameters]) { if (preg_match('|^([^/]+)/([^/]+)$|', $identifier, $matches)) { - yield $index => new ClientMediaType($matches[1], $matches[2], $parameters); + yield $index => new ClientMediaType( + type: $matches[1], + subtype: $matches[2], + parameters: $parameters, + ); } } } @@ -81,7 +89,11 @@ public static function parseAcceptLanguageHeader(string $header): Generator foreach ($values as $index => [$identifier, $parameters]) { if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches)) { - yield $index => new ClientLanguage($matches[1], $identifier, $parameters); + yield $index => new ClientLanguage( + code: $matches[1], + locale: $identifier, + parameters: $parameters, + ); } } } diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index 530d8efe..7837beb2 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -17,6 +17,7 @@ use InvalidArgumentException; use Stringable; +use function get_debug_type; use function is_int; use function is_string; use function sprintf; @@ -41,22 +42,14 @@ public static function buildRoute(string $route, array $values = []): string $statement = substr($route, $variable['offset'], $variable['length']); if (isset($values[$variable['name']])) { - $value = $values[$variable['name']]; - - if (is_int($value)) { - $value = (string) $value; - } elseif ($value instanceof BackedEnum) { - $value = (string) $value->value; - } elseif ($value instanceof Stringable) { - $value = $value->__toString(); - } - - if (!is_string($value)) { + try { + $value = self::stringifyValue($values[$variable['name']]); + } catch (InvalidArgumentException $e) { throw new InvalidArgumentException(sprintf( 'The route %s could not be built with an unsupported value for the variable %s.', $route, $variable['name'], - )); + ), previous: $e); } $search[] = $statement; @@ -85,4 +78,28 @@ public static function buildRoute(string $route, array $values = []): string return str_replace($search, $replace, $route); } + + /** + * @throws InvalidArgumentException If the value couldn't be converted to a string. + */ + public static function stringifyValue(mixed $value): string + { + if (is_string($value)) { + return $value; + } + if (is_int($value)) { + return (string) $value; + } + if ($value instanceof BackedEnum) { + return (string) $value->value; + } + if ($value instanceof Stringable) { + return $value->__toString(); + } + + throw new InvalidArgumentException(sprintf( + 'The value "%s" could be converted to a string.', + get_debug_type($value), + )); + } } diff --git a/src/ParameterResolver.php b/src/ParameterResolver.php index bb3d933e..1934b931 100644 --- a/src/ParameterResolver.php +++ b/src/ParameterResolver.php @@ -19,6 +19,7 @@ use ReflectionParameter; use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; +use function array_unshift; use function sprintf; /** @@ -26,10 +27,10 @@ */ final class ParameterResolver { - private mixed $context; + private mixed $context = null; public function __construct( - /** @var array */ + /** @var ParameterResolverInterface[] */ private array $resolvers, ) { } @@ -45,15 +46,8 @@ public function withContext(mixed $context): self public function withPriorityResolver(ParameterResolverInterface ...$resolvers): self { $clone = clone $this; - $clone->resolvers = []; - foreach ($resolvers as $resolver) { - $clone->resolvers[] = $resolver; - } - - foreach ($this->resolvers as $resolver) { - $clone->resolvers[] = $resolver; - } + array_unshift($clone->resolvers, ...$resolvers); return $clone; } @@ -82,13 +76,9 @@ private function resolveParameter(ReflectionParameter $parameter): Generator } } - if ($parameter->isDefaultValueAvailable()) { - return yield $parameter->getDefaultValue(); - } - throw new LogicException(sprintf( - 'The parameter %s cannot be resolved.', - self::stringifyParameter($parameter) + 'The parameter %s could not be resolved because a suitable resolver for it was not found.', + self::stringifyParameter($parameter), )); } @@ -97,20 +87,9 @@ public static function stringifyParameter(ReflectionParameter $parameter): strin $function = $parameter->getDeclaringFunction(); if ($function instanceof ReflectionMethod) { - return sprintf( - '%s::%s($%s[%d])', - $function->getDeclaringClass()->getName(), - $function->getName(), - $parameter->getName(), - $parameter->getPosition(), - ); + return sprintf('%s::%s($%s[%d])', $function->getDeclaringClass()->getName(), $function->getName(), $parameter->getName(), $parameter->getPosition()); } - return sprintf( - '%s($%s[%d])', - $function->getName(), - $parameter->getName(), - $parameter->getPosition(), - ); + return sprintf('%s($%s[%d])', $function->getName(), $parameter->getName(), $parameter->getPosition()); } } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 78de1a4c..e59f82ab 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -68,18 +68,18 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) throw new LogicException('At this level of the application, any operations with the request are not possible.'); } - $requestBody = $annotations[0]->newInstance(); + $processParams = $annotations[0]->newInstance(); try { $argument = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidDataException $e) { - throw HttpException::bodyInvalid($requestBody->errorStatusCode, $requestBody->errorMessage, previous: $e) + throw HttpException::bodyInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { - throw HttpException::bodyInvalid($requestBody->errorStatusCode, $requestBody->errorMessage) + throw HttpException::bodyInvalid($processParams->errorStatusCode, $processParams->errorMessage) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index faafdece..46ac7bca 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -59,31 +59,31 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) throw new LogicException('At this level of the application, any operations with the request are not possible.'); } - $request = ServerRequest::create($context); - $requestCookie = $annotations[0]->newInstance(); + $requestProxy = ServerRequest::create($context); + $processParams = $annotations[0]->newInstance(); - if (!$request->hasCookieParam($requestCookie->name)) { + if (!$requestProxy->hasCookieParam($processParams->cookieName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } - throw HttpException::cookieMissed($requestCookie->errorStatusCode, $requestCookie->errorMessage) - ->addMessagePlaceholder('{{ cookie_name }}', $requestCookie->name); + throw HttpException::cookieMissed($processParams->errorStatusCode, $processParams->errorMessage) + ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName); } try { - $argument = $this->hydrator->castValue($request->getCookieParam($requestCookie->name), Type::fromParameter($parameter), path: [$requestCookie->name]); + $argument = $this->hydrator->castValue($requestProxy->getCookieParam($processParams->cookieName), Type::fromParameter($parameter), path: [$processParams->cookieName]); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpException::cookieInvalid($requestCookie->errorStatusCode, $requestCookie->errorMessage, previous: $e) - ->addMessagePlaceholder('{{ cookie_name }}', $requestCookie->name) + throw HttpException::cookieInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) + ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpException::cookieInvalid($requestCookie->errorStatusCode, $requestCookie->errorMessage) - ->addMessagePlaceholder('{{ cookie_name }}', $requestCookie->name) + throw HttpException::cookieInvalid($processParams->errorStatusCode, $processParams->errorMessage) + ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 9b35b892..2a368ea2 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -58,30 +58,30 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) throw new LogicException('At this level of the application, any operations with the request are not possible.'); } - $requestHeader = $annotations[0]->newInstance(); + $processParams = $annotations[0]->newInstance(); - if (!$context->hasHeader($requestHeader->name)) { + if (!$context->hasHeader($processParams->headerName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } - throw HttpException::headerMissed($requestHeader->errorStatusCode, $requestHeader->errorMessage) - ->addMessagePlaceholder('{{ header_name }}', $requestHeader->name); + throw HttpException::headerMissed($processParams->errorStatusCode, $processParams->errorMessage) + ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName); } try { - $argument = $this->hydrator->castValue($context->getHeaderLine($requestHeader->name), Type::fromParameter($parameter), path: [$requestHeader->name]); + $argument = $this->hydrator->castValue($context->getHeaderLine($processParams->headerName), Type::fromParameter($parameter), path: [$processParams->headerName]); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpException::headerInvalid($requestHeader->errorStatusCode, $requestHeader->errorMessage, previous: $e) - ->addMessagePlaceholder('{{ header_name }}', $requestHeader->name) + throw HttpException::headerInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) + ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpException::headerInvalid($requestHeader->errorStatusCode, $requestHeader->errorMessage) - ->addMessagePlaceholder('{{ header_name }}', $requestHeader->name) + throw HttpException::headerInvalid($processParams->errorStatusCode, $processParams->errorMessage) + ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/ParameterResolver/RequestPathVariableParameterResolver.php b/src/ParameterResolver/RequestPathVariableParameterResolver.php index c665a59e..d720a289 100644 --- a/src/ParameterResolver/RequestPathVariableParameterResolver.php +++ b/src/ParameterResolver/RequestPathVariableParameterResolver.php @@ -72,10 +72,11 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) )); } - $requestPathVariable = $annotations[0]->newInstance(); - $pathVariableName = $requestPathVariable->name ?? $parameter->getName(); + $processParams = $annotations[0]->newInstance(); - if (!$route->hasAttribute($pathVariableName)) { + $variableName = $processParams->variableName ?? $parameter->getName(); + + if (!$route->hasAttribute($variableName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } @@ -83,18 +84,18 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) throw new LogicException(sprintf( 'The parameter %1$s expects the value of the variable %3$s from the route %2$s ' . 'which is not present in the request, most likely, because the variable is optional. ' . - 'To resolve this issue, assign the default value to the parameter, for example, null.', + 'To resolve this issue, assign the default value to the parameter.', ParameterResolver::stringifyParameter($parameter), $route->getName(), - $pathVariableName, + $variableName, )); } try { - $argument = $this->hydrator->castValue($route->getAttribute($pathVariableName), Type::fromParameter($parameter), path: [$pathVariableName]); + $argument = $this->hydrator->castValue($route->getAttribute($variableName), Type::fromParameter($parameter), path: [$variableName]); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpException::pathVariableInvalid($requestPathVariable->errorStatusCode, $requestPathVariable->errorMessage, previous: $e) - ->addMessagePlaceholder('{{ variable_name }}', $pathVariableName) + throw HttpException::pathVariableInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) + ->addMessagePlaceholder('{{ variable_name }}', $variableName) ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } @@ -102,8 +103,8 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpException::pathVariableInvalid($requestPathVariable->errorStatusCode, $requestPathVariable->errorMessage) - ->addMessagePlaceholder('{{ variable_name }}', $pathVariableName) + throw HttpException::pathVariableInvalid($processParams->errorStatusCode, $processParams->errorMessage) + ->addMessagePlaceholder('{{ variable_name }}', $variableName) ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } diff --git a/src/ParameterResolver/RequestQueryParamParameterResolver.php b/src/ParameterResolver/RequestQueryParamParameterResolver.php index 4af43579..ff9c9155 100644 --- a/src/ParameterResolver/RequestQueryParamParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamParameterResolver.php @@ -59,31 +59,31 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) throw new LogicException('At this level of the application, any operations with the request are not possible.'); } - $request = ServerRequest::create($context); - $requestQueryParam = $annotations[0]->newInstance(); + $requestProxy = ServerRequest::create($context); + $processParams = $annotations[0]->newInstance(); - if (!$request->hasQueryParam($requestQueryParam->name)) { + if (!$requestProxy->hasQueryParam($processParams->paramName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } - throw HttpException::queryParamMissed($requestQueryParam->errorStatusCode, $requestQueryParam->errorMessage) - ->addMessagePlaceholder('{{ param_name }}', $requestQueryParam->name); + throw HttpException::queryParamMissed($processParams->errorStatusCode, $processParams->errorMessage) + ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName); } try { - $argument = $this->hydrator->castValue($request->getQueryParam($requestQueryParam->name), Type::fromParameter($parameter), path: [$requestQueryParam->name]); + $argument = $this->hydrator->castValue($requestProxy->getQueryParam($processParams->paramName), Type::fromParameter($parameter), path: [$processParams->paramName]); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpException::queryParamInvalid($requestQueryParam->errorStatusCode, $requestQueryParam->errorMessage, previous: $e) - ->addMessagePlaceholder('{{ param_name }}', $requestQueryParam->name) + throw HttpException::queryParamInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) + ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpException::queryParamInvalid($requestQueryParam->errorStatusCode, $requestQueryParam->errorMessage) - ->addMessagePlaceholder('{{ param_name }}', $requestQueryParam->name) + throw HttpException::queryParamInvalid($processParams->errorStatusCode, $processParams->errorMessage) + ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/ParameterResolver/RequestQueryParamsParameterResolver.php b/src/ParameterResolver/RequestQueryParamsParameterResolver.php index d65d436d..8dbe5bb5 100644 --- a/src/ParameterResolver/RequestQueryParamsParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamsParameterResolver.php @@ -68,18 +68,18 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) throw new LogicException('At this level of the application, any operations with the request are not possible.'); } - $requestQueryParams = $annotations[0]->newInstance(); + $processParams = $annotations[0]->newInstance(); try { $argument = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { - throw HttpException::queryParamsInvalid($requestQueryParams->errorStatusCode, $requestQueryParams->errorMessage, previous: $e) + throw HttpException::queryParamsInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { - throw HttpException::queryParamsInvalid($requestQueryParams->errorStatusCode, $requestQueryParams->errorMessage) + throw HttpException::queryParamsInvalid($processParams->errorStatusCode, $processParams->errorMessage) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/InterceptorResolver.php b/src/RequestHandlerResolver.php similarity index 75% rename from src/InterceptorResolver.php rename to src/RequestHandlerResolver.php index ee8c8d88..e45a539c 100644 --- a/src/InterceptorResolver.php +++ b/src/RequestHandlerResolver.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router; use Closure; +use InvalidArgumentException; use LogicException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; @@ -37,7 +38,7 @@ /** * @since 2.10.0 */ -final class InterceptorResolver +final class RequestHandlerResolver { /** * @var array @@ -51,20 +52,10 @@ public function __construct( } /** - * @throws LogicException If the requst handler couldn't be resolved. + * @throws InvalidArgumentException If the requst handler couldn't be resolved. */ public function resolveRequestHandler(mixed $requestHandler): RequestHandlerInterface { - if ($requestHandler instanceof RequestHandlerInterface) { - return $requestHandler; - } - - if ($requestHandler instanceof Closure) { - return new CallableRequestHandler( - $this->createRequestHandlerCallback($requestHandler, new ReflectionFunction($requestHandler)), - ); - } - // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 if (is_array($requestHandler) && is_callable($requestHandler, true)) { /** @var array{0: class-string|object, 1: non-empty-string} $requestHandler */ @@ -74,9 +65,7 @@ public function resolveRequestHandler(mixed $requestHandler): RequestHandlerInte } if (is_callable($requestHandler)) { - return new CallableRequestHandler( - $this->createRequestHandlerCallback($requestHandler, new ReflectionMethod($requestHandler[0], $requestHandler[1])), - ); + return new CallableRequestHandler($this->createRequestHandlerCallback($requestHandler, new ReflectionMethod($requestHandler[0], $requestHandler[1]))); } } @@ -84,27 +73,25 @@ public function resolveRequestHandler(mixed $requestHandler): RequestHandlerInte return $this->resolveClass($requestHandler); } - throw new LogicException(sprintf( - 'The request handler %s could not be resolved.', - self::stringifyInterceptor($requestHandler), + if ($requestHandler instanceof Closure) { + return new CallableRequestHandler($this->createRequestHandlerCallback($requestHandler, new ReflectionFunction($requestHandler))); + } + + if ($requestHandler instanceof RequestHandlerInterface) { + return $requestHandler; + } + + throw new InvalidArgumentException(sprintf( + 'The request handler "%s" could not be resolved.', + get_debug_type($requestHandler), )); } /** - * @throws LogicException If the middleware couldn't be resolved. + * @throws InvalidArgumentException If the middleware couldn't be resolved. */ public function resolveMiddleware(mixed $middleware): MiddlewareInterface { - if ($middleware instanceof MiddlewareInterface) { - return $middleware; - } - - if ($middleware instanceof Closure) { - return new CallableMiddleware( - $this->createMiddlewareCallback($middleware, new ReflectionFunction($middleware)), - ); - } - if (is_string($middleware) && is_subclass_of($middleware, MiddlewareInterface::class)) { return $this->resolveClass($middleware); } @@ -118,18 +105,59 @@ public function resolveMiddleware(mixed $middleware): MiddlewareInterface } if (is_callable($middleware)) { - return new CallableMiddleware( - $this->createMiddlewareCallback($middleware, new ReflectionMethod($middleware[0], $middleware[1])), - ); + return new CallableMiddleware($this->createMiddlewareCallback($middleware, new ReflectionMethod($middleware[0], $middleware[1]))); } } - throw new LogicException(sprintf( - 'The middleware %s could not be resolved.', - self::stringifyInterceptor($middleware), + if ($middleware instanceof Closure) { + return new CallableMiddleware($this->createMiddlewareCallback($middleware, new ReflectionFunction($middleware))); + } + + if ($middleware instanceof MiddlewareInterface) { + return $middleware; + } + + throw new InvalidArgumentException(sprintf( + 'The middleware "%s" could not be resolved.', + get_debug_type($middleware), )); } + /** + * @param class-string $className + * + * @return T + * + * @template T of object + * + * @throws LogicException If the class couldn't be resolved. + */ + private function resolveClass(string $className): object + { + if (isset($this->resolvedClasses[$className])) { + /** @var T */ + return $this->resolvedClasses[$className]; + } + + if (!class_exists($className)) { + throw new LogicException(sprintf('The class %s does not exist and cannot be resolved.', $className)); + } + + $classReflection = new ReflectionClass($className); + if (!$classReflection->isInstantiable()) { + throw new LogicException(sprintf('The class %s is not instantiable and cannot be resolved.', $className)); + } + + $arguments = []; + $constructor = $classReflection->getConstructor(); + if (isset($constructor) && $constructor->getNumberOfParameters()) { + $arguments = $this->parameterResolver->resolveParameters(...$constructor->getParameters()); + } + + /** @var T */ + return $this->resolvedClasses[$className] = $classReflection->newInstance(...$arguments); + } + /** * @return Closure(ServerRequestInterface=): ResponseInterface */ @@ -163,8 +191,10 @@ private function createMiddlewareCallback( $callback(... $this->parameterResolver ->withContext($request) - ->withPriorityResolver(new ObjectInjectionParameterResolver($request)) - ->withPriorityResolver(new ObjectInjectionParameterResolver($handler)) + ->withPriorityResolver( + new ObjectInjectionParameterResolver($request), + new ObjectInjectionParameterResolver($handler), + ) ->resolveParameters(...$reflection->getParameters()) ), $reflection, @@ -172,51 +202,4 @@ private function createMiddlewareCallback( ) ); } - - /** - * Resolves the given named class - * - * @param class-string $className - * - * @return T - * - * @template T of object - * - * @throws LogicException If the class couldn't be resolved. - */ - private function resolveClass(string $className): object - { - if (isset($this->resolvedClasses[$className])) { - /** @var T */ - return $this->resolvedClasses[$className]; - } - - if (!class_exists($className)) { - throw new LogicException(sprintf('The class %s does not exist.', $className)); - } - - $classReflection = new ReflectionClass($className); - if (!$classReflection->isInstantiable()) { - throw new LogicException(sprintf('The class %s is not instantiable.', $className)); - } - - $arguments = []; - $constructor = $classReflection->getConstructor(); - if (isset($constructor) && $constructor->getNumberOfParameters()) { - $arguments = $this->parameterResolver->resolveParameters(...$constructor->getParameters()); - } - - /** @var T */ - return $this->resolvedClasses[$className] = $classReflection->newInstance(...$arguments); - } - - private static function stringifyInterceptor(mixed $interceptor): string - { - // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 - if (is_callable($interceptor, true, $result)) { - return $result; - } - - return get_debug_type($interceptor); - } } diff --git a/src/ResponseResolver.php b/src/ResponseResolver.php index ecc99fb2..68a1e2f0 100644 --- a/src/ResponseResolver.php +++ b/src/ResponseResolver.php @@ -23,6 +23,7 @@ use Sunrise\Http\Router\Annotation\ResponseStatus; use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; +use function get_debug_type; use function sprintf; /** @@ -31,7 +32,7 @@ final class ResponseResolver { public function __construct( - /** @var array */ + /** @var ResponseResolverInterface[] */ private readonly array $resolvers, ) { } @@ -43,51 +44,52 @@ public function resolveResponse( mixed $response, ReflectionMethod|ReflectionFunction $responder, ServerRequestInterface $request, - ) : ResponseInterface { + ): ResponseInterface { if ($response instanceof ResponseInterface) { - return $this->handleResponse($response, $responder); + return $response; } foreach ($this->resolvers as $resolver) { - $result = $resolver->resolveResponse($response, $responder, $request); - if ($result instanceof ResponseInterface) { - return $this->handleResponse($result, $responder); + $resolvedResponse = $resolver->resolveResponse($response, $responder, $request); + if ($resolvedResponse instanceof ResponseInterface) { + return $this->completeResponse($resolvedResponse, $responder); } } throw new LogicException(sprintf( - 'The responder %s returned an unsupported response.', + 'The responder %s returned the unsupported response "%s".', self::stringifyResponder($responder), + get_debug_type($response), )); } - private function handleResponse( + private function completeResponse( ResponseInterface $response, ReflectionMethod|ReflectionFunction $responder, - ) : ResponseInterface { - /** @var ReflectionAttribute $attributes */ - $attributes = $responder->getAttributes(ResponseStatus::class); - if (isset($attributes[0])) { - $status = $attributes[0]->newInstance(); + ): ResponseInterface { + /** @var list> $annotations */ + $annotations = $responder->getAttributes(ResponseStatus::class); + if (isset($annotations[0])) { + $status = $annotations[0]->newInstance(); $response = $response->withStatus($status->code, $status->phrase); } - /** @var ReflectionAttribute $attributes */ - $attributes = $responder->getAttributes(ResponseHeader::class); - foreach ($attributes as $attribute) { - $header = $attribute->newInstance(); + /** @var list> $annotations */ + $annotations = $responder->getAttributes(ResponseHeader::class); + foreach ($annotations as $annotation) { + $header = $annotation->newInstance(); $response = $response->withHeader($header->name, $header->value); } return $response; } - public static function stringifyResponder(ReflectionMethod|ReflectionFunction $function): string + public static function stringifyResponder(ReflectionMethod|ReflectionFunction $responder): string { - if ($function instanceof ReflectionMethod) { - return sprintf('%s::%s()', $function->getDeclaringClass()->getName(), $function->getName()); + if ($responder instanceof ReflectionMethod) { + return sprintf('%s::%s()', $responder->getDeclaringClass()->getName(), $responder->getName()); } - return sprintf('%s()', $function->getName()); + return sprintf('%s()', $responder->getName()); } } diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index 7574b984..df94c24d 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -25,6 +25,7 @@ use Sunrise\Http\Router\Annotation\JsonResponse; use Sunrise\Http\Router\ResponseResolver; +use function get_debug_type; use function json_encode; use function sprintf; @@ -53,24 +54,25 @@ public function resolveResponse( return null; } - $jsonResponse = $annotations[0]->newInstance(); + $jsonResponseParams = $annotations[0]->newInstance(); try { /** @psalm-suppress ArgumentTypeCoercion */ - $payload = json_encode($response, $jsonResponse->flags | JSON_THROW_ON_ERROR, $jsonResponse->depth); + $payload = json_encode($response, $jsonResponseParams->flags | JSON_THROW_ON_ERROR, $jsonResponseParams->depth); } catch (JsonException $e) { throw new LogicException(sprintf( - 'The responder %s returned a response that could not be encoded to JSON due to: %s', + 'The responder %s returned the response "%s" that could not be encoded to JSON due to: %s', ResponseResolver::stringifyResponder($responder), + get_debug_type($response), $e->getMessage(), ), previous: $e); } - $result = $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK) + $jsonResponse = $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK) ->withHeader('Content-Type', 'application/json; charset=UTF-8'); - $result->getBody()->write($payload); + $jsonResponse->getBody()->write($payload); - return $result; + return $jsonResponse; } } diff --git a/src/ResponseResolver/RouteResponseResolver.php b/src/ResponseResolver/RouteResponseResolver.php deleted file mode 100644 index 918effc5..00000000 --- a/src/ResponseResolver/RouteResponseResolver.php +++ /dev/null @@ -1,48 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ResponseResolver; - -use LogicException; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use ReflectionFunction; -use ReflectionMethod; -use Sunrise\Http\Router\Route; -use Sunrise\Http\Router\Router; - -/** - * @since 3.0.0 - */ -final class RouteResponseResolver implements ResponseResolverInterface -{ - /** - * @throws LogicException If the resolver is used incorrectly. - */ - public function resolveResponse( - mixed $response, - ReflectionMethod|ReflectionFunction $responder, - ServerRequestInterface $request, - ): ?ResponseInterface { - if (! $response instanceof Route) { - return null; - } - - $router = $request->getAttribute('@router'); - if (! $router instanceof Router) { - throw new LogicException('Something went wrong; the request must contain the @router attribute.'); - } - - return $router->runRoute($response, $request); - } -} diff --git a/src/ResponseResolver/SerializableResponseResolver.php b/src/ResponseResolver/SerializableResponseResolver.php deleted file mode 100644 index 59692d0b..00000000 --- a/src/ResponseResolver/SerializableResponseResolver.php +++ /dev/null @@ -1,86 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ResponseResolver; - -use Fig\Http\Message\StatusCodeInterface; -use Psr\Http\Message\ResponseFactoryInterface; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use ReflectionAttribute; -use ReflectionFunction; -use ReflectionMethod; -use Sunrise\Http\Router\Annotation\SerializableResponse; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; -use Sunrise\Http\Router\ServerRequest; -use Symfony\Component\Serializer\Encoder\JsonEncoder; -use Symfony\Component\Serializer\Encoder\XmlEncoder; -use Symfony\Component\Serializer\SerializerInterface; - -/** - * @since 3.0.0 - */ -final class SerializableResponseResolver implements ResponseResolverInterface -{ - public function __construct( - private readonly ResponseFactoryInterface $responseFactory, - private readonly SerializerInterface $serializer, - private readonly array $context = [], - ) { - } - - public function resolveResponse( - mixed $response, - ReflectionMethod|ReflectionFunction $responder, - ServerRequestInterface $request - ): ?ResponseInterface { - /** @var list> $annotations */ - $annotations = $responder->getAttributes(SerializableResponse::class); - if ($annotations === []) { - return null; - } - - $serializableResponse = $annotations[0]->newInstance(); - - $serverProducesMediaTypes = [ - new ServerMediaType('application', 'json'), - new ServerMediaType('application', 'xml'), - new ServerMediaType('text', 'xml'), - ]; - - $clientPreferredMediaType = ServerRequest::create($request) - ->getClientPreferredMediaType(...$serverProducesMediaTypes) - ?? $serverProducesMediaTypes[0]; - - $mediaTypeComparator = new MediaTypeComparator(); - if ($serverProducesMediaTypes[0] === $clientPreferredMediaType || - $mediaTypeComparator->equals($serverProducesMediaTypes[0], $clientPreferredMediaType)) { - $format = JsonEncoder::FORMAT; - } elseif ($mediaTypeComparator->equals($serverProducesMediaTypes[1], $clientPreferredMediaType) || - $mediaTypeComparator->equals($serverProducesMediaTypes[2], $clientPreferredMediaType)) { - $format = XmlEncoder::FORMAT; - } - - $context = $serializableResponse->context + $this->context; - - $payload = $this->serializer->serialize($response, $format, $context); - - $result = $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK) - ->withHeader('Content-Type', $clientPreferredMediaType . '; charset=UTF-8'); - - $result->getBody()->write($payload); - - return $result; - } -} diff --git a/src/ResponseResolver/StringableResponseResolver.php b/src/ResponseResolver/StringableResponseResolver.php index ad4091d1..83ec2103 100644 --- a/src/ResponseResolver/StringableResponseResolver.php +++ b/src/ResponseResolver/StringableResponseResolver.php @@ -51,16 +51,16 @@ public function resolveResponse( if (!is_string($response) && !($response instanceof Stringable)) { throw new LogicException(sprintf( - 'The responder %s returned the response %s that cannot be converted to a string.', + 'The responder %s returned the response "%s" that cannot be converted to a string.', ResponseResolver::stringifyResponder($responder), get_debug_type($response), )); } - $result = $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK); + $stringableResponse = $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK); - $result->getBody()->write((string) $response); + $stringableResponse->getBody()->write((string) $response); - return $result; + return $stringableResponse; } } diff --git a/src/Router.php b/src/Router.php index f673e950..291047da 100644 --- a/src/Router.php +++ b/src/Router.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router; use InvalidArgumentException; +use LogicException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; @@ -29,14 +30,13 @@ use function array_flip; use function array_keys; -use function count; use function in_array; use function rawurldecode; use function sprintf; class Router { - private readonly InterceptorResolver $interceptorResolver; + private readonly RequestHandlerResolver $requestHandlerResolver; private array $middlewares; @@ -58,8 +58,8 @@ class Router private ?RequestHandlerInterface $routerRequestHandler = null; /** - * @param array $parameterResolvers - * @param array $responseResolvers + * @param ParameterResolverInterface[] $parameterResolvers + * @param ResponseResolverInterface[] $responseResolvers * @param list $loaders * * @since 3.0.0 @@ -72,7 +72,7 @@ public function __construct( ) { $this->middlewares = $middlewares; - $this->interceptorResolver = new InterceptorResolver( + $this->requestHandlerResolver = new RequestHandlerResolver( new ParameterResolver($parameterResolvers), new ResponseResolver($responseResolvers), ); @@ -103,7 +103,7 @@ public function getRoute(string $name): Route )); } - public function addRoute(Route ...$routes) : void + public function addRoute(Route ...$routes): void { foreach ($routes as $route) { $this->routes[$route->getName()] = $route; @@ -231,6 +231,8 @@ public function routeSupportsMethod(Route|string $route, string $method): bool } /** + * @throws LogicException If the route is associated with an unsupported request handler or middleware. + * * @since 3.0.0 */ public function getRouteRequestHandler(Route|string $route): RequestHandlerInterface @@ -244,7 +246,14 @@ public function getRouteRequestHandler(Route|string $route): RequestHandlerInter return $this->routeRequestHandlers[$routeName]; } - $this->routeRequestHandlers[$routeName] = $this->interceptorResolver->resolveRequestHandler($route->getRequestHandler()); + try { + $this->routeRequestHandlers[$routeName] = $this->requestHandlerResolver->resolveRequestHandler($route->getRequestHandler()); + } catch (InvalidArgumentException $e) { + throw new LogicException(sprintf( + 'The route %s refers to an unsupported request handler.', + $routeName, + ), previous: $e); + } $middlewares = $route->getMiddlewares(); if ($middlewares === []) { @@ -252,16 +261,26 @@ public function getRouteRequestHandler(Route|string $route): RequestHandlerInter } $this->routeRequestHandlers[$routeName] = new QueueableRequestHandler($this->routeRequestHandlers[$routeName]); + foreach ($middlewares as $middleware) { - $this->routeRequestHandlers[$routeName]->enqueue( - $this->interceptorResolver->resolveMiddleware($middleware) - ); + try { + $middleware = $this->requestHandlerResolver->resolveMiddleware($middleware); + } catch (InvalidArgumentException $e) { + throw new LogicException(sprintf( + 'The route %s refers to an unsupported middleware.', + $routeName, + ), previous: $e); + } + + $this->routeRequestHandlers[$routeName]->enqueue($middleware); } return $this->routeRequestHandlers[$routeName]; } /** + * @throws LogicException If the router is associated with an unsupported middleware. + * * @since 3.0.0 */ public function getRouterRequestHandler(): RequestHandlerInterface @@ -271,9 +290,9 @@ public function getRouterRequestHandler(): RequestHandlerInterface } $this->routerRequestHandler = new CallableRequestHandler( - function (ServerRequestInterface $request): ResponseInterface { - return $this->runRoute($this->match($request), $request); - } + fn(ServerRequestInterface $request): ResponseInterface => ( + $this->runRoute($this->match($request), $request) + ) ); if ($this->middlewares === []) { @@ -281,10 +300,15 @@ function (ServerRequestInterface $request): ResponseInterface { } $this->routerRequestHandler = new QueueableRequestHandler($this->routerRequestHandler); + foreach ($this->middlewares as $middleware) { - $this->routerRequestHandler->enqueue( - $this->interceptorResolver->resolveMiddleware($middleware) - ); + try { + $middleware = $this->requestHandlerResolver->resolveMiddleware($middleware); + } catch (InvalidArgumentException $e) { + throw new LogicException('The router refers to an unsupported middleware.', previous: $e); + } + + $this->routerRequestHandler->enqueue($middleware); } return $this->routerRequestHandler; From 8c93bbb33d2e9dc98fa7125acb736439ad7fa820 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Tue, 5 Mar 2024 03:48:37 +0100 Subject: [PATCH 112/180] v3 --- src/Annotation/JsonResponse.php | 4 +- src/Annotation/StringableResponse.php | 24 -- src/Entity/MediaType/MediaTypeInterface.php | 2 +- src/Exception/HttpException.php | 212 ---------------- src/Exception/HttpExceptionFactory.php | 234 ++++++++++++++++++ src/Helper/RouteBuilder.php | 7 +- .../JsonPayloadDecodingMiddleware.php | 7 +- src/ParameterResolver.php | 2 +- .../RequestBodyParameterResolver.php | 5 +- .../RequestCookieParameterResolver.php | 7 +- .../RequestHeaderParameterResolver.php | 7 +- .../RequestPathVariableParameterResolver.php | 9 +- .../RequestQueryParamParameterResolver.php | 7 +- .../RequestQueryParamsParameterResolver.php | 7 +- src/RequestHandlerResolver.php | 11 +- src/ResponseResolver.php | 4 +- src/ResponseResolver/JsonResponseResolver.php | 21 +- .../StringableResponseResolver.php | 66 ----- src/Router.php | 7 +- 19 files changed, 292 insertions(+), 351 deletions(-) delete mode 100644 src/Annotation/StringableResponse.php create mode 100644 src/Exception/HttpExceptionFactory.php delete mode 100644 src/ResponseResolver/StringableResponseResolver.php diff --git a/src/Annotation/JsonResponse.php b/src/Annotation/JsonResponse.php index b2615787..9910aac6 100644 --- a/src/Annotation/JsonResponse.php +++ b/src/Annotation/JsonResponse.php @@ -22,8 +22,8 @@ final class JsonResponse { public function __construct( - public readonly int $flags = 0, - public readonly int $depth = 512, + public readonly ?int $encodingFlags = null, + public readonly ?int $encodingDepth = null, ) { } } diff --git a/src/Annotation/StringableResponse.php b/src/Annotation/StringableResponse.php deleted file mode 100644 index 881a5963..00000000 --- a/src/Annotation/StringableResponse.php +++ /dev/null @@ -1,24 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation; - -use Attribute; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] -final class StringableResponse -{ -} diff --git a/src/Entity/MediaType/MediaTypeInterface.php b/src/Entity/MediaType/MediaTypeInterface.php index 01bb0ffc..91bc5b94 100644 --- a/src/Entity/MediaType/MediaTypeInterface.php +++ b/src/Entity/MediaType/MediaTypeInterface.php @@ -20,7 +20,7 @@ */ interface MediaTypeInterface extends Stringable { - public const SEPARATOR = '/'; + final public const SEPARATOR = '/'; public function getType(): string; diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index 1180a1ca..4b2ac64f 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -13,11 +13,9 @@ namespace Sunrise\Http\Router\Exception; -use Fig\Http\Message\StatusCodeInterface; use RuntimeException; use Stringable; use Sunrise\Http\Router\ConstraintViolationInterface; -use Sunrise\Http\Router\Dictionary\ErrorMessage; use Throwable; use function join; @@ -60,216 +58,6 @@ public function __construct(int $code, string $message, array $placeholders = [] parent::__construct($interpolatedMessage, $code, $previous); } - final public static function resourceNotFound( - ?int $code = null, - ?string $message = null, - array $placeholders = [], - ?Throwable $previous = null, - ): self { - return new self( - code: $code ?? StatusCodeInterface::STATUS_NOT_FOUND, - message: $message ?? ErrorMessage::RESOURCE_NOT_FOUND, - placeholders: $placeholders, - previous: $previous, - ); - } - - final public static function methodNotAllowed( - ?int $code = null, - ?string $message = null, - array $placeholders = [], - ?Throwable $previous = null, - ): self { - return new self( - code: $code ?? StatusCodeInterface::STATUS_METHOD_NOT_ALLOWED, - message: $message ?? ErrorMessage::METHOD_NOT_ALLOWED, - placeholders: $placeholders, - previous: $previous, - ); - } - - final public static function mediaTypeNotSupported( - ?int $code = null, - ?string $message = null, - array $placeholders = [], - ?Throwable $previous = null, - ): self { - return new self( - code: $code ?? StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE, - message: $message ?? ErrorMessage::MEDIA_TYPE_NOT_SUPPORTED, - placeholders: $placeholders, - previous: $previous, - ); - } - - final public static function pathVariableInvalid( - ?int $code = null, - ?string $message = null, - array $placeholders = [], - ?Throwable $previous = null, - ): self { - return new self( - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::PATH_VARIABLE_INVALID, - placeholders: $placeholders, - previous: $previous, - ); - } - - final public static function queryParamsInvalid( - ?int $code = null, - ?string $message = null, - array $placeholders = [], - ?Throwable $previous = null, - ): self { - return new self( - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::QUERY_PARAMS_INVALID, - placeholders: $placeholders, - previous: $previous, - ); - } - - final public static function queryParamMissed( - ?int $code = null, - ?string $message = null, - array $placeholders = [], - ?Throwable $previous = null, - ): self { - return new self( - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::QUERY_PARAM_MISSED, - placeholders: $placeholders, - previous: $previous, - ); - } - - final public static function queryParamInvalid( - ?int $code = null, - ?string $message = null, - array $placeholders = [], - ?Throwable $previous = null, - ): self { - return new self( - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::QUERY_PARAM_INVALID, - placeholders: $placeholders, - previous: $previous, - ); - } - - final public static function headerMissed( - ?int $code = null, - ?string $message = null, - array $placeholders = [], - ?Throwable $previous = null, - ): self { - return new self( - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::HEADER_MISSED, - placeholders: $placeholders, - previous: $previous, - ); - } - - final public static function headerInvalid( - ?int $code = null, - ?string $message = null, - array $placeholders = [], - ?Throwable $previous = null, - ): self { - return new self( - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::HEADER_INVALID, - placeholders: $placeholders, - previous: $previous, - ); - } - - final public static function cookieMissed( - ?int $code = null, - ?string $message = null, - array $placeholders = [], - ?Throwable $previous = null, - ): self { - return new self( - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::COOKIE_MISSED, - placeholders: $placeholders, - previous: $previous, - ); - } - - final public static function cookieInvalid( - ?int $code = null, - ?string $message = null, - array $placeholders = [], - ?Throwable $previous = null, - ): self { - return new self( - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::COOKIE_INVALID, - placeholders: $placeholders, - previous: $previous, - ); - } - - final public static function bodyInvalid( - ?int $code = null, - ?string $message = null, - array $placeholders = [], - ?Throwable $previous = null, - ): self { - return new self( - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::BODY_INVALID, - placeholders: $placeholders, - previous: $previous, - ); - } - - final public static function jsonPayloadEmpty( - ?int $code = null, - ?string $message = null, - array $placeholders = [], - ?Throwable $previous = null, - ): self { - return new self( - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::JSON_PAYLOAD_EMPTY, - placeholders: $placeholders, - previous: $previous, - ); - } - - final public static function jsonPayloadInvalid( - ?int $code = null, - ?string $message = null, - array $placeholders = [], - ?Throwable $previous = null, - ): self { - return new self( - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::JSON_PAYLOAD_INVALID, - placeholders: $placeholders, - previous: $previous, - ); - } - - final public static function jsonPayloadFormInvalid( - ?int $code = null, - ?string $message = null, - array $placeholders = [], - ?Throwable $previous = null, - ): self { - return new self( - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::JSON_PAYLOAD_FORM_INVALID, - placeholders: $placeholders, - previous: $previous, - ); - } - /** * @inheritDoc */ diff --git a/src/Exception/HttpExceptionFactory.php b/src/Exception/HttpExceptionFactory.php new file mode 100644 index 00000000..6ca980b4 --- /dev/null +++ b/src/Exception/HttpExceptionFactory.php @@ -0,0 +1,234 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Exception; + +use Fig\Http\Message\StatusCodeInterface; +use Sunrise\Http\Router\Dictionary\ErrorMessage; +use Throwable; + +/** + * @since 3.0.0 + */ +final class HttpExceptionFactory +{ + final public static function resourceNotFound( + ?int $code = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + code: $code ?? StatusCodeInterface::STATUS_NOT_FOUND, + message: $message ?? ErrorMessage::RESOURCE_NOT_FOUND, + placeholders: $placeholders, + previous: $previous, + ); + } + + final public static function methodNotAllowed( + ?int $code = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + code: $code ?? StatusCodeInterface::STATUS_METHOD_NOT_ALLOWED, + message: $message ?? ErrorMessage::METHOD_NOT_ALLOWED, + placeholders: $placeholders, + previous: $previous, + ); + } + + final public static function mediaTypeNotSupported( + ?int $code = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + code: $code ?? StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE, + message: $message ?? ErrorMessage::MEDIA_TYPE_NOT_SUPPORTED, + placeholders: $placeholders, + previous: $previous, + ); + } + + final public static function pathVariableInvalid( + ?int $code = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::PATH_VARIABLE_INVALID, + placeholders: $placeholders, + previous: $previous, + ); + } + + final public static function queryParamsInvalid( + ?int $code = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::QUERY_PARAMS_INVALID, + placeholders: $placeholders, + previous: $previous, + ); + } + + final public static function queryParamMissed( + ?int $code = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::QUERY_PARAM_MISSED, + placeholders: $placeholders, + previous: $previous, + ); + } + + final public static function queryParamInvalid( + ?int $code = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::QUERY_PARAM_INVALID, + placeholders: $placeholders, + previous: $previous, + ); + } + + final public static function headerMissed( + ?int $code = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::HEADER_MISSED, + placeholders: $placeholders, + previous: $previous, + ); + } + + final public static function headerInvalid( + ?int $code = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::HEADER_INVALID, + placeholders: $placeholders, + previous: $previous, + ); + } + + final public static function cookieMissed( + ?int $code = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::COOKIE_MISSED, + placeholders: $placeholders, + previous: $previous, + ); + } + + final public static function cookieInvalid( + ?int $code = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::COOKIE_INVALID, + placeholders: $placeholders, + previous: $previous, + ); + } + + final public static function bodyInvalid( + ?int $code = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::BODY_INVALID, + placeholders: $placeholders, + previous: $previous, + ); + } + + final public static function jsonPayloadEmpty( + ?int $code = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::JSON_PAYLOAD_EMPTY, + placeholders: $placeholders, + previous: $previous, + ); + } + + final public static function jsonPayloadInvalid( + ?int $code = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::JSON_PAYLOAD_INVALID, + placeholders: $placeholders, + previous: $previous, + ); + } + + final public static function jsonPayloadFormInvalid( + ?int $code = null, + ?string $message = null, + array $placeholders = [], + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + message: $message ?? ErrorMessage::JSON_PAYLOAD_FORM_INVALID, + placeholders: $placeholders, + previous: $previous, + ); + } +} diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index 7837beb2..af391f8c 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -46,9 +46,10 @@ public static function buildRoute(string $route, array $values = []): string $value = self::stringifyValue($values[$variable['name']]); } catch (InvalidArgumentException $e) { throw new InvalidArgumentException(sprintf( - 'The route %s could not be built with an unsupported value for the variable %s.', + 'The route %s could not be built with an invalid value for the variable %s due to: %s', $route, $variable['name'], + $e->getMessage(), ), previous: $e); } @@ -98,7 +99,9 @@ public static function stringifyValue(mixed $value): string } throw new InvalidArgumentException(sprintf( - 'The value "%s" could be converted to a string.', + 'The value of the type %s could not be converted to a string. ' . + 'To resolve this issue, use one of the following value types: ' . + 'string, integer, backed enum or stringable object.', get_debug_type($value), )); } diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 95093bfe..743b907a 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -20,6 +20,7 @@ use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\ServerRequest; use function is_array; @@ -55,17 +56,17 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface private function decodePayload(string $payload): array { if ($payload === '') { - throw HttpException::jsonPayloadEmpty(); + throw HttpExceptionFactory::jsonPayloadEmpty(); } try { $data = json_decode($payload, true, flags: JSON_BIGINT_AS_STRING | JSON_THROW_ON_ERROR); } catch (JsonException $e) { - throw HttpException::jsonPayloadInvalid(previous: $e); + throw HttpExceptionFactory::jsonPayloadInvalid(previous: $e); } if (is_array($data) === false) { - throw HttpException::jsonPayloadFormInvalid(); + throw HttpExceptionFactory::jsonPayloadFormInvalid(); } return $data; diff --git a/src/ParameterResolver.php b/src/ParameterResolver.php index 1934b931..8bd11067 100644 --- a/src/ParameterResolver.php +++ b/src/ParameterResolver.php @@ -77,7 +77,7 @@ private function resolveParameter(ReflectionParameter $parameter): Generator } throw new LogicException(sprintf( - 'The parameter %s could not be resolved because a suitable resolver for it was not found.', + 'The parameter %s could not be resolved.', self::stringifyParameter($parameter), )); } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index e59f82ab..44cfdc4e 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -21,6 +21,7 @@ use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestBody; use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Helper\HydratorHelper; use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ParameterResolver; @@ -73,13 +74,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) try { $argument = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidDataException $e) { - throw HttpException::bodyInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::bodyInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { - throw HttpException::bodyInvalid($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::bodyInvalid($processParams->errorStatusCode, $processParams->errorMessage) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index 46ac7bca..3977767b 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -20,6 +20,7 @@ use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestCookie; use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Helper\HydratorHelper; use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ServerRequest; @@ -67,14 +68,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return yield $parameter->getDefaultValue(); } - throw HttpException::cookieMissed($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::cookieMissed($processParams->errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName); } try { $argument = $this->hydrator->castValue($requestProxy->getCookieParam($processParams->cookieName), Type::fromParameter($parameter), path: [$processParams->cookieName]); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpException::cookieInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::cookieInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } @@ -82,7 +83,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpException::cookieInvalid($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::cookieInvalid($processParams->errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 2a368ea2..d1e04a77 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -20,6 +20,7 @@ use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestHeader; use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Helper\HydratorHelper; use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Hydrator\Exception\InvalidDataException; @@ -65,14 +66,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return yield $parameter->getDefaultValue(); } - throw HttpException::headerMissed($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::headerMissed($processParams->errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName); } try { $argument = $this->hydrator->castValue($context->getHeaderLine($processParams->headerName), Type::fromParameter($parameter), path: [$processParams->headerName]); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpException::headerInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::headerInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } @@ -80,7 +81,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpException::headerInvalid($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::headerInvalid($processParams->errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } diff --git a/src/ParameterResolver/RequestPathVariableParameterResolver.php b/src/ParameterResolver/RequestPathVariableParameterResolver.php index d720a289..ed8b9455 100644 --- a/src/ParameterResolver/RequestPathVariableParameterResolver.php +++ b/src/ParameterResolver/RequestPathVariableParameterResolver.php @@ -20,6 +20,7 @@ use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestPathVariable; use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Helper\HydratorHelper; use Sunrise\Http\Router\Helper\RouteSimplifier; use Sunrise\Http\Router\Helper\ValidatorHelper; @@ -49,7 +50,7 @@ public function __construct( * * @throws LogicException If the resolver is used incorrectly. * - * @throws HttpException If the request's path variable isn't valid. + * @throws HttpException If a path variable isn't valid. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -82,7 +83,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } throw new LogicException(sprintf( - 'The parameter %1$s expects the value of the variable %3$s from the route %2$s ' . + 'The parameter %1$s expects a value of the variable %3$s from the route %2$s ' . 'which is not present in the request, most likely, because the variable is optional. ' . 'To resolve this issue, assign the default value to the parameter.', ParameterResolver::stringifyParameter($parameter), @@ -94,7 +95,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) try { $argument = $this->hydrator->castValue($route->getAttribute($variableName), Type::fromParameter($parameter), path: [$variableName]); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpException::pathVariableInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::pathVariableInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) ->addMessagePlaceholder('{{ variable_name }}', $variableName) ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); @@ -103,7 +104,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpException::pathVariableInvalid($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::pathVariableInvalid($processParams->errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ variable_name }}', $variableName) ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); diff --git a/src/ParameterResolver/RequestQueryParamParameterResolver.php b/src/ParameterResolver/RequestQueryParamParameterResolver.php index ff9c9155..a4cd2e78 100644 --- a/src/ParameterResolver/RequestQueryParamParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamParameterResolver.php @@ -20,6 +20,7 @@ use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestQueryParam; use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Helper\HydratorHelper; use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ServerRequest; @@ -67,14 +68,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return yield $parameter->getDefaultValue(); } - throw HttpException::queryParamMissed($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::queryParamMissed($processParams->errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName); } try { $argument = $this->hydrator->castValue($requestProxy->getQueryParam($processParams->paramName), Type::fromParameter($parameter), path: [$processParams->paramName]); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpException::queryParamInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::queryParamInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } @@ -82,7 +83,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpException::queryParamInvalid($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::queryParamInvalid($processParams->errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } diff --git a/src/ParameterResolver/RequestQueryParamsParameterResolver.php b/src/ParameterResolver/RequestQueryParamsParameterResolver.php index 8dbe5bb5..d58c61d1 100644 --- a/src/ParameterResolver/RequestQueryParamsParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamsParameterResolver.php @@ -21,6 +21,7 @@ use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestQueryParams; use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Helper\HydratorHelper; use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ParameterResolver; @@ -46,7 +47,7 @@ public function __construct( * * @throws LogicException If the resolver is used incorrectly or if an object isn't valid. * - * @throws HttpException If the request's query parameters isn't valid. + * @throws HttpException If the request's query parameters aren't valid. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -73,13 +74,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) try { $argument = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { - throw HttpException::queryParamsInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::queryParamsInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { - throw HttpException::queryParamsInvalid($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::queryParamsInvalid($processParams->errorStatusCode, $processParams->errorMessage) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/RequestHandlerResolver.php b/src/RequestHandlerResolver.php index e45a539c..08d53032 100644 --- a/src/RequestHandlerResolver.php +++ b/src/RequestHandlerResolver.php @@ -28,7 +28,6 @@ use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use function class_exists; -use function get_debug_type; use function is_array; use function is_callable; use function is_string; @@ -81,10 +80,7 @@ public function resolveRequestHandler(mixed $requestHandler): RequestHandlerInte return $requestHandler; } - throw new InvalidArgumentException(sprintf( - 'The request handler "%s" could not be resolved.', - get_debug_type($requestHandler), - )); + throw new InvalidArgumentException('Unsupported request handler.'); } /** @@ -117,10 +113,7 @@ public function resolveMiddleware(mixed $middleware): MiddlewareInterface return $middleware; } - throw new InvalidArgumentException(sprintf( - 'The middleware "%s" could not be resolved.', - get_debug_type($middleware), - )); + throw new InvalidArgumentException('Unsupported middleware.'); } /** diff --git a/src/ResponseResolver.php b/src/ResponseResolver.php index 68a1e2f0..99d6a564 100644 --- a/src/ResponseResolver.php +++ b/src/ResponseResolver.php @@ -23,7 +23,6 @@ use Sunrise\Http\Router\Annotation\ResponseStatus; use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; -use function get_debug_type; use function sprintf; /** @@ -57,9 +56,8 @@ public function resolveResponse( } throw new LogicException(sprintf( - 'The responder %s returned the unsupported response "%s".', + 'The responder %s returned an unsupported response.', self::stringifyResponder($responder), - get_debug_type($response), )); } diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index df94c24d..2bb47455 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -25,7 +25,6 @@ use Sunrise\Http\Router\Annotation\JsonResponse; use Sunrise\Http\Router\ResponseResolver; -use function get_debug_type; use function json_encode; use function sprintf; @@ -36,8 +35,14 @@ */ final class JsonResponseResolver implements ResponseResolverInterface { - public function __construct(private readonly ResponseFactoryInterface $responseFactory) - { + public const DEFAULT_ENCODING_FLAGS = 0; + public const DEFAULT_ENCODING_DEPTH = 512; + + public function __construct( + private readonly ResponseFactoryInterface $responseFactory, + private readonly ?int $defaultEncodingFlags = null, + private readonly ?int $defaultEncodingDepth = null, + ) { } /** @@ -54,16 +59,18 @@ public function resolveResponse( return null; } - $jsonResponseParams = $annotations[0]->newInstance(); + $processParams = $annotations[0]->newInstance(); + + $encodingFlags = $processParams->encodingFlags ?? $this->defaultEncodingFlags ?? self::DEFAULT_ENCODING_FLAGS; + $encodingDepth = $processParams->encodingDepth ?? $this->defaultEncodingDepth ?? self::DEFAULT_ENCODING_DEPTH; try { /** @psalm-suppress ArgumentTypeCoercion */ - $payload = json_encode($response, $jsonResponseParams->flags | JSON_THROW_ON_ERROR, $jsonResponseParams->depth); + $payload = json_encode($response, $encodingFlags | JSON_THROW_ON_ERROR, $encodingDepth); } catch (JsonException $e) { throw new LogicException(sprintf( - 'The responder %s returned the response "%s" that could not be encoded to JSON due to: %s', + 'The responder %s returned a response that could not be encoded to JSON due to: %s', ResponseResolver::stringifyResponder($responder), - get_debug_type($response), $e->getMessage(), ), previous: $e); } diff --git a/src/ResponseResolver/StringableResponseResolver.php b/src/ResponseResolver/StringableResponseResolver.php deleted file mode 100644 index 83ec2103..00000000 --- a/src/ResponseResolver/StringableResponseResolver.php +++ /dev/null @@ -1,66 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ResponseResolver; - -use Fig\Http\Message\StatusCodeInterface; -use LogicException; -use Psr\Http\Message\ResponseFactoryInterface; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use ReflectionFunction; -use ReflectionMethod; -use Stringable; -use Sunrise\Http\Router\Annotation\StringableResponse; -use Sunrise\Http\Router\ResponseResolver; - -use function get_debug_type; -use function is_string; -use function sprintf; - -/** - * @since 3.0.0 - */ -final class StringableResponseResolver implements ResponseResolverInterface -{ - public function __construct(private readonly ResponseFactoryInterface $responseFactory) - { - } - - /** - * @throws LogicException If the resolver is used incorrectly. - */ - public function resolveResponse( - mixed $response, - ReflectionMethod|ReflectionFunction $responder, - ServerRequestInterface $request, - ): ?ResponseInterface { - if ($responder->getAttributes(StringableResponse::class) === []) { - return null; - } - - if (!is_string($response) && !($response instanceof Stringable)) { - throw new LogicException(sprintf( - 'The responder %s returned the response "%s" that cannot be converted to a string.', - ResponseResolver::stringifyResponder($responder), - get_debug_type($response), - )); - } - - $stringableResponse = $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK); - - $stringableResponse->getBody()->write((string) $response); - - return $stringableResponse; - } -} diff --git a/src/Router.php b/src/Router.php index 291047da..83f0fad4 100644 --- a/src/Router.php +++ b/src/Router.php @@ -19,6 +19,7 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Helper\RouteBuilder; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Helper\RouteMatcher; @@ -141,7 +142,7 @@ public function match(ServerRequestInterface $request): Route } if (!ServerRequest::create($request)->clientProducesMediaType(...$route->getConsumedMediaTypes())) { - throw HttpException::mediaTypeNotSupported() + throw HttpExceptionFactory::mediaTypeNotSupported() ->addMessagePlaceholder('{{ media_type }}', ServerRequest::create($request)->getClientProducedMediaType()) ->addHeaderField('Accept', ...$route->getConsumedMediaTypes()); } @@ -150,12 +151,12 @@ public function match(ServerRequestInterface $request): Route } if (!empty($allowedMethods)) { - throw HttpException::methodNotAllowed() + throw HttpExceptionFactory::methodNotAllowed() ->addMessagePlaceholder('{{ method }}', $request->getMethod()) ->addHeaderField('Allow', ...array_keys($allowedMethods)); } - throw HttpException::resourceNotFound() + throw HttpExceptionFactory::resourceNotFound() ->addMessagePlaceholder('{{ resource }}', $requestPath); } From 3f4ca182e48e43793d844f2351e5267cbc97a5f3 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Tue, 5 Mar 2024 03:53:45 +0100 Subject: [PATCH 113/180] v3 --- src/Exception/HttpExceptionFactory.php | 30 +++++++++++++------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/src/Exception/HttpExceptionFactory.php b/src/Exception/HttpExceptionFactory.php index 6ca980b4..9afb8cd4 100644 --- a/src/Exception/HttpExceptionFactory.php +++ b/src/Exception/HttpExceptionFactory.php @@ -22,7 +22,7 @@ */ final class HttpExceptionFactory { - final public static function resourceNotFound( + public static function resourceNotFound( ?int $code = null, ?string $message = null, array $placeholders = [], @@ -36,7 +36,7 @@ final public static function resourceNotFound( ); } - final public static function methodNotAllowed( + public static function methodNotAllowed( ?int $code = null, ?string $message = null, array $placeholders = [], @@ -50,7 +50,7 @@ final public static function methodNotAllowed( ); } - final public static function mediaTypeNotSupported( + public static function mediaTypeNotSupported( ?int $code = null, ?string $message = null, array $placeholders = [], @@ -64,7 +64,7 @@ final public static function mediaTypeNotSupported( ); } - final public static function pathVariableInvalid( + public static function pathVariableInvalid( ?int $code = null, ?string $message = null, array $placeholders = [], @@ -78,7 +78,7 @@ final public static function pathVariableInvalid( ); } - final public static function queryParamsInvalid( + public static function queryParamsInvalid( ?int $code = null, ?string $message = null, array $placeholders = [], @@ -92,7 +92,7 @@ final public static function queryParamsInvalid( ); } - final public static function queryParamMissed( + public static function queryParamMissed( ?int $code = null, ?string $message = null, array $placeholders = [], @@ -106,7 +106,7 @@ final public static function queryParamMissed( ); } - final public static function queryParamInvalid( + public static function queryParamInvalid( ?int $code = null, ?string $message = null, array $placeholders = [], @@ -120,7 +120,7 @@ final public static function queryParamInvalid( ); } - final public static function headerMissed( + public static function headerMissed( ?int $code = null, ?string $message = null, array $placeholders = [], @@ -134,7 +134,7 @@ final public static function headerMissed( ); } - final public static function headerInvalid( + public static function headerInvalid( ?int $code = null, ?string $message = null, array $placeholders = [], @@ -148,7 +148,7 @@ final public static function headerInvalid( ); } - final public static function cookieMissed( + public static function cookieMissed( ?int $code = null, ?string $message = null, array $placeholders = [], @@ -162,7 +162,7 @@ final public static function cookieMissed( ); } - final public static function cookieInvalid( + public static function cookieInvalid( ?int $code = null, ?string $message = null, array $placeholders = [], @@ -176,7 +176,7 @@ final public static function cookieInvalid( ); } - final public static function bodyInvalid( + public static function bodyInvalid( ?int $code = null, ?string $message = null, array $placeholders = [], @@ -190,7 +190,7 @@ final public static function bodyInvalid( ); } - final public static function jsonPayloadEmpty( + public static function jsonPayloadEmpty( ?int $code = null, ?string $message = null, array $placeholders = [], @@ -204,7 +204,7 @@ final public static function jsonPayloadEmpty( ); } - final public static function jsonPayloadInvalid( + public static function jsonPayloadInvalid( ?int $code = null, ?string $message = null, array $placeholders = [], @@ -218,7 +218,7 @@ final public static function jsonPayloadInvalid( ); } - final public static function jsonPayloadFormInvalid( + public static function jsonPayloadFormInvalid( ?int $code = null, ?string $message = null, array $placeholders = [], From faf3640d03134f9f8fe6e0956de6f08b185dbb0f Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Wed, 6 Mar 2024 01:09:13 +0100 Subject: [PATCH 114/180] v3 --- src/Annotation/Route.php | 2 +- src/Entity/Language/ClientLanguage.php | 1 + src/Exception/HttpException.php | 2 - src/Exception/HttpExceptionInterface.php | 2 - src/Helper/HeaderParser.php | 76 ----------------- src/Loader/DescriptorLoader.php | 12 +-- src/Middleware/CallableMiddleware.php | 2 + .../JsonPayloadDecodingMiddleware.php | 4 +- .../PayloadMediaTypeNegotiationMiddleware.php | 46 +++++++++++ src/ParameterResolver.php | 2 +- .../RequestBodyParameterResolver.php | 7 +- .../RequestCookieParameterResolver.php | 19 +++-- .../RequestHeaderParameterResolver.php | 15 +++- .../RequestPathVariableParameterResolver.php | 16 ++-- .../RequestQueryParamParameterResolver.php | 19 +++-- .../RequestQueryParamsParameterResolver.php | 7 +- .../RequestStreamParameterResolver.php | 46 ----------- .../RequestUriParameterResolver.php | 46 ----------- src/RequestHandler/CallableRequestHandler.php | 2 + .../QueueableRequestHandler.php | 2 +- src/RequestHandlerResolver.php | 7 +- src/ResponseResolver.php | 2 +- src/ResponseResolver/JsonResponseResolver.php | 6 +- src/Route.php | 10 +++ src/Router.php | 45 +++-------- src/ServerRequest.php | 81 ++++++++++++++++--- 26 files changed, 221 insertions(+), 258 deletions(-) create mode 100644 src/Middleware/PayloadMediaTypeNegotiationMiddleware.php delete mode 100644 src/ParameterResolver/RequestStreamParameterResolver.php delete mode 100644 src/ParameterResolver/RequestUriParameterResolver.php diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index 378598a3..e407c05f 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -60,7 +60,7 @@ final class Route public int $priority = 0; public function __construct( - public string $name, + public readonly string $name, public string $path, ) { } diff --git a/src/Entity/Language/ClientLanguage.php b/src/Entity/Language/ClientLanguage.php index 98bc4ff9..df0ed9c0 100644 --- a/src/Entity/Language/ClientLanguage.php +++ b/src/Entity/Language/ClientLanguage.php @@ -21,6 +21,7 @@ final class ClientLanguage implements LanguageInterface public function __construct( private readonly string $code, // One of the Accept-Language header's identifiers + // https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.5 private readonly string $locale, /** @var array */ private readonly array $parameters, diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index 4b2ac64f..0894b6cc 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -32,8 +32,6 @@ class HttpException extends RuntimeException implements HttpExceptionInterface private string $messageTemplate; /** - * Placeholders for interpolating the exception's non-interpolated message. - * * @var array */ private array $messagePlaceholders; diff --git a/src/Exception/HttpExceptionInterface.php b/src/Exception/HttpExceptionInterface.php index 67fd02cb..f78c9220 100644 --- a/src/Exception/HttpExceptionInterface.php +++ b/src/Exception/HttpExceptionInterface.php @@ -26,8 +26,6 @@ interface HttpExceptionInterface extends ExceptionInterface public function getMessageTemplate(): string; /** - * Returns placeholders for interpolating the exception's non-interpolated message. - * * @return array */ public function getMessagePlaceholders(): array; diff --git a/src/Helper/HeaderParser.php b/src/Helper/HeaderParser.php index 12b31692..da6d241a 100644 --- a/src/Helper/HeaderParser.php +++ b/src/Helper/HeaderParser.php @@ -13,91 +13,15 @@ namespace Sunrise\Http\Router\Helper; -use Generator; use Sunrise\Http\Router\Dictionary\Charset; -use Sunrise\Http\Router\Entity\Language\ClientLanguage; -use Sunrise\Http\Router\Entity\MediaType\ClientMediaType; -use function current; -use function preg_match; use function trim; -use function usort; /** * @since 3.0.0 */ final class HeaderParser { - public static function parseContentTypeHeader(string $header): ?ClientMediaType - { - $values = self::parseHeader($header); - if ($values === []) { - return null; - } - - [$identifier, $parameters] = current($values); - - if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier, $matches)) { - return new ClientMediaType( - type: $matches[1], - subtype: $matches[2], - parameters: $parameters, - ); - } - - return null; - } - - /** - * @return Generator, ClientMediaType> - */ - public static function parseAcceptHeader(string $header): Generator - { - $values = self::parseHeader($header); - if ($values === []) { - return; - } - - usort($values, static fn(array $a, array $b): int => ( - (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') - )); - - foreach ($values as $index => [$identifier, $parameters]) { - if (preg_match('|^([^/]+)/([^/]+)$|', $identifier, $matches)) { - yield $index => new ClientMediaType( - type: $matches[1], - subtype: $matches[2], - parameters: $parameters, - ); - } - } - } - - /** - * @return Generator, ClientLanguage> - */ - public static function parseAcceptLanguageHeader(string $header): Generator - { - $values = self::parseHeader($header); - if ($values === []) { - return; - } - - usort($values, static fn(array $a, array $b): int => ( - (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') - )); - - foreach ($values as $index => [$identifier, $parameters]) { - if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches)) { - yield $index => new ClientLanguage( - code: $matches[1], - locale: $identifier, - parameters: $parameters, - ); - } - } - } - /** * @return array, array{0: string, 1: array}> */ diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index cbd9b6b4..2f2ce3fa 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Loader; use Generator; -use LogicException; +use InvalidArgumentException; use Psr\Http\Server\RequestHandlerInterface; use Psr\SimpleCache\CacheException; use Psr\SimpleCache\CacheInterface; @@ -65,7 +65,7 @@ public function __construct( /** * @inheritDoc * - * @throws LogicException If one of the resources isn't supported. + * @throws InvalidArgumentException If one of the resources isn't supported. * * @throws CacheException If something went wrong while working with the cache. */ @@ -95,13 +95,13 @@ public function load(): Generator /** * @return list * - * @throws LogicException If one of the resources isn't supported. + * @throws InvalidArgumentException If one of the resources isn't supported. * * @throws CacheException If something went wrong while working with the cache. */ private function getDescriptors(): array { - /** @var list|null $descriptors */ + /** @var null|list $descriptors */ $descriptors = $this->cache?->get($this->cacheKey); if (isset($descriptors)) { return $descriptors; @@ -124,7 +124,7 @@ private function getDescriptors(): array /** * @return Generator * - * @throws LogicException If the resource isn't supported. + * @throws InvalidArgumentException If the resource isn't supported. */ private function getResourceDescriptors(string $resource): Generator { @@ -152,7 +152,7 @@ private function getResourceDescriptors(string $resource): Generator return; } - throw new LogicException(sprintf( + throw new InvalidArgumentException(sprintf( 'The loader %s only accepts directory, file or class names; ' . 'however, the resource %s is not one of them.', __CLASS__, diff --git a/src/Middleware/CallableMiddleware.php b/src/Middleware/CallableMiddleware.php index 2311d771..1a68543b 100644 --- a/src/Middleware/CallableMiddleware.php +++ b/src/Middleware/CallableMiddleware.php @@ -27,6 +27,8 @@ final class CallableMiddleware implements MiddlewareInterface { /** * @var T + * + * @readonly */ private $callback; diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 743b907a..46a0e43d 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -38,6 +38,8 @@ final class JsonPayloadDecodingMiddleware implements MiddlewareInterface { /** * @inheritDoc + * + * @throws HttpException If the request's payload couldn't be decoded. */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { @@ -51,7 +53,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface /** * @return array * - * @throws HttpException If the JSON payload couldn't be decoded. + * @throws HttpException If the payload couldn't be decoded. */ private function decodePayload(string $payload): array { diff --git a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php new file mode 100644 index 00000000..625b6c5a --- /dev/null +++ b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php @@ -0,0 +1,46 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Middleware; + +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Exception\HttpExceptionFactory; +use Sunrise\Http\Router\ServerRequest; + +/** + * @since 3.0.0 + */ +final class PayloadMediaTypeNegotiationMiddleware implements MiddlewareInterface +{ + /** + * @inheritDoc + * + * @throws HttpException If the request's payload media type isn't supported by the server. + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + $serverRequest = ServerRequest::create($request); + $serverConsumedMediaTypes = $serverRequest->getRoute()->getConsumedMediaTypes(); + if (! $serverRequest->clientProducesMediaType(...$serverConsumedMediaTypes)) { + throw HttpExceptionFactory::mediaTypeNotSupported() + ->addMessagePlaceholder('{{ media_type }}', $serverRequest->getClientProducedMediaType()) + ->addHeaderField('Accept', ...$serverConsumedMediaTypes); + } + + return $handler->handle($request); + } +} diff --git a/src/ParameterResolver.php b/src/ParameterResolver.php index 8bd11067..b9ae289c 100644 --- a/src/ParameterResolver.php +++ b/src/ParameterResolver.php @@ -77,7 +77,7 @@ private function resolveParameter(ReflectionParameter $parameter): Generator } throw new LogicException(sprintf( - 'The parameter %s could not be resolved.', + 'The parameter %s could not be resolved because it is not supported.', self::stringifyParameter($parameter), )); } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 44cfdc4e..eaecf7c3 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -39,6 +39,7 @@ final class RequestBodyParameterResolver implements ParameterResolverInterface public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, + private readonly ?int $defaultErrorStatusCode = null, ) { } @@ -71,16 +72,18 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $processParams = $annotations[0]->newInstance(); + $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; + try { $argument = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidDataException $e) { - throw HttpExceptionFactory::bodyInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::bodyInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { - throw HttpExceptionFactory::bodyInvalid($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::bodyInvalid($errorStatusCode, $processParams->errorMessage) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index 3977767b..a485d5c7 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -38,6 +38,7 @@ final class RequestCookieParameterResolver implements ParameterResolverInterface public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, + private readonly ?int $defaultErrorStatusCode = null, ) { } @@ -60,22 +61,28 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) throw new LogicException('At this level of the application, any operations with the request are not possible.'); } - $requestProxy = ServerRequest::create($context); + $request = ServerRequest::create($context); $processParams = $annotations[0]->newInstance(); - if (!$requestProxy->hasCookieParam($processParams->cookieName)) { + $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; + + if (!$request->hasCookieParam($processParams->cookieName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } - throw HttpExceptionFactory::cookieMissed($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::cookieMissed($errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName); } try { - $argument = $this->hydrator->castValue($requestProxy->getCookieParam($processParams->cookieName), Type::fromParameter($parameter), path: [$processParams->cookieName]); + $argument = $this->hydrator->castValue( + $request->getCookieParam($processParams->cookieName), + Type::fromParameter($parameter), + path: [$processParams->cookieName], + ); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpExceptionFactory::cookieInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::cookieInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } @@ -83,7 +90,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpExceptionFactory::cookieInvalid($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::cookieInvalid($errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index d1e04a77..75a57f97 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -37,6 +37,7 @@ final class RequestHeaderParameterResolver implements ParameterResolverInterface public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, + private readonly ?int $defaultErrorStatusCode = null, ) { } @@ -61,19 +62,25 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $processParams = $annotations[0]->newInstance(); + $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; + if (!$context->hasHeader($processParams->headerName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } - throw HttpExceptionFactory::headerMissed($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::headerMissed($errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName); } try { - $argument = $this->hydrator->castValue($context->getHeaderLine($processParams->headerName), Type::fromParameter($parameter), path: [$processParams->headerName]); + $argument = $this->hydrator->castValue( + $context->getHeaderLine($processParams->headerName), + Type::fromParameter($parameter), + path: [$processParams->headerName], + ); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpExceptionFactory::headerInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::headerInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } @@ -81,7 +88,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpExceptionFactory::headerInvalid($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::headerInvalid($errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } diff --git a/src/ParameterResolver/RequestPathVariableParameterResolver.php b/src/ParameterResolver/RequestPathVariableParameterResolver.php index ed8b9455..de8e1c14 100644 --- a/src/ParameterResolver/RequestPathVariableParameterResolver.php +++ b/src/ParameterResolver/RequestPathVariableParameterResolver.php @@ -42,6 +42,7 @@ final class RequestPathVariableParameterResolver implements ParameterResolverInt public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, + private readonly ?int $defaultErrorStatusCode = null, ) { } @@ -76,6 +77,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $processParams = $annotations[0]->newInstance(); $variableName = $processParams->variableName ?? $parameter->getName(); + $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; if (!$route->hasAttribute($variableName)) { if ($parameter->isDefaultValueAvailable()) { @@ -83,19 +85,23 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } throw new LogicException(sprintf( - 'The parameter %1$s expects a value of the variable %3$s from the route %2$s ' . + 'The parameter %s expects a value of the variable %s from the route %s ' . 'which is not present in the request, most likely, because the variable is optional. ' . 'To resolve this issue, assign the default value to the parameter.', ParameterResolver::stringifyParameter($parameter), - $route->getName(), $variableName, + $route->getName(), )); } try { - $argument = $this->hydrator->castValue($route->getAttribute($variableName), Type::fromParameter($parameter), path: [$variableName]); + $argument = $this->hydrator->castValue( + $route->getAttribute($variableName), + Type::fromParameter($parameter), + path: [$variableName], + ); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpExceptionFactory::pathVariableInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::pathVariableInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) ->addMessagePlaceholder('{{ variable_name }}', $variableName) ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); @@ -104,7 +110,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpExceptionFactory::pathVariableInvalid($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::pathVariableInvalid($errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ variable_name }}', $variableName) ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); diff --git a/src/ParameterResolver/RequestQueryParamParameterResolver.php b/src/ParameterResolver/RequestQueryParamParameterResolver.php index a4cd2e78..2c6d79fb 100644 --- a/src/ParameterResolver/RequestQueryParamParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamParameterResolver.php @@ -38,6 +38,7 @@ final class RequestQueryParamParameterResolver implements ParameterResolverInter public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, + private readonly ?int $defaultErrorStatusCode = null, ) { } @@ -60,22 +61,28 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) throw new LogicException('At this level of the application, any operations with the request are not possible.'); } - $requestProxy = ServerRequest::create($context); + $request = ServerRequest::create($context); $processParams = $annotations[0]->newInstance(); - if (!$requestProxy->hasQueryParam($processParams->paramName)) { + $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; + + if (!$request->hasQueryParam($processParams->paramName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } - throw HttpExceptionFactory::queryParamMissed($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::queryParamMissed($errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName); } try { - $argument = $this->hydrator->castValue($requestProxy->getQueryParam($processParams->paramName), Type::fromParameter($parameter), path: [$processParams->paramName]); + $argument = $this->hydrator->castValue( + $request->getQueryParam($processParams->paramName), + Type::fromParameter($parameter), + path: [$processParams->paramName], + ); } catch (InvalidDataException|InvalidValueException $e) { - throw HttpExceptionFactory::queryParamInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::queryParamInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } @@ -83,7 +90,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpExceptionFactory::queryParamInvalid($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::queryParamInvalid($errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } diff --git a/src/ParameterResolver/RequestQueryParamsParameterResolver.php b/src/ParameterResolver/RequestQueryParamsParameterResolver.php index d58c61d1..f2341339 100644 --- a/src/ParameterResolver/RequestQueryParamsParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamsParameterResolver.php @@ -39,6 +39,7 @@ final class RequestQueryParamsParameterResolver implements ParameterResolverInte public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, + private readonly ?int $defaultErrorStatusCode = null, ) { } @@ -71,16 +72,18 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $processParams = $annotations[0]->newInstance(); + $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; + try { $argument = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { - throw HttpExceptionFactory::queryParamsInvalid($processParams->errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::queryParamsInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); } if (isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { - throw HttpExceptionFactory::queryParamsInvalid($processParams->errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::queryParamsInvalid($errorStatusCode, $processParams->errorMessage) ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); } } diff --git a/src/ParameterResolver/RequestStreamParameterResolver.php b/src/ParameterResolver/RequestStreamParameterResolver.php deleted file mode 100644 index 806d603f..00000000 --- a/src/ParameterResolver/RequestStreamParameterResolver.php +++ /dev/null @@ -1,46 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ParameterResolver; - -use Generator; -use LogicException; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Message\StreamInterface; -use ReflectionNamedType; -use ReflectionParameter; - -/** - * @since 3.0.0 - */ -final class RequestStreamParameterResolver implements ParameterResolverInterface -{ - /** - * @inheritDoc - * - * @throws LogicException If the resolver is used incorrectly. - */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator - { - $type = $parameter->getType(); - if (! $type instanceof ReflectionNamedType || $type->getName() !== StreamInterface::class) { - return; - } - - if (! $context instanceof ServerRequestInterface) { - throw new LogicException('At this level of the application, any operations with the request are not possible.'); - } - - yield $context->getBody(); - } -} diff --git a/src/ParameterResolver/RequestUriParameterResolver.php b/src/ParameterResolver/RequestUriParameterResolver.php deleted file mode 100644 index 1d92265c..00000000 --- a/src/ParameterResolver/RequestUriParameterResolver.php +++ /dev/null @@ -1,46 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ParameterResolver; - -use Generator; -use LogicException; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Message\UriInterface; -use ReflectionNamedType; -use ReflectionParameter; - -/** - * @since 3.0.0 - */ -final class RequestUriParameterResolver implements ParameterResolverInterface -{ - /** - * @inheritDoc - * - * @throws LogicException If the resolver is used incorrectly. - */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator - { - $type = $parameter->getType(); - if (! $type instanceof ReflectionNamedType || $type->getName() !== UriInterface::class) { - return; - } - - if (! $context instanceof ServerRequestInterface) { - throw new LogicException('At this level of the application, any operations with the request are not possible.'); - } - - yield $context->getUri(); - } -} diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index 785d3730..e603c119 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -24,6 +24,8 @@ final class CallableRequestHandler implements RequestHandlerInterface { /** * @var T + * + * @readonly */ private $callback; diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index 9735bdbe..c71a9057 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -34,6 +34,6 @@ public function __construct( */ public function handle(ServerRequestInterface $request): ResponseInterface { - return $this->isEmpty() ? $this->endpoint->handle($request) : ($clone = clone $this)->dequeue()->process($request, $clone); + return ! $this->isEmpty() ? ($clone = clone $this)->dequeue()->process($request, $clone) : $this->endpoint->handle($request); } } diff --git a/src/RequestHandlerResolver.php b/src/RequestHandlerResolver.php index 08d53032..4253c23a 100644 --- a/src/RequestHandlerResolver.php +++ b/src/RequestHandlerResolver.php @@ -15,7 +15,6 @@ use Closure; use InvalidArgumentException; -use LogicException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; @@ -123,7 +122,7 @@ public function resolveMiddleware(mixed $middleware): MiddlewareInterface * * @template T of object * - * @throws LogicException If the class couldn't be resolved. + * @throws InvalidArgumentException If the class couldn't be resolved. */ private function resolveClass(string $className): object { @@ -133,12 +132,12 @@ private function resolveClass(string $className): object } if (!class_exists($className)) { - throw new LogicException(sprintf('The class %s does not exist and cannot be resolved.', $className)); + throw new InvalidArgumentException(sprintf('The class %s does not exist and cannot be resolved.', $className)); } $classReflection = new ReflectionClass($className); if (!$classReflection->isInstantiable()) { - throw new LogicException(sprintf('The class %s is not instantiable and cannot be resolved.', $className)); + throw new InvalidArgumentException(sprintf('The class %s is not instantiable and cannot be resolved.', $className)); } $arguments = []; diff --git a/src/ResponseResolver.php b/src/ResponseResolver.php index 99d6a564..b62116b5 100644 --- a/src/ResponseResolver.php +++ b/src/ResponseResolver.php @@ -56,7 +56,7 @@ public function resolveResponse( } throw new LogicException(sprintf( - 'The responder %s returned an unsupported response.', + 'The responder %s returned an unsupported response that could not be resolved.', self::stringifyResponder($responder), )); } diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index 2bb47455..f7bd770f 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -14,8 +14,8 @@ namespace Sunrise\Http\Router\ResponseResolver; use Fig\Http\Message\StatusCodeInterface; +use InvalidArgumentException; use JsonException; -use LogicException; use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; @@ -46,7 +46,7 @@ public function __construct( } /** - * @throws LogicException If the resolver is used incorrectly. + * @throws InvalidArgumentException If the resolver is used incorrectly. */ public function resolveResponse( mixed $response, @@ -68,7 +68,7 @@ public function resolveResponse( /** @psalm-suppress ArgumentTypeCoercion */ $payload = json_encode($response, $encodingFlags | JSON_THROW_ON_ERROR, $encodingDepth); } catch (JsonException $e) { - throw new LogicException(sprintf( + throw new InvalidArgumentException(sprintf( 'The responder %s returned a response that could not be encoded to JSON due to: %s', ResponseResolver::stringifyResponder($responder), $e->getMessage(), diff --git a/src/Route.php b/src/Route.php index c56c7cad..92627564 100644 --- a/src/Route.php +++ b/src/Route.php @@ -16,6 +16,7 @@ use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; use function array_key_exists; +use function in_array; final class Route { @@ -78,6 +79,15 @@ public function getMethods(): array return $this->methods; } + public function allowsMethod(string $method): bool + { + if ($this->methods === []) { + return true; + } + + return in_array($method, $this->methods, true); + } + /** * @return array */ diff --git a/src/Router.php b/src/Router.php index 83f0fad4..2a342b03 100644 --- a/src/Router.php +++ b/src/Router.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router; use InvalidArgumentException; -use LogicException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; @@ -31,7 +30,6 @@ use function array_flip; use function array_keys; -use function in_array; use function rawurldecode; use function sprintf; @@ -136,17 +134,11 @@ public function match(ServerRequestInterface $request): Route continue; } - if (!$this->routeSupportsMethod($route, $request->getMethod())) { + if (!$route->allowsMethod($request->getMethod())) { $allowedMethods += array_flip($route->getMethods()); continue; } - if (!ServerRequest::create($request)->clientProducesMediaType(...$route->getConsumedMediaTypes())) { - throw HttpExceptionFactory::mediaTypeNotSupported() - ->addMessagePlaceholder('{{ media_type }}', ServerRequest::create($request)->getClientProducedMediaType()) - ->addHeaderField('Accept', ...$route->getConsumedMediaTypes()); - } - return $route->withAddedAttributes($matches); } @@ -165,9 +157,7 @@ public function match(ServerRequestInterface $request): Route */ public function run(ServerRequestInterface $request): ResponseInterface { - return $this->getRouterRequestHandler()->handle( - $request->withAttribute('@router', $this) - ); + return $this->getRouterRequestHandler()->handle($request); } /** @@ -190,6 +180,8 @@ public function runRoute(Route|string $route, ServerRequestInterface $request): /** * @throws InvalidArgumentException + * + * @since 3.0.0 */ public function buildRoute(Route|string $route, array $values = []): string { @@ -204,6 +196,8 @@ public function buildRoute(Route|string $route, array $values = []): string * @return non-empty-string * * @throws InvalidArgumentException + * + * @since 3.0.0 */ public function compileRoute(Route|string $route): string { @@ -215,24 +209,7 @@ public function compileRoute(Route|string $route): string } /** - * @since 3.0.0 - */ - public function routeSupportsMethod(Route|string $route, string $method): bool - { - if (! $route instanceof Route) { - $route = $this->getRoute($route); - } - - $methods = $route->getMethods(); - if ($methods === []) { - return true; - } - - return in_array($method, $methods, true); - } - - /** - * @throws LogicException If the route is associated with an unsupported request handler or middleware. + * @throws InvalidArgumentException If the route is associated with an unsupported request handler or middleware. * * @since 3.0.0 */ @@ -250,7 +227,7 @@ public function getRouteRequestHandler(Route|string $route): RequestHandlerInter try { $this->routeRequestHandlers[$routeName] = $this->requestHandlerResolver->resolveRequestHandler($route->getRequestHandler()); } catch (InvalidArgumentException $e) { - throw new LogicException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s refers to an unsupported request handler.', $routeName, ), previous: $e); @@ -267,7 +244,7 @@ public function getRouteRequestHandler(Route|string $route): RequestHandlerInter try { $middleware = $this->requestHandlerResolver->resolveMiddleware($middleware); } catch (InvalidArgumentException $e) { - throw new LogicException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s refers to an unsupported middleware.', $routeName, ), previous: $e); @@ -280,7 +257,7 @@ public function getRouteRequestHandler(Route|string $route): RequestHandlerInter } /** - * @throws LogicException If the router is associated with an unsupported middleware. + * @throws InvalidArgumentException If the router is associated with an unsupported middleware. * * @since 3.0.0 */ @@ -306,7 +283,7 @@ public function getRouterRequestHandler(): RequestHandlerInterface try { $middleware = $this->requestHandlerResolver->resolveMiddleware($middleware); } catch (InvalidArgumentException $e) { - throw new LogicException('The router refers to an unsupported middleware.', previous: $e); + throw new InvalidArgumentException('The router refers to an unsupported middleware.', previous: $e); } $this->routerRequestHandler->enqueue($middleware); diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 3edf1183..be0a5a4a 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router; use Generator; +use LogicException; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\StreamInterface; use Psr\Http\Message\UriInterface; @@ -25,6 +26,9 @@ use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; use Sunrise\Http\Router\Helper\HeaderParser; +use function current; +use function preg_match; +use function usort; /** * @since 3.0.0 @@ -45,11 +49,36 @@ public function getOriginalRequest(): ServerRequestInterface return $this->request; } + public function getRoute(): Route + { + /** @var Route|null $route */ + $route = $this->getAttribute('@route'); + if (! $route instanceof Route) { + throw new LogicException('At this level of the application, the request does not contain a route.'); + } + + return $route; + } + public function getClientProducedMediaType(): ?ClientMediaType { - return HeaderParser::parseContentTypeHeader( - $this->request->getHeaderLine('Content-Type') - ); + $header = $this->request->getHeaderLine('Content-Type'); + $values = HeaderParser::parseHeader($header); + if ($values === []) { + return null; + } + + [$identifier, $parameters] = current($values); + + if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier, $matches)) { + return new ClientMediaType( + type: $matches[1], + subtype: $matches[2], + parameters: $parameters, + ); + } + + return null; } /** @@ -57,9 +86,26 @@ public function getClientProducedMediaType(): ?ClientMediaType */ public function getClientConsumedMediaTypes(): Generator { - yield from HeaderParser::parseAcceptHeader( - $this->request->getHeaderLine('Accept') - ); + $header = $this->request->getHeaderLine('Accept'); + $values = HeaderParser::parseHeader($header); + if ($values === []) { + return; + } + + // https://github.com/php/php-src/blob/d9549d2ee215cb04aa5d2e3195c608d581fb272c/ext/standard/array.c#L900-L903 + usort($values, static fn(array $a, array $b): int => ( + (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') + )); + + foreach ($values as $index => [$identifier, $parameters]) { + if (preg_match('|^([^/]+)/([^/]+)$|', $identifier, $matches)) { + yield $index => new ClientMediaType( + type: $matches[1], + subtype: $matches[2], + parameters: $parameters, + ); + } + } } /** @@ -67,9 +113,26 @@ public function getClientConsumedMediaTypes(): Generator */ public function getClientConsumedLanguages(): Generator { - yield from HeaderParser::parseAcceptLanguageHeader( - $this->request->getHeaderLine('Accept-Language') - ); + $header = $this->request->getHeaderLine('Accept-Language'); + $values = HeaderParser::parseHeader($header); + if ($values === []) { + return; + } + + // https://github.com/php/php-src/blob/d9549d2ee215cb04aa5d2e3195c608d581fb272c/ext/standard/array.c#L900-L903 + usort($values, static fn(array $a, array $b): int => ( + (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') + )); + + foreach ($values as $index => [$identifier, $parameters]) { + if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches)) { + yield $index => new ClientLanguage( + code: $matches[1], + locale: $identifier, + parameters: $parameters, + ); + } + } } public function getClientPreferredMediaType(MediaTypeInterface|Stringable|string ...$serverProducedMediaTypes): ?ClientMediaType From 0323dce13f32b745cdaeaa8925b7c1198c4b1bcf Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Wed, 6 Mar 2024 15:49:23 +0100 Subject: [PATCH 115/180] v3 --- src/ClassResolver.php | 71 +++++++++++++++ .../RequestCookieParameterResolver.php | 8 +- .../RequestHeaderParameterResolver.php | 2 +- .../RequestPathVariableParameterResolver.php | 2 +- .../RequestQueryParamParameterResolver.php | 8 +- .../RequestRouteParameterResolver.php | 59 ------------- .../ServerRequestParameterResolver.php | 46 ---------- src/RequestHandlerResolver.php | 88 ++++++------------- .../StreamResponseResolver.php | 45 ---------- src/ResponseResolver/UriResponseResolver.php | 45 ---------- src/Router.php | 27 +++--- src/ServerRequest.php | 24 +++-- 12 files changed, 137 insertions(+), 288 deletions(-) create mode 100644 src/ClassResolver.php delete mode 100644 src/ParameterResolver/RequestRouteParameterResolver.php delete mode 100644 src/ParameterResolver/ServerRequestParameterResolver.php delete mode 100644 src/ResponseResolver/StreamResponseResolver.php delete mode 100644 src/ResponseResolver/UriResponseResolver.php diff --git a/src/ClassResolver.php b/src/ClassResolver.php new file mode 100644 index 00000000..7dbfecac --- /dev/null +++ b/src/ClassResolver.php @@ -0,0 +1,71 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router; + +use InvalidArgumentException; +use ReflectionClass; + +use function class_exists; +use function sprintf; + +/** + * @since 3.0.0 + */ +final class ClassResolver +{ + /** + * @var array + */ + private array $resolvedClasses = []; + + public function __construct( + private readonly ParameterResolver $parameterResolver, + ) { + } + + /** + * @param class-string $fqn + * + * @return T + * + * @template T of object + * + * @throws InvalidArgumentException If the class cannot be resolved. + */ + public function resolveClass(string $fqn): object + { + if (isset($this->resolvedClasses[$fqn])) { + /** @var T */ + return $this->resolvedClasses[$fqn]; + } + + if (!class_exists($fqn)) { + throw new InvalidArgumentException(sprintf('The class %s does not exist and cannot be resolved.', $fqn)); + } + + /** @var ReflectionClass $reflection */ + $reflection = new ReflectionClass($fqn); + if (!$reflection->isInstantiable()) { + throw new InvalidArgumentException(sprintf('The class %s is uninstantiable and cannot be resolved.', $fqn)); + } + + $arguments = []; + $constructor = $reflection->getConstructor(); + if (isset($constructor)) { + $arguments = $this->parameterResolver->resolveParameters(...$constructor->getParameters()); + } + + return $this->resolvedClasses[$fqn] = $reflection->newInstance(...$arguments); + } +} diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index a485d5c7..f4075765 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -61,12 +61,12 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) throw new LogicException('At this level of the application, any operations with the request are not possible.'); } - $request = ServerRequest::create($context); + $serverRequest = ServerRequest::create($context); $processParams = $annotations[0]->newInstance(); $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; - if (!$request->hasCookieParam($processParams->cookieName)) { + if (!$serverRequest->hasCookieParam($processParams->cookieName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } @@ -77,11 +77,11 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) try { $argument = $this->hydrator->castValue( - $request->getCookieParam($processParams->cookieName), + $serverRequest->getCookieParam($processParams->cookieName), Type::fromParameter($parameter), path: [$processParams->cookieName], ); - } catch (InvalidDataException|InvalidValueException $e) { + } catch (InvalidValueException|InvalidDataException $e) { throw HttpExceptionFactory::cookieInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 75a57f97..e543ab18 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -79,7 +79,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) Type::fromParameter($parameter), path: [$processParams->headerName], ); - } catch (InvalidDataException|InvalidValueException $e) { + } catch (InvalidValueException|InvalidDataException $e) { throw HttpExceptionFactory::headerInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); diff --git a/src/ParameterResolver/RequestPathVariableParameterResolver.php b/src/ParameterResolver/RequestPathVariableParameterResolver.php index de8e1c14..5a3a8d96 100644 --- a/src/ParameterResolver/RequestPathVariableParameterResolver.php +++ b/src/ParameterResolver/RequestPathVariableParameterResolver.php @@ -100,7 +100,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) Type::fromParameter($parameter), path: [$variableName], ); - } catch (InvalidDataException|InvalidValueException $e) { + } catch (InvalidValueException|InvalidDataException $e) { throw HttpExceptionFactory::pathVariableInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) ->addMessagePlaceholder('{{ variable_name }}', $variableName) ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) diff --git a/src/ParameterResolver/RequestQueryParamParameterResolver.php b/src/ParameterResolver/RequestQueryParamParameterResolver.php index 2c6d79fb..489303e0 100644 --- a/src/ParameterResolver/RequestQueryParamParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamParameterResolver.php @@ -61,12 +61,12 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) throw new LogicException('At this level of the application, any operations with the request are not possible.'); } - $request = ServerRequest::create($context); + $serverRequest = ServerRequest::create($context); $processParams = $annotations[0]->newInstance(); $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; - if (!$request->hasQueryParam($processParams->paramName)) { + if (!$serverRequest->hasQueryParam($processParams->paramName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } @@ -77,11 +77,11 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) try { $argument = $this->hydrator->castValue( - $request->getQueryParam($processParams->paramName), + $serverRequest->getQueryParam($processParams->paramName), Type::fromParameter($parameter), path: [$processParams->paramName], ); - } catch (InvalidDataException|InvalidValueException $e) { + } catch (InvalidValueException|InvalidDataException $e) { throw HttpExceptionFactory::queryParamInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName) ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); diff --git a/src/ParameterResolver/RequestRouteParameterResolver.php b/src/ParameterResolver/RequestRouteParameterResolver.php deleted file mode 100644 index f1baf084..00000000 --- a/src/ParameterResolver/RequestRouteParameterResolver.php +++ /dev/null @@ -1,59 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ParameterResolver; - -use Generator; -use LogicException; -use Psr\Http\Message\ServerRequestInterface; -use ReflectionNamedType; -use ReflectionParameter; -use Sunrise\Http\Router\ParameterResolver; -use Sunrise\Http\Router\Route; - -use function sprintf; - -/** - * @since 3.0.0 - */ -final class RequestRouteParameterResolver implements ParameterResolverInterface -{ - /** - * @inheritDoc - * - * @throws LogicException If the resolver is used incorrectly. - */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator - { - $type = $parameter->getType(); - if (! $type instanceof ReflectionNamedType || $type->getName() !== Route::class) { - return; - } - - if (! $context instanceof ServerRequestInterface) { - throw new LogicException('At this level of the application, any operations with the request are not possible.'); - } - - /** @var Route|null $route */ - $route = $context->getAttribute('@route'); - if (! $route instanceof Route && !$parameter->allowsNull()) { - throw new LogicException(sprintf( - 'At this level of the application, the request does not contain a route. ' . - 'To suppress this error, the parameter %s should be nullable.', - ParameterResolver::stringifyParameter($parameter), - )); - } - - yield $route; - } -} diff --git a/src/ParameterResolver/ServerRequestParameterResolver.php b/src/ParameterResolver/ServerRequestParameterResolver.php deleted file mode 100644 index 6c898e66..00000000 --- a/src/ParameterResolver/ServerRequestParameterResolver.php +++ /dev/null @@ -1,46 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ParameterResolver; - -use Generator; -use LogicException; -use Psr\Http\Message\ServerRequestInterface; -use ReflectionNamedType; -use ReflectionParameter; -use Sunrise\Http\Router\ServerRequest; - -/** - * @since 3.0.0 - */ -final class ServerRequestParameterResolver implements ParameterResolverInterface -{ - /** - * @inheritDoc - * - * @throws LogicException If the resolver is used incorrectly. - */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator - { - $type = $parameter->getType(); - if (! $type instanceof ReflectionNamedType || $type->getName() !== ServerRequest::class) { - return; - } - - if (! $context instanceof ServerRequestInterface) { - throw new LogicException('At this level of the application, any operations with the request are not possible.'); - } - - yield ServerRequest::create($context); - } -} diff --git a/src/RequestHandlerResolver.php b/src/RequestHandlerResolver.php index 4253c23a..2bff37bc 100644 --- a/src/RequestHandlerResolver.php +++ b/src/RequestHandlerResolver.php @@ -19,34 +19,29 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use ReflectionClass; use ReflectionFunction; use ReflectionMethod; use Sunrise\Http\Router\Middleware\CallableMiddleware; use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; -use function class_exists; use function is_array; use function is_callable; use function is_string; use function is_subclass_of; -use function sprintf; /** * @since 2.10.0 */ final class RequestHandlerResolver { - /** - * @var array - */ - private array $resolvedClasses = []; + private readonly ClassResolver $classResolver; public function __construct( private readonly ParameterResolver $parameterResolver, private readonly ResponseResolver $responseResolver, ) { + $this->classResolver = new ClassResolver($parameterResolver); } /** @@ -54,12 +49,20 @@ public function __construct( */ public function resolveRequestHandler(mixed $requestHandler): RequestHandlerInterface { + if ($requestHandler instanceof RequestHandlerInterface) { + return $requestHandler; + } + + if ($requestHandler instanceof Closure) { + return new CallableRequestHandler($this->createRequestHandlerCallback($requestHandler, new ReflectionFunction($requestHandler))); + } + // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 if (is_array($requestHandler) && is_callable($requestHandler, true)) { /** @var array{0: class-string|object, 1: non-empty-string} $requestHandler */ if (is_string($requestHandler[0])) { - $requestHandler[0] = $this->resolveClass($requestHandler[0]); + $requestHandler[0] = $this->classResolver->resolveClass($requestHandler[0]); } if (is_callable($requestHandler)) { @@ -68,15 +71,7 @@ public function resolveRequestHandler(mixed $requestHandler): RequestHandlerInte } if (is_string($requestHandler) && is_subclass_of($requestHandler, RequestHandlerInterface::class)) { - return $this->resolveClass($requestHandler); - } - - if ($requestHandler instanceof Closure) { - return new CallableRequestHandler($this->createRequestHandlerCallback($requestHandler, new ReflectionFunction($requestHandler))); - } - - if ($requestHandler instanceof RequestHandlerInterface) { - return $requestHandler; + return $this->classResolver->resolveClass($requestHandler); } throw new InvalidArgumentException('Unsupported request handler.'); @@ -87,8 +82,16 @@ public function resolveRequestHandler(mixed $requestHandler): RequestHandlerInte */ public function resolveMiddleware(mixed $middleware): MiddlewareInterface { + if ($middleware instanceof MiddlewareInterface) { + return $middleware; + } + + if ($middleware instanceof Closure) { + return new CallableMiddleware($this->createMiddlewareCallback($middleware, new ReflectionFunction($middleware))); + } + if (is_string($middleware) && is_subclass_of($middleware, MiddlewareInterface::class)) { - return $this->resolveClass($middleware); + return $this->classResolver->resolveClass($middleware); } // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 @@ -96,7 +99,7 @@ public function resolveMiddleware(mixed $middleware): MiddlewareInterface /** @var array{0: class-string|object, 1: non-empty-string} $middleware */ if (is_string($middleware[0])) { - $middleware[0] = $this->resolveClass($middleware[0]); + $middleware[0] = $this->classResolver->resolveClass($middleware[0]); } if (is_callable($middleware)) { @@ -104,52 +107,9 @@ public function resolveMiddleware(mixed $middleware): MiddlewareInterface } } - if ($middleware instanceof Closure) { - return new CallableMiddleware($this->createMiddlewareCallback($middleware, new ReflectionFunction($middleware))); - } - - if ($middleware instanceof MiddlewareInterface) { - return $middleware; - } - throw new InvalidArgumentException('Unsupported middleware.'); } - /** - * @param class-string $className - * - * @return T - * - * @template T of object - * - * @throws InvalidArgumentException If the class couldn't be resolved. - */ - private function resolveClass(string $className): object - { - if (isset($this->resolvedClasses[$className])) { - /** @var T */ - return $this->resolvedClasses[$className]; - } - - if (!class_exists($className)) { - throw new InvalidArgumentException(sprintf('The class %s does not exist and cannot be resolved.', $className)); - } - - $classReflection = new ReflectionClass($className); - if (!$classReflection->isInstantiable()) { - throw new InvalidArgumentException(sprintf('The class %s is not instantiable and cannot be resolved.', $className)); - } - - $arguments = []; - $constructor = $classReflection->getConstructor(); - if (isset($constructor) && $constructor->getNumberOfParameters()) { - $arguments = $this->parameterResolver->resolveParameters(...$constructor->getParameters()); - } - - /** @var T */ - return $this->resolvedClasses[$className] = $classReflection->newInstance(...$arguments); - } - /** * @return Closure(ServerRequestInterface=): ResponseInterface */ @@ -162,7 +122,9 @@ private function createRequestHandlerCallback( $callback(... $this->parameterResolver ->withContext($request) - ->withPriorityResolver(new ObjectInjectionParameterResolver($request)) + ->withPriorityResolver( + new ObjectInjectionParameterResolver($request), + ) ->resolveParameters(...$reflection->getParameters()) ), $reflection, diff --git a/src/ResponseResolver/StreamResponseResolver.php b/src/ResponseResolver/StreamResponseResolver.php deleted file mode 100644 index bfc2df43..00000000 --- a/src/ResponseResolver/StreamResponseResolver.php +++ /dev/null @@ -1,45 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ResponseResolver; - -use Fig\Http\Message\StatusCodeInterface; -use Psr\Http\Message\ResponseFactoryInterface; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Message\StreamInterface; -use ReflectionFunction; -use ReflectionMethod; - -/** - * @since 3.0.0 - */ -final class StreamResponseResolver implements ResponseResolverInterface -{ - public function __construct(private readonly ResponseFactoryInterface $responseFactory) - { - } - - public function resolveResponse( - mixed $response, - ReflectionMethod|ReflectionFunction $responder, - ServerRequestInterface $request, - ): ?ResponseInterface { - if (! $response instanceof StreamInterface) { - return null; - } - - return $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK) - ->withBody($response); - } -} diff --git a/src/ResponseResolver/UriResponseResolver.php b/src/ResponseResolver/UriResponseResolver.php deleted file mode 100644 index 73d821d0..00000000 --- a/src/ResponseResolver/UriResponseResolver.php +++ /dev/null @@ -1,45 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ResponseResolver; - -use Fig\Http\Message\StatusCodeInterface; -use Psr\Http\Message\ResponseFactoryInterface; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Message\UriInterface; -use ReflectionFunction; -use ReflectionMethod; - -/** - * @since 3.0.0 - */ -final class UriResponseResolver implements ResponseResolverInterface -{ - public function __construct(private readonly ResponseFactoryInterface $responseFactory) - { - } - - public function resolveResponse( - mixed $response, - ReflectionMethod|ReflectionFunction $responder, - ServerRequestInterface $request, - ): ?ResponseInterface { - if (! $response instanceof UriInterface) { - return null; - } - - return $this->responseFactory->createResponse(StatusCodeInterface::STATUS_FOUND) - ->withHeader('Location', $response->__toString()); - } -} diff --git a/src/Router.php b/src/Router.php index 2a342b03..64ef5bf6 100644 --- a/src/Router.php +++ b/src/Router.php @@ -16,6 +16,7 @@ use InvalidArgumentException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; @@ -28,8 +29,7 @@ use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; -use function array_flip; -use function array_keys; +use function array_merge; use function rawurldecode; use function sprintf; @@ -37,8 +37,6 @@ class Router { private readonly RequestHandlerResolver $requestHandlerResolver; - private array $middlewares; - /** * @var array */ @@ -59,24 +57,25 @@ class Router /** * @param ParameterResolverInterface[] $parameterResolvers * @param ResponseResolverInterface[] $responseResolvers - * @param list $loaders + * @param LoaderInterface[] $loaders * * @since 3.0.0 */ public function __construct( - array $middlewares = [], + /** @var MiddlewareInterface[] */ + private readonly array $middlewares = [], array $parameterResolvers = [], array $responseResolvers = [], array $loaders = [], ) { - $this->middlewares = $middlewares; - $this->requestHandlerResolver = new RequestHandlerResolver( new ParameterResolver($parameterResolvers), new ResponseResolver($responseResolvers), ); - $this->load(...$loaders); + foreach ($loaders as $loader) { + $this->load($loader); + } } /** @@ -135,7 +134,7 @@ public function match(ServerRequestInterface $request): Route } if (!$route->allowsMethod($request->getMethod())) { - $allowedMethods += array_flip($route->getMethods()); + $allowedMethods = array_merge($allowedMethods, $route->getMethods()); continue; } @@ -145,7 +144,7 @@ public function match(ServerRequestInterface $request): Route if (!empty($allowedMethods)) { throw HttpExceptionFactory::methodNotAllowed() ->addMessagePlaceholder('{{ method }}', $request->getMethod()) - ->addHeaderField('Allow', ...array_keys($allowedMethods)); + ->addHeaderField('Allow', ...$allowedMethods); } throw HttpExceptionFactory::resourceNotFound() @@ -173,9 +172,9 @@ public function runRoute(Route|string $route, ServerRequestInterface $request): $request = $request->withAttribute($name, $value); } - return $this->getRouteRequestHandler($route)->handle( - $request->withAttribute('@route', $route) - ); + $request = $request->withAttribute('@route', $route); + + return $this->getRouteRequestHandler($route)->handle($request); } /** diff --git a/src/ServerRequest.php b/src/ServerRequest.php index be0a5a4a..b749db80 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -18,7 +18,6 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\StreamInterface; use Psr\Http\Message\UriInterface; -use Stringable; use Sunrise\Http\Router\Entity\Language\ClientLanguage; use Sunrise\Http\Router\Entity\Language\LanguageComparator; use Sunrise\Http\Router\Entity\Language\LanguageInterface; @@ -26,6 +25,7 @@ use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; use Sunrise\Http\Router\Helper\HeaderParser; + use function current; use function preg_match; use function usort; @@ -63,6 +63,10 @@ public function getRoute(): Route public function getClientProducedMediaType(): ?ClientMediaType { $header = $this->request->getHeaderLine('Content-Type'); + if ($header === '') { + return null; + } + $values = HeaderParser::parseHeader($header); if ($values === []) { return null; @@ -87,6 +91,10 @@ public function getClientProducedMediaType(): ?ClientMediaType public function getClientConsumedMediaTypes(): Generator { $header = $this->request->getHeaderLine('Accept'); + if ($header === '') { + return; + } + $values = HeaderParser::parseHeader($header); if ($values === []) { return; @@ -114,6 +122,10 @@ public function getClientConsumedMediaTypes(): Generator public function getClientConsumedLanguages(): Generator { $header = $this->request->getHeaderLine('Accept-Language'); + if ($header === '') { + return; + } + $values = HeaderParser::parseHeader($header); if ($values === []) { return; @@ -135,7 +147,7 @@ public function getClientConsumedLanguages(): Generator } } - public function getClientPreferredMediaType(MediaTypeInterface|Stringable|string ...$serverProducedMediaTypes): ?ClientMediaType + public function getClientPreferredMediaType(MediaTypeInterface ...$serverProducedMediaTypes): ?ClientMediaType { if ($serverProducedMediaTypes === []) { return null; @@ -153,7 +165,7 @@ public function getClientPreferredMediaType(MediaTypeInterface|Stringable|string return null; } - public function getClientPreferredLanguage(LanguageInterface|Stringable|string ...$serverProducedLanguages): ?ClientLanguage + public function getClientPreferredLanguage(LanguageInterface ...$serverProducedLanguages): ?ClientLanguage { if ($serverProducedLanguages === []) { return null; @@ -171,7 +183,7 @@ public function getClientPreferredLanguage(LanguageInterface|Stringable|string . return null; } - public function clientProducesMediaType(MediaTypeInterface|Stringable|string ...$serverConsumedMediaTypes): bool + public function clientProducesMediaType(MediaTypeInterface ...$serverConsumedMediaTypes): bool { // This case is interpreted as follows: the server accepts any media type... if ($serverConsumedMediaTypes === []) { @@ -193,7 +205,7 @@ public function clientProducesMediaType(MediaTypeInterface|Stringable|string ... return false; } - public function clientConsumesMediaType(MediaTypeInterface|Stringable|string ...$serverProducedMediaTypes): bool + public function clientConsumesMediaType(MediaTypeInterface ...$serverProducedMediaTypes): bool { if ($serverProducedMediaTypes === []) { return false; @@ -216,7 +228,7 @@ public function clientConsumesMediaType(MediaTypeInterface|Stringable|string ... return false; } - public function clientConsumesLanguage(LanguageInterface|Stringable|string ...$serverProducedLanguages): bool + public function clientConsumesLanguage(LanguageInterface ...$serverProducedLanguages): bool { if ($serverProducedLanguages === []) { return false; From 15461b0b32ba4b38c9833420d98326f1f707deb8 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 7 Mar 2024 05:38:27 +0100 Subject: [PATCH 116/180] v3 --- src/Annotation/Route.php | 79 ++++++++++++++++--- src/Exception/HttpException.php | 2 +- src/Exception/HttpExceptionInterface.php | 2 +- src/Helper/HydratorHelper.php | 54 ------------- src/Helper/RouteBuilder.php | 9 +-- src/Helper/RouteParser.php | 4 +- src/Helper/ValidatorHelper.php | 19 ----- .../CrossOriginResourceSharingMiddleware.php | 73 +++++++++++++++++ .../RequestBodyParameterResolver.php | 9 ++- .../RequestCookieParameterResolver.php | 11 ++- .../RequestHeaderParameterResolver.php | 11 ++- .../RequestPathVariableParameterResolver.php | 10 ++- .../RequestQueryParamParameterResolver.php | 11 ++- .../RequestQueryParamsParameterResolver.php | 9 ++- src/{ => Validation}/ConstraintViolation.php | 2 +- .../HydratorConstraintViolationProxy.php | 57 +++++++++++++ .../ValidatorConstraintViolationProxy.php | 57 +++++++++++++ .../ConstraintViolationInterface.php | 2 +- 18 files changed, 304 insertions(+), 117 deletions(-) delete mode 100644 src/Helper/HydratorHelper.php create mode 100644 src/Middleware/CrossOriginResourceSharingMiddleware.php rename src/{ => Validation}/ConstraintViolation.php (96%) create mode 100644 src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php create mode 100644 src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php rename src/{ => Validation}/ConstraintViolationInterface.php (93%) diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index e407c05f..6c1cc534 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -19,46 +19,101 @@ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] final class Route { + /** + * The route's request handler. + */ public mixed $holder = null; - /** @var list */ + /** + * Use the {@see Prefix} annotation. + * + * @var list + */ public array $prefixes = []; - /** @var array */ + /** + * Use the {@see Pattern} annotation. + * + * @var array + */ public array $patterns = []; - /** @var list */ + /** + * Use the {@see Method} annotation. + * + * @var list + */ public array $methods = []; - /** @var array */ + /** + * Use the {@see \Sunrise\Http\Router\Annotation\Attribute} annotation. + * + * @var array + */ public array $attributes = []; - /** @var list */ + /** + * Use the {@see Middleware} annotation. + * + * @var list + */ public array $middlewares = []; - /** @var list */ + /** + * Use the {@see Constraint} annotation. + * + * @var list + */ public array $constraints = []; - /** @var list */ + /** + * Use the {@see Consumes} annotation. + * + * @var list + */ public array $consumes = []; - /** @var list */ + /** + * Use the {@see Produces} annotation. + * + * @var list + */ public array $produces = []; - /** @var list */ + /** + * Use the {@see Tag} annotation. + * + * @var list + */ public array $tags = []; + /** + * Use the {@see Summary} annotation. + */ public string $summary = ''; + /** + * Use the {@see Description} annotation. + */ public string $description = ''; + /** + * Use the {@see Deprecated} annotation. + */ public bool $isDeprecated = false; - /** @var non-empty-string|null */ - public string|null $pattern = null; - + /** + * Use the {@see Priority} annotation. + */ public int $priority = 0; + /** + * The route compilation result. + * + * @var non-empty-string|null + */ + public string|null $pattern = null; + public function __construct( public readonly string $name, public string $path, diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index 0894b6cc..0c67f92e 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -15,7 +15,7 @@ use RuntimeException; use Stringable; -use Sunrise\Http\Router\ConstraintViolationInterface; +use Sunrise\Http\Router\Validation\ConstraintViolationInterface; use Throwable; use function join; diff --git a/src/Exception/HttpExceptionInterface.php b/src/Exception/HttpExceptionInterface.php index f78c9220..847454e7 100644 --- a/src/Exception/HttpExceptionInterface.php +++ b/src/Exception/HttpExceptionInterface.php @@ -13,7 +13,7 @@ namespace Sunrise\Http\Router\Exception; -use Sunrise\Http\Router\ConstraintViolationInterface; +use Sunrise\Http\Router\Validation\ConstraintViolationInterface; /** * @since 3.0.0 diff --git a/src/Helper/HydratorHelper.php b/src/Helper/HydratorHelper.php deleted file mode 100644 index 9dc50589..00000000 --- a/src/Helper/HydratorHelper.php +++ /dev/null @@ -1,54 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Helper; - -use Generator; -use Sunrise\Http\Router\ConstraintViolation; -use Sunrise\Http\Router\ConstraintViolationInterface; -use Sunrise\Hydrator\Exception\InvalidDataException; -use Sunrise\Hydrator\Exception\InvalidValueException; - -/** - * @since 3.0.0 - */ -final class HydratorHelper -{ - /** - * @return Generator - */ - public static function adaptConstraintViolations(InvalidDataException|InvalidValueException $error): Generator - { - if ($error instanceof InvalidDataException) { - foreach ($error->getExceptions() as $violation) { - yield new ConstraintViolation( - $violation->getMessage(), - $violation->getMessageTemplate(), - $violation->getMessagePlaceholders(), - $violation->getPropertyPath(), - $violation->getErrorCode(), - ); - } - - return; - } - - yield new ConstraintViolation( - $error->getMessage(), - $error->getMessageTemplate(), - $error->getMessagePlaceholders(), - $error->getPropertyPath(), - $error->getErrorCode(), - ); - } -} diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index af391f8c..9eba4830 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -87,14 +87,11 @@ public static function stringifyValue(mixed $value): string { if (is_string($value)) { return $value; - } - if (is_int($value)) { + } elseif (is_int($value)) { return (string) $value; - } - if ($value instanceof BackedEnum) { + } elseif ($value instanceof BackedEnum) { return (string) $value->value; - } - if ($value instanceof Stringable) { + } elseif ($value instanceof Stringable) { return $value->__toString(); } diff --git a/src/Helper/RouteParser.php b/src/Helper/RouteParser.php index cfc0123f..775a4361 100644 --- a/src/Helper/RouteParser.php +++ b/src/Helper/RouteParser.php @@ -185,8 +185,8 @@ public static function parseRoute(string $route): array continue; } - // (xxx{foo}xxx) - // ~^^^~~~~~^^^~ + // (left{foo}right) + // ~^^^^~~~~~^^^^^~ if (($cursor & $inOptionalPart) && !($cursor & $inVariable)) { if (!($cursor & $inOccupiedPart)) { $left .= $route[$offset]; diff --git a/src/Helper/ValidatorHelper.php b/src/Helper/ValidatorHelper.php index 70d43546..d6de6e30 100644 --- a/src/Helper/ValidatorHelper.php +++ b/src/Helper/ValidatorHelper.php @@ -17,10 +17,7 @@ use ReflectionAttribute; use ReflectionParameter; use Sunrise\Http\Router\Annotation\Constraint as RouterConstraint; -use Sunrise\Http\Router\ConstraintViolation as RouterConstraintViolation; -use Sunrise\Http\Router\ConstraintViolationInterface as RouterConstraintViolationInterface; use Symfony\Component\Validator\Constraint as ValidatorConstraint; -use Symfony\Component\Validator\ConstraintViolationInterface as ValidatorConstraintViolationInterface; /** * @since 3.0.0 @@ -40,20 +37,4 @@ public static function getParameterConstraints(ReflectionParameter $parameter): } } } - - /** - * @return Generator - */ - public static function adaptConstraintViolations(ValidatorConstraintViolationInterface ...$validatorConstraintViolations): Generator - { - foreach ($validatorConstraintViolations as $validatorConstraintViolation) { - yield new RouterConstraintViolation( - (string) $validatorConstraintViolation->getMessage(), - $validatorConstraintViolation->getMessageTemplate(), - $validatorConstraintViolation->getParameters(), - $validatorConstraintViolation->getPropertyPath(), - $validatorConstraintViolation->getCode(), - ); - } - } } diff --git a/src/Middleware/CrossOriginResourceSharingMiddleware.php b/src/Middleware/CrossOriginResourceSharingMiddleware.php new file mode 100644 index 00000000..ee5afb9c --- /dev/null +++ b/src/Middleware/CrossOriginResourceSharingMiddleware.php @@ -0,0 +1,73 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Middleware; + +use Neomerx\Cors\Contracts\AnalysisResultInterface; +use Neomerx\Cors\Contracts\AnalyzerInterface; +use Psr\Http\Message\ResponseFactoryInterface; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; + +/** + * @since 3.0.0 + */ +final class CrossOriginResourceSharingMiddleware implements MiddlewareInterface +{ + public function __construct( + private readonly AnalyzerInterface $requestAnalyzer, + private readonly ResponseFactoryInterface $responseFactory, + ) { + } + + /** + * @inheritDoc + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + $requestAnalysisResult = $this->requestAnalyzer->analyze($request); + + switch ($requestAnalysisResult->getRequestType()) { + case AnalysisResultInterface::TYPE_REQUEST_OUT_OF_CORS_SCOPE: + return $handler->handle($request); + + case AnalysisResultInterface::ERR_NO_HOST_HEADER: + case AnalysisResultInterface::ERR_ORIGIN_NOT_ALLOWED: + case AnalysisResultInterface::ERR_METHOD_NOT_SUPPORTED: + case AnalysisResultInterface::ERR_HEADERS_NOT_SUPPORTED: + return $this->responseFactory->createResponse(403); + + case AnalysisResultInterface::TYPE_PRE_FLIGHT_REQUEST: + $response = $this->responseFactory->createResponse(200); + /** @var array $preflightHeaders */ + $preflightHeaders = $requestAnalysisResult->getResponseHeaders(); + foreach ($preflightHeaders as $fieldName => $fieldValue) { + $response = $response->withHeader($fieldName, $fieldValue); + } + + return $response; + + default: + $response = $handler->handle($request); + /** @var array $preflightHeaders */ + $preflightHeaders = $requestAnalysisResult->getResponseHeaders(); + foreach ($preflightHeaders as $fieldName => $fieldValue) { + $response = $response->withHeader($fieldName, $fieldValue); + } + + return $response; + } + } +} diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index eaecf7c3..5eb1cd1d 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -22,13 +22,14 @@ use Sunrise\Http\Router\Annotation\RequestBody; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Helper\HydratorHelper; -use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ParameterResolver; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; +use function array_map; use function sprintf; /** @@ -78,13 +79,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidDataException $e) { throw HttpExceptionFactory::bodyInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) - ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); + ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $e->getExceptions())); } if (isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { throw HttpExceptionFactory::bodyInvalid($errorStatusCode, $processParams->errorMessage) - ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); + ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } } diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index f4075765..0160641a 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -21,15 +21,18 @@ use Sunrise\Http\Router\Annotation\RequestCookie; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Helper\HydratorHelper; use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ServerRequest; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; use Sunrise\Hydrator\Type; use Symfony\Component\Validator\Validator\ValidatorInterface; +use function array_map; + /** * @since 3.0.0 */ @@ -82,9 +85,11 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) path: [$processParams->cookieName], ); } catch (InvalidValueException|InvalidDataException $e) { + $violations = ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions(); + throw HttpExceptionFactory::cookieInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName) - ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); + ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $violations)); } if (isset($this->validator)) { @@ -92,7 +97,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { throw HttpExceptionFactory::cookieInvalid($errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName) - ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); + ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } } } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index e543ab18..8a845401 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -21,14 +21,17 @@ use Sunrise\Http\Router\Annotation\RequestHeader; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Helper\HydratorHelper; use Sunrise\Http\Router\Helper\ValidatorHelper; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; use Sunrise\Hydrator\Type; use Symfony\Component\Validator\Validator\ValidatorInterface; +use function array_map; + /** * @since 3.0.0 */ @@ -80,9 +83,11 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) path: [$processParams->headerName], ); } catch (InvalidValueException|InvalidDataException $e) { + $violations = ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions(); + throw HttpExceptionFactory::headerInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName) - ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); + ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $violations)); } if (isset($this->validator)) { @@ -90,7 +95,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { throw HttpExceptionFactory::headerInvalid($errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName) - ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); + ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } } } diff --git a/src/ParameterResolver/RequestPathVariableParameterResolver.php b/src/ParameterResolver/RequestPathVariableParameterResolver.php index 5a3a8d96..6e8d4425 100644 --- a/src/ParameterResolver/RequestPathVariableParameterResolver.php +++ b/src/ParameterResolver/RequestPathVariableParameterResolver.php @@ -21,17 +21,19 @@ use Sunrise\Http\Router\Annotation\RequestPathVariable; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Helper\HydratorHelper; use Sunrise\Http\Router\Helper\RouteSimplifier; use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ParameterResolver; use Sunrise\Http\Router\Route; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; use Sunrise\Hydrator\Type; use Symfony\Component\Validator\Validator\ValidatorInterface; +use function array_map; use function sprintf; /** @@ -101,10 +103,12 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) path: [$variableName], ); } catch (InvalidValueException|InvalidDataException $e) { + $violations = ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions(); + throw HttpExceptionFactory::pathVariableInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) ->addMessagePlaceholder('{{ variable_name }}', $variableName) ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) - ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); + ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $violations)); } if (isset($this->validator)) { @@ -113,7 +117,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) throw HttpExceptionFactory::pathVariableInvalid($errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ variable_name }}', $variableName) ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) - ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); + ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } } } diff --git a/src/ParameterResolver/RequestQueryParamParameterResolver.php b/src/ParameterResolver/RequestQueryParamParameterResolver.php index 489303e0..c63c3e31 100644 --- a/src/ParameterResolver/RequestQueryParamParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamParameterResolver.php @@ -21,15 +21,18 @@ use Sunrise\Http\Router\Annotation\RequestQueryParam; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Helper\HydratorHelper; use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ServerRequest; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; use Sunrise\Hydrator\Type; use Symfony\Component\Validator\Validator\ValidatorInterface; +use function array_map; + /** * @since 3.0.0 */ @@ -82,9 +85,11 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) path: [$processParams->paramName], ); } catch (InvalidValueException|InvalidDataException $e) { + $violations = ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions(); + throw HttpExceptionFactory::queryParamInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName) - ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); + ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $violations)); } if (isset($this->validator)) { @@ -92,7 +97,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { throw HttpExceptionFactory::queryParamInvalid($errorStatusCode, $processParams->errorMessage) ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName) - ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); + ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } } } diff --git a/src/ParameterResolver/RequestQueryParamsParameterResolver.php b/src/ParameterResolver/RequestQueryParamsParameterResolver.php index f2341339..a51cba42 100644 --- a/src/ParameterResolver/RequestQueryParamsParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamsParameterResolver.php @@ -22,13 +22,14 @@ use Sunrise\Http\Router\Annotation\RequestQueryParams; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Helper\HydratorHelper; -use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ParameterResolver; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; +use function array_map; use function sprintf; /** @@ -78,13 +79,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { throw HttpExceptionFactory::queryParamsInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) - ->addConstraintViolation(...HydratorHelper::adaptConstraintViolations($e)); + ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $e->getExceptions())); } if (isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { throw HttpExceptionFactory::queryParamsInvalid($errorStatusCode, $processParams->errorMessage) - ->addConstraintViolation(...ValidatorHelper::adaptConstraintViolations(...$violations)); + ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } } diff --git a/src/ConstraintViolation.php b/src/Validation/ConstraintViolation.php similarity index 96% rename from src/ConstraintViolation.php rename to src/Validation/ConstraintViolation.php index bd6c1d45..ed31f16e 100644 --- a/src/ConstraintViolation.php +++ b/src/Validation/ConstraintViolation.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router; +namespace Sunrise\Http\Router\Validation; /** * @since 3.0.0 diff --git a/src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php b/src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php new file mode 100644 index 00000000..adb5e759 --- /dev/null +++ b/src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php @@ -0,0 +1,57 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Validation\ConstraintViolation; + +use Sunrise\Http\Router\Validation\ConstraintViolationInterface; +use Sunrise\Hydrator\Exception\InvalidValueException; + +/** + * @since 3.0.0 + */ +final class HydratorConstraintViolationProxy implements ConstraintViolationInterface +{ + public function __construct(private readonly InvalidValueException $hydratorConstraintViolation) + { + } + + public static function create(InvalidValueException $hydratorConstraintViolation): self + { + return new self($hydratorConstraintViolation); + } + + public function getMessage(): string + { + return $this->hydratorConstraintViolation->getMessage(); + } + + public function getMessageTemplate(): string + { + return $this->hydratorConstraintViolation->getMessageTemplate(); + } + + public function getMessagePlaceholders(): array + { + return $this->hydratorConstraintViolation->getMessagePlaceholders(); + } + + public function getPropertyPath(): string + { + return $this->hydratorConstraintViolation->getPropertyPath(); + } + + public function getCode(): ?string + { + return $this->hydratorConstraintViolation->getErrorCode(); + } +} diff --git a/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php b/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php new file mode 100644 index 00000000..e7a9d841 --- /dev/null +++ b/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php @@ -0,0 +1,57 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Validation\ConstraintViolation; + +use Sunrise\Http\Router\Validation\ConstraintViolationInterface as RouterConstraintViolationInterface; +use Symfony\Component\Validator\ConstraintViolationInterface as ValidatorConstraintViolationInterface; + +/** + * @since 3.0.0 + */ +final class ValidatorConstraintViolationProxy implements RouterConstraintViolationInterface +{ + public function __construct(private readonly ValidatorConstraintViolationInterface $validatorConstraintViolation) + { + } + + public static function create(ValidatorConstraintViolationInterface $validatorConstraintViolation): self + { + return new self($validatorConstraintViolation); + } + + public function getMessage(): string + { + return (string) $this->validatorConstraintViolation->getMessage(); + } + + public function getMessageTemplate(): string + { + return $this->validatorConstraintViolation->getMessageTemplate(); + } + + public function getMessagePlaceholders(): array + { + return $this->validatorConstraintViolation->getParameters(); + } + + public function getPropertyPath(): string + { + return $this->validatorConstraintViolation->getPropertyPath(); + } + + public function getCode(): ?string + { + return $this->validatorConstraintViolation->getCode(); + } +} diff --git a/src/ConstraintViolationInterface.php b/src/Validation/ConstraintViolationInterface.php similarity index 93% rename from src/ConstraintViolationInterface.php rename to src/Validation/ConstraintViolationInterface.php index 8bff1d15..c17ef729 100644 --- a/src/ConstraintViolationInterface.php +++ b/src/Validation/ConstraintViolationInterface.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router; +namespace Sunrise\Http\Router\Validation; /** * @since 3.0.0 From 53b44ac3aaf3ab3e2ebefa6024f27fabd5cf68d6 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 7 Mar 2024 06:15:45 +0100 Subject: [PATCH 117/180] v3 --- src/Helper/RouteBuilder.php | 40 +--------- .../CrossOriginResourceSharingMiddleware.php | 73 ------------------- 2 files changed, 4 insertions(+), 109 deletions(-) delete mode 100644 src/Middleware/CrossOriginResourceSharingMiddleware.php diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index 9eba4830..cab02b93 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -15,11 +15,7 @@ use BackedEnum; use InvalidArgumentException; -use Stringable; -use function get_debug_type; -use function is_int; -use function is_string; use function sprintf; use function str_replace; use function substr; @@ -42,15 +38,10 @@ public static function buildRoute(string $route, array $values = []): string $statement = substr($route, $variable['offset'], $variable['length']); if (isset($values[$variable['name']])) { - try { - $value = self::stringifyValue($values[$variable['name']]); - } catch (InvalidArgumentException $e) { - throw new InvalidArgumentException(sprintf( - 'The route %s could not be built with an invalid value for the variable %s due to: %s', - $route, - $variable['name'], - $e->getMessage(), - ), previous: $e); + $value = $values[$variable['name']]; + + if ($value instanceof BackedEnum) { + $value = $value->value; } $search[] = $statement; @@ -79,27 +70,4 @@ public static function buildRoute(string $route, array $values = []): string return str_replace($search, $replace, $route); } - - /** - * @throws InvalidArgumentException If the value couldn't be converted to a string. - */ - public static function stringifyValue(mixed $value): string - { - if (is_string($value)) { - return $value; - } elseif (is_int($value)) { - return (string) $value; - } elseif ($value instanceof BackedEnum) { - return (string) $value->value; - } elseif ($value instanceof Stringable) { - return $value->__toString(); - } - - throw new InvalidArgumentException(sprintf( - 'The value of the type %s could not be converted to a string. ' . - 'To resolve this issue, use one of the following value types: ' . - 'string, integer, backed enum or stringable object.', - get_debug_type($value), - )); - } } diff --git a/src/Middleware/CrossOriginResourceSharingMiddleware.php b/src/Middleware/CrossOriginResourceSharingMiddleware.php deleted file mode 100644 index ee5afb9c..00000000 --- a/src/Middleware/CrossOriginResourceSharingMiddleware.php +++ /dev/null @@ -1,73 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Middleware; - -use Neomerx\Cors\Contracts\AnalysisResultInterface; -use Neomerx\Cors\Contracts\AnalyzerInterface; -use Psr\Http\Message\ResponseFactoryInterface; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; - -/** - * @since 3.0.0 - */ -final class CrossOriginResourceSharingMiddleware implements MiddlewareInterface -{ - public function __construct( - private readonly AnalyzerInterface $requestAnalyzer, - private readonly ResponseFactoryInterface $responseFactory, - ) { - } - - /** - * @inheritDoc - */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface - { - $requestAnalysisResult = $this->requestAnalyzer->analyze($request); - - switch ($requestAnalysisResult->getRequestType()) { - case AnalysisResultInterface::TYPE_REQUEST_OUT_OF_CORS_SCOPE: - return $handler->handle($request); - - case AnalysisResultInterface::ERR_NO_HOST_HEADER: - case AnalysisResultInterface::ERR_ORIGIN_NOT_ALLOWED: - case AnalysisResultInterface::ERR_METHOD_NOT_SUPPORTED: - case AnalysisResultInterface::ERR_HEADERS_NOT_SUPPORTED: - return $this->responseFactory->createResponse(403); - - case AnalysisResultInterface::TYPE_PRE_FLIGHT_REQUEST: - $response = $this->responseFactory->createResponse(200); - /** @var array $preflightHeaders */ - $preflightHeaders = $requestAnalysisResult->getResponseHeaders(); - foreach ($preflightHeaders as $fieldName => $fieldValue) { - $response = $response->withHeader($fieldName, $fieldValue); - } - - return $response; - - default: - $response = $handler->handle($request); - /** @var array $preflightHeaders */ - $preflightHeaders = $requestAnalysisResult->getResponseHeaders(); - foreach ($preflightHeaders as $fieldName => $fieldValue) { - $response = $response->withHeader($fieldName, $fieldValue); - } - - return $response; - } - } -} From 5b86abfd64e1dbc42ad75a8d181e76bc1d23a0c6 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 8 Mar 2024 05:24:51 +0100 Subject: [PATCH 118/180] v3 --- src/Dictionary/ErrorMessage.php | 27 ++-- src/Exception/HttpException.php | 13 +- src/Exception/HttpExceptionFactory.php | 126 ++++++++---------- src/Exception/HttpExceptionInterface.php | 2 +- .../InvalidLoaderResourceException.php | 23 ++++ .../InvalidRouteBuildingValueException.php | 23 ++++ .../InvalidRouteMatchingPatternException.php | 23 ++++ .../InvalidRouteMatchingSubjectException.php | 23 ++++ .../InvalidRouteParsingSubjectException.php | 23 ++++ src/Helper/RouteBuilder.php | 8 +- src/Helper/RouteCompiler.php | 4 +- src/Helper/RouteMatcher.php | 50 +++++-- src/Helper/RouteParser.php | 36 ++--- src/Helper/RouteSimplifier.php | 4 +- src/Loader/DescriptorLoader.php | 16 +-- .../JsonPayloadDecodingMiddleware.php | 6 +- .../PayloadMediaTypeNegotiationMiddleware.php | 7 +- .../RequestBodyParameterResolver.php | 5 +- .../RequestCookieParameterResolver.php | 7 +- .../RequestHeaderParameterResolver.php | 7 +- .../RequestPathVariableParameterResolver.php | 5 +- .../RequestQueryParamParameterResolver.php | 7 +- .../RequestQueryParamsParameterResolver.php | 5 +- src/Router.php | 18 ++- src/ServerRequest.php | 19 +-- 25 files changed, 299 insertions(+), 188 deletions(-) create mode 100644 src/Exception/InvalidLoaderResourceException.php create mode 100644 src/Exception/InvalidRouteBuildingValueException.php create mode 100644 src/Exception/InvalidRouteMatchingPatternException.php create mode 100644 src/Exception/InvalidRouteMatchingSubjectException.php create mode 100644 src/Exception/InvalidRouteParsingSubjectException.php diff --git a/src/Dictionary/ErrorMessage.php b/src/Dictionary/ErrorMessage.php index 8609f436..a0bc2d64 100644 --- a/src/Dictionary/ErrorMessage.php +++ b/src/Dictionary/ErrorMessage.php @@ -20,17 +20,18 @@ final class ErrorMessage { public const RESOURCE_NOT_FOUND = 'The resource {{ resource }} was not found.'; public const METHOD_NOT_ALLOWED = 'The method {{ method }} is not allowed; check the Allow response header for allowed methods.'; - public const MEDIA_TYPE_NOT_SUPPORTED = 'The media type {{ media_type }} is not supported; check the Accept response header for supported media types.'; - public const PATH_VARIABLE_INVALID = 'The variable {{ variable_name }} of the route {{ route_path }} is invalid.'; - public const QUERY_PARAMS_INVALID = 'The query parameters are invalid.'; - public const QUERY_PARAM_MISSED = 'The query parameter {{ param_name }} must be provided.'; - public const QUERY_PARAM_INVALID = 'The query parameter {{ param_name }} is invalid.'; - public const HEADER_MISSED = 'The header {{ header_name }} must be provided.'; - public const HEADER_INVALID = 'The header {{ header_name }} is invalid.'; - public const COOKIE_MISSED = 'The cookie {{ cookie_name }} must be provided.'; - public const COOKIE_INVALID = 'The cookie {{ cookie_name }} is invalid.'; - public const BODY_INVALID = 'The request body is invalid.'; - public const JSON_PAYLOAD_EMPTY = 'The JSON payload cannot be empty.'; - public const JSON_PAYLOAD_INVALID = 'The JSON payload is invalid and could not be decoded.'; - public const JSON_PAYLOAD_FORM_INVALID = 'The JSON payload must be in the form of an array or an object.'; + public const MISSING_MEDIA_TYPE = 'The Content-Type header must be provided and cannot be empty; check the Accept response header for supported media types.'; + public const UNSUPPORTED_MEDIA_TYPE = 'The media type {{ media_type }} is not supported; check the Accept response header for supported media types.'; + public const INVALID_PATH_VARIABLE = 'The variable {{ variable_name }} of the route {{ route_path }} is invalid.'; + public const INVALID_QUERY_PARAMS = 'The query parameters are invalid.'; + public const MISSING_QUERY_PARAM = 'The query parameter {{ param_name }} must be provided.'; + public const INVALID_QUERY_PARAM = 'The query parameter {{ param_name }} is invalid.'; + public const MISSING_HEADER_FIELD = 'The header {{ header_name }} must be provided.'; + public const INVALID_HEADER_FIELD = 'The header {{ header_name }} is invalid.'; + public const MISSING_COOKIE_PARAM = 'The cookie {{ cookie_name }} must be provided.'; + public const INVALID_COOKIE_PARAM = 'The cookie {{ cookie_name }} is invalid.'; + public const INVALID_BODY = 'The request body is invalid.'; + public const EMPTY_JSON_PAYLOAD = 'The JSON payload cannot be empty.'; + public const INVALID_JSON_PAYLOAD = 'The JSON payload is invalid and could not be decoded.'; + public const INVALID_JSON_PAYLOAD_FORM = 'The JSON payload must be in the form of an array or an object.'; } diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index 0c67f92e..2380637b 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -32,9 +32,9 @@ class HttpException extends RuntimeException implements HttpExceptionInterface private string $messageTemplate; /** - * @var array + * @var array */ - private array $messagePlaceholders; + private array $messagePlaceholders = []; /** * @var list @@ -46,14 +46,11 @@ class HttpException extends RuntimeException implements HttpExceptionInterface */ private array $constraintViolations = []; - public function __construct(int $code, string $message, array $placeholders = [], ?Throwable $previous = null) + public function __construct(string $message, int $code, ?Throwable $previous = null) { - $this->messageTemplate = $message; - $this->messagePlaceholders = $placeholders; - - $interpolatedMessage = strtr($message, $placeholders); + parent::__construct($message, $code, $previous); - parent::__construct($interpolatedMessage, $code, $previous); + $this->messageTemplate = $message; } /** diff --git a/src/Exception/HttpExceptionFactory.php b/src/Exception/HttpExceptionFactory.php index 9afb8cd4..76f97611 100644 --- a/src/Exception/HttpExceptionFactory.php +++ b/src/Exception/HttpExceptionFactory.php @@ -23,211 +23,193 @@ final class HttpExceptionFactory { public static function resourceNotFound( - ?int $code = null, ?string $message = null, - array $placeholders = [], + ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - code: $code ?? StatusCodeInterface::STATUS_NOT_FOUND, message: $message ?? ErrorMessage::RESOURCE_NOT_FOUND, - placeholders: $placeholders, + code: $code ?? StatusCodeInterface::STATUS_NOT_FOUND, previous: $previous, ); } public static function methodNotAllowed( - ?int $code = null, ?string $message = null, - array $placeholders = [], + ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - code: $code ?? StatusCodeInterface::STATUS_METHOD_NOT_ALLOWED, message: $message ?? ErrorMessage::METHOD_NOT_ALLOWED, - placeholders: $placeholders, + code: $code ?? StatusCodeInterface::STATUS_METHOD_NOT_ALLOWED, previous: $previous, ); } - public static function mediaTypeNotSupported( - ?int $code = null, + public static function missingMediaType( ?string $message = null, - array $placeholders = [], + ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( + message: $message ?? ErrorMessage::MISSING_MEDIA_TYPE, code: $code ?? StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE, - message: $message ?? ErrorMessage::MEDIA_TYPE_NOT_SUPPORTED, - placeholders: $placeholders, previous: $previous, ); } - public static function pathVariableInvalid( + public static function unsupportedMediaType( + ?string $message = null, ?int $code = null, + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + message: $message ?? ErrorMessage::UNSUPPORTED_MEDIA_TYPE, + code: $code ?? StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE, + previous: $previous, + ); + } + + public static function invalidPathVariable( ?string $message = null, - array $placeholders = [], + ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( + message: $message ?? ErrorMessage::INVALID_PATH_VARIABLE, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::PATH_VARIABLE_INVALID, - placeholders: $placeholders, previous: $previous, ); } - public static function queryParamsInvalid( - ?int $code = null, + public static function invalidQueryParams( ?string $message = null, - array $placeholders = [], + ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( + message: $message ?? ErrorMessage::INVALID_QUERY_PARAMS, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::QUERY_PARAMS_INVALID, - placeholders: $placeholders, previous: $previous, ); } - public static function queryParamMissed( - ?int $code = null, + public static function missingQueryParam( ?string $message = null, - array $placeholders = [], + ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( + message: $message ?? ErrorMessage::MISSING_QUERY_PARAM, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::QUERY_PARAM_MISSED, - placeholders: $placeholders, previous: $previous, ); } - public static function queryParamInvalid( - ?int $code = null, + public static function invalidQueryParam( ?string $message = null, - array $placeholders = [], + ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( + message: $message ?? ErrorMessage::INVALID_QUERY_PARAM, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::QUERY_PARAM_INVALID, - placeholders: $placeholders, previous: $previous, ); } - public static function headerMissed( - ?int $code = null, + public static function missingHeaderField( ?string $message = null, - array $placeholders = [], + ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( + message: $message ?? ErrorMessage::MISSING_HEADER_FIELD, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::HEADER_MISSED, - placeholders: $placeholders, previous: $previous, ); } - public static function headerInvalid( - ?int $code = null, + public static function invalidHeaderField( ?string $message = null, - array $placeholders = [], + ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( + message: $message ?? ErrorMessage::INVALID_HEADER_FIELD, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::HEADER_INVALID, - placeholders: $placeholders, previous: $previous, ); } - public static function cookieMissed( - ?int $code = null, + public static function missingCookieParam( ?string $message = null, - array $placeholders = [], + ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( + message: $message ?? ErrorMessage::MISSING_COOKIE_PARAM, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::COOKIE_MISSED, - placeholders: $placeholders, previous: $previous, ); } - public static function cookieInvalid( - ?int $code = null, + public static function invalidCookieParam( ?string $message = null, - array $placeholders = [], + ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( + message: $message ?? ErrorMessage::INVALID_COOKIE_PARAM, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::COOKIE_INVALID, - placeholders: $placeholders, previous: $previous, ); } - public static function bodyInvalid( - ?int $code = null, + public static function invalidBody( ?string $message = null, - array $placeholders = [], + ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( + message: $message ?? ErrorMessage::INVALID_BODY, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::BODY_INVALID, - placeholders: $placeholders, previous: $previous, ); } - public static function jsonPayloadEmpty( - ?int $code = null, + public static function emptyJsonPayload( ?string $message = null, - array $placeholders = [], + ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( + message: $message ?? ErrorMessage::EMPTY_JSON_PAYLOAD, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::JSON_PAYLOAD_EMPTY, - placeholders: $placeholders, previous: $previous, ); } - public static function jsonPayloadInvalid( - ?int $code = null, + public static function invalidJsonPayload( ?string $message = null, - array $placeholders = [], + ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( + message: $message ?? ErrorMessage::INVALID_JSON_PAYLOAD, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::JSON_PAYLOAD_INVALID, - placeholders: $placeholders, previous: $previous, ); } - public static function jsonPayloadFormInvalid( - ?int $code = null, + public static function invalidJsonPayloadForm( ?string $message = null, - array $placeholders = [], + ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( + message: $message ?? ErrorMessage::INVALID_JSON_PAYLOAD_FORM, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - message: $message ?? ErrorMessage::JSON_PAYLOAD_FORM_INVALID, - placeholders: $placeholders, previous: $previous, ); } diff --git a/src/Exception/HttpExceptionInterface.php b/src/Exception/HttpExceptionInterface.php index 847454e7..5b4e6800 100644 --- a/src/Exception/HttpExceptionInterface.php +++ b/src/Exception/HttpExceptionInterface.php @@ -26,7 +26,7 @@ interface HttpExceptionInterface extends ExceptionInterface public function getMessageTemplate(): string; /** - * @return array + * @return array */ public function getMessagePlaceholders(): array; diff --git a/src/Exception/InvalidLoaderResourceException.php b/src/Exception/InvalidLoaderResourceException.php new file mode 100644 index 00000000..47cf151c --- /dev/null +++ b/src/Exception/InvalidLoaderResourceException.php @@ -0,0 +1,23 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Exception; + +use InvalidArgumentException; + +/** + * @since 3.0.0 + */ +final class InvalidLoaderResourceException extends InvalidArgumentException implements ExceptionInterface +{ +} diff --git a/src/Exception/InvalidRouteBuildingValueException.php b/src/Exception/InvalidRouteBuildingValueException.php new file mode 100644 index 00000000..e3c95641 --- /dev/null +++ b/src/Exception/InvalidRouteBuildingValueException.php @@ -0,0 +1,23 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Exception; + +use InvalidArgumentException; + +/** + * @since 3.0.0 + */ +final class InvalidRouteBuildingValueException extends InvalidArgumentException implements ExceptionInterface +{ +} diff --git a/src/Exception/InvalidRouteMatchingPatternException.php b/src/Exception/InvalidRouteMatchingPatternException.php new file mode 100644 index 00000000..ac6e280f --- /dev/null +++ b/src/Exception/InvalidRouteMatchingPatternException.php @@ -0,0 +1,23 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Exception; + +use InvalidArgumentException; + +/** + * @since 3.0.0 + */ +final class InvalidRouteMatchingPatternException extends InvalidArgumentException implements ExceptionInterface +{ +} diff --git a/src/Exception/InvalidRouteMatchingSubjectException.php b/src/Exception/InvalidRouteMatchingSubjectException.php new file mode 100644 index 00000000..4fa08962 --- /dev/null +++ b/src/Exception/InvalidRouteMatchingSubjectException.php @@ -0,0 +1,23 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Exception; + +use InvalidArgumentException; + +/** + * @since 3.0.0 + */ +final class InvalidRouteMatchingSubjectException extends InvalidArgumentException implements ExceptionInterface +{ +} diff --git a/src/Exception/InvalidRouteParsingSubjectException.php b/src/Exception/InvalidRouteParsingSubjectException.php new file mode 100644 index 00000000..1e6b72cb --- /dev/null +++ b/src/Exception/InvalidRouteParsingSubjectException.php @@ -0,0 +1,23 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Exception; + +use InvalidArgumentException; + +/** + * @since 3.0.0 + */ +final class InvalidRouteParsingSubjectException extends InvalidArgumentException implements ExceptionInterface +{ +} diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index cab02b93..a22c1b40 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -14,7 +14,8 @@ namespace Sunrise\Http\Router\Helper; use BackedEnum; -use InvalidArgumentException; +use Sunrise\Http\Router\Exception\InvalidRouteBuildingValueException; +use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; use function sprintf; use function str_replace; @@ -26,7 +27,8 @@ final class RouteBuilder { /** - * @throws InvalidArgumentException If the route isn't valid or any of the required values are missing. + * @throws InvalidRouteBuildingValueException + * @throws InvalidRouteParsingSubjectException */ public static function buildRoute(string $route, array $values = []): string { @@ -58,7 +60,7 @@ public static function buildRoute(string $route, array $values = []): string continue; } - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteBuildingValueException(sprintf( 'The route %s could not be built without a required value for the variable %s.', $route, $variable['name'], diff --git a/src/Helper/RouteCompiler.php b/src/Helper/RouteCompiler.php index 9d521852..1e41ec3a 100644 --- a/src/Helper/RouteCompiler.php +++ b/src/Helper/RouteCompiler.php @@ -13,7 +13,7 @@ namespace Sunrise\Http\Router\Helper; -use InvalidArgumentException; +use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; use function addcslashes; use function str_replace; @@ -31,7 +31,7 @@ final class RouteCompiler * * @return non-empty-string * - * @throws InvalidArgumentException If the route isn't valid. + * @throws InvalidRouteParsingSubjectException */ public static function compileRoute(string $route, array $patterns = []): string { diff --git a/src/Helper/RouteMatcher.php b/src/Helper/RouteMatcher.php index 79942646..cce8294e 100644 --- a/src/Helper/RouteMatcher.php +++ b/src/Helper/RouteMatcher.php @@ -14,7 +14,10 @@ namespace Sunrise\Http\Router\Helper; use ErrorException; -use InvalidArgumentException; +use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; +use Sunrise\Http\Router\Exception\InvalidRouteMatchingPatternException; +use Sunrise\Http\Router\Exception\InvalidRouteMatchingSubjectException; +use Throwable; use function is_int; use function preg_last_error; @@ -23,6 +26,7 @@ use function sprintf; use const E_WARNING; +use const PREG_BAD_UTF8_ERROR; use const PREG_UNMATCHED_AS_NULL; /** @@ -34,7 +38,9 @@ final class RouteMatcher * @param array $patterns * @param-out array $matches * - * @throws InvalidArgumentException If the route or one of the patterns isn't valid. + * @throws InvalidRouteMatchingPatternException + * @throws InvalidRouteMatchingSubjectException + * @throws InvalidRouteParsingSubjectException */ public static function matchRoute(string $route, array $patterns, string $subject, ?array &$matches = null): bool { @@ -47,7 +53,8 @@ public static function matchRoute(string $route, array $patterns, string $subjec * @param non-empty-string $pattern * @param-out array $matches * - * @throws InvalidArgumentException If the pattern isn't valid. + * @throws InvalidRouteMatchingPatternException + * @throws InvalidRouteMatchingSubjectException */ public static function matchPattern(string $route, string $pattern, string $subject, ?array &$matches = null): bool { @@ -55,12 +62,35 @@ public static function matchPattern(string $route, string $pattern, string $subj if (($result = @preg_match($pattern, $subject, $matches, PREG_UNMATCHED_AS_NULL)) === false) { throw new ErrorException(preg_last_error_msg(), preg_last_error(), E_WARNING); } - } catch (ErrorException $e) { - throw new InvalidArgumentException(sprintf( - 'The route %s could not be matched due to a syntax error in one of variable patterns: %s', - $route, - $e->getMessage(), - ), previous: $e); + } catch (Throwable $e) { + if (preg_last_error() === PREG_BAD_UTF8_ERROR) { + throw new InvalidRouteMatchingSubjectException( + sprintf( + 'The route %s could not be matched due to an invalid subject: %s.', + $route, + preg_last_error_msg(), + ), + code: preg_last_error(), + previous: $e, + ); + } + + throw new InvalidRouteMatchingPatternException( + sprintf( + 'The route %s could not be matched due to: %s; ' . + 'most likely, this problem is related to one of the route patterns. ' . + 'Please refer to the official documentation: ' . + 'https://www.php.net/preg_last_error', + $route, + preg_last_error_msg(), + ), + code: preg_last_error(), + previous: $e, + ); + } + + if ($result === 0) { + return false; } foreach ($matches as $key => $match) { @@ -71,6 +101,6 @@ public static function matchPattern(string $route, string $pattern, string $subj /** @var array $matches */ - return $result === 1; + return true; } } diff --git a/src/Helper/RouteParser.php b/src/Helper/RouteParser.php index 775a4361..fec714b7 100644 --- a/src/Helper/RouteParser.php +++ b/src/Helper/RouteParser.php @@ -13,8 +13,8 @@ namespace Sunrise\Http\Router\Helper; -use InvalidArgumentException; use Sunrise\Http\Router\Dictionary\Charset; +use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; use function sprintf; @@ -28,7 +28,7 @@ final class RouteParser * * @return list * - * @throws InvalidArgumentException If the route isn't valid. + * @throws InvalidRouteParsingSubjectException */ public static function parseRoute(string $route): array { @@ -47,7 +47,7 @@ public static function parseRoute(string $route): array for ($offset = 0; isset($route[$offset]); $offset++) { if ($route[$offset] === '(' && !($cursor & $inVariable)) { if (($cursor & $inOptionalPart)) { - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to open an optional part at position %d has failed ' . 'because nested optional parts are not supported.', @@ -61,7 +61,7 @@ public static function parseRoute(string $route): array } if ($route[$offset] === ')' && !($cursor & $inVariable)) { if (!($cursor & $inOptionalPart)) { - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to close an optional part at position %d has failed ' . 'because an open optional part was not found.', @@ -83,7 +83,7 @@ public static function parseRoute(string $route): array if ($route[$offset] === '{' && !($cursor & $inVariablePattern)) { if (($cursor & $inVariable)) { - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to open a variable at position %d has failed ' . 'because nested variables are not supported.', @@ -92,7 +92,7 @@ public static function parseRoute(string $route): array )); } if (($cursor & $inOccupiedPart)) { - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to open a variable at position %d has failed ' . 'because more than one variable inside an optional part is not supported.', @@ -114,7 +114,7 @@ public static function parseRoute(string $route): array } if ($route[$offset] === '}' && !($cursor & $inVariablePattern)) { if (!($cursor & $inVariable)) { - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to close a variable at position %d has failed ' . 'because an open variable was not found.', @@ -123,7 +123,7 @@ public static function parseRoute(string $route): array )); } if (!isset($variables[$variable]['name'])) { - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to close a variable at position %d has failed ' . 'because its name is required for its declaration.', @@ -140,7 +140,7 @@ public static function parseRoute(string $route): array if ($route[$offset] === '<' && ($cursor & $inVariable)) { if (($cursor & $inVariablePattern)) { - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to open a variable pattern at position %d has failed ' . 'because nested patterns are not supported.', @@ -149,7 +149,7 @@ public static function parseRoute(string $route): array )); } if (!($cursor & $inVariableName)) { - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to open a variable pattern at position %d has failed ' . 'because the pattern must be preceded by the variable name.', @@ -163,7 +163,7 @@ public static function parseRoute(string $route): array } if ($route[$offset] === '>' && ($cursor & $inVariable)) { if (!($cursor & $inVariablePattern)) { - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to close a variable pattern at position %d has failed ' . 'because an open pattern was not found.', @@ -172,7 +172,7 @@ public static function parseRoute(string $route): array )); } if (!isset($variables[$variable]['pattern'])) { - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to close a variable pattern at position %d has failed ' . 'because its content is required for its declaration.', @@ -200,7 +200,7 @@ public static function parseRoute(string $route): array // https://www.pcre.org/original/doc/html/pcrepattern.html#SEC16 if (($cursor & $inVariableName)) { if (!isset($variables[$variable]['name']) && $route[$offset] >= '0' && $route[$offset] <= '9') { - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An invalid character was found at position %d. ' . 'Please note that variable names cannot start with digits.', @@ -209,7 +209,7 @@ public static function parseRoute(string $route): array )); } if (!isset(Charset::PCRE_SUBPATTERN_NAME[$route[$offset]])) { - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An invalid character was found at position %d. ' . 'Please note that variable names must consist only of digits, letters and underscores.', @@ -218,7 +218,7 @@ public static function parseRoute(string $route): array )); } if (isset($variables[$variable]['name'][31])) { - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An extra character was found at position %d. ' . 'Please note that variable names must not exceed 32 characters.', @@ -234,7 +234,7 @@ public static function parseRoute(string $route): array if (($cursor & $inVariablePattern)) { if ($route[$offset] === RouteCompiler::PATTERN_DELIMITER) { - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An invalid character was found at position %d. ' . 'Please note that variable patterns cannot contain the %s character; ' . @@ -253,7 +253,7 @@ public static function parseRoute(string $route): array // {foo<\w+>xxx} // ~~~~~~~~~^^^~ if (($cursor & $inVariable)) { - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An unexpected character was found at position %d; a variable at this position must be closed.', $route, @@ -263,7 +263,7 @@ public static function parseRoute(string $route): array } if (($cursor & $inVariable) || ($cursor & $inOptionalPart)) { - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to parse the route has failed because it contains an unclosed optional part or variable.', $route, diff --git a/src/Helper/RouteSimplifier.php b/src/Helper/RouteSimplifier.php index 947ee119..ec1288ad 100644 --- a/src/Helper/RouteSimplifier.php +++ b/src/Helper/RouteSimplifier.php @@ -13,7 +13,7 @@ namespace Sunrise\Http\Router\Helper; -use InvalidArgumentException; +use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; use function str_replace; use function substr; @@ -24,7 +24,7 @@ final class RouteSimplifier { /** - * @throws InvalidArgumentException If the route isn't valid. + * @throws InvalidRouteParsingSubjectException */ public static function simplifyRoute(string $route): string { diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 2f2ce3fa..9ba3c13c 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router\Loader; use Generator; -use InvalidArgumentException; use Psr\Http\Server\RequestHandlerInterface; use Psr\SimpleCache\CacheException; use Psr\SimpleCache\CacheInterface; @@ -37,6 +36,7 @@ use Sunrise\Http\Router\Annotation\Route as Descriptor; use Sunrise\Http\Router\Annotation\Summary; use Sunrise\Http\Router\Annotation\Tag; +use Sunrise\Http\Router\Exception\InvalidLoaderResourceException; use Sunrise\Http\Router\Helper\FilesystemHelper; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Route; @@ -65,9 +65,8 @@ public function __construct( /** * @inheritDoc * - * @throws InvalidArgumentException If one of the resources isn't supported. - * - * @throws CacheException If something went wrong while working with the cache. + * @throws InvalidLoaderResourceException + * @throws CacheException */ public function load(): Generator { @@ -95,9 +94,8 @@ public function load(): Generator /** * @return list * - * @throws InvalidArgumentException If one of the resources isn't supported. - * - * @throws CacheException If something went wrong while working with the cache. + * @throws InvalidLoaderResourceException + * @throws CacheException */ private function getDescriptors(): array { @@ -124,7 +122,7 @@ private function getDescriptors(): array /** * @return Generator * - * @throws InvalidArgumentException If the resource isn't supported. + * @throws InvalidLoaderResourceException */ private function getResourceDescriptors(string $resource): Generator { @@ -152,7 +150,7 @@ private function getResourceDescriptors(string $resource): Generator return; } - throw new InvalidArgumentException(sprintf( + throw new InvalidLoaderResourceException(sprintf( 'The loader %s only accepts directory, file or class names; ' . 'however, the resource %s is not one of them.', __CLASS__, diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 46a0e43d..61a39b63 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -58,17 +58,17 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface private function decodePayload(string $payload): array { if ($payload === '') { - throw HttpExceptionFactory::jsonPayloadEmpty(); + throw HttpExceptionFactory::emptyJsonPayload(); } try { $data = json_decode($payload, true, flags: JSON_BIGINT_AS_STRING | JSON_THROW_ON_ERROR); } catch (JsonException $e) { - throw HttpExceptionFactory::jsonPayloadInvalid(previous: $e); + throw HttpExceptionFactory::invalidJsonPayload(previous: $e); } if (is_array($data) === false) { - throw HttpExceptionFactory::jsonPayloadFormInvalid(); + throw HttpExceptionFactory::invalidJsonPayloadForm(); } return $data; diff --git a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php index 625b6c5a..e6f82e9a 100644 --- a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php +++ b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php @@ -36,7 +36,12 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface $serverRequest = ServerRequest::create($request); $serverConsumedMediaTypes = $serverRequest->getRoute()->getConsumedMediaTypes(); if (! $serverRequest->clientProducesMediaType(...$serverConsumedMediaTypes)) { - throw HttpExceptionFactory::mediaTypeNotSupported() + if ($serverRequest->getClientProducedMediaType() === null) { + throw HttpExceptionFactory::missingMediaType() + ->addHeaderField('Accept', ...$serverConsumedMediaTypes); + } + + throw HttpExceptionFactory::unsupportedMediaType() ->addMessagePlaceholder('{{ media_type }}', $serverRequest->getClientProducedMediaType()) ->addHeaderField('Accept', ...$serverConsumedMediaTypes); } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 5eb1cd1d..59c64aff 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -48,7 +48,6 @@ public function __construct( * @inheritDoc * * @throws LogicException If the resolver is used incorrectly or if an object isn't valid. - * * @throws HttpException If the request's parsed body isn't valid. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator @@ -78,13 +77,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) try { $argument = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidDataException $e) { - throw HttpExceptionFactory::bodyInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::invalidBody($processParams->errorMessage, $errorStatusCode, previous: $e) ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $e->getExceptions())); } if (isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { - throw HttpExceptionFactory::bodyInvalid($errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::invalidBody($processParams->errorMessage, $errorStatusCode) ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } } diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index 0160641a..70e05750 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -49,7 +49,6 @@ public function __construct( * @inheritDoc * * @throws LogicException If the resolver is used incorrectly. - * * @throws HttpException If a cookie was missed or invalid. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator @@ -74,7 +73,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return yield $parameter->getDefaultValue(); } - throw HttpExceptionFactory::cookieMissed($errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::missingCookieParam($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName); } @@ -87,7 +86,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } catch (InvalidValueException|InvalidDataException $e) { $violations = ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions(); - throw HttpExceptionFactory::cookieInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::invalidCookieParam($processParams->errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName) ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $violations)); } @@ -95,7 +94,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpExceptionFactory::cookieInvalid($errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::invalidCookieParam($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName) ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 8a845401..07fcfd37 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -48,7 +48,6 @@ public function __construct( * @inheritDoc * * @throws LogicException If the resolver is used incorrectly. - * * @throws HttpException If a header was missed or invalid. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator @@ -72,7 +71,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return yield $parameter->getDefaultValue(); } - throw HttpExceptionFactory::headerMissed($errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::missingHeaderField($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName); } @@ -85,7 +84,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } catch (InvalidValueException|InvalidDataException $e) { $violations = ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions(); - throw HttpExceptionFactory::headerInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::invalidHeaderField($processParams->errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName) ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $violations)); } @@ -93,7 +92,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpExceptionFactory::headerInvalid($errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::invalidHeaderField($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName) ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } diff --git a/src/ParameterResolver/RequestPathVariableParameterResolver.php b/src/ParameterResolver/RequestPathVariableParameterResolver.php index 6e8d4425..9f949e12 100644 --- a/src/ParameterResolver/RequestPathVariableParameterResolver.php +++ b/src/ParameterResolver/RequestPathVariableParameterResolver.php @@ -52,7 +52,6 @@ public function __construct( * @inheritDoc * * @throws LogicException If the resolver is used incorrectly. - * * @throws HttpException If a path variable isn't valid. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator @@ -105,7 +104,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } catch (InvalidValueException|InvalidDataException $e) { $violations = ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions(); - throw HttpExceptionFactory::pathVariableInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::invalidPathVariable($processParams->errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ variable_name }}', $variableName) ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $violations)); @@ -114,7 +113,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpExceptionFactory::pathVariableInvalid($errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::invalidPathVariable($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ variable_name }}', $variableName) ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); diff --git a/src/ParameterResolver/RequestQueryParamParameterResolver.php b/src/ParameterResolver/RequestQueryParamParameterResolver.php index c63c3e31..33a137b6 100644 --- a/src/ParameterResolver/RequestQueryParamParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamParameterResolver.php @@ -49,7 +49,6 @@ public function __construct( * @inheritDoc * * @throws LogicException If the resolver is used incorrectly. - * * @throws HttpException If a query parameter was missed or invalid. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator @@ -74,7 +73,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return yield $parameter->getDefaultValue(); } - throw HttpExceptionFactory::queryParamMissed($errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::missingQueryParam($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName); } @@ -87,7 +86,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } catch (InvalidValueException|InvalidDataException $e) { $violations = ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions(); - throw HttpExceptionFactory::queryParamInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::invalidQueryParam($processParams->errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName) ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $violations)); } @@ -95,7 +94,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpExceptionFactory::queryParamInvalid($errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::invalidQueryParam($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName) ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } diff --git a/src/ParameterResolver/RequestQueryParamsParameterResolver.php b/src/ParameterResolver/RequestQueryParamsParameterResolver.php index a51cba42..f8a5a800 100644 --- a/src/ParameterResolver/RequestQueryParamsParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamsParameterResolver.php @@ -48,7 +48,6 @@ public function __construct( * @inheritDoc * * @throws LogicException If the resolver is used incorrectly or if an object isn't valid. - * * @throws HttpException If the request's query parameters aren't valid. */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator @@ -78,13 +77,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) try { $argument = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { - throw HttpExceptionFactory::queryParamsInvalid($errorStatusCode, $processParams->errorMessage, previous: $e) + throw HttpExceptionFactory::invalidQueryParams($processParams->errorMessage, $errorStatusCode, previous: $e) ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $e->getExceptions())); } if (isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { - throw HttpExceptionFactory::queryParamsInvalid($errorStatusCode, $processParams->errorMessage) + throw HttpExceptionFactory::invalidQueryParams($processParams->errorMessage, $errorStatusCode) ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } } diff --git a/src/Router.php b/src/Router.php index 64ef5bf6..42cd6660 100644 --- a/src/Router.php +++ b/src/Router.php @@ -20,6 +20,7 @@ use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; +use Sunrise\Http\Router\Exception\InvalidRouteMatchingSubjectException; use Sunrise\Http\Router\Helper\RouteBuilder; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Helper\RouteMatcher; @@ -29,7 +30,8 @@ use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; -use function array_merge; +use function array_flip; +use function array_keys; use function rawurldecode; use function sprintf; @@ -127,14 +129,16 @@ public function match(ServerRequestInterface $request): Route foreach ($this->routes as $route) { $routePattern = $this->compileRoute($route); - // https://github.com/sunrise-php/http-router/issues/50 - // https://tools.ietf.org/html/rfc7231#section-6.5.5 - if (!RouteMatcher::matchPattern($route->getPath(), $routePattern, $requestPath, $matches)) { - continue; + try { + if (!RouteMatcher::matchPattern($route->getPath(), $routePattern, $requestPath, $matches)) { + continue; + } + } catch (InvalidRouteMatchingSubjectException $e) { + throw new HttpException($e->getMessage(), 400); // TODO } if (!$route->allowsMethod($request->getMethod())) { - $allowedMethods = array_merge($allowedMethods, $route->getMethods()); + $allowedMethods += array_flip($route->getMethods()); continue; } @@ -144,7 +148,7 @@ public function match(ServerRequestInterface $request): Route if (!empty($allowedMethods)) { throw HttpExceptionFactory::methodNotAllowed() ->addMessagePlaceholder('{{ method }}', $request->getMethod()) - ->addHeaderField('Allow', ...$allowedMethods); + ->addHeaderField('Allow', ...array_keys($allowedMethods)); } throw HttpExceptionFactory::resourceNotFound() diff --git a/src/ServerRequest.php b/src/ServerRequest.php index b749db80..9fbe54e0 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -212,6 +212,7 @@ public function clientConsumesMediaType(MediaTypeInterface ...$serverProducedMed } $clientConsumedMediaTypes = $this->getClientConsumedMediaTypes(); + // This case is interpreted as follows: the client accepts any media type... if (!$clientConsumedMediaTypes->valid()) { return true; } @@ -228,24 +229,6 @@ public function clientConsumesMediaType(MediaTypeInterface ...$serverProducedMed return false; } - public function clientConsumesLanguage(LanguageInterface ...$serverProducedLanguages): bool - { - if ($serverProducedLanguages === []) { - return false; - } - - $languageComparator = new LanguageComparator(); - foreach ($this->getClientConsumedLanguages() as $clientConsumedLanguage) { - foreach ($serverProducedLanguages as $serverProducedLanguage) { - if ($languageComparator->equals($clientConsumedLanguage, $serverProducedLanguage)) { - return true; - } - } - } - - return false; - } - /** * @inheritDoc */ From 82e70c494b492a5d73e935ee53fe027c188a49a4 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 8 Mar 2024 08:07:33 +0100 Subject: [PATCH 119/180] v3 --- src/Exception/HttpExceptionInterface.php | 4 +- src/Loader/DescriptorLoader.php | 2 +- src/Loader/LoaderInterface.php | 4 +- .../PayloadMediaTypeNegotiationMiddleware.php | 4 +- .../RequestPathVariableParameterResolver.php | 13 +-- src/Route.php | 48 +++++----- src/RouteInterface.php | 92 +++++++++++++++++++ src/Router.php | 39 ++++---- src/ServerRequest.php | 12 ++- 9 files changed, 155 insertions(+), 63 deletions(-) create mode 100644 src/RouteInterface.php diff --git a/src/Exception/HttpExceptionInterface.php b/src/Exception/HttpExceptionInterface.php index 5b4e6800..dd11599b 100644 --- a/src/Exception/HttpExceptionInterface.php +++ b/src/Exception/HttpExceptionInterface.php @@ -31,12 +31,12 @@ public function getMessageTemplate(): string; public function getMessagePlaceholders(): array; /** - * @return list + * @return array */ public function getHeaderFields(): array; /** - * @return list + * @return array */ public function getConstraintViolations(): array; } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 9ba3c13c..1a44640a 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -99,7 +99,7 @@ public function load(): Generator */ private function getDescriptors(): array { - /** @var null|list $descriptors */ + /** @var list|null $descriptors */ $descriptors = $this->cache?->get($this->cacheKey); if (isset($descriptors)) { return $descriptors; diff --git a/src/Loader/LoaderInterface.php b/src/Loader/LoaderInterface.php index 5b4b7097..e17222d5 100644 --- a/src/Loader/LoaderInterface.php +++ b/src/Loader/LoaderInterface.php @@ -13,12 +13,12 @@ namespace Sunrise\Http\Router\Loader; -use Sunrise\Http\Router\Route; +use Sunrise\Http\Router\RouteInterface; interface LoaderInterface { /** - * @return iterable + * @return iterable */ public function load(): iterable; } diff --git a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php index e6f82e9a..57968388 100644 --- a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php +++ b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php @@ -21,6 +21,8 @@ use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\ServerRequest; +use function array_values; + /** * @since 3.0.0 */ @@ -34,7 +36,7 @@ final class PayloadMediaTypeNegotiationMiddleware implements MiddlewareInterface public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { $serverRequest = ServerRequest::create($request); - $serverConsumedMediaTypes = $serverRequest->getRoute()->getConsumedMediaTypes(); + $serverConsumedMediaTypes = array_values($serverRequest->getRoute()->getConsumedMediaTypes()); if (! $serverRequest->clientProducesMediaType(...$serverConsumedMediaTypes)) { if ($serverRequest->getClientProducedMediaType() === null) { throw HttpExceptionFactory::missingMediaType() diff --git a/src/ParameterResolver/RequestPathVariableParameterResolver.php b/src/ParameterResolver/RequestPathVariableParameterResolver.php index 9f949e12..c6cdede5 100644 --- a/src/ParameterResolver/RequestPathVariableParameterResolver.php +++ b/src/ParameterResolver/RequestPathVariableParameterResolver.php @@ -24,7 +24,7 @@ use Sunrise\Http\Router\Helper\RouteSimplifier; use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ParameterResolver; -use Sunrise\Http\Router\Route; +use Sunrise\Http\Router\ServerRequest; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; @@ -66,15 +66,8 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) throw new LogicException('At this level of the application, any operations with the request are not possible.'); } - $route = $context->getAttribute('@route'); - if (! $route instanceof Route) { - throw new LogicException(sprintf( - 'The #[RequestPathVariable] annotation cannot be applied to the parameter %s ' . - 'because the request does not contain information about the requested route.', - ParameterResolver::stringifyParameter($parameter), - )); - } - + $serverRequest = ServerRequest::create($context); + $route = $serverRequest->getRoute(); $processParams = $annotations[0]->newInstance(); $variableName = $processParams->variableName ?? $parameter->getName(); diff --git a/src/Route.php b/src/Route.php index 92627564..eaf21439 100644 --- a/src/Route.php +++ b/src/Route.php @@ -18,7 +18,7 @@ use function array_key_exists; use function in_array; -final class Route +final class Route implements RouteInterface { public function __construct( private readonly string $name, @@ -26,22 +26,22 @@ public function __construct( private readonly mixed $requestHandler, /** @var array */ private readonly array $patterns = [], - /** @var list */ + /** @var array */ private readonly array $methods = [], /** @var array */ private array $attributes = [], - /** @var list */ + /** @var array */ private readonly array $middlewares = [], - /** @var list */ + /** @var array */ private readonly array $constraints = [], - /** @var list */ + /** @var array */ private readonly array $consumes = [], - /** @var list */ + /** @var array */ private readonly array $produces = [], - /** @var list */ + /** @var array */ private readonly array $tags = [], - private readonly ?string $summary = null, - private readonly ?string $description = null, + private readonly string $summary = '', + private readonly string $description = '', private readonly bool $isDeprecated = false, /** @var non-empty-string|null */ private readonly ?string $pattern = null, @@ -64,7 +64,7 @@ public function getRequestHandler(): mixed } /** - * @return array + * @inheritDoc */ public function getPatterns(): array { @@ -72,7 +72,7 @@ public function getPatterns(): array } /** - * @return list + * @inheritDoc */ public function getMethods(): array { @@ -89,7 +89,7 @@ public function allowsMethod(string $method): bool } /** - * @return array + * @inheritDoc */ public function getAttributes(): array { @@ -107,9 +107,9 @@ public function hasAttribute(string $name): bool } /** - * @param array $attributes + * @inheritDoc */ - public function withAttributes(array $attributes): self + public function withAttributes(array $attributes): static { $clone = clone $this; $clone->attributes = $attributes; @@ -118,9 +118,9 @@ public function withAttributes(array $attributes): self } /** - * @param array $attributes + * @inheritDoc */ - public function withAddedAttributes(array $attributes): self + public function withAddedAttributes(array $attributes): static { $clone = clone $this; foreach ($attributes as $name => $value) { @@ -131,7 +131,7 @@ public function withAddedAttributes(array $attributes): self } /** - * @return list + * @inheritDoc */ public function getMiddlewares(): array { @@ -139,7 +139,7 @@ public function getMiddlewares(): array } /** - * @return list + * @inheritDoc */ public function getConstraints(): array { @@ -147,7 +147,7 @@ public function getConstraints(): array } /** - * @return list + * @inheritDoc */ public function getConsumedMediaTypes(): array { @@ -155,7 +155,7 @@ public function getConsumedMediaTypes(): array } /** - * @return list + * @inheritDoc */ public function getProducedMediaTypes(): array { @@ -163,19 +163,19 @@ public function getProducedMediaTypes(): array } /** - * @return list + * @inheritDoc */ public function getTags(): array { return $this->tags; } - public function getSummary(): ?string + public function getSummary(): string { return $this->summary; } - public function getDescription(): ?string + public function getDescription(): string { return $this->description; } @@ -186,7 +186,7 @@ public function isDeprecated(): bool } /** - * @return non-empty-string|null + * @inheritDoc */ public function getPattern(): ?string { diff --git a/src/RouteInterface.php b/src/RouteInterface.php new file mode 100644 index 00000000..f61c1991 --- /dev/null +++ b/src/RouteInterface.php @@ -0,0 +1,92 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router; + +use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; + +interface RouteInterface +{ + public function getName(): string; + + public function getPath(): string; + + public function getRequestHandler(): mixed; + + /** + * @return array + */ + public function getPatterns(): array; + + /** + * @return array + */ + public function getMethods(): array; + + public function allowsMethod(string $method): bool; + + /** + * @return array + */ + public function getAttributes(): array; + + public function getAttribute(string $name, mixed $default = null): mixed; + + public function hasAttribute(string $name): bool; + + /** + * @param array $attributes + */ + public function withAttributes(array $attributes): static; + + /** + * @param array $attributes + */ + public function withAddedAttributes(array $attributes): static; + + /** + * @return array + */ + public function getMiddlewares(): array; + + /** + * @return array + */ + public function getConstraints(): array; + + /** + * @return array + */ + public function getConsumedMediaTypes(): array; + + /** + * @return array + */ + public function getProducedMediaTypes(): array; + + /** + * @return array + */ + public function getTags(): array; + + public function getSummary(): string; + + public function getDescription(): string; + + public function isDeprecated(): bool; + + /** + * @return non-empty-string|null + */ + public function getPattern(): ?string; +} diff --git a/src/Router.php b/src/Router.php index 42cd6660..e95ef54e 100644 --- a/src/Router.php +++ b/src/Router.php @@ -20,7 +20,9 @@ use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; +use Sunrise\Http\Router\Exception\InvalidRouteBuildingValueException; use Sunrise\Http\Router\Exception\InvalidRouteMatchingSubjectException; +use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; use Sunrise\Http\Router\Helper\RouteBuilder; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Helper\RouteMatcher; @@ -35,12 +37,12 @@ use function rawurldecode; use function sprintf; -class Router +class Router implements RequestHandlerInterface { private readonly RequestHandlerResolver $requestHandlerResolver; /** - * @var array + * @var array */ private array $routes = []; @@ -81,7 +83,7 @@ public function __construct( } /** - * @return array + * @return array */ public function getRoutes(): array { @@ -91,7 +93,7 @@ public function getRoutes(): array /** * @throws InvalidArgumentException If the route doesn't exist. */ - public function getRoute(string $name): Route + public function getRoute(string $name): RouteInterface { if (isset($this->routes[$name])) { return $this->routes[$name]; @@ -103,7 +105,7 @@ public function getRoute(string $name): Route )); } - public function addRoute(Route ...$routes): void + public function addRoute(RouteInterface ...$routes): void { foreach ($routes as $route) { $this->routes[$route->getName()] = $route; @@ -122,7 +124,7 @@ public function load(LoaderInterface ...$loaders): void /** * @throws HttpException */ - public function match(ServerRequestInterface $request): Route + public function match(ServerRequestInterface $request): RouteInterface { $requestPath = rawurldecode($request->getUri()->getPath()); $allowedMethods = []; @@ -156,9 +158,9 @@ public function match(ServerRequestInterface $request): Route } /** - * @since 2.8.0 + * @inheritDoc */ - public function run(ServerRequestInterface $request): ResponseInterface + public function handle(ServerRequestInterface $request): ResponseInterface { return $this->getRouterRequestHandler()->handle($request); } @@ -166,9 +168,9 @@ public function run(ServerRequestInterface $request): ResponseInterface /** * @since 3.0.0 */ - public function runRoute(Route|string $route, ServerRequestInterface $request): ResponseInterface + public function runRoute(RouteInterface|string $route, ServerRequestInterface $request): ResponseInterface { - if (! $route instanceof Route) { + if (! $route instanceof RouteInterface) { $route = $this->getRoute($route); } @@ -182,13 +184,14 @@ public function runRoute(Route|string $route, ServerRequestInterface $request): } /** - * @throws InvalidArgumentException + * @throws InvalidRouteBuildingValueException + * @throws InvalidRouteParsingSubjectException * * @since 3.0.0 */ - public function buildRoute(Route|string $route, array $values = []): string + public function buildRoute(RouteInterface|string $route, array $values = []): string { - if (! $route instanceof Route) { + if (! $route instanceof RouteInterface) { $route = $this->getRoute($route); } @@ -198,13 +201,13 @@ public function buildRoute(Route|string $route, array $values = []): string /** * @return non-empty-string * - * @throws InvalidArgumentException + * @throws InvalidRouteParsingSubjectException * * @since 3.0.0 */ - public function compileRoute(Route|string $route): string + public function compileRoute(RouteInterface|string $route): string { - if (! $route instanceof Route) { + if (! $route instanceof RouteInterface) { $route = $this->getRoute($route); } @@ -216,9 +219,9 @@ public function compileRoute(Route|string $route): string * * @since 3.0.0 */ - public function getRouteRequestHandler(Route|string $route): RequestHandlerInterface + public function getRouteRequestHandler(RouteInterface|string $route): RequestHandlerInterface { - if (! $route instanceof Route) { + if (! $route instanceof RouteInterface) { $route = $this->getRoute($route); } diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 9fbe54e0..69678e5a 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -41,7 +41,7 @@ public function __construct(private ServerRequestInterface $request) public static function create(ServerRequestInterface $request): self { - return ($request instanceof self) ? $request : new self($request); + return new self($request); } public function getOriginalRequest(): ServerRequestInterface @@ -49,12 +49,14 @@ public function getOriginalRequest(): ServerRequestInterface return $this->request; } - public function getRoute(): Route + /** + * @throws LogicException If the request doesn't contain a route. + */ + public function getRoute(): RouteInterface { - /** @var Route|null $route */ $route = $this->getAttribute('@route'); - if (! $route instanceof Route) { - throw new LogicException('At this level of the application, the request does not contain a route.'); + if (! $route instanceof RouteInterface) { + throw new LogicException('At this level of the application, the request does not contain information about the requested route.'); } return $route; From 23719d6a9fa0099b6c8d69314b5400e8f99422b7 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 9 Mar 2024 05:58:30 +0100 Subject: [PATCH 120/180] v3 --- ...equestQueryParams.php => RequestQuery.php} | 2 +- src/Dictionary/ErrorMessage.php | 4 +- src/Exception/HttpExceptionFactory.php | 4 +- ...ption.php => InvalidResponseException.php} | 2 +- .../InvalidRouteLoadingResourceException.php | 23 ++++ src/Exception/RouteNotFoundException.php | 23 ++++ src/Helper/RouteBuilder.php | 19 ++- src/Helper/RouteMatcher.php | 6 +- src/Loader/DescriptorLoader.php | 19 ++- .../PayloadMediaTypeNegotiationMiddleware.php | 5 +- .../DependencyInjectionParameterResolver.php | 2 +- .../RequestBodyParameterResolver.php | 6 +- .../RequestCookieParameterResolver.php | 23 ++-- .../RequestHeaderParameterResolver.php | 23 ++-- .../RequestPathVariableParameterResolver.php | 21 ++-- .../RequestQueryParamParameterResolver.php | 23 ++-- ....php => RequestQueryParameterResolver.php} | 20 +-- ...olver.php => RequestProcessorResolver.php} | 4 +- src/ResponseResolver/JsonResponseResolver.php | 6 +- src/Route.php | 5 +- src/Router.php | 9 +- src/ServerRequest.php | 116 +++++------------- 22 files changed, 182 insertions(+), 183 deletions(-) rename src/Annotation/{RequestQueryParams.php => RequestQuery.php} (95%) rename src/Exception/{InvalidLoaderResourceException.php => InvalidResponseException.php} (80%) create mode 100644 src/Exception/InvalidRouteLoadingResourceException.php create mode 100644 src/Exception/RouteNotFoundException.php rename src/ParameterResolver/{RequestQueryParamsParameterResolver.php => RequestQueryParameterResolver.php} (77%) rename src/{RequestHandlerResolver.php => RequestProcessorResolver.php} (98%) diff --git a/src/Annotation/RequestQueryParams.php b/src/Annotation/RequestQuery.php similarity index 95% rename from src/Annotation/RequestQueryParams.php rename to src/Annotation/RequestQuery.php index 8710e1f7..0759e9c4 100644 --- a/src/Annotation/RequestQueryParams.php +++ b/src/Annotation/RequestQuery.php @@ -19,7 +19,7 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_PARAMETER)] -final class RequestQueryParams +final class RequestQuery { public function __construct( public readonly ?int $errorStatusCode = null, diff --git a/src/Dictionary/ErrorMessage.php b/src/Dictionary/ErrorMessage.php index a0bc2d64..101237e1 100644 --- a/src/Dictionary/ErrorMessage.php +++ b/src/Dictionary/ErrorMessage.php @@ -22,8 +22,8 @@ final class ErrorMessage public const METHOD_NOT_ALLOWED = 'The method {{ method }} is not allowed; check the Allow response header for allowed methods.'; public const MISSING_MEDIA_TYPE = 'The Content-Type header must be provided and cannot be empty; check the Accept response header for supported media types.'; public const UNSUPPORTED_MEDIA_TYPE = 'The media type {{ media_type }} is not supported; check the Accept response header for supported media types.'; - public const INVALID_PATH_VARIABLE = 'The variable {{ variable_name }} of the route {{ route_path }} is invalid.'; - public const INVALID_QUERY_PARAMS = 'The query parameters are invalid.'; + public const INVALID_PATH_VARIABLE = 'The variable {{ variable_name }} of the route {{ route }} is invalid.'; + public const INVALID_QUERY = 'The query parameters are invalid.'; public const MISSING_QUERY_PARAM = 'The query parameter {{ param_name }} must be provided.'; public const INVALID_QUERY_PARAM = 'The query parameter {{ param_name }} is invalid.'; public const MISSING_HEADER_FIELD = 'The header {{ header_name }} must be provided.'; diff --git a/src/Exception/HttpExceptionFactory.php b/src/Exception/HttpExceptionFactory.php index 76f97611..756f8641 100644 --- a/src/Exception/HttpExceptionFactory.php +++ b/src/Exception/HttpExceptionFactory.php @@ -82,13 +82,13 @@ public static function invalidPathVariable( ); } - public static function invalidQueryParams( + public static function invalidQuery( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::INVALID_QUERY_PARAMS, + message: $message ?? ErrorMessage::INVALID_QUERY, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, previous: $previous, ); diff --git a/src/Exception/InvalidLoaderResourceException.php b/src/Exception/InvalidResponseException.php similarity index 80% rename from src/Exception/InvalidLoaderResourceException.php rename to src/Exception/InvalidResponseException.php index 47cf151c..97863c59 100644 --- a/src/Exception/InvalidLoaderResourceException.php +++ b/src/Exception/InvalidResponseException.php @@ -18,6 +18,6 @@ /** * @since 3.0.0 */ -final class InvalidLoaderResourceException extends InvalidArgumentException implements ExceptionInterface +final class InvalidResponseException extends InvalidArgumentException implements ExceptionInterface { } diff --git a/src/Exception/InvalidRouteLoadingResourceException.php b/src/Exception/InvalidRouteLoadingResourceException.php new file mode 100644 index 00000000..86f699be --- /dev/null +++ b/src/Exception/InvalidRouteLoadingResourceException.php @@ -0,0 +1,23 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Exception; + +use InvalidArgumentException; + +/** + * @since 3.0.0 + */ +final class InvalidRouteLoadingResourceException extends InvalidArgumentException implements ExceptionInterface +{ +} diff --git a/src/Exception/RouteNotFoundException.php b/src/Exception/RouteNotFoundException.php new file mode 100644 index 00000000..17e6aaed --- /dev/null +++ b/src/Exception/RouteNotFoundException.php @@ -0,0 +1,23 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Exception; + +use InvalidArgumentException; + +/** + * @since 3.0.0 + */ +final class RouteNotFoundException extends InvalidArgumentException implements ExceptionInterface +{ +} diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index a22c1b40..e756b35c 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -14,9 +14,12 @@ namespace Sunrise\Http\Router\Helper; use BackedEnum; +use Stringable; use Sunrise\Http\Router\Exception\InvalidRouteBuildingValueException; use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; +use function is_int; +use function is_string; use function sprintf; use function str_replace; use function substr; @@ -42,8 +45,20 @@ public static function buildRoute(string $route, array $values = []): string if (isset($values[$variable['name']])) { $value = $values[$variable['name']]; - if ($value instanceof BackedEnum) { - $value = $value->value; + if (is_int($value)) { + $value = (string) $value; + } elseif ($value instanceof BackedEnum) { + $value = (string) $value->value; + } elseif ($value instanceof Stringable) { + $value = (string) $value; + } + + if (!is_string($value)) { + throw new InvalidRouteBuildingValueException(sprintf( + 'The route %s could not be built with an unexpected value for the variable %s.', + $route, + $variable['name'], + )); } $search[] = $statement; diff --git a/src/Helper/RouteMatcher.php b/src/Helper/RouteMatcher.php index cce8294e..dbd864e0 100644 --- a/src/Helper/RouteMatcher.php +++ b/src/Helper/RouteMatcher.php @@ -89,10 +89,6 @@ public static function matchPattern(string $route, string $pattern, string $subj ); } - if ($result === 0) { - return false; - } - foreach ($matches as $key => $match) { if (is_int($key) || $match === null) { unset($matches[$key]); @@ -101,6 +97,6 @@ public static function matchPattern(string $route, string $pattern, string $subj /** @var array $matches */ - return true; + return $result === 1; } } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 1a44640a..97de9f32 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -36,7 +36,8 @@ use Sunrise\Http\Router\Annotation\Route as Descriptor; use Sunrise\Http\Router\Annotation\Summary; use Sunrise\Http\Router\Annotation\Tag; -use Sunrise\Http\Router\Exception\InvalidLoaderResourceException; +use Sunrise\Http\Router\Exception\InvalidRouteLoadingResourceException; +use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; use Sunrise\Http\Router\Helper\FilesystemHelper; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Route; @@ -65,7 +66,8 @@ public function __construct( /** * @inheritDoc * - * @throws InvalidLoaderResourceException + * @throws InvalidRouteLoadingResourceException + * @throws InvalidRouteParsingSubjectException * @throws CacheException */ public function load(): Generator @@ -94,7 +96,8 @@ public function load(): Generator /** * @return list * - * @throws InvalidLoaderResourceException + * @throws InvalidRouteLoadingResourceException + * @throws InvalidRouteParsingSubjectException * @throws CacheException */ private function getDescriptors(): array @@ -122,7 +125,8 @@ private function getDescriptors(): array /** * @return Generator * - * @throws InvalidLoaderResourceException + * @throws InvalidRouteLoadingResourceException + * @throws InvalidRouteParsingSubjectException */ private function getResourceDescriptors(string $resource): Generator { @@ -150,7 +154,7 @@ private function getResourceDescriptors(string $resource): Generator return; } - throw new InvalidLoaderResourceException(sprintf( + throw new InvalidRouteLoadingResourceException(sprintf( 'The loader %s only accepts directory, file or class names; ' . 'however, the resource %s is not one of them.', __CLASS__, @@ -160,6 +164,8 @@ private function getResourceDescriptors(string $resource): Generator /** * @return Generator + * + * @throws InvalidRouteParsingSubjectException */ private function getClassDescriptors(ReflectionClass $class): Generator { @@ -312,6 +318,9 @@ private function supplementDescriptorFromClassOrMethod(Descriptor $descriptor, R } } + /** + * @throws InvalidRouteParsingSubjectException + */ private function completeDescriptor(Descriptor $descriptor): void { $descriptor->path = join($descriptor->prefixes) . $descriptor->path; diff --git a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php index 57968388..30adad88 100644 --- a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php +++ b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php @@ -38,13 +38,14 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface $serverRequest = ServerRequest::create($request); $serverConsumedMediaTypes = array_values($serverRequest->getRoute()->getConsumedMediaTypes()); if (! $serverRequest->clientProducesMediaType(...$serverConsumedMediaTypes)) { - if ($serverRequest->getClientProducedMediaType() === null) { + $clientProducedMediaType = $serverRequest->getClientProducedMediaType(); + if ($clientProducedMediaType === null) { throw HttpExceptionFactory::missingMediaType() ->addHeaderField('Accept', ...$serverConsumedMediaTypes); } throw HttpExceptionFactory::unsupportedMediaType() - ->addMessagePlaceholder('{{ media_type }}', $serverRequest->getClientProducedMediaType()) + ->addMessagePlaceholder('{{ media_type }}', $clientProducedMediaType) ->addHeaderField('Accept', ...$serverConsumedMediaTypes); } diff --git a/src/ParameterResolver/DependencyInjectionParameterResolver.php b/src/ParameterResolver/DependencyInjectionParameterResolver.php index d41aa8ea..b675e962 100644 --- a/src/ParameterResolver/DependencyInjectionParameterResolver.php +++ b/src/ParameterResolver/DependencyInjectionParameterResolver.php @@ -31,7 +31,7 @@ public function __construct(private readonly ContainerInterface $container) /** * @inheritDoc * - * @throws ContainerExceptionInterface If something went wrong while working with the container. + * @throws ContainerExceptionInterface */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 59c64aff..f95ba455 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -26,6 +26,7 @@ use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; +use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; @@ -47,8 +48,9 @@ public function __construct( /** * @inheritDoc * - * @throws LogicException If the resolver is used incorrectly or if an object isn't valid. - * @throws HttpException If the request's parsed body isn't valid. + * @throws HttpException + * @throws InvalidObjectException + * @throws LogicException */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index 70e05750..e1ba6b76 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -48,8 +48,8 @@ public function __construct( /** * @inheritDoc * - * @throws LogicException If the resolver is used incorrectly. - * @throws HttpException If a cookie was missed or invalid. + * @throws HttpException + * @throws LogicException */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -66,36 +66,31 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $serverRequest = ServerRequest::create($context); $processParams = $annotations[0]->newInstance(); + $cookieName = $processParams->cookieName; $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; - if (!$serverRequest->hasCookieParam($processParams->cookieName)) { + if (!$serverRequest->hasCookieParam($cookieName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } throw HttpExceptionFactory::missingCookieParam($processParams->errorMessage, $errorStatusCode) - ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName); + ->addMessagePlaceholder('{{ cookie_name }}', $cookieName); } try { - $argument = $this->hydrator->castValue( - $serverRequest->getCookieParam($processParams->cookieName), - Type::fromParameter($parameter), - path: [$processParams->cookieName], - ); + $argument = $this->hydrator->castValue($serverRequest->getCookieParam($cookieName), Type::fromParameter($parameter), path: [$cookieName]); } catch (InvalidValueException|InvalidDataException $e) { - $violations = ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions(); - throw HttpExceptionFactory::invalidCookieParam($processParams->errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName) - ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $violations)); + ->addMessagePlaceholder('{{ cookie_name }}', $cookieName) + ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions())); } if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { throw HttpExceptionFactory::invalidCookieParam($processParams->errorMessage, $errorStatusCode) - ->addMessagePlaceholder('{{ cookie_name }}', $processParams->cookieName) + ->addMessagePlaceholder('{{ cookie_name }}', $cookieName) ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 07fcfd37..59cb2129 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -47,8 +47,8 @@ public function __construct( /** * @inheritDoc * - * @throws LogicException If the resolver is used incorrectly. - * @throws HttpException If a header was missed or invalid. + * @throws HttpException + * @throws LogicException */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -64,36 +64,31 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $processParams = $annotations[0]->newInstance(); + $headerName = $processParams->headerName; $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; - if (!$context->hasHeader($processParams->headerName)) { + if (!$context->hasHeader($headerName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } throw HttpExceptionFactory::missingHeaderField($processParams->errorMessage, $errorStatusCode) - ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName); + ->addMessagePlaceholder('{{ header_name }}', $headerName); } try { - $argument = $this->hydrator->castValue( - $context->getHeaderLine($processParams->headerName), - Type::fromParameter($parameter), - path: [$processParams->headerName], - ); + $argument = $this->hydrator->castValue($context->getHeaderLine($headerName), Type::fromParameter($parameter), path: [$headerName]); } catch (InvalidValueException|InvalidDataException $e) { - $violations = ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions(); - throw HttpExceptionFactory::invalidHeaderField($processParams->errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName) - ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $violations)); + ->addMessagePlaceholder('{{ header_name }}', $headerName) + ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions())); } if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { throw HttpExceptionFactory::invalidHeaderField($processParams->errorMessage, $errorStatusCode) - ->addMessagePlaceholder('{{ header_name }}', $processParams->headerName) + ->addMessagePlaceholder('{{ header_name }}', $headerName) ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } } diff --git a/src/ParameterResolver/RequestPathVariableParameterResolver.php b/src/ParameterResolver/RequestPathVariableParameterResolver.php index c6cdede5..98a8f0f9 100644 --- a/src/ParameterResolver/RequestPathVariableParameterResolver.php +++ b/src/ParameterResolver/RequestPathVariableParameterResolver.php @@ -51,8 +51,8 @@ public function __construct( /** * @inheritDoc * - * @throws LogicException If the resolver is used incorrectly. - * @throws HttpException If a path variable isn't valid. + * @throws HttpException + * @throws LogicException */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -66,8 +66,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) throw new LogicException('At this level of the application, any operations with the request are not possible.'); } - $serverRequest = ServerRequest::create($context); - $route = $serverRequest->getRoute(); + $route = ServerRequest::create($context)->getRoute(); $processParams = $annotations[0]->newInstance(); $variableName = $processParams->variableName ?? $parameter->getName(); @@ -89,18 +88,12 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } try { - $argument = $this->hydrator->castValue( - $route->getAttribute($variableName), - Type::fromParameter($parameter), - path: [$variableName], - ); + $argument = $this->hydrator->castValue($route->getAttribute($variableName), Type::fromParameter($parameter), path: [$variableName]); } catch (InvalidValueException|InvalidDataException $e) { - $violations = ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions(); - throw HttpExceptionFactory::invalidPathVariable($processParams->errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ variable_name }}', $variableName) - ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) - ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $violations)); + ->addMessagePlaceholder('{{ route }}', RouteSimplifier::simplifyRoute($route->getPath())) + ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions())); } if (isset($this->validator)) { @@ -108,7 +101,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { throw HttpExceptionFactory::invalidPathVariable($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ variable_name }}', $variableName) - ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) + ->addMessagePlaceholder('{{ route }}', RouteSimplifier::simplifyRoute($route->getPath())) ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } } diff --git a/src/ParameterResolver/RequestQueryParamParameterResolver.php b/src/ParameterResolver/RequestQueryParamParameterResolver.php index 33a137b6..c5b25b28 100644 --- a/src/ParameterResolver/RequestQueryParamParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamParameterResolver.php @@ -48,8 +48,8 @@ public function __construct( /** * @inheritDoc * - * @throws LogicException If the resolver is used incorrectly. - * @throws HttpException If a query parameter was missed or invalid. + * @throws HttpException + * @throws LogicException */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -66,36 +66,31 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $serverRequest = ServerRequest::create($context); $processParams = $annotations[0]->newInstance(); + $paramName = $processParams->paramName; $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; - if (!$serverRequest->hasQueryParam($processParams->paramName)) { + if (!$serverRequest->hasQueryParam($paramName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } throw HttpExceptionFactory::missingQueryParam($processParams->errorMessage, $errorStatusCode) - ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName); + ->addMessagePlaceholder('{{ param_name }}', $paramName); } try { - $argument = $this->hydrator->castValue( - $serverRequest->getQueryParam($processParams->paramName), - Type::fromParameter($parameter), - path: [$processParams->paramName], - ); + $argument = $this->hydrator->castValue($serverRequest->getQueryParam($paramName), Type::fromParameter($parameter), path: [$paramName]); } catch (InvalidValueException|InvalidDataException $e) { - $violations = ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions(); - throw HttpExceptionFactory::invalidQueryParam($processParams->errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName) - ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $violations)); + ->addMessagePlaceholder('{{ param_name }}', $paramName) + ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions())); } if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { throw HttpExceptionFactory::invalidQueryParam($processParams->errorMessage, $errorStatusCode) - ->addMessagePlaceholder('{{ param_name }}', $processParams->paramName) + ->addMessagePlaceholder('{{ param_name }}', $paramName) ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } } diff --git a/src/ParameterResolver/RequestQueryParamsParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php similarity index 77% rename from src/ParameterResolver/RequestQueryParamsParameterResolver.php rename to src/ParameterResolver/RequestQueryParameterResolver.php index f8a5a800..9b2f6623 100644 --- a/src/ParameterResolver/RequestQueryParamsParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -19,13 +19,14 @@ use ReflectionAttribute; use ReflectionNamedType; use ReflectionParameter; -use Sunrise\Http\Router\Annotation\RequestQueryParams; +use Sunrise\Http\Router\Annotation\RequestQuery; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\ParameterResolver; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; +use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; @@ -35,7 +36,7 @@ /** * @since 3.0.0 */ -final class RequestQueryParamsParameterResolver implements ParameterResolverInterface +final class RequestQueryParameterResolver implements ParameterResolverInterface { public function __construct( private readonly HydratorInterface $hydrator, @@ -47,13 +48,14 @@ public function __construct( /** * @inheritDoc * - * @throws LogicException If the resolver is used incorrectly or if an object isn't valid. - * @throws HttpException If the request's query parameters aren't valid. + * @throws HttpException + * @throws InvalidObjectException + * @throws LogicException */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - /** @var list> $annotations */ - $annotations = $parameter->getAttributes(RequestQueryParams::class); + /** @var list> $annotations */ + $annotations = $parameter->getAttributes(RequestQuery::class); if ($annotations === []) { return; } @@ -61,7 +63,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { throw new LogicException(sprintf( - 'To use the #[RequestQueryParams] annotation, the parameter %s must be typed with an object.', + 'To use the #[RequestQuery] annotation, the parameter %s must be typed with an object.', ParameterResolver::stringifyParameter($parameter), )); } @@ -77,13 +79,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) try { $argument = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { - throw HttpExceptionFactory::invalidQueryParams($processParams->errorMessage, $errorStatusCode, previous: $e) + throw HttpExceptionFactory::invalidQuery($processParams->errorMessage, $errorStatusCode, previous: $e) ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $e->getExceptions())); } if (isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { - throw HttpExceptionFactory::invalidQueryParams($processParams->errorMessage, $errorStatusCode) + throw HttpExceptionFactory::invalidQuery($processParams->errorMessage, $errorStatusCode) ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } } diff --git a/src/RequestHandlerResolver.php b/src/RequestProcessorResolver.php similarity index 98% rename from src/RequestHandlerResolver.php rename to src/RequestProcessorResolver.php index 2bff37bc..8991a645 100644 --- a/src/RequestHandlerResolver.php +++ b/src/RequestProcessorResolver.php @@ -33,13 +33,13 @@ /** * @since 2.10.0 */ -final class RequestHandlerResolver +final class RequestProcessorResolver { private readonly ClassResolver $classResolver; public function __construct( private readonly ParameterResolver $parameterResolver, - private readonly ResponseResolver $responseResolver, + private readonly ResponseResolver $responseResolver, ) { $this->classResolver = new ClassResolver($parameterResolver); } diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index f7bd770f..36f6d569 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router\ResponseResolver; use Fig\Http\Message\StatusCodeInterface; -use InvalidArgumentException; use JsonException; use Psr\Http\Message\ResponseFactoryInterface; use Psr\Http\Message\ResponseInterface; @@ -23,6 +22,7 @@ use ReflectionFunction; use ReflectionMethod; use Sunrise\Http\Router\Annotation\JsonResponse; +use Sunrise\Http\Router\Exception\InvalidResponseException; use Sunrise\Http\Router\ResponseResolver; use function json_encode; @@ -46,7 +46,7 @@ public function __construct( } /** - * @throws InvalidArgumentException If the resolver is used incorrectly. + * @throws InvalidResponseException */ public function resolveResponse( mixed $response, @@ -68,7 +68,7 @@ public function resolveResponse( /** @psalm-suppress ArgumentTypeCoercion */ $payload = json_encode($response, $encodingFlags | JSON_THROW_ON_ERROR, $encodingDepth); } catch (JsonException $e) { - throw new InvalidArgumentException(sprintf( + throw new InvalidResponseException(sprintf( 'The responder %s returned a response that could not be encoded to JSON due to: %s', ResponseResolver::stringifyResponder($responder), $e->getMessage(), diff --git a/src/Route.php b/src/Route.php index eaf21439..969b1924 100644 --- a/src/Route.php +++ b/src/Route.php @@ -15,7 +15,6 @@ use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; -use function array_key_exists; use function in_array; final class Route implements RouteInterface @@ -98,12 +97,12 @@ public function getAttributes(): array public function getAttribute(string $name, mixed $default = null): mixed { - return array_key_exists($name, $this->attributes) ? $this->attributes[$name] : $default; + return $this->attributes[$name] ?? $default; } public function hasAttribute(string $name): bool { - return array_key_exists($name, $this->attributes); + return isset($this->attributes[$name]); } /** diff --git a/src/Router.php b/src/Router.php index e95ef54e..e88e9f96 100644 --- a/src/Router.php +++ b/src/Router.php @@ -23,6 +23,7 @@ use Sunrise\Http\Router\Exception\InvalidRouteBuildingValueException; use Sunrise\Http\Router\Exception\InvalidRouteMatchingSubjectException; use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; +use Sunrise\Http\Router\Exception\RouteNotFoundException; use Sunrise\Http\Router\Helper\RouteBuilder; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Helper\RouteMatcher; @@ -39,7 +40,7 @@ class Router implements RequestHandlerInterface { - private readonly RequestHandlerResolver $requestHandlerResolver; + private readonly RequestProcessorResolver $requestHandlerResolver; /** * @var array @@ -72,7 +73,7 @@ public function __construct( array $responseResolvers = [], array $loaders = [], ) { - $this->requestHandlerResolver = new RequestHandlerResolver( + $this->requestHandlerResolver = new RequestProcessorResolver( new ParameterResolver($parameterResolvers), new ResponseResolver($responseResolvers), ); @@ -91,7 +92,7 @@ public function getRoutes(): array } /** - * @throws InvalidArgumentException If the route doesn't exist. + * @throws RouteNotFoundException */ public function getRoute(string $name): RouteInterface { @@ -99,7 +100,7 @@ public function getRoute(string $name): RouteInterface return $this->routes[$name]; } - return throw new InvalidArgumentException(sprintf( + return throw new RouteNotFoundException(sprintf( 'The route %s does not exist.', $name, )); diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 69678e5a..d7babb8b 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -54,7 +54,7 @@ public function getOriginalRequest(): ServerRequestInterface */ public function getRoute(): RouteInterface { - $route = $this->getAttribute('@route'); + $route = $this->request->getAttribute('@route'); if (! $route instanceof RouteInterface) { throw new LogicException('At this level of the application, the request does not contain information about the requested route.'); } @@ -77,11 +77,7 @@ public function getClientProducedMediaType(): ?ClientMediaType [$identifier, $parameters] = current($values); if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier, $matches)) { - return new ClientMediaType( - type: $matches[1], - subtype: $matches[2], - parameters: $parameters, - ); + return new ClientMediaType($matches[1], $matches[2], $parameters); } return null; @@ -109,11 +105,7 @@ public function getClientConsumedMediaTypes(): Generator foreach ($values as $index => [$identifier, $parameters]) { if (preg_match('|^([^/]+)/([^/]+)$|', $identifier, $matches)) { - yield $index => new ClientMediaType( - type: $matches[1], - subtype: $matches[2], - parameters: $parameters, - ); + yield $index => new ClientMediaType($matches[1], $matches[2], $parameters); } } } @@ -140,11 +132,7 @@ public function getClientConsumedLanguages(): Generator foreach ($values as $index => [$identifier, $parameters]) { if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches)) { - yield $index => new ClientLanguage( - code: $matches[1], - locale: $identifier, - parameters: $parameters, - ); + yield $index => new ClientLanguage($matches[1], $identifier, $parameters); } } } @@ -187,7 +175,7 @@ public function getClientPreferredLanguage(LanguageInterface ...$serverProducedL public function clientProducesMediaType(MediaTypeInterface ...$serverConsumedMediaTypes): bool { - // This case is interpreted as follows: the server accepts any media type... + // The server is ready to accept any media type. if ($serverConsumedMediaTypes === []) { return true; } @@ -207,30 +195,6 @@ public function clientProducesMediaType(MediaTypeInterface ...$serverConsumedMed return false; } - public function clientConsumesMediaType(MediaTypeInterface ...$serverProducedMediaTypes): bool - { - if ($serverProducedMediaTypes === []) { - return false; - } - - $clientConsumedMediaTypes = $this->getClientConsumedMediaTypes(); - // This case is interpreted as follows: the client accepts any media type... - if (!$clientConsumedMediaTypes->valid()) { - return true; - } - - $mediaTypeComparator = new MediaTypeComparator(); - foreach ($clientConsumedMediaTypes as $clientConsumedMediaType) { - foreach ($serverProducedMediaTypes as $serverProducedMediaType) { - if ($mediaTypeComparator->equals($clientConsumedMediaType, $serverProducedMediaType)) { - return true; - } - } - } - - return false; - } - /** * @inheritDoc */ @@ -244,10 +208,9 @@ public function getProtocolVersion(): string */ public function withProtocolVersion($version): self { - $clone = clone $this; - $clone->request = $clone->request->withProtocolVersion($version); + $this->request = $this->request->withProtocolVersion($version); - return $clone; + return $this; } /** @@ -287,10 +250,9 @@ public function getHeaderLine($name): string */ public function withHeader($name, $value): self { - $clone = clone $this; - $clone->request = $clone->request->withHeader($name, $value); + $this->request = $this->request->withHeader($name, $value); - return $clone; + return $this; } /** @@ -298,10 +260,9 @@ public function withHeader($name, $value): self */ public function withAddedHeader($name, $value): self { - $clone = clone $this; - $clone->request = $clone->request->withAddedHeader($name, $value); + $this->request = $this->request->withAddedHeader($name, $value); - return $clone; + return $this; } /** @@ -309,10 +270,9 @@ public function withAddedHeader($name, $value): self */ public function withoutHeader($name): self { - $clone = clone $this; - $clone->request = $clone->request->withoutHeader($name); + $this->request = $this->request->withoutHeader($name); - return $clone; + return $this; } /** @@ -328,10 +288,9 @@ public function getBody(): StreamInterface */ public function withBody(StreamInterface $body): self { - $clone = clone $this; - $clone->request = $clone->request->withBody($body); + $this->request = $this->request->withBody($body); - return $clone; + return $this; } /** @@ -347,10 +306,9 @@ public function getMethod(): string */ public function withMethod($method): self { - $clone = clone $this; - $clone->request = $clone->request->withMethod($method); + $this->request = $this->request->withMethod($method); - return $clone; + return $this; } /** @@ -366,10 +324,9 @@ public function getUri(): UriInterface */ public function withUri(UriInterface $uri, $preserveHost = false): self { - $clone = clone $this; - $clone->request = $clone->request->withUri($uri, $preserveHost); + $this->request = $this->request->withUri($uri, $preserveHost); - return $clone; + return $this; } /** @@ -385,10 +342,9 @@ public function getRequestTarget(): string */ public function withRequestTarget($requestTarget): self { - $clone = clone $this; - $clone->request = $clone->request->withRequestTarget($requestTarget); + $this->request = $this->request->withRequestTarget($requestTarget); - return $clone; + return $this; } /** @@ -426,10 +382,9 @@ public function getQueryParam(string $name, mixed $default = null): mixed */ public function withQueryParams(array $query): self { - $clone = clone $this; - $clone->request = $clone->request->withQueryParams($query); + $this->request = $this->request->withQueryParams($query); - return $clone; + return $this; } /** @@ -459,10 +414,9 @@ public function getCookieParam(string $name, mixed $default = null): mixed */ public function withCookieParams(array $cookies): self { - $clone = clone $this; - $clone->request = $clone->request->withCookieParams($cookies); + $this->request = $this->request->withCookieParams($cookies); - return $clone; + return $this; } /** @@ -478,10 +432,9 @@ public function getUploadedFiles(): array */ public function withUploadedFiles(array $uploadedFiles): self { - $clone = clone $this; - $clone->request = $clone->request->withUploadedFiles($uploadedFiles); + $this->request = $this->request->withUploadedFiles($uploadedFiles); - return $clone; + return $this; } /** @@ -497,10 +450,9 @@ public function getParsedBody(): mixed */ public function withParsedBody($data): self { - $clone = clone $this; - $clone->request = $clone->request->withParsedBody($data); + $this->request = $this->request->withParsedBody($data); - return $clone; + return $this; } /** @@ -524,10 +476,9 @@ public function getAttribute($name, $default = null): mixed */ public function withAttribute($name, $value): self { - $clone = clone $this; - $clone->request = $clone->request->withAttribute($name, $value); + $this->request = $this->request->withAttribute($name, $value); - return $clone; + return $this; } /** @@ -535,9 +486,8 @@ public function withAttribute($name, $value): self */ public function withoutAttribute($name): self { - $clone = clone $this; - $clone->request = $clone->request->withoutAttribute($name); + $this->request = $this->request->withoutAttribute($name); - return $clone; + return $this; } } From 85ac6814352733575bea99907c1d9e9dcd4cfaca Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 9 Mar 2024 06:34:43 +0100 Subject: [PATCH 121/180] v3 --- src/Dictionary/ErrorMessage.php | 14 +++++------ src/Exception/HttpExceptionFactory.php | 24 +++++++++---------- .../PayloadMediaTypeNegotiationMiddleware.php | 2 +- .../RequestCookieParameterResolver.php | 6 ++--- .../RequestHeaderParameterResolver.php | 6 ++--- .../RequestPathVariableParameterResolver.php | 4 ++-- .../RequestQueryParamParameterResolver.php | 2 +- 7 files changed, 29 insertions(+), 29 deletions(-) diff --git a/src/Dictionary/ErrorMessage.php b/src/Dictionary/ErrorMessage.php index 101237e1..e6ccc7c3 100644 --- a/src/Dictionary/ErrorMessage.php +++ b/src/Dictionary/ErrorMessage.php @@ -20,16 +20,16 @@ final class ErrorMessage { public const RESOURCE_NOT_FOUND = 'The resource {{ resource }} was not found.'; public const METHOD_NOT_ALLOWED = 'The method {{ method }} is not allowed; check the Allow response header for allowed methods.'; - public const MISSING_MEDIA_TYPE = 'The Content-Type header must be provided and cannot be empty; check the Accept response header for supported media types.'; + public const MEDIA_TYPE_REQUIRED = 'The Content-Type header must be provided and cannot be empty; check the Accept response header for supported media types.'; public const UNSUPPORTED_MEDIA_TYPE = 'The media type {{ media_type }} is not supported; check the Accept response header for supported media types.'; - public const INVALID_PATH_VARIABLE = 'The variable {{ variable_name }} of the route {{ route }} is invalid.'; + public const INVALID_PATH_VARIABLE = 'The variable {{ variable_name }} of the route {{ route_path }} is invalid.'; public const INVALID_QUERY = 'The query parameters are invalid.'; - public const MISSING_QUERY_PARAM = 'The query parameter {{ param_name }} must be provided.'; + public const QUERY_PARAM_REQUIRED = 'The query parameter {{ param_name }} must be provided.'; public const INVALID_QUERY_PARAM = 'The query parameter {{ param_name }} is invalid.'; - public const MISSING_HEADER_FIELD = 'The header {{ header_name }} must be provided.'; - public const INVALID_HEADER_FIELD = 'The header {{ header_name }} is invalid.'; - public const MISSING_COOKIE_PARAM = 'The cookie {{ cookie_name }} must be provided.'; - public const INVALID_COOKIE_PARAM = 'The cookie {{ cookie_name }} is invalid.'; + public const HEADER_REQUIRED = 'The header {{ header_name }} must be provided.'; + public const INVALID_HEADER = 'The header {{ header_name }} is invalid.'; + public const COOKIE_REQUIRED = 'The cookie {{ cookie_name }} must be provided.'; + public const INVALID_COOKIE = 'The cookie {{ cookie_name }} is invalid.'; public const INVALID_BODY = 'The request body is invalid.'; public const EMPTY_JSON_PAYLOAD = 'The JSON payload cannot be empty.'; public const INVALID_JSON_PAYLOAD = 'The JSON payload is invalid and could not be decoded.'; diff --git a/src/Exception/HttpExceptionFactory.php b/src/Exception/HttpExceptionFactory.php index 756f8641..7e16ab68 100644 --- a/src/Exception/HttpExceptionFactory.php +++ b/src/Exception/HttpExceptionFactory.php @@ -46,13 +46,13 @@ public static function methodNotAllowed( ); } - public static function missingMediaType( + public static function mediaTypeRequired( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::MISSING_MEDIA_TYPE, + message: $message ?? ErrorMessage::MEDIA_TYPE_REQUIRED, code: $code ?? StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE, previous: $previous, ); @@ -94,13 +94,13 @@ public static function invalidQuery( ); } - public static function missingQueryParam( + public static function queryParamRequired( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::MISSING_QUERY_PARAM, + message: $message ?? ErrorMessage::QUERY_PARAM_REQUIRED, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, previous: $previous, ); @@ -118,49 +118,49 @@ public static function invalidQueryParam( ); } - public static function missingHeaderField( + public static function headerRequired( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::MISSING_HEADER_FIELD, + message: $message ?? ErrorMessage::HEADER_REQUIRED, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, previous: $previous, ); } - public static function invalidHeaderField( + public static function invalidHeader( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::INVALID_HEADER_FIELD, + message: $message ?? ErrorMessage::INVALID_HEADER, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, previous: $previous, ); } - public static function missingCookieParam( + public static function cookieRequired( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::MISSING_COOKIE_PARAM, + message: $message ?? ErrorMessage::COOKIE_REQUIRED, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, previous: $previous, ); } - public static function invalidCookieParam( + public static function invalidCookie( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::INVALID_COOKIE_PARAM, + message: $message ?? ErrorMessage::INVALID_COOKIE, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, previous: $previous, ); diff --git a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php index 30adad88..90567530 100644 --- a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php +++ b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php @@ -40,7 +40,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface if (! $serverRequest->clientProducesMediaType(...$serverConsumedMediaTypes)) { $clientProducedMediaType = $serverRequest->getClientProducedMediaType(); if ($clientProducedMediaType === null) { - throw HttpExceptionFactory::missingMediaType() + throw HttpExceptionFactory::mediaTypeRequired() ->addHeaderField('Accept', ...$serverConsumedMediaTypes); } diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index e1ba6b76..52691a5f 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -74,14 +74,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return yield $parameter->getDefaultValue(); } - throw HttpExceptionFactory::missingCookieParam($processParams->errorMessage, $errorStatusCode) + throw HttpExceptionFactory::cookieRequired($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ cookie_name }}', $cookieName); } try { $argument = $this->hydrator->castValue($serverRequest->getCookieParam($cookieName), Type::fromParameter($parameter), path: [$cookieName]); } catch (InvalidValueException|InvalidDataException $e) { - throw HttpExceptionFactory::invalidCookieParam($processParams->errorMessage, $errorStatusCode, previous: $e) + throw HttpExceptionFactory::invalidCookie($processParams->errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ cookie_name }}', $cookieName) ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions())); } @@ -89,7 +89,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpExceptionFactory::invalidCookieParam($processParams->errorMessage, $errorStatusCode) + throw HttpExceptionFactory::invalidCookie($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ cookie_name }}', $cookieName) ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 59cb2129..08e9a523 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -72,14 +72,14 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return yield $parameter->getDefaultValue(); } - throw HttpExceptionFactory::missingHeaderField($processParams->errorMessage, $errorStatusCode) + throw HttpExceptionFactory::headerRequired($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ header_name }}', $headerName); } try { $argument = $this->hydrator->castValue($context->getHeaderLine($headerName), Type::fromParameter($parameter), path: [$headerName]); } catch (InvalidValueException|InvalidDataException $e) { - throw HttpExceptionFactory::invalidHeaderField($processParams->errorMessage, $errorStatusCode, previous: $e) + throw HttpExceptionFactory::invalidHeader($processParams->errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ header_name }}', $headerName) ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions())); } @@ -87,7 +87,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpExceptionFactory::invalidHeaderField($processParams->errorMessage, $errorStatusCode) + throw HttpExceptionFactory::invalidHeader($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ header_name }}', $headerName) ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } diff --git a/src/ParameterResolver/RequestPathVariableParameterResolver.php b/src/ParameterResolver/RequestPathVariableParameterResolver.php index 98a8f0f9..ba5197bb 100644 --- a/src/ParameterResolver/RequestPathVariableParameterResolver.php +++ b/src/ParameterResolver/RequestPathVariableParameterResolver.php @@ -92,7 +92,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } catch (InvalidValueException|InvalidDataException $e) { throw HttpExceptionFactory::invalidPathVariable($processParams->errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ variable_name }}', $variableName) - ->addMessagePlaceholder('{{ route }}', RouteSimplifier::simplifyRoute($route->getPath())) + ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions())); } @@ -101,7 +101,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { throw HttpExceptionFactory::invalidPathVariable($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ variable_name }}', $variableName) - ->addMessagePlaceholder('{{ route }}', RouteSimplifier::simplifyRoute($route->getPath())) + ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } } diff --git a/src/ParameterResolver/RequestQueryParamParameterResolver.php b/src/ParameterResolver/RequestQueryParamParameterResolver.php index c5b25b28..c9c44cad 100644 --- a/src/ParameterResolver/RequestQueryParamParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParamParameterResolver.php @@ -74,7 +74,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return yield $parameter->getDefaultValue(); } - throw HttpExceptionFactory::missingQueryParam($processParams->errorMessage, $errorStatusCode) + throw HttpExceptionFactory::queryParamRequired($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ param_name }}', $paramName); } From 0a1e3808596decd58de32d8973bd379400f430f2 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 10 Mar 2024 03:01:05 +0100 Subject: [PATCH 122/180] v3 --- src/Annotation/RequestQueryParam.php | 30 ------ ...stPathVariable.php => RequestVariable.php} | 2 +- src/Dictionary/ErrorMessage.php | 18 ++-- src/Exception/HttpExceptionFactory.php | 48 +++------ src/Helper/FilesystemHelper.php | 4 +- src/Helper/RouteBuilder.php | 4 +- src/Helper/RouteMatcher.php | 38 +++---- src/Loader/DescriptorLoader.php | 2 +- .../PayloadMediaTypeNegotiationMiddleware.php | 4 +- src/ParameterResolver.php | 9 +- .../DependencyInjectionParameterResolver.php | 3 +- .../ObjectInjectionParameterResolver.php | 3 +- .../ParameterResolverInterface.php | 3 +- .../RequestBodyParameterResolver.php | 12 +-- .../RequestCookieParameterResolver.php | 28 ++--- .../RequestHeaderParameterResolver.php | 26 ++--- .../RequestQueryParamParameterResolver.php | 101 ------------------ .../RequestQueryParameterResolver.php | 12 +-- ...p => RequestVariableParameterResolver.php} | 35 +++--- src/RequestProcessorResolver.php | 4 +- src/Router.php | 6 +- .../ValidatorConstraintViolationProxy.php | 4 +- 22 files changed, 125 insertions(+), 271 deletions(-) delete mode 100644 src/Annotation/RequestQueryParam.php rename src/Annotation/{RequestPathVariable.php => RequestVariable.php} (95%) delete mode 100644 src/ParameterResolver/RequestQueryParamParameterResolver.php rename src/ParameterResolver/{RequestPathVariableParameterResolver.php => RequestVariableParameterResolver.php} (70%) diff --git a/src/Annotation/RequestQueryParam.php b/src/Annotation/RequestQueryParam.php deleted file mode 100644 index 9f7d34e8..00000000 --- a/src/Annotation/RequestQueryParam.php +++ /dev/null @@ -1,30 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation; - -use Attribute; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_PARAMETER)] -final class RequestQueryParam -{ - public function __construct( - public readonly string $paramName, - public readonly ?int $errorStatusCode = null, - public readonly ?string $errorMessage = null, - ) { - } -} diff --git a/src/Annotation/RequestPathVariable.php b/src/Annotation/RequestVariable.php similarity index 95% rename from src/Annotation/RequestPathVariable.php rename to src/Annotation/RequestVariable.php index 2014f3ab..1dde6f6b 100644 --- a/src/Annotation/RequestPathVariable.php +++ b/src/Annotation/RequestVariable.php @@ -19,7 +19,7 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_PARAMETER)] -final class RequestPathVariable +final class RequestVariable { public function __construct( public readonly ?string $variableName = null, diff --git a/src/Dictionary/ErrorMessage.php b/src/Dictionary/ErrorMessage.php index e6ccc7c3..9691e150 100644 --- a/src/Dictionary/ErrorMessage.php +++ b/src/Dictionary/ErrorMessage.php @@ -18,20 +18,18 @@ */ final class ErrorMessage { - public const RESOURCE_NOT_FOUND = 'The resource {{ resource }} was not found.'; - public const METHOD_NOT_ALLOWED = 'The method {{ method }} is not allowed; check the Allow response header for allowed methods.'; - public const MEDIA_TYPE_REQUIRED = 'The Content-Type header must be provided and cannot be empty; check the Accept response header for supported media types.'; - public const UNSUPPORTED_MEDIA_TYPE = 'The media type {{ media_type }} is not supported; check the Accept response header for supported media types.'; - public const INVALID_PATH_VARIABLE = 'The variable {{ variable_name }} of the route {{ route_path }} is invalid.'; + public const ROUTE_NOT_FOUND = 'The resource {{ request_uri }} was not found.'; + public const METHOD_NOT_ALLOWED = 'The method {{ request_method }} is not allowed; check the Allow response header for allowed methods.'; + public const MEDIA_TYPE_NOT_PROVIDED = 'The Content-Type header must be provided and must not be empty; check the Accept response header for supported media types.'; + public const MEDIA_TYPE_NOT_SUPPORTED = 'The media type {{ media_type }} is not supported; check the Accept response header for supported media types.'; + public const INVALID_VARIABLE = 'The variable {{ variable_name }} of the route {{ route_uri }} is invalid.'; public const INVALID_QUERY = 'The query parameters are invalid.'; - public const QUERY_PARAM_REQUIRED = 'The query parameter {{ param_name }} must be provided.'; - public const INVALID_QUERY_PARAM = 'The query parameter {{ param_name }} is invalid.'; - public const HEADER_REQUIRED = 'The header {{ header_name }} must be provided.'; + public const MISSING_HEADER = 'The header {{ header_name }} must be provided.'; public const INVALID_HEADER = 'The header {{ header_name }} is invalid.'; - public const COOKIE_REQUIRED = 'The cookie {{ cookie_name }} must be provided.'; + public const MISSING_COOKIE = 'The cookie {{ cookie_name }} must be provided.'; public const INVALID_COOKIE = 'The cookie {{ cookie_name }} is invalid.'; public const INVALID_BODY = 'The request body is invalid.'; - public const EMPTY_JSON_PAYLOAD = 'The JSON payload cannot be empty.'; + public const EMPTY_JSON_PAYLOAD = 'The JSON payload must not be empty.'; public const INVALID_JSON_PAYLOAD = 'The JSON payload is invalid and could not be decoded.'; public const INVALID_JSON_PAYLOAD_FORM = 'The JSON payload must be in the form of an array or an object.'; } diff --git a/src/Exception/HttpExceptionFactory.php b/src/Exception/HttpExceptionFactory.php index 7e16ab68..0884c6a2 100644 --- a/src/Exception/HttpExceptionFactory.php +++ b/src/Exception/HttpExceptionFactory.php @@ -22,13 +22,13 @@ */ final class HttpExceptionFactory { - public static function resourceNotFound( + public static function routeNotFound( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::RESOURCE_NOT_FOUND, + message: $message ?? ErrorMessage::ROUTE_NOT_FOUND, code: $code ?? StatusCodeInterface::STATUS_NOT_FOUND, previous: $previous, ); @@ -46,37 +46,37 @@ public static function methodNotAllowed( ); } - public static function mediaTypeRequired( + public static function mediaTypeNotProvided( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::MEDIA_TYPE_REQUIRED, + message: $message ?? ErrorMessage::MEDIA_TYPE_NOT_PROVIDED, code: $code ?? StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE, previous: $previous, ); } - public static function unsupportedMediaType( + public static function mediaTypeNotSupported( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::UNSUPPORTED_MEDIA_TYPE, + message: $message ?? ErrorMessage::MEDIA_TYPE_NOT_SUPPORTED, code: $code ?? StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE, previous: $previous, ); } - public static function invalidPathVariable( + public static function invalidVariable( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::INVALID_PATH_VARIABLE, + message: $message ?? ErrorMessage::INVALID_VARIABLE, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, previous: $previous, ); @@ -94,37 +94,13 @@ public static function invalidQuery( ); } - public static function queryParamRequired( + public static function missingHeader( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::QUERY_PARAM_REQUIRED, - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - previous: $previous, - ); - } - - public static function invalidQueryParam( - ?string $message = null, - ?int $code = null, - ?Throwable $previous = null, - ): HttpException { - return new HttpException( - message: $message ?? ErrorMessage::INVALID_QUERY_PARAM, - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - previous: $previous, - ); - } - - public static function headerRequired( - ?string $message = null, - ?int $code = null, - ?Throwable $previous = null, - ): HttpException { - return new HttpException( - message: $message ?? ErrorMessage::HEADER_REQUIRED, + message: $message ?? ErrorMessage::MISSING_HEADER, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, previous: $previous, ); @@ -142,13 +118,13 @@ public static function invalidHeader( ); } - public static function cookieRequired( + public static function missingCookie( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::COOKIE_REQUIRED, + message: $message ?? ErrorMessage::MISSING_COOKIE, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, previous: $previous, ); diff --git a/src/Helper/FilesystemHelper.php b/src/Helper/FilesystemHelper.php index 9ffff469..4d6fbc01 100644 --- a/src/Helper/FilesystemHelper.php +++ b/src/Helper/FilesystemHelper.php @@ -42,7 +42,7 @@ public static function getDirClasses(string $dirname): Generator { if (!is_dir($dirname)) { throw new InvalidArgumentException(sprintf( - 'The directory %s could not be scanned because it does not exist.', + 'The directory %s does not exist.', $dirname, )); } @@ -86,7 +86,7 @@ public static function getFileClasses(string $filename): Generator { if (!is_file($filename)) { throw new InvalidArgumentException(sprintf( - 'The file %s could not be scanned because it does not exist.', + 'The file %s does not exist.', $filename, )); } diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index e756b35c..7804266b 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -18,6 +18,7 @@ use Sunrise\Http\Router\Exception\InvalidRouteBuildingValueException; use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; +use function get_debug_type; use function is_int; use function is_string; use function sprintf; @@ -55,9 +56,10 @@ public static function buildRoute(string $route, array $values = []): string if (!is_string($value)) { throw new InvalidRouteBuildingValueException(sprintf( - 'The route %s could not be built with an unexpected value for the variable %s.', + 'The route %s could not be built with a value for the variable %s that has an unsupported type %s.', $route, $variable['name'], + get_debug_type($value), )); } diff --git a/src/Helper/RouteMatcher.php b/src/Helper/RouteMatcher.php index dbd864e0..06b2b7a7 100644 --- a/src/Helper/RouteMatcher.php +++ b/src/Helper/RouteMatcher.php @@ -62,31 +62,25 @@ public static function matchPattern(string $route, string $pattern, string $subj if (($result = @preg_match($pattern, $subject, $matches, PREG_UNMATCHED_AS_NULL)) === false) { throw new ErrorException(preg_last_error_msg(), preg_last_error(), E_WARNING); } - } catch (Throwable $e) { + } catch (Throwable) { + // a client side error; must be handled as 4xx. if (preg_last_error() === PREG_BAD_UTF8_ERROR) { - throw new InvalidRouteMatchingSubjectException( - sprintf( - 'The route %s could not be matched due to an invalid subject: %s.', - $route, - preg_last_error_msg(), - ), - code: preg_last_error(), - previous: $e, - ); - } - - throw new InvalidRouteMatchingPatternException( - sprintf( - 'The route %s could not be matched due to: %s; ' . - 'most likely, this problem is related to one of the route patterns. ' . - 'Please refer to the official documentation: ' . - 'https://www.php.net/preg_last_error', + throw new InvalidRouteMatchingSubjectException(sprintf( + 'The route %s could not be matched due to: %s.', $route, preg_last_error_msg(), - ), - code: preg_last_error(), - previous: $e, - ); + )); + } + + // a server side error; must be handled as 5xx error. + throw new InvalidRouteMatchingPatternException(sprintf( + 'The route %s could not be matched due to: %s; ' . + 'most likely, this problem is related to one of the route patterns. ' . + 'Please refer to the official documentation: ' . + 'https://www.php.net/preg_last_error', + $route, + preg_last_error_msg(), + ), preg_last_error()); } foreach ($matches as $key => $match) { diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 97de9f32..aa57e8d9 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -157,7 +157,7 @@ private function getResourceDescriptors(string $resource): Generator throw new InvalidRouteLoadingResourceException(sprintf( 'The loader %s only accepts directory, file or class names; ' . 'however, the resource %s is not one of them.', - __CLASS__, + $this::class, $resource, )); } diff --git a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php index 90567530..4d67c023 100644 --- a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php +++ b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php @@ -40,11 +40,11 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface if (! $serverRequest->clientProducesMediaType(...$serverConsumedMediaTypes)) { $clientProducedMediaType = $serverRequest->getClientProducedMediaType(); if ($clientProducedMediaType === null) { - throw HttpExceptionFactory::mediaTypeRequired() + throw HttpExceptionFactory::mediaTypeNotProvided() ->addHeaderField('Accept', ...$serverConsumedMediaTypes); } - throw HttpExceptionFactory::unsupportedMediaType() + throw HttpExceptionFactory::mediaTypeNotSupported() ->addMessagePlaceholder('{{ media_type }}', $clientProducedMediaType) ->addHeaderField('Accept', ...$serverConsumedMediaTypes); } diff --git a/src/ParameterResolver.php b/src/ParameterResolver.php index b9ae289c..8dffd9a6 100644 --- a/src/ParameterResolver.php +++ b/src/ParameterResolver.php @@ -15,6 +15,7 @@ use Generator; use LogicException; +use Psr\Http\Message\ServerRequestInterface; use ReflectionMethod; use ReflectionParameter; use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; @@ -27,7 +28,7 @@ */ final class ParameterResolver { - private mixed $context = null; + private ?ServerRequestInterface $request = null; public function __construct( /** @var ParameterResolverInterface[] */ @@ -35,10 +36,10 @@ public function __construct( ) { } - public function withContext(mixed $context): self + public function withRequest(ServerRequestInterface $request): self { $clone = clone $this; - $clone->context = $context; + $clone->request = $request; return $clone; } @@ -70,7 +71,7 @@ public function resolveParameters(ReflectionParameter ...$parameters): Generator private function resolveParameter(ReflectionParameter $parameter): Generator { foreach ($this->resolvers as $resolver) { - $arguments = $resolver->resolveParameter($parameter, $this->context); + $arguments = $resolver->resolveParameter($parameter, $this->request); if ($arguments->valid()) { return yield from $arguments; } diff --git a/src/ParameterResolver/DependencyInjectionParameterResolver.php b/src/ParameterResolver/DependencyInjectionParameterResolver.php index b675e962..df116b7f 100644 --- a/src/ParameterResolver/DependencyInjectionParameterResolver.php +++ b/src/ParameterResolver/DependencyInjectionParameterResolver.php @@ -16,6 +16,7 @@ use Generator; use Psr\Container\ContainerExceptionInterface; use Psr\Container\ContainerInterface; +use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; @@ -33,7 +34,7 @@ public function __construct(private readonly ContainerInterface $container) * * @throws ContainerExceptionInterface */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator { $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { diff --git a/src/ParameterResolver/ObjectInjectionParameterResolver.php b/src/ParameterResolver/ObjectInjectionParameterResolver.php index 0f9eb9bb..46d00d79 100644 --- a/src/ParameterResolver/ObjectInjectionParameterResolver.php +++ b/src/ParameterResolver/ObjectInjectionParameterResolver.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router\ParameterResolver; use Generator; +use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; @@ -31,7 +32,7 @@ public function __construct(private readonly object $object) /** * @inheritDoc */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator { $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { diff --git a/src/ParameterResolver/ParameterResolverInterface.php b/src/ParameterResolver/ParameterResolverInterface.php index 231e59bb..6aa0d920 100644 --- a/src/ParameterResolver/ParameterResolverInterface.php +++ b/src/ParameterResolver/ParameterResolverInterface.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router\ParameterResolver; use Generator; +use Psr\Http\Message\ServerRequestInterface; use ReflectionParameter; /** @@ -24,5 +25,5 @@ interface ParameterResolverInterface /** * @return Generator */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator; + public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator; } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index f95ba455..f27549bb 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -52,8 +52,12 @@ public function __construct( * @throws InvalidObjectException * @throws LogicException */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator { + if ($request === null) { + return; + } + /** @var list> $annotations */ $annotations = $parameter->getAttributes(RequestBody::class); if ($annotations === []) { @@ -68,16 +72,12 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) )); } - if (! $context instanceof ServerRequestInterface) { - throw new LogicException('At this level of the application, any operations with the request are not possible.'); - } - $processParams = $annotations[0]->newInstance(); $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; try { - $argument = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); + $argument = $this->hydrator->hydrate($type->getName(), (array) $request->getParsedBody()); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidBody($processParams->errorMessage, $errorStatusCode, previous: $e) ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $e->getExceptions())); diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index 52691a5f..cece5874 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router\ParameterResolver; use Generator; -use LogicException; use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionParameter; @@ -49,41 +48,44 @@ public function __construct( * @inheritDoc * * @throws HttpException - * @throws LogicException */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator { + if ($request === null) { + return; + } + /** @var list> $annotations */ $annotations = $parameter->getAttributes(RequestCookie::class); if ($annotations === []) { return; } - if (! $context instanceof ServerRequestInterface) { - throw new LogicException('At this level of the application, any operations with the request are not possible.'); - } - - $serverRequest = ServerRequest::create($context); + $request = ServerRequest::create($request); $processParams = $annotations[0]->newInstance(); $cookieName = $processParams->cookieName; $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; - if (!$serverRequest->hasCookieParam($cookieName)) { + if (!$request->hasCookieParam($cookieName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } - throw HttpExceptionFactory::cookieRequired($processParams->errorMessage, $errorStatusCode) + throw HttpExceptionFactory::missingCookie($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ cookie_name }}', $cookieName); } try { - $argument = $this->hydrator->castValue($serverRequest->getCookieParam($cookieName), Type::fromParameter($parameter), path: [$cookieName]); - } catch (InvalidValueException|InvalidDataException $e) { + $argument = $this->hydrator->castValue($request->getCookieParam($cookieName), Type::fromParameter($parameter), path: [$cookieName]); + } catch (InvalidValueException $e) { + throw HttpExceptionFactory::invalidCookie($processParams->errorMessage, $errorStatusCode, previous: $e) + ->addMessagePlaceholder('{{ cookie_name }}', $cookieName) + ->addConstraintViolation(HydratorConstraintViolationProxy::create($e)); + } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidCookie($processParams->errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ cookie_name }}', $cookieName) - ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions())); + ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $e->getExceptions())); } if (isset($this->validator)) { diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 08e9a523..bcf54a3b 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router\ParameterResolver; use Generator; -use LogicException; use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionParameter; @@ -48,40 +47,43 @@ public function __construct( * @inheritDoc * * @throws HttpException - * @throws LogicException */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator { + if ($request === null) { + return; + } + /** @var list> $annotations */ $annotations = $parameter->getAttributes(RequestHeader::class); if ($annotations === []) { return; } - if (! $context instanceof ServerRequestInterface) { - throw new LogicException('At this level of the application, any operations with the request are not possible.'); - } - $processParams = $annotations[0]->newInstance(); $headerName = $processParams->headerName; $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; - if (!$context->hasHeader($headerName)) { + if (!$request->hasHeader($headerName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } - throw HttpExceptionFactory::headerRequired($processParams->errorMessage, $errorStatusCode) + throw HttpExceptionFactory::missingHeader($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ header_name }}', $headerName); } try { - $argument = $this->hydrator->castValue($context->getHeaderLine($headerName), Type::fromParameter($parameter), path: [$headerName]); - } catch (InvalidValueException|InvalidDataException $e) { + $argument = $this->hydrator->castValue($request->getHeaderLine($headerName), Type::fromParameter($parameter), path: [$headerName]); + } catch (InvalidValueException $e) { + throw HttpExceptionFactory::invalidHeader($processParams->errorMessage, $errorStatusCode, previous: $e) + ->addMessagePlaceholder('{{ header_name }}', $headerName) + ->addConstraintViolation(HydratorConstraintViolationProxy::create($e)); + } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidHeader($processParams->errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ header_name }}', $headerName) - ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions())); + ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $e->getExceptions())); } if (isset($this->validator)) { diff --git a/src/ParameterResolver/RequestQueryParamParameterResolver.php b/src/ParameterResolver/RequestQueryParamParameterResolver.php deleted file mode 100644 index c9c44cad..00000000 --- a/src/ParameterResolver/RequestQueryParamParameterResolver.php +++ /dev/null @@ -1,101 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ParameterResolver; - -use Generator; -use LogicException; -use Psr\Http\Message\ServerRequestInterface; -use ReflectionAttribute; -use ReflectionParameter; -use Sunrise\Http\Router\Annotation\RequestQueryParam; -use Sunrise\Http\Router\Exception\HttpException; -use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Helper\ValidatorHelper; -use Sunrise\Http\Router\ServerRequest; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; -use Sunrise\Hydrator\Exception\InvalidDataException; -use Sunrise\Hydrator\Exception\InvalidValueException; -use Sunrise\Hydrator\HydratorInterface; -use Sunrise\Hydrator\Type; -use Symfony\Component\Validator\Validator\ValidatorInterface; - -use function array_map; - -/** - * @since 3.0.0 - */ -final class RequestQueryParamParameterResolver implements ParameterResolverInterface -{ - public function __construct( - private readonly HydratorInterface $hydrator, - private readonly ?ValidatorInterface $validator = null, - private readonly ?int $defaultErrorStatusCode = null, - ) { - } - - /** - * @inheritDoc - * - * @throws HttpException - * @throws LogicException - */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator - { - /** @var list> $annotations */ - $annotations = $parameter->getAttributes(RequestQueryParam::class); - if ($annotations === []) { - return; - } - - if (! $context instanceof ServerRequestInterface) { - throw new LogicException('At this level of the application, any operations with the request are not possible.'); - } - - $serverRequest = ServerRequest::create($context); - $processParams = $annotations[0]->newInstance(); - - $paramName = $processParams->paramName; - $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; - - if (!$serverRequest->hasQueryParam($paramName)) { - if ($parameter->isDefaultValueAvailable()) { - return yield $parameter->getDefaultValue(); - } - - throw HttpExceptionFactory::queryParamRequired($processParams->errorMessage, $errorStatusCode) - ->addMessagePlaceholder('{{ param_name }}', $paramName); - } - - try { - $argument = $this->hydrator->castValue($serverRequest->getQueryParam($paramName), Type::fromParameter($parameter), path: [$paramName]); - } catch (InvalidValueException|InvalidDataException $e) { - throw HttpExceptionFactory::invalidQueryParam($processParams->errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder('{{ param_name }}', $paramName) - ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions())); - } - - if (isset($this->validator)) { - if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { - if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpExceptionFactory::invalidQueryParam($processParams->errorMessage, $errorStatusCode) - ->addMessagePlaceholder('{{ param_name }}', $paramName) - ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); - } - } - } - - yield $argument; - } -} diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 9b2f6623..763afc75 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -52,8 +52,12 @@ public function __construct( * @throws InvalidObjectException * @throws LogicException */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator { + if ($request === null) { + return; + } + /** @var list> $annotations */ $annotations = $parameter->getAttributes(RequestQuery::class); if ($annotations === []) { @@ -68,16 +72,12 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) )); } - if (! $context instanceof ServerRequestInterface) { - throw new LogicException('At this level of the application, any operations with the request are not possible.'); - } - $processParams = $annotations[0]->newInstance(); $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; try { - $argument = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); + $argument = $this->hydrator->hydrate($type->getName(), $request->getQueryParams()); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidQuery($processParams->errorMessage, $errorStatusCode, previous: $e) ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $e->getExceptions())); diff --git a/src/ParameterResolver/RequestPathVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php similarity index 70% rename from src/ParameterResolver/RequestPathVariableParameterResolver.php rename to src/ParameterResolver/RequestVariableParameterResolver.php index ba5197bb..9135a013 100644 --- a/src/ParameterResolver/RequestPathVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -18,7 +18,7 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionParameter; -use Sunrise\Http\Router\Annotation\RequestPathVariable; +use Sunrise\Http\Router\Annotation\RequestVariable; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Helper\RouteSimplifier; @@ -39,7 +39,7 @@ /** * @since 3.0.0 */ -final class RequestPathVariableParameterResolver implements ParameterResolverInterface +final class RequestVariableParameterResolver implements ParameterResolverInterface { public function __construct( private readonly HydratorInterface $hydrator, @@ -54,19 +54,19 @@ public function __construct( * @throws HttpException * @throws LogicException */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator { - /** @var list> $annotations */ - $annotations = $parameter->getAttributes(RequestPathVariable::class); - if ($annotations === []) { + if ($request === null) { return; } - if (! $context instanceof ServerRequestInterface) { - throw new LogicException('At this level of the application, any operations with the request are not possible.'); + /** @var list> $annotations */ + $annotations = $parameter->getAttributes(RequestVariable::class); + if ($annotations === []) { + return; } - $route = ServerRequest::create($context)->getRoute(); + $route = ServerRequest::create($request)->getRoute(); $processParams = $annotations[0]->newInstance(); $variableName = $processParams->variableName ?? $parameter->getName(); @@ -89,19 +89,24 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) try { $argument = $this->hydrator->castValue($route->getAttribute($variableName), Type::fromParameter($parameter), path: [$variableName]); - } catch (InvalidValueException|InvalidDataException $e) { - throw HttpExceptionFactory::invalidPathVariable($processParams->errorMessage, $errorStatusCode, previous: $e) + } catch (InvalidValueException $e) { + throw HttpExceptionFactory::invalidVariable($processParams->errorMessage, $errorStatusCode, previous: $e) + ->addMessagePlaceholder('{{ variable_name }}', $variableName) + ->addMessagePlaceholder('{{ route_uri }}', RouteSimplifier::simplifyRoute($route->getPath())) + ->addConstraintViolation(HydratorConstraintViolationProxy::create($e)); + } catch (InvalidDataException $e) { + throw HttpExceptionFactory::invalidVariable($processParams->errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ variable_name }}', $variableName) - ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) - ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), ($e instanceof InvalidValueException) ? [$e] : $e->getExceptions())); + ->addMessagePlaceholder('{{ route_uri }}', RouteSimplifier::simplifyRoute($route->getPath())) + ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $e->getExceptions())); } if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpExceptionFactory::invalidPathVariable($processParams->errorMessage, $errorStatusCode) + throw HttpExceptionFactory::invalidVariable($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ variable_name }}', $variableName) - ->addMessagePlaceholder('{{ route_path }}', RouteSimplifier::simplifyRoute($route->getPath())) + ->addMessagePlaceholder('{{ route_uri }}', RouteSimplifier::simplifyRoute($route->getPath())) ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); } } diff --git a/src/RequestProcessorResolver.php b/src/RequestProcessorResolver.php index 8991a645..5920b65c 100644 --- a/src/RequestProcessorResolver.php +++ b/src/RequestProcessorResolver.php @@ -121,7 +121,7 @@ private function createRequestHandlerCallback( $this->responseResolver->resolveResponse( $callback(... $this->parameterResolver - ->withContext($request) + ->withRequest($request) ->withPriorityResolver( new ObjectInjectionParameterResolver($request), ) @@ -144,7 +144,7 @@ private function createMiddlewareCallback( $this->responseResolver->resolveResponse( $callback(... $this->parameterResolver - ->withContext($request) + ->withRequest($request) ->withPriorityResolver( new ObjectInjectionParameterResolver($request), new ObjectInjectionParameterResolver($handler), diff --git a/src/Router.php b/src/Router.php index e88e9f96..629d5d7a 100644 --- a/src/Router.php +++ b/src/Router.php @@ -150,12 +150,12 @@ public function match(ServerRequestInterface $request): RouteInterface if (!empty($allowedMethods)) { throw HttpExceptionFactory::methodNotAllowed() - ->addMessagePlaceholder('{{ method }}', $request->getMethod()) + ->addMessagePlaceholder('{{ request_method }}', $request->getMethod()) ->addHeaderField('Allow', ...array_keys($allowedMethods)); } - throw HttpExceptionFactory::resourceNotFound() - ->addMessagePlaceholder('{{ resource }}', $requestPath); + throw HttpExceptionFactory::routeNotFound() + ->addMessagePlaceholder('{{ request_uri }}', $requestPath); } /** diff --git a/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php b/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php index e7a9d841..34c89667 100644 --- a/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php +++ b/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php @@ -16,6 +16,8 @@ use Sunrise\Http\Router\Validation\ConstraintViolationInterface as RouterConstraintViolationInterface; use Symfony\Component\Validator\ConstraintViolationInterface as ValidatorConstraintViolationInterface; +use function preg_replace; + /** * @since 3.0.0 */ @@ -47,7 +49,7 @@ public function getMessagePlaceholders(): array public function getPropertyPath(): string { - return $this->validatorConstraintViolation->getPropertyPath(); + return preg_replace(['/\x5b([^\x5b\x5d]+)\x5d/', '/^\x2e/'], ['.$1'], $this->validatorConstraintViolation->getPropertyPath()); } public function getCode(): ?string From 28d9f6629af5fe8c41a4e3b0ed94df03859557eb Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 10 Mar 2024 03:45:10 +0100 Subject: [PATCH 123/180] v3 --- src/Helper/RouteBuilder.php | 7 ++----- src/Helper/RouteMatcher.php | 2 +- src/Helper/RouteParser.php | 9 ++++----- 3 files changed, 7 insertions(+), 11 deletions(-) diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index 7804266b..6c30afc5 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -56,7 +56,7 @@ public static function buildRoute(string $route, array $values = []): string if (!is_string($value)) { throw new InvalidRouteBuildingValueException(sprintf( - 'The route %s could not be built with a value for the variable %s that has an unsupported type %s.', + 'The route %s could not be built because the value assigned to the variable %s has an unsupported type: %s.', $route, $variable['name'], get_debug_type($value), @@ -69,10 +69,7 @@ public static function buildRoute(string $route, array $values = []): string } if (isset($variable['optional'])) { - $left = $variable['left'] ?? ''; - $right = $variable['right'] ?? ''; - - $search[] = '(' . $left . $statement . $right . ')'; + $search[] = '(' . $variable['optional']['left'] . $statement . $variable['optional']['right'] . ')'; $replace[] = ''; continue; } diff --git a/src/Helper/RouteMatcher.php b/src/Helper/RouteMatcher.php index 06b2b7a7..d1351de8 100644 --- a/src/Helper/RouteMatcher.php +++ b/src/Helper/RouteMatcher.php @@ -63,7 +63,7 @@ public static function matchPattern(string $route, string $pattern, string $subj throw new ErrorException(preg_last_error_msg(), preg_last_error(), E_WARNING); } } catch (Throwable) { - // a client side error; must be handled as 4xx. + // a client side error; must be handled as 4xx error. if (preg_last_error() === PREG_BAD_UTF8_ERROR) { throw new InvalidRouteMatchingSubjectException(sprintf( 'The route %s could not be matched due to: %s.', diff --git a/src/Helper/RouteParser.php b/src/Helper/RouteParser.php index fec714b7..1ae75ac3 100644 --- a/src/Helper/RouteParser.php +++ b/src/Helper/RouteParser.php @@ -26,7 +26,7 @@ final class RouteParser /** * Parses the given route and returns its variables * - * @return list + * @return list * * @throws InvalidRouteParsingSubjectException */ @@ -72,8 +72,8 @@ public static function parseRoute(string $route): array if (($cursor & $inOccupiedPart)) { $cursor &= ~$inOccupiedPart; - $variables[$variable]['left'] = $left; - $variables[$variable]['right'] = $right; + $variables[$variable]['optional']['left'] = $left; + $variables[$variable]['optional']['right'] = $right; } $cursor &= ~$inOptionalPart; @@ -105,7 +105,6 @@ public static function parseRoute(string $route): array if (($cursor & $inOptionalPart)) { $cursor |= $inOccupiedPart; - $variables[$variable]['optional'] = true; } $cursor |= $inVariable | $inVariableName; @@ -270,7 +269,7 @@ public static function parseRoute(string $route): array )); } - /** @var list */ + /** @var list */ return $variables; } } From d598bb5485fb2ce9527f7e45b8d211e6846b39ee Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 10 Mar 2024 04:15:20 +0100 Subject: [PATCH 124/180] v3 --- src/Exception/InvalidParameterException.php | 23 +++++++++++++++++++ .../RequestBodyParameterResolver.php | 6 ++--- .../RequestQueryParameterResolver.php | 6 ++--- .../RequestVariableParameterResolver.php | 6 ++--- 4 files changed, 32 insertions(+), 9 deletions(-) create mode 100644 src/Exception/InvalidParameterException.php diff --git a/src/Exception/InvalidParameterException.php b/src/Exception/InvalidParameterException.php new file mode 100644 index 00000000..6ca2fac3 --- /dev/null +++ b/src/Exception/InvalidParameterException.php @@ -0,0 +1,23 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Exception; + +use LogicException; + +/** + * @since 3.0.0 + */ +final class InvalidParameterException extends LogicException implements ExceptionInterface +{ +} diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index f27549bb..0fa75498 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router\ParameterResolver; use Generator; -use LogicException; use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionNamedType; @@ -22,6 +21,7 @@ use Sunrise\Http\Router\Annotation\RequestBody; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; +use Sunrise\Http\Router\Exception\InvalidParameterException; use Sunrise\Http\Router\ParameterResolver; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; @@ -50,7 +50,7 @@ public function __construct( * * @throws HttpException * @throws InvalidObjectException - * @throws LogicException + * @throws InvalidParameterException */ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator { @@ -66,7 +66,7 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { - throw new LogicException(sprintf( + throw new InvalidParameterException(sprintf( 'To use the #[RequestBody] annotation, the parameter %s must be typed with an object.', ParameterResolver::stringifyParameter($parameter), )); diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 763afc75..2bf4e644 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router\ParameterResolver; use Generator; -use LogicException; use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionNamedType; @@ -22,6 +21,7 @@ use Sunrise\Http\Router\Annotation\RequestQuery; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; +use Sunrise\Http\Router\Exception\InvalidParameterException; use Sunrise\Http\Router\ParameterResolver; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; @@ -50,7 +50,7 @@ public function __construct( * * @throws HttpException * @throws InvalidObjectException - * @throws LogicException + * @throws InvalidParameterException */ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator { @@ -66,7 +66,7 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { - throw new LogicException(sprintf( + throw new InvalidParameterException(sprintf( 'To use the #[RequestQuery] annotation, the parameter %s must be typed with an object.', ParameterResolver::stringifyParameter($parameter), )); diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index 9135a013..b5625a66 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -14,13 +14,13 @@ namespace Sunrise\Http\Router\ParameterResolver; use Generator; -use LogicException; use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestVariable; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; +use Sunrise\Http\Router\Exception\InvalidParameterException; use Sunrise\Http\Router\Helper\RouteSimplifier; use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ParameterResolver; @@ -52,7 +52,7 @@ public function __construct( * @inheritDoc * * @throws HttpException - * @throws LogicException + * @throws InvalidParameterException */ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator { @@ -77,7 +77,7 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI return yield $parameter->getDefaultValue(); } - throw new LogicException(sprintf( + throw new InvalidParameterException(sprintf( 'The parameter %s expects a value of the variable %s from the route %s ' . 'which is not present in the request, most likely, because the variable is optional. ' . 'To resolve this issue, assign the default value to the parameter.', From ca1f16767bd07109ae848a2ac6bdb2ca88d21a7d Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 10 Mar 2024 10:49:27 +0100 Subject: [PATCH 125/180] v3 --- src/ClassResolver.php | 13 ++- .../UnsupportedParameterException.php | 23 +++++ .../UnsupportedReferenceException.php | 23 +++++ .../UnsupportedResponseException.php | 23 +++++ src/ParameterResolver.php | 21 ++-- ...ssorResolver.php => ReferenceResolver.php} | 96 +++++++++++-------- src/ResponseResolver.php | 10 +- src/Router.php | 24 ++--- 8 files changed, 163 insertions(+), 70 deletions(-) create mode 100644 src/Exception/UnsupportedParameterException.php create mode 100644 src/Exception/UnsupportedReferenceException.php create mode 100644 src/Exception/UnsupportedResponseException.php rename src/{RequestProcessorResolver.php => ReferenceResolver.php} (52%) diff --git a/src/ClassResolver.php b/src/ClassResolver.php index 7dbfecac..2449e672 100644 --- a/src/ClassResolver.php +++ b/src/ClassResolver.php @@ -51,20 +51,19 @@ public function resolveClass(string $fqn): object } if (!class_exists($fqn)) { - throw new InvalidArgumentException(sprintf('The class %s does not exist and cannot be resolved.', $fqn)); + throw new InvalidArgumentException(sprintf('The class %s does not exist.', $fqn)); } /** @var ReflectionClass $reflection */ $reflection = new ReflectionClass($fqn); + if (!$reflection->isInstantiable()) { - throw new InvalidArgumentException(sprintf('The class %s is uninstantiable and cannot be resolved.', $fqn)); + throw new InvalidArgumentException(sprintf('The class %s is not instantiable.', $fqn)); } - $arguments = []; - $constructor = $reflection->getConstructor(); - if (isset($constructor)) { - $arguments = $this->parameterResolver->resolveParameters(...$constructor->getParameters()); - } + $arguments = $this->parameterResolver->resolveParameters( + ...($reflection->getConstructor()?->getParameters() ?? []) + ); return $this->resolvedClasses[$fqn] = $reflection->newInstance(...$arguments); } diff --git a/src/Exception/UnsupportedParameterException.php b/src/Exception/UnsupportedParameterException.php new file mode 100644 index 00000000..ffa457f2 --- /dev/null +++ b/src/Exception/UnsupportedParameterException.php @@ -0,0 +1,23 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Exception; + +use LogicException; + +/** + * @since 3.0.0 + */ +final class UnsupportedParameterException extends LogicException implements ExceptionInterface +{ +} diff --git a/src/Exception/UnsupportedReferenceException.php b/src/Exception/UnsupportedReferenceException.php new file mode 100644 index 00000000..1029ef99 --- /dev/null +++ b/src/Exception/UnsupportedReferenceException.php @@ -0,0 +1,23 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Exception; + +use InvalidArgumentException; + +/** + * @since 3.0.0 + */ +final class UnsupportedReferenceException extends InvalidArgumentException implements ExceptionInterface +{ +} diff --git a/src/Exception/UnsupportedResponseException.php b/src/Exception/UnsupportedResponseException.php new file mode 100644 index 00000000..c4a1978f --- /dev/null +++ b/src/Exception/UnsupportedResponseException.php @@ -0,0 +1,23 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Exception; + +use LogicException; + +/** + * @since 3.0.0 + */ +final class UnsupportedResponseException extends LogicException implements ExceptionInterface +{ +} diff --git a/src/ParameterResolver.php b/src/ParameterResolver.php index 8dffd9a6..e57bc083 100644 --- a/src/ParameterResolver.php +++ b/src/ParameterResolver.php @@ -14,10 +14,11 @@ namespace Sunrise\Http\Router; use Generator; -use LogicException; use Psr\Http\Message\ServerRequestInterface; use ReflectionMethod; use ReflectionParameter; +use Sunrise\Http\Router\Exception\InvalidParameterException; +use Sunrise\Http\Router\Exception\UnsupportedParameterException; use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; use function array_unshift; @@ -54,31 +55,35 @@ public function withPriorityResolver(ParameterResolverInterface ...$resolvers): } /** - * @throws LogicException If one of the parameters couldn't be resolved to an argument(s). + * @return Generator + * + * @throws InvalidParameterException + * @throws UnsupportedParameterException */ public function resolveParameters(ReflectionParameter ...$parameters): Generator { foreach ($parameters as $parameter) { - yield from $this->resolveParameter($parameter); + yield from $this->resolveParameter($parameter, $this->request); } } /** * @return Generator * - * @throws LogicException If the parameter couldn't be resolved to an argument(s). + * @throws InvalidParameterException + * @throws UnsupportedParameterException */ - private function resolveParameter(ReflectionParameter $parameter): Generator + private function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator { foreach ($this->resolvers as $resolver) { - $arguments = $resolver->resolveParameter($parameter, $this->request); + $arguments = $resolver->resolveParameter($parameter, $request); if ($arguments->valid()) { return yield from $arguments; } } - throw new LogicException(sprintf( - 'The parameter %s could not be resolved because it is not supported.', + throw new UnsupportedParameterException(sprintf( + 'The parameter %s is not supported.', self::stringifyParameter($parameter), )); } diff --git a/src/RequestProcessorResolver.php b/src/ReferenceResolver.php similarity index 52% rename from src/RequestProcessorResolver.php rename to src/ReferenceResolver.php index 5920b65c..c11418ba 100644 --- a/src/RequestProcessorResolver.php +++ b/src/ReferenceResolver.php @@ -14,100 +14,111 @@ namespace Sunrise\Http\Router; use Closure; -use InvalidArgumentException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use ReflectionFunction; use ReflectionMethod; +use Sunrise\Http\Router\Exception\UnsupportedReferenceException; use Sunrise\Http\Router\Middleware\CallableMiddleware; use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; +use function class_exists; +use function get_debug_type; use function is_array; use function is_callable; use function is_string; use function is_subclass_of; +use function sprintf; /** * @since 2.10.0 */ -final class RequestProcessorResolver +final class ReferenceResolver { - private readonly ClassResolver $classResolver; - public function __construct( private readonly ParameterResolver $parameterResolver, - private readonly ResponseResolver $responseResolver, + private readonly ClassResolver $classResolver, + private readonly ResponseResolver $responseResolver, ) { - $this->classResolver = new ClassResolver($parameterResolver); } /** - * @throws InvalidArgumentException If the requst handler couldn't be resolved. + * @throws UnsupportedReferenceException If the requst handler couldn't be resolved. */ - public function resolveRequestHandler(mixed $requestHandler): RequestHandlerInterface + public function resolveRequestHandler(mixed $reference): RequestHandlerInterface { - if ($requestHandler instanceof RequestHandlerInterface) { - return $requestHandler; + if ($reference instanceof RequestHandlerInterface) { + return $reference; } - if ($requestHandler instanceof Closure) { - return new CallableRequestHandler($this->createRequestHandlerCallback($requestHandler, new ReflectionFunction($requestHandler))); + if ($reference instanceof Closure) { + return new CallableRequestHandler($this->createRequestHandlerCallback($reference, new ReflectionFunction($reference))); } // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 - if (is_array($requestHandler) && is_callable($requestHandler, true)) { - /** @var array{0: class-string|object, 1: non-empty-string} $requestHandler */ + if (is_array($reference) && is_callable($reference, true)) { + /** @var array{0: string|object, 1: string} $reference */ - if (is_string($requestHandler[0])) { - $requestHandler[0] = $this->classResolver->resolveClass($requestHandler[0]); + if (is_string($reference[0]) && class_exists($reference[0])) { + $reference[0] = $this->classResolver->resolveClass($reference[0]); } - if (is_callable($requestHandler)) { - return new CallableRequestHandler($this->createRequestHandlerCallback($requestHandler, new ReflectionMethod($requestHandler[0], $requestHandler[1]))); + if (is_callable($reference)) { + /** @var array{0: class-string|object, 1: non-empty-string} $reference */ + + return new CallableRequestHandler($this->createRequestHandlerCallback($reference, new ReflectionMethod($reference[0], $reference[1]))); } } - if (is_string($requestHandler) && is_subclass_of($requestHandler, RequestHandlerInterface::class)) { - return $this->classResolver->resolveClass($requestHandler); + if (is_string($reference) && is_subclass_of($reference, RequestHandlerInterface::class)) { + return $this->classResolver->resolveClass($reference); } - throw new InvalidArgumentException('Unsupported request handler.'); + throw new UnsupportedReferenceException(sprintf( + 'The request handler reference %s is not supported.', + self::stringifyReference($reference), + )); } /** - * @throws InvalidArgumentException If the middleware couldn't be resolved. + * @throws UnsupportedReferenceException If the middleware couldn't be resolved. */ - public function resolveMiddleware(mixed $middleware): MiddlewareInterface + public function resolveMiddleware(mixed $reference): MiddlewareInterface { - if ($middleware instanceof MiddlewareInterface) { - return $middleware; + if ($reference instanceof MiddlewareInterface) { + return $reference; } - if ($middleware instanceof Closure) { - return new CallableMiddleware($this->createMiddlewareCallback($middleware, new ReflectionFunction($middleware))); + if ($reference instanceof Closure) { + return new CallableMiddleware($this->createMiddlewareCallback($reference, new ReflectionFunction($reference))); } - if (is_string($middleware) && is_subclass_of($middleware, MiddlewareInterface::class)) { - return $this->classResolver->resolveClass($middleware); + if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { + return $this->classResolver->resolveClass($reference); } // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 - if (is_array($middleware) && is_callable($middleware, true)) { - /** @var array{0: class-string|object, 1: non-empty-string} $middleware */ + if (is_array($reference) && is_callable($reference, true)) { + /** @var array{0: string|object, 1: string} $reference */ - if (is_string($middleware[0])) { - $middleware[0] = $this->classResolver->resolveClass($middleware[0]); + if (is_string($reference[0]) && class_exists($reference[0])) { + $reference[0] = $this->classResolver->resolveClass($reference[0]); } - if (is_callable($middleware)) { - return new CallableMiddleware($this->createMiddlewareCallback($middleware, new ReflectionMethod($middleware[0], $middleware[1]))); + if (is_callable($reference)) { + /** @var array{0: class-string|object, 1: non-empty-string} $reference */ + + return new CallableMiddleware($this->createMiddlewareCallback($reference, new ReflectionMethod($reference[0], $reference[1]))); } } - throw new InvalidArgumentException('Unsupported middleware.'); + throw new UnsupportedReferenceException(sprintf( + 'The middleware reference %s is not supported.', + self::stringifyReference($reference), + )); } /** @@ -119,8 +130,8 @@ private function createRequestHandlerCallback( ): Closure { return fn(ServerRequestInterface $request): ResponseInterface => ( $this->responseResolver->resolveResponse( - $callback(... - $this->parameterResolver + $callback( + ...$this->parameterResolver ->withRequest($request) ->withPriorityResolver( new ObjectInjectionParameterResolver($request), @@ -142,8 +153,8 @@ private function createMiddlewareCallback( ): Closure { return fn(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface => ( $this->responseResolver->resolveResponse( - $callback(... - $this->parameterResolver + $callback( + ...$this->parameterResolver ->withRequest($request) ->withPriorityResolver( new ObjectInjectionParameterResolver($request), @@ -156,4 +167,9 @@ private function createMiddlewareCallback( ) ); } + + private static function stringifyReference(mixed $reference): string + { + return is_callable($reference, true, $result) ? $result : get_debug_type($reference); + } } diff --git a/src/ResponseResolver.php b/src/ResponseResolver.php index b62116b5..fa12d3d8 100644 --- a/src/ResponseResolver.php +++ b/src/ResponseResolver.php @@ -13,7 +13,6 @@ namespace Sunrise\Http\Router; -use LogicException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; @@ -21,6 +20,8 @@ use ReflectionMethod; use Sunrise\Http\Router\Annotation\ResponseHeader; use Sunrise\Http\Router\Annotation\ResponseStatus; +use Sunrise\Http\Router\Exception\InvalidResponseException; +use Sunrise\Http\Router\Exception\UnsupportedResponseException; use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; use function sprintf; @@ -37,7 +38,8 @@ public function __construct( } /** - * @throws LogicException If the response couldn't be resolved to PSR-7 response. + * @throws InvalidResponseException + * @throws UnsupportedResponseException */ public function resolveResponse( mixed $response, @@ -55,8 +57,8 @@ public function resolveResponse( } } - throw new LogicException(sprintf( - 'The responder %s returned an unsupported response that could not be resolved.', + throw new UnsupportedResponseException(sprintf( + 'The responder %s returned an unsupported response.', self::stringifyResponder($responder), )); } diff --git a/src/Router.php b/src/Router.php index 629d5d7a..5efe7f0f 100644 --- a/src/Router.php +++ b/src/Router.php @@ -40,7 +40,7 @@ class Router implements RequestHandlerInterface { - private readonly RequestProcessorResolver $requestHandlerResolver; + private readonly ReferenceResolver $referenceResolver; /** * @var array @@ -73,9 +73,14 @@ public function __construct( array $responseResolvers = [], array $loaders = [], ) { - $this->requestHandlerResolver = new RequestProcessorResolver( - new ParameterResolver($parameterResolvers), - new ResponseResolver($responseResolvers), + $parameterResolver = new ParameterResolver($parameterResolvers); + $classResolver = new ClassResolver($parameterResolver); + $responseResolver = new ResponseResolver($responseResolvers); + + $this->referenceResolver = new ReferenceResolver( + parameterResolver: $parameterResolver, + classResolver: $classResolver, + responseResolver: $responseResolver, ); foreach ($loaders as $loader) { @@ -100,10 +105,7 @@ public function getRoute(string $name): RouteInterface return $this->routes[$name]; } - return throw new RouteNotFoundException(sprintf( - 'The route %s does not exist.', - $name, - )); + return throw new RouteNotFoundException(sprintf('The route %s does not exist.', $name)); } public function addRoute(RouteInterface ...$routes): void @@ -232,7 +234,7 @@ public function getRouteRequestHandler(RouteInterface|string $route): RequestHan } try { - $this->routeRequestHandlers[$routeName] = $this->requestHandlerResolver->resolveRequestHandler($route->getRequestHandler()); + $this->routeRequestHandlers[$routeName] = $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()); } catch (InvalidArgumentException $e) { throw new InvalidArgumentException(sprintf( 'The route %s refers to an unsupported request handler.', @@ -249,7 +251,7 @@ public function getRouteRequestHandler(RouteInterface|string $route): RequestHan foreach ($middlewares as $middleware) { try { - $middleware = $this->requestHandlerResolver->resolveMiddleware($middleware); + $middleware = $this->referenceResolver->resolveMiddleware($middleware); } catch (InvalidArgumentException $e) { throw new InvalidArgumentException(sprintf( 'The route %s refers to an unsupported middleware.', @@ -288,7 +290,7 @@ public function getRouterRequestHandler(): RequestHandlerInterface foreach ($this->middlewares as $middleware) { try { - $middleware = $this->requestHandlerResolver->resolveMiddleware($middleware); + $middleware = $this->referenceResolver->resolveMiddleware($middleware); } catch (InvalidArgumentException $e) { throw new InvalidArgumentException('The router refers to an unsupported middleware.', previous: $e); } From aacb5f56610e78f2a87e340f1a03cabe55d509f1 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 10 Mar 2024 11:40:01 +0100 Subject: [PATCH 126/180] v3 --- src/Exception/InvalidParameterException.php | 4 +- ...tion.php => InvalidReferenceException.php} | 2 +- src/ReferenceResolver.php | 14 ++--- src/Router.php | 52 +++++++------------ 4 files changed, 29 insertions(+), 43 deletions(-) rename src/Exception/{UnsupportedReferenceException.php => InvalidReferenceException.php} (80%) diff --git a/src/Exception/InvalidParameterException.php b/src/Exception/InvalidParameterException.php index 6ca2fac3..1ae574dd 100644 --- a/src/Exception/InvalidParameterException.php +++ b/src/Exception/InvalidParameterException.php @@ -13,11 +13,11 @@ namespace Sunrise\Http\Router\Exception; -use LogicException; +use InvalidArgumentException; /** * @since 3.0.0 */ -final class InvalidParameterException extends LogicException implements ExceptionInterface +final class InvalidParameterException extends InvalidArgumentException implements ExceptionInterface { } diff --git a/src/Exception/UnsupportedReferenceException.php b/src/Exception/InvalidReferenceException.php similarity index 80% rename from src/Exception/UnsupportedReferenceException.php rename to src/Exception/InvalidReferenceException.php index 1029ef99..e1e4c873 100644 --- a/src/Exception/UnsupportedReferenceException.php +++ b/src/Exception/InvalidReferenceException.php @@ -18,6 +18,6 @@ /** * @since 3.0.0 */ -final class UnsupportedReferenceException extends InvalidArgumentException implements ExceptionInterface +final class InvalidReferenceException extends InvalidArgumentException implements ExceptionInterface { } diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index c11418ba..e373156b 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -20,7 +20,7 @@ use Psr\Http\Server\RequestHandlerInterface; use ReflectionFunction; use ReflectionMethod; -use Sunrise\Http\Router\Exception\UnsupportedReferenceException; +use Sunrise\Http\Router\Exception\InvalidReferenceException; use Sunrise\Http\Router\Middleware\CallableMiddleware; use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; @@ -46,7 +46,7 @@ public function __construct( } /** - * @throws UnsupportedReferenceException If the requst handler couldn't be resolved. + * @throws InvalidReferenceException If the requst handler couldn't be resolved. */ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface { @@ -77,14 +77,14 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface return $this->classResolver->resolveClass($reference); } - throw new UnsupportedReferenceException(sprintf( - 'The request handler reference %s is not supported.', + throw new InvalidReferenceException(sprintf( + 'The request handler reference %s could not be resolved.', self::stringifyReference($reference), )); } /** - * @throws UnsupportedReferenceException If the middleware couldn't be resolved. + * @throws InvalidReferenceException If the middleware couldn't be resolved. */ public function resolveMiddleware(mixed $reference): MiddlewareInterface { @@ -115,8 +115,8 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface } } - throw new UnsupportedReferenceException(sprintf( - 'The middleware reference %s is not supported.', + throw new InvalidReferenceException(sprintf( + 'The middleware reference %s could not be resolved.', self::stringifyReference($reference), )); } diff --git a/src/Router.php b/src/Router.php index 5efe7f0f..62abf11e 100644 --- a/src/Router.php +++ b/src/Router.php @@ -13,13 +13,13 @@ namespace Sunrise\Http\Router; -use InvalidArgumentException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; +use Sunrise\Http\Router\Exception\InvalidReferenceException; use Sunrise\Http\Router\Exception\InvalidRouteBuildingValueException; use Sunrise\Http\Router\Exception\InvalidRouteMatchingSubjectException; use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; @@ -105,7 +105,7 @@ public function getRoute(string $name): RouteInterface return $this->routes[$name]; } - return throw new RouteNotFoundException(sprintf('The route %s does not exist.', $name)); + throw new RouteNotFoundException(sprintf('The route %s does not exist.', $name)); } public function addRoute(RouteInterface ...$routes): void @@ -169,6 +169,8 @@ public function handle(ServerRequestInterface $request): ResponseInterface } /** + * @throws RouteNotFoundException + * * @since 3.0.0 */ public function runRoute(RouteInterface|string $route, ServerRequestInterface $request): ResponseInterface @@ -187,6 +189,7 @@ public function runRoute(RouteInterface|string $route, ServerRequestInterface $r } /** + * @throws RouteNotFoundException * @throws InvalidRouteBuildingValueException * @throws InvalidRouteParsingSubjectException * @@ -204,6 +207,7 @@ public function buildRoute(RouteInterface|string $route, array $values = []): st /** * @return non-empty-string * + * @throws RouteNotFoundException * @throws InvalidRouteParsingSubjectException * * @since 3.0.0 @@ -218,7 +222,8 @@ public function compileRoute(RouteInterface|string $route): string } /** - * @throws InvalidArgumentException If the route is associated with an unsupported request handler or middleware. + * @throws RouteNotFoundException + * @throws InvalidReferenceException * * @since 3.0.0 */ @@ -233,40 +238,26 @@ public function getRouteRequestHandler(RouteInterface|string $route): RequestHan return $this->routeRequestHandlers[$routeName]; } - try { - $this->routeRequestHandlers[$routeName] = $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()); - } catch (InvalidArgumentException $e) { - throw new InvalidArgumentException(sprintf( - 'The route %s refers to an unsupported request handler.', - $routeName, - ), previous: $e); - } - $middlewares = $route->getMiddlewares(); if ($middlewares === []) { - return $this->routeRequestHandlers[$routeName]; + return $this->routeRequestHandlers[$routeName] = $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()); } - $this->routeRequestHandlers[$routeName] = new QueueableRequestHandler($this->routeRequestHandlers[$routeName]); + $this->routeRequestHandlers[$routeName] = new QueueableRequestHandler( + $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()) + ); foreach ($middlewares as $middleware) { - try { - $middleware = $this->referenceResolver->resolveMiddleware($middleware); - } catch (InvalidArgumentException $e) { - throw new InvalidArgumentException(sprintf( - 'The route %s refers to an unsupported middleware.', - $routeName, - ), previous: $e); - } - - $this->routeRequestHandlers[$routeName]->enqueue($middleware); + $this->routeRequestHandlers[$routeName]->enqueue( + $this->referenceResolver->resolveMiddleware($middleware) + ); } return $this->routeRequestHandlers[$routeName]; } /** - * @throws InvalidArgumentException If the router is associated with an unsupported middleware. + * @throws InvalidReferenceException * * @since 3.0.0 */ @@ -287,15 +278,10 @@ public function getRouterRequestHandler(): RequestHandlerInterface } $this->routerRequestHandler = new QueueableRequestHandler($this->routerRequestHandler); - foreach ($this->middlewares as $middleware) { - try { - $middleware = $this->referenceResolver->resolveMiddleware($middleware); - } catch (InvalidArgumentException $e) { - throw new InvalidArgumentException('The router refers to an unsupported middleware.', previous: $e); - } - - $this->routerRequestHandler->enqueue($middleware); + $this->routerRequestHandler->enqueue( + $this->referenceResolver->resolveMiddleware($middleware) + ); } return $this->routerRequestHandler; From f3d82c43bd358392837ad2d361bb7b96c8d2aa6a Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 10 Mar 2024 12:18:05 +0100 Subject: [PATCH 127/180] v3 --- src/ReferenceResolver.php | 2 +- src/Router.php | 4 +-- src/ServerRequest.php | 75 ++++++++++++++++++++++----------------- 3 files changed, 45 insertions(+), 36 deletions(-) diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index e373156b..aef333ea 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -39,8 +39,8 @@ final class ReferenceResolver { public function __construct( - private readonly ParameterResolver $parameterResolver, private readonly ClassResolver $classResolver, + private readonly ParameterResolver $parameterResolver, private readonly ResponseResolver $responseResolver, ) { } diff --git a/src/Router.php b/src/Router.php index 62abf11e..eed477e4 100644 --- a/src/Router.php +++ b/src/Router.php @@ -74,12 +74,12 @@ public function __construct( array $loaders = [], ) { $parameterResolver = new ParameterResolver($parameterResolvers); - $classResolver = new ClassResolver($parameterResolver); $responseResolver = new ResponseResolver($responseResolvers); + $classResolver = new ClassResolver($parameterResolver); $this->referenceResolver = new ReferenceResolver( - parameterResolver: $parameterResolver, classResolver: $classResolver, + parameterResolver: $parameterResolver, responseResolver: $responseResolver, ); diff --git a/src/ServerRequest.php b/src/ServerRequest.php index d7babb8b..d4cb200f 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -44,11 +44,6 @@ public static function create(ServerRequestInterface $request): self return new self($request); } - public function getOriginalRequest(): ServerRequestInterface - { - return $this->request; - } - /** * @throws LogicException If the request doesn't contain a route. */ @@ -208,9 +203,10 @@ public function getProtocolVersion(): string */ public function withProtocolVersion($version): self { - $this->request = $this->request->withProtocolVersion($version); + $clone = clone $this; + $clone->request = $this->request->withProtocolVersion($version); - return $this; + return $clone; } /** @@ -250,9 +246,10 @@ public function getHeaderLine($name): string */ public function withHeader($name, $value): self { - $this->request = $this->request->withHeader($name, $value); + $clone = clone $this; + $clone->request = $this->request->withHeader($name, $value); - return $this; + return $clone; } /** @@ -260,9 +257,10 @@ public function withHeader($name, $value): self */ public function withAddedHeader($name, $value): self { - $this->request = $this->request->withAddedHeader($name, $value); + $clone = clone $this; + $clone->request = $this->request->withAddedHeader($name, $value); - return $this; + return $clone; } /** @@ -270,9 +268,10 @@ public function withAddedHeader($name, $value): self */ public function withoutHeader($name): self { - $this->request = $this->request->withoutHeader($name); + $clone = clone $this; + $clone->request = $this->request->withoutHeader($name); - return $this; + return $clone; } /** @@ -288,9 +287,10 @@ public function getBody(): StreamInterface */ public function withBody(StreamInterface $body): self { - $this->request = $this->request->withBody($body); + $clone = clone $this; + $clone->request = $this->request->withBody($body); - return $this; + return $clone; } /** @@ -306,9 +306,10 @@ public function getMethod(): string */ public function withMethod($method): self { - $this->request = $this->request->withMethod($method); + $clone = clone $this; + $clone->request = $this->request->withMethod($method); - return $this; + return $clone; } /** @@ -324,9 +325,10 @@ public function getUri(): UriInterface */ public function withUri(UriInterface $uri, $preserveHost = false): self { - $this->request = $this->request->withUri($uri, $preserveHost); + $clone = clone $this; + $clone->request = $this->request->withUri($uri, $preserveHost); - return $this; + return $clone; } /** @@ -342,9 +344,10 @@ public function getRequestTarget(): string */ public function withRequestTarget($requestTarget): self { - $this->request = $this->request->withRequestTarget($requestTarget); + $clone = clone $this; + $clone->request = $this->request->withRequestTarget($requestTarget); - return $this; + return $clone; } /** @@ -382,9 +385,10 @@ public function getQueryParam(string $name, mixed $default = null): mixed */ public function withQueryParams(array $query): self { - $this->request = $this->request->withQueryParams($query); + $clone = clone $this; + $clone->request = $this->request->withQueryParams($query); - return $this; + return $clone; } /** @@ -414,9 +418,10 @@ public function getCookieParam(string $name, mixed $default = null): mixed */ public function withCookieParams(array $cookies): self { - $this->request = $this->request->withCookieParams($cookies); + $clone = clone $this; + $clone->request = $this->request->withCookieParams($cookies); - return $this; + return $clone; } /** @@ -432,9 +437,10 @@ public function getUploadedFiles(): array */ public function withUploadedFiles(array $uploadedFiles): self { - $this->request = $this->request->withUploadedFiles($uploadedFiles); + $clone = clone $this; + $clone->request = $this->request->withUploadedFiles($uploadedFiles); - return $this; + return $clone; } /** @@ -450,9 +456,10 @@ public function getParsedBody(): mixed */ public function withParsedBody($data): self { - $this->request = $this->request->withParsedBody($data); + $clone = clone $this; + $clone->request = $this->request->withParsedBody($data); - return $this; + return $clone; } /** @@ -476,9 +483,10 @@ public function getAttribute($name, $default = null): mixed */ public function withAttribute($name, $value): self { - $this->request = $this->request->withAttribute($name, $value); + $clone = clone $this; + $clone->request = $this->request->withAttribute($name, $value); - return $this; + return $clone; } /** @@ -486,8 +494,9 @@ public function withAttribute($name, $value): self */ public function withoutAttribute($name): self { - $this->request = $this->request->withoutAttribute($name); + $clone = clone $this; + $clone->request = $this->request->withoutAttribute($name); - return $this; + return $clone; } } From 12931aa5886656541cd082b6f4cee9af55c49cee Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 10 Mar 2024 20:26:47 +0100 Subject: [PATCH 128/180] v3 --- src/Dictionary/ErrorMessage.php | 1 + src/Exception/HttpExceptionFactory.php | 12 ++++ src/Helper/RouteMatcher.php | 2 +- src/ResponseResolver/JsonResponseResolver.php | 8 +-- src/Router.php | 70 +++++++++---------- 5 files changed, 53 insertions(+), 40 deletions(-) diff --git a/src/Dictionary/ErrorMessage.php b/src/Dictionary/ErrorMessage.php index 9691e150..bf872575 100644 --- a/src/Dictionary/ErrorMessage.php +++ b/src/Dictionary/ErrorMessage.php @@ -18,6 +18,7 @@ */ final class ErrorMessage { + public const INVALID_URI = 'The requested URI is invalid and cannot be accepted by the server.'; public const ROUTE_NOT_FOUND = 'The resource {{ request_uri }} was not found.'; public const METHOD_NOT_ALLOWED = 'The method {{ request_method }} is not allowed; check the Allow response header for allowed methods.'; public const MEDIA_TYPE_NOT_PROVIDED = 'The Content-Type header must be provided and must not be empty; check the Accept response header for supported media types.'; diff --git a/src/Exception/HttpExceptionFactory.php b/src/Exception/HttpExceptionFactory.php index 0884c6a2..b1e99038 100644 --- a/src/Exception/HttpExceptionFactory.php +++ b/src/Exception/HttpExceptionFactory.php @@ -22,6 +22,18 @@ */ final class HttpExceptionFactory { + public static function invalidUri( + ?string $message = null, + ?int $code = null, + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + message: $message ?? ErrorMessage::INVALID_URI, + code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + previous: $previous, + ); + } + public static function routeNotFound( ?string $message = null, ?int $code = null, diff --git a/src/Helper/RouteMatcher.php b/src/Helper/RouteMatcher.php index d1351de8..43a3489c 100644 --- a/src/Helper/RouteMatcher.php +++ b/src/Helper/RouteMatcher.php @@ -67,7 +67,7 @@ public static function matchPattern(string $route, string $pattern, string $subj if (preg_last_error() === PREG_BAD_UTF8_ERROR) { throw new InvalidRouteMatchingSubjectException(sprintf( 'The route %s could not be matched due to: %s.', - $route, + RouteSimplifier::simplifyRoute($route), preg_last_error_msg(), )); } diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index 36f6d569..9e09d1bd 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -40,8 +40,8 @@ final class JsonResponseResolver implements ResponseResolverInterface public function __construct( private readonly ResponseFactoryInterface $responseFactory, - private readonly ?int $defaultEncodingFlags = null, - private readonly ?int $defaultEncodingDepth = null, + private readonly int $defaultEncodingFlags = self::DEFAULT_ENCODING_FLAGS, + private readonly int $defaultEncodingDepth = self::DEFAULT_ENCODING_DEPTH, ) { } @@ -61,8 +61,8 @@ public function resolveResponse( $processParams = $annotations[0]->newInstance(); - $encodingFlags = $processParams->encodingFlags ?? $this->defaultEncodingFlags ?? self::DEFAULT_ENCODING_FLAGS; - $encodingDepth = $processParams->encodingDepth ?? $this->defaultEncodingDepth ?? self::DEFAULT_ENCODING_DEPTH; + $encodingFlags = $processParams->encodingFlags ?? $this->defaultEncodingFlags; + $encodingDepth = $processParams->encodingDepth ?? $this->defaultEncodingDepth; try { /** @psalm-suppress ArgumentTypeCoercion */ diff --git a/src/Router.php b/src/Router.php index eed477e4..249d088e 100644 --- a/src/Router.php +++ b/src/Router.php @@ -17,10 +17,11 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; +use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\Exception\InvalidReferenceException; use Sunrise\Http\Router\Exception\InvalidRouteBuildingValueException; +use Sunrise\Http\Router\Exception\InvalidRouteMatchingPatternException; use Sunrise\Http\Router\Exception\InvalidRouteMatchingSubjectException; use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; use Sunrise\Http\Router\Exception\RouteNotFoundException; @@ -42,6 +43,8 @@ class Router implements RequestHandlerInterface { private readonly ReferenceResolver $referenceResolver; + private ?RequestHandlerInterface $requestHandler = null; + /** * @var array */ @@ -57,8 +60,6 @@ class Router implements RequestHandlerInterface */ private array $routeRequestHandlers = []; - private ?RequestHandlerInterface $routerRequestHandler = null; - /** * @param ParameterResolverInterface[] $parameterResolvers * @param ResponseResolverInterface[] $responseResolvers @@ -125,7 +126,9 @@ public function load(LoaderInterface ...$loaders): void } /** - * @throws HttpException + * @throws HttpExceptionInterface + * @throws InvalidRouteMatchingPatternException + * @throws InvalidRouteParsingSubjectException */ public function match(ServerRequestInterface $request): RouteInterface { @@ -139,7 +142,7 @@ public function match(ServerRequestInterface $request): RouteInterface continue; } } catch (InvalidRouteMatchingSubjectException $e) { - throw new HttpException($e->getMessage(), 400); // TODO + throw HttpExceptionFactory::invalidUri(previous: $e); } if (!$route->allowsMethod($request->getMethod())) { @@ -162,14 +165,20 @@ public function match(ServerRequestInterface $request): RouteInterface /** * @inheritDoc + * + * @throws HttpExceptionInterface + * @throws InvalidReferenceException + * @throws InvalidRouteMatchingPatternException + * @throws InvalidRouteParsingSubjectException */ public function handle(ServerRequestInterface $request): ResponseInterface { - return $this->getRouterRequestHandler()->handle($request); + return $this->getRequestHandler()->handle($request); } /** * @throws RouteNotFoundException + * @throws InvalidReferenceException * * @since 3.0.0 */ @@ -183,9 +192,9 @@ public function runRoute(RouteInterface|string $route, ServerRequestInterface $r $request = $request->withAttribute($name, $value); } - $request = $request->withAttribute('@route', $route); - - return $this->getRouteRequestHandler($route)->handle($request); + return $this->getRouteRequestHandler($route)->handle( + $request->withAttribute('@route', $route) + ); } /** @@ -238,19 +247,14 @@ public function getRouteRequestHandler(RouteInterface|string $route): RequestHan return $this->routeRequestHandlers[$routeName]; } - $middlewares = $route->getMiddlewares(); - if ($middlewares === []) { - return $this->routeRequestHandlers[$routeName] = $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()); - } - - $this->routeRequestHandlers[$routeName] = new QueueableRequestHandler( - $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()) - ); + $this->routeRequestHandlers[$routeName] = $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()); - foreach ($middlewares as $middleware) { - $this->routeRequestHandlers[$routeName]->enqueue( - $this->referenceResolver->resolveMiddleware($middleware) - ); + $routeMiddlewares = $route->getMiddlewares(); + if (!empty($routeMiddlewares)) { + $this->routeRequestHandlers[$routeName] = new QueueableRequestHandler($this->routeRequestHandlers[$routeName]); + foreach ($routeMiddlewares as $routeMiddleware) { + $this->routeRequestHandlers[$routeName]->enqueue($this->referenceResolver->resolveMiddleware($routeMiddleware)); + } } return $this->routeRequestHandlers[$routeName]; @@ -261,29 +265,25 @@ public function getRouteRequestHandler(RouteInterface|string $route): RequestHan * * @since 3.0.0 */ - public function getRouterRequestHandler(): RequestHandlerInterface + public function getRequestHandler(): RequestHandlerInterface { - if (isset($this->routerRequestHandler)) { - return $this->routerRequestHandler; + if (isset($this->requestHandler)) { + return $this->requestHandler; } - $this->routerRequestHandler = new CallableRequestHandler( + $this->requestHandler = new CallableRequestHandler( fn(ServerRequestInterface $request): ResponseInterface => ( $this->runRoute($this->match($request), $request) ) ); - if ($this->middlewares === []) { - return $this->routerRequestHandler; - } - - $this->routerRequestHandler = new QueueableRequestHandler($this->routerRequestHandler); - foreach ($this->middlewares as $middleware) { - $this->routerRequestHandler->enqueue( - $this->referenceResolver->resolveMiddleware($middleware) - ); + if (!empty($this->middlewares)) { + $this->requestHandler = new QueueableRequestHandler($this->requestHandler); + foreach ($this->middlewares as $middleware) { + $this->requestHandler->enqueue($this->referenceResolver->resolveMiddleware($middleware)); + } } - return $this->routerRequestHandler; + return $this->requestHandler; } } From c45ac4b2a5639a29075f6c57983497a45e68573c Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 10 Mar 2024 20:38:49 +0100 Subject: [PATCH 129/180] v3 --- src/Router.php | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/src/Router.php b/src/Router.php index 249d088e..1493f4be 100644 --- a/src/Router.php +++ b/src/Router.php @@ -109,6 +109,11 @@ public function getRoute(string $name): RouteInterface throw new RouteNotFoundException(sprintf('The route %s does not exist.', $name)); } + public function hasRoute(string $name): bool + { + return isset($this->routes[$name]); + } + public function addRoute(RouteInterface ...$routes): void { foreach ($routes as $route) { @@ -138,13 +143,15 @@ public function match(ServerRequestInterface $request): RouteInterface $routePattern = $this->compileRoute($route); try { - if (!RouteMatcher::matchPattern($route->getPath(), $routePattern, $requestPath, $matches)) { - continue; - } + $isRouteMatched = RouteMatcher::matchPattern($route->getPath(), $routePattern, $requestPath, $matches); } catch (InvalidRouteMatchingSubjectException $e) { throw HttpExceptionFactory::invalidUri(previous: $e); } + if (!$isRouteMatched) { + continue; + } + if (!$route->allowsMethod($request->getMethod())) { $allowedMethods += array_flip($route->getMethods()); continue; From a1922b55a447dfb286f555523ada1af1c3b58df5 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Mon, 11 Mar 2024 00:11:08 +0100 Subject: [PATCH 130/180] v3 --- CHANGELOG.md | 22 - README.md | 715 +------------ composer.json | 3 +- phpcs.xml.dist | 7 +- tests/Command/RouteListCommandTest.php | 101 -- tests/Fixtures/CacheAwareTrait.php | 32 - tests/Fixtures/ContainerAwareTrait.php | 28 - .../Controllers/AbstractController.php | 57 -- .../Annotated/AbstractAnnotatedController.php | 12 - .../CacheableAnnotatedController.php | 16 - .../Annotated/GroupedAnnotatedController.php | 75 -- .../0/FirstLoadableAnnotatedController.php | 16 - .../1/SecondLoadableAnnotatedController.php | 16 - .../MaximallyAnnotatedController.php | 27 - .../MinimallyAnnotatedController.php | 16 - .../ResolvableAnnotatedController.php | 19 - .../FirstSortableAnnotatedController.php | 17 - .../SecondSortableAnnotatedController.php | 17 - .../ThirdSortableAnnotatedController.php | 17 - .../GroupedAttributedController.php | 43 - .../MaximallyAttributedController.php | 27 - .../MinimallyAttributedController.php | 15 - .../Fixtures/Controllers/BlankController.php | 22 - .../Middlewares/AbstractMiddleware.php | 79 -- .../Fixtures/Middlewares/BlankMiddleware.php | 24 - tests/Fixtures/Route.php | 34 - tests/Fixtures/routes/bar.php | 7 - tests/Fixtures/routes/foo.php | 7 - .../routes/resolvable/class-method-name.php | 11 - .../Fixtures/routes/resolvable/class-name.php | 11 - tests/Fixtures/routes/resolvable/closure.php | 16 - tests/Functions/FunctionPathBuildTest.php | 81 -- tests/Functions/FunctionPathMatchTest.php | 36 - tests/Functions/FunctionPathParseTest.php | 307 ------ tests/Functions/FunctionPathPlainTest.php | 25 - tests/Functions/FunctionPathRegexTest.php | 25 - tests/Helper/RouteParserTest.php | 70 ++ tests/Loader/ConfigLoaderTest.php | 123 --- tests/Loader/DescriptorLoaderTest.php | 350 ------- tests/Middleware/CallableMiddlewareTest.php | 44 - .../JsonPayloadDecodingMiddlewareTest.php | 127 --- tests/ReferenceResolverTest.php | 166 --- .../CallableRequestHandlerTest.php | 43 - .../QueueableRequestHandlerTest.php | 89 -- tests/RouteCollectionFactoryTest.php | 51 - tests/RouteCollectionTest.php | 327 ------ tests/RouteCollectorTest.php | 350 ------- tests/RouteFactoryTest.php | 58 -- tests/RouteTest.php | 408 -------- tests/RouterBuilderTest.php | 75 -- tests/RouterTest.php | 961 ------------------ 51 files changed, 79 insertions(+), 5146 deletions(-) delete mode 100644 tests/Command/RouteListCommandTest.php delete mode 100644 tests/Fixtures/CacheAwareTrait.php delete mode 100644 tests/Fixtures/ContainerAwareTrait.php delete mode 100644 tests/Fixtures/Controllers/AbstractController.php delete mode 100644 tests/Fixtures/Controllers/Annotated/AbstractAnnotatedController.php delete mode 100644 tests/Fixtures/Controllers/Annotated/CacheableAnnotatedController.php delete mode 100644 tests/Fixtures/Controllers/Annotated/GroupedAnnotatedController.php delete mode 100644 tests/Fixtures/Controllers/Annotated/Loadable/0/FirstLoadableAnnotatedController.php delete mode 100644 tests/Fixtures/Controllers/Annotated/Loadable/1/SecondLoadableAnnotatedController.php delete mode 100644 tests/Fixtures/Controllers/Annotated/MaximallyAnnotatedController.php delete mode 100644 tests/Fixtures/Controllers/Annotated/MinimallyAnnotatedController.php delete mode 100644 tests/Fixtures/Controllers/Annotated/ResolvableAnnotatedController.php delete mode 100644 tests/Fixtures/Controllers/Annotated/Sortable/FirstSortableAnnotatedController.php delete mode 100644 tests/Fixtures/Controllers/Annotated/Sortable/SecondSortableAnnotatedController.php delete mode 100644 tests/Fixtures/Controllers/Annotated/Sortable/ThirdSortableAnnotatedController.php delete mode 100644 tests/Fixtures/Controllers/Attributed/GroupedAttributedController.php delete mode 100644 tests/Fixtures/Controllers/Attributed/MaximallyAttributedController.php delete mode 100644 tests/Fixtures/Controllers/Attributed/MinimallyAttributedController.php delete mode 100644 tests/Fixtures/Controllers/BlankController.php delete mode 100644 tests/Fixtures/Middlewares/AbstractMiddleware.php delete mode 100644 tests/Fixtures/Middlewares/BlankMiddleware.php delete mode 100644 tests/Fixtures/Route.php delete mode 100644 tests/Fixtures/routes/bar.php delete mode 100644 tests/Fixtures/routes/foo.php delete mode 100644 tests/Fixtures/routes/resolvable/class-method-name.php delete mode 100644 tests/Fixtures/routes/resolvable/class-name.php delete mode 100644 tests/Fixtures/routes/resolvable/closure.php delete mode 100644 tests/Functions/FunctionPathBuildTest.php delete mode 100644 tests/Functions/FunctionPathMatchTest.php delete mode 100644 tests/Functions/FunctionPathParseTest.php delete mode 100644 tests/Functions/FunctionPathPlainTest.php delete mode 100644 tests/Functions/FunctionPathRegexTest.php create mode 100644 tests/Helper/RouteParserTest.php delete mode 100644 tests/Loader/ConfigLoaderTest.php delete mode 100644 tests/Loader/DescriptorLoaderTest.php delete mode 100644 tests/Middleware/CallableMiddlewareTest.php delete mode 100644 tests/Middleware/JsonPayloadDecodingMiddlewareTest.php delete mode 100644 tests/ReferenceResolverTest.php delete mode 100644 tests/RequestHandler/CallableRequestHandlerTest.php delete mode 100644 tests/RequestHandler/QueueableRequestHandlerTest.php delete mode 100644 tests/RouteCollectionFactoryTest.php delete mode 100644 tests/RouteCollectionTest.php delete mode 100644 tests/RouteCollectorTest.php delete mode 100644 tests/RouteFactoryTest.php delete mode 100644 tests/RouteTest.php delete mode 100644 tests/RouterBuilderTest.php delete mode 100644 tests/RouterTest.php diff --git a/CHANGELOG.md b/CHANGELOG.md index c35e1984..b1a1074b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,23 +1 @@ # v3.0.0 - -* Minimal PHP version **7.4**; -* ... - -## v2.16.0 - -* New method: `Router::hasRoute(string):bool`. - -## v2.15.0 - -* New middleware: `Sunrise\Http\Router\Middleware\JsonPayloadDecodingMiddleware`. - -## v2.14.0 - -* New method: `Route::getHolder():Reflector`; -* New method: `Router::resolveHostname(string):?string`; -* New method: `Router::getRoutesByHostname(string):array`; -* New method: `RouterBuilder::setEventDispatcher(?EventDispatcherInterface):void`. - -## v2.13.0 - -* Supports for events using the `symfony/event-dispatcher`. diff --git a/README.md b/README.md index 20828682..6dcfdf22 100644 --- a/README.md +++ b/README.md @@ -1,714 +1 @@ -# HTTP router for PHP 7.1+ based on PSR-7 and PSR-15 with support for annotations/attributes and OpenAPI (Swagger) Specification - -**psr router**, **router with annotations**, **router with attributes**, **php router**. - -[![Build Status](https://circleci.com/gh/sunrise-php/http-router.svg?style=shield)](https://circleci.com/gh/sunrise-php/http-router) -[![Code Coverage](https://scrutinizer-ci.com/g/sunrise-php/http-router/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/sunrise-php/http-router/?branch=master) -[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/sunrise-php/http-router/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/sunrise-php/http-router/?branch=master) -[![Total Downloads](https://poser.pugx.org/sunrise/http-router/downloads?format=flat)](https://packagist.org/packages/sunrise/http-router) -[![Latest Stable Version](https://poser.pugx.org/sunrise/http-router/v/stable?format=flat)](https://packagist.org/packages/sunrise/http-router) -[![License](https://poser.pugx.org/sunrise/http-router/license?format=flat)](https://packagist.org/packages/sunrise/http-router) - ---- - -## Installation - -```bash -composer require 'sunrise/http-router:^2.15' -``` - -## Support for OpenAPI (Swagger) Specification (optional) - -```bash -composer require 'sunrise/http-router-openapi:^2.0' -``` - -More details can be found here: [sunrise/http-router-openapi](https://github.com/sunrise-php/http-router-openapi). - -## QuickStart - -This example uses other sunrise packages, but you can use e.g. `zend/diactoros` or any other. - -```bash -composer require sunrise/http-message sunrise/http-server-request -``` - -```php -use Sunrise\Http\Message\ResponseFactory; -use Sunrise\Http\Router\RouteCollector; -use Sunrise\Http\Router\Router; -use Sunrise\Http\ServerRequest\ServerRequestFactory; - -use function Sunrise\Http\Router\emit; - -$collector = new RouteCollector(); - -// PSR-15 request handler (optimal performance): -$collector->get('home', '/', new HomeRequestHandler()); - -// or you can use an anonymous function as your request handler: -$collector->get('home', '/', function ($request) { - return (new ResponseFactory)->createResponse(200); -}); - -// or you can use the name of a class that implements PSR-15: -$collector->get('home', '/', HomeRequestHandler::class); - -// or you can use a class method name as your request handler: -// (note that such a class mayn't implement PSR-15) -$collector->get('home', '/', [HomeRequestHandler::class, 'index']); - -// most likely you will need to use PSR-11 container: -// (note that only named classes will be pulled from such a container) -$collector->setContainer($container); - -$router = new Router(); -$router->addRoute(...$collector->getRoutes()->all()); - -$request = ServerRequestFactory::fromGlobals(); -$response = $router->handle($request); - -emit($response); -``` - ---- - -## Examples of using - -Study [sunrise/awesome-skeleton](https://github.com/sunrise-php/awesome-skeleton) to understand how this can be used. - -#### Strategy for loading routes from configs - -> Please note that since version 2.10.0 class `ConfigLoader` must be used. - -```php -use Sunrise\Http\Router\Loader\ConfigLoader; -use Sunrise\Http\Router\Router; - -$loader = new ConfigLoader(); - -// set container if necessary... -$loader->setContainer($container); - -// attach configs... -$loader->attach('routes/api.php'); -$loader->attach('routes/admin.php'); -$loader->attach('routes/public.php'); - -// or attach a directory... -// [!] available from version 2.2 -$loader->attach('routes'); - -// or attach an array... -// [!] available from version 2.4 -$loader->attachArray([ - 'routes/api.php', - 'routes/admin.php', - 'routes/public.php', -]); - -// install container if necessary... -$loader->setContainer($container); - -$router = new Router(); -$router->load($loader); - -// if the router matching should be isolated for top middlewares... -// for example for error handling... -// [!] available from version 2.8 -$response = $router->run($request); - -// if the router is used as a request handler -$response = $router->handle($request); - -// if the router is used as middleware -$response = $router->process($request, $handler); -``` - -```php -/** @var Sunrise\Http\Router\RouteCollector $this */ - -$this->get('home', '/', new CallableRequestHandler(function ($request) { - return (new ResponseFactory)->createJsonResponse(200); -})); - -// or using a direct reference to a request handler... -$this->get('home', '/', new App\Http\Controller\HomeController()); -``` - -> Please note that since version 2.10.0 you can refer to the request handler in different ways. - -```php -/** @var Sunrise\Http\Router\RouteCollector $this */ - -$this->get('home', '/', function ($request) { - return (new ResponseFactory)->createJsonResponse(200); -}); - -$this->get('home', '/', App\Http\Controller\HomeController::class, [ - App\Http\Middleware\FooMiddleware::class, - App\Http\Middleware\BarMiddleware::class, -]); - -$this->get('home', '/', [App\Http\Controller\HomeController::class, 'index'], [ - App\Http\Middleware\FooMiddleware::class, - App\Http\Middleware\BarMiddleware::class, -]); -``` - -#### Strategy for loading routes from descriptors (annotations or attributes) - -Install the [doctrine/annotations](https://github.com/doctrine/annotations) package if you will be use annotations: - -```bash -composer require doctrine/annotations -``` - -> Please note that since version 2.10.0 class `DescriptorLoader` must be used. - -> Please note that since version 2.10.0 you can bind the @Rote() annotation to a class methods. - -```php -use Doctrine\Common\Annotations\AnnotationRegistry; -use Sunrise\Http\Router\Loader\DescriptorLoader; -use Sunrise\Http\Router\Router; - -// necessary if you will use annotations (annotations isn't attributes)... -AnnotationRegistry::registerLoader('class_exists'); - -$loader = new DescriptorLoader(); - -// set container if necessary... -$loader->setContainer($container); - -// attach a directory with controllers... -$loader->attach('src/Controller'); - -// or attach an array -// [!] available from version 2.4 -$loader->attachArray([ - 'src/Controller', - 'src/Bundle/BundleName/Controller', -]); - -// or attach a class only -// [!] available from 2.10 version. -$loader->attach(App\Http\Controller\FooController::class); - -$router = new Router(); -$router->load($loader); - -// if the router matching should be isolated for top middlewares... -// for example for error handling... -// [!] available from version 2.8 -$response = $router->run($request); - -// if the router is used as a request handler -$response = $router->handle($request); - -// if the router is used as middleware -$response = $router->process($request, $handler); -``` - -```php -use Sunrise\Http\Router\Annotation as Mapping; - -#[Mapping\Prefix('/api/v1')] -#[Mapping\Middleware(SomeMiddleware::class)] -class SomeController { - - #[Mapping\Route('foo', path: '/foo')] - public function foo() { - // will be available at: /api/v1/foo - } - - #[Mapping\Route('bar', path: '/bar')] - public function bar() { - // will be available at: /api/v1/bar - } -} -``` - -#### Without loading strategy - -```php -use App\Controller\HomeController; -use Sunrise\Http\Router\RouteCollector; -use Sunrise\Http\Router\Router; - -$collector = new RouteCollector(); - -// set container if necessary... -$collector->setContainer($container); - -$collector->get('home', '/', new HomeController()); - -$router = new Router(); -$router->addRoute(...$collector->getRoutes()->all()); - -// if the router matching should be isolated for top middlewares... -// for example for error handling... -// [!] available from version 2.8 -$response = $router->run($request); - -// if the router is used as a request handler -$response = $router->handle($request); - -// if the router is used as middleware -$response = $router->process($request, $handler); -``` - -#### Error handling example - -```php -use Sunrise\Http\Message\ResponseFactory; -use Sunrise\Http\Router\Exception\MethodNotAllowedException; -use Sunrise\Http\Router\Exception\RouteNotFoundException; -use Sunrise\Http\Router\Middleware\CallbackMiddleware; -use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; -use Sunrise\Http\Router\RouteCollector; -use Sunrise\Http\Router\Router; -use Sunrise\Http\ServerRequest\ServerRequestFactory; - -use function Sunrise\Http\Router\emit; - -$collector = new RouteCollector(); - -$collector->get('home', '/', new CallbackRequestHandler(function ($request) { - return (new ResponseFactory)->createJsonResponse(200); -})); - -$router = new Router(); -$router->addRoute(...$collector->getRoutes()->all()); - -$router->addMiddleware(new CallbackMiddleware(function ($request, $handler) { - try { - return $handler->handle($request); - } catch (MethodNotAllowedException $e) { - return (new ResponseFactory)->createResponse(405); - } catch (RouteNotFoundException $e) { - return (new ResponseFactory)->createResponse(404); - } catch (Throwable $e) { - return (new ResponseFactory)->createResponse(500); - } -})); - -emit($router->run(ServerRequestFactory::fromGlobals())); -``` - -#### Work with PSR-11 container - -##### Collector - -```php -$collector = new RouteCollector(); - -/** @var \Psr\Container\ContainerInterface $container */ - -// Pass DI container to the collector... -$collector->setContainer($container); - -// Objects passed as strings will be initialized through the DI container... -$route = $collector->get('home', '/', HomeController::class, [ - FooMiddleware::class, - BarMiddleware::class, -]); -``` - -##### Config loader - -```php -$loader = new ConfigLoader(); - -/** @var \Psr\Container\ContainerInterface $container */ - -// Pass DI container to the loader... -$loader->setContainer($container); - -// All found objects which has been passed as strings will be initialized through the DI container... -$routes = $loader->load(); -``` - -##### Descriptor loader - -```php -$loader = new DescriptorLoader(); - -/** @var \Psr\Container\ContainerInterface $container */ - -// Pass DI container to the loader... -$loader->setContainer($container); - -// All found objects will be initialized through the DI container... -$routes = $loader->load(); -``` - -#### Descriptors cache (PSR-16) - -```php -$loader = new DescriptorLoader(); - -/** @var \Psr\SimpleCache\CacheInterface $cache */ - -// Pass a cache to the loader... -$loader->setCache($cache); -``` - -#### Route Annotation Example - -##### Minimal annotation view - -```php -/** - * @Route( - * name="api_v1_entry_update", - * path="/api/v1/entry/{id<@uuid>}(/{optionalAttribute})", - * methods={"PATCH"}, - * ) - */ -final class EntryUpdateRequestHandler implements RequestHandlerInterface -``` - -##### Full annotation - -```php -/** - * @Route( - * name="api_v1_entry_update", - * host="api.host", - * path="/api/v1/entry/{id<@uuid>}(/{optionalAttribute})", - * methods={"PATCH"}, - * middlewares={ - * "App\Middleware\CorsMiddleware", - * "App\Middleware\ApiAuthMiddleware", - * }, - * attributes={ - * "optionalAttribute": "defaultValue", - * }, - * summary="Updates an entry by UUID", - * description="Here you can describe the method in more detail...", - * tags={"api", "entry"}, - * priority=0, - * ) - */ -final class EntryUpdateRequestHandler implements RequestHandlerInterface -``` - -##### One method only - -```php -/** - * @Route( - * name="home", - * path="/", - * method="GET", - * ) - */ -``` - -#### Route Attribute Example - -##### Minimal attribute view - -```php -use Sunrise\Http\Router\Annotation\Route; - -#[Route( - name: 'api_v1_entry_update', - path: '/api/v1/entry/{id<@uuid>}(/{optionalAttribute})', - methods: ['PATCH'], -)] -final class EntryUpdateRequestHandler implements RequestHandlerInterface -``` - -##### Full attribute - -```php -use Sunrise\Http\Router\Annotation\Route; - -#[Route( - name: 'api_v1_entry_update', - host: 'api.host', - path: '/api/v1/entry/{id<@uuid>}(/{optionalAttribute})', - methods: ['PATCH'], - middlewares: [ - \App\Middleware\CorsMiddleware::class, - \App\Middleware\ApiAuthMiddleware::class, - ], - attributes: [ - 'optionalAttribute' => 'defaultValue', - ], - summary: 'Updates an entry by UUID', - description: 'Here you can describe the method in more detail...', - tags: ['api', 'entry'], - priority: 0, -)] -final class EntryUpdateRequestHandler implements RequestHandlerInterface -``` - -##### Additional annotations - -```php -use Sunrise\Http\Router\Annotation\Host; - -#[Host('admin')] -#[Prefix('/api/v1')] -#[Postfix('.json')] -#[Middleware(SomeMiddleware::class)] -final class SomeController -{ - #[Route('foo', '/foo')] - public function foo(ServerRequestInterface $request) : ResponseInterface - { - // this action will be available at: - // http://admin.host/api/v1/foo.json - // - // this can be handy to reduce code duplication... - } -} -``` - ---- - -## Useful to know - -### JSON-payload decoding - -```php -use Sunrise\Http\Router\Middleware\JsonPayloadDecodingMiddleware; - -$router->addMiddleware(new JsonPayloadDecodingMiddleware()); -``` - -### Get a route by name - -```php -// checks if a route is exists -$router->hasRoute('foo'); - -// gets a route by name -$router->getRoute('foo'); -``` - -### Get a current route - -#### Through Router - -> Available from version 2.12. - -```php -$router->getMatchedRoute(); -``` - -#### Through Request - -> Available from version 1.x, but wasn't documented before... - -```php -$request->getAttribute('@route'); - -// or -$request->getAttribute(\Sunrise\Http\Router\RouteInterface::ATTR_ROUTE); -``` - -#### Through Event - -> Available from version 2.13. - -```php -$eventDispatcher->addListener(RouteEvent::NAME, function (RouteEvent $event) { - $event->getRoute(); -}); -``` - -### Generation a route URI - -```php -$uri = $router->generateUri('route.name', [ - 'attribute' => 'value', -], true); -``` - -### Run a route - -```php -$response = $router->getRoute('route.name')->handle($request); -``` - -### Route grouping - -Example for annotations [here](#additional-annotations). - -```php -$collector->group(function ($collector) { - $collector->group(function ($collector) { - $collector->group(function ($collector) { - $collector->get('api.entry.read', '/{id<\d+>}', ...) - ->addMiddleware(...); // add the middleware(s) to the route... - }) - ->addPrefix('/entry') // add the prefix to the group... - ->prependMiddleware(...); // add the middleware(s) to the group... - }, [ - App\Http\Middleware\Bar::class, // resolvable middlewares... - ]) - ->addPrefix('/v1') // add the prefix to the group... - ->prependMiddleware(...); // add the middleware(s) to the group... -}, [ - App\Http\Middleware\Foo::class, // resolvable middlewares... -]) -->addPrefix('/api') // add the prefix to the group... -->prependMiddleware(...); // add the middleware(s) to the group... -``` - -### Route patterns - -```php -$collector->get('api.entry.read', '/api/v1/entry/{id<\d+>}(/{optional<\w+>})'); -``` - -##### Global route patterns - -```php -// @uuid pattern -$collector->get('api.entry.read', '/api/v1/entry/{id<@uuid>}'); - -// @slug pattern -$collector->get('api.entry.read', '/api/v1/entry/{slug<@slug>}'); - -// Custom patterns (available from version 2.9.0): -\Sunrise\Http\Router\Router::$patterns['@id'] = '[1-9][0-9]*'; - -// Just use the custom pattern... -$collector->get('api.entry.read', '/api/v1/entry/{id<@id>}'); -``` - -It is better to set patterns through the router: - -```php -// available since version 2.11.0 -$router->addPatterns([ - '@id' => '[1-9][0-9]*', -]); -``` - -...or through the router's builder: - -```php -// available since version 2.11.0 -$builder->setPatterns([ - '@id' => '[1-9][0-9]*', -]); -``` - -### Hosts (available from version 2.6.0) - -> Note: if you don't assign a host for a route, it will be available on any hosts! - -```php -// move the hosts table into the settings... -$router->addHost('public.host', 'www.example.com', ...); -$router->addHost('admin.host', 'secret.example.com', ...); -$router->addHost('api.host', 'api.example.com', ...); - -// ...or: -$router->addHosts([ - 'public.host' => ['www.example.com', ...], - ... -]); - -// the route will available only on the `secret.example.com` host... -$route->setHost('admin.host'); - -// routes in the group will available on the `secret.example.com` host... -$collector->group(function ($collector) { - // some code... -}) -->setHost('admin.host'); -``` - -You can resolve the hostname since version 2.14.0 as follows: - -```php -$router->addHost('admin', 'www1.admin.example.com', 'www2.admin.example.com'); - -$router->resolveHostname('www1.admin.example.com'); // return "admin" -$router->resolveHostname('www2.admin.example.com'); // return "admin" -$router->resolveHostname('unknown'); // return null -``` - -Also you can get all routes by hostname: - -```php -$router->getRoutesByHostname('www1.admin.example.com'); -``` - -### Route Holder - -```php -$route->getHolder(); // return Reflector (class, method or function) -``` - -### The router builder - -```php -$router = (new RouterBuilder) - ->setEventDispatcher(...) // null or use to symfony/event-dispatcher... - ->setContainer(...) // null or PSR-11 container instance... - ->setCache(...) // null or PSR-16 cache instance... (only for descriptor loader) - ->setCacheKey(...) // null or string... (only for descriptor loader) - ->useConfigLoader([]) // array with files or directory with files... - ->useDescriptorLoader([]) // array with classes or directory with classes... - ->setHosts([]) // - ->setMiddlewares([]) // array with middlewares... - ->setPatterns([]) // available since version 2.11.0 - ->build(); -``` - -### CLI commands - -```php -use Sunrise\Http\Router\Command\RouteListCommand; - -new RouteListCommand($router); -``` - -### Events - -> Available from version 2.13 - -```bash -composer require symfony/event-dispatcher -``` - -```php -use Sunrise\Http\Router\Event\RouteMatchedEvent; -use Symfony\Component\EventDispatcher\EventDispatcher; - -$eventDispatcher = new EventDispatcher(); - -$eventDispatcher->addListener(RouteMatchedEvent::NAME, function (RouteMatchedEvent $event) { - // gets the matched route: - $event->getRoute(); - // gets the current request: - $event->getRequest(); - // overrides the current request: - $event->setRequest(ServerRequestInterface $request); -}); - -$router->setEventDispatcher($eventDispatcher); -``` - ---- - -## Test run - -```bash -composer test -``` - -## Useful links - -* https://www.php-fig.org/psr/psr-7/ -* https://www.php-fig.org/psr/psr-15/ -* https://github.com/sunrise-php/awesome-skeleton -* https://github.com/middlewares +# Work In Progress diff --git a/composer.json b/composer.json index 3e30b579..d290a798 100644 --- a/composer.json +++ b/composer.json @@ -56,7 +56,8 @@ "doctrine/orm": "^2.16", "symfony/uid": "^6.0", "ramsey/uuid": "^4.7", - "neomerx/cors-psr7": "^3.0" + "neomerx/cors-psr7": "^3.0", + "php-di/php-di": "^7.0" }, "autoload": { "files": [ diff --git a/phpcs.xml.dist b/phpcs.xml.dist index 862c7d44..1f6e6c02 100644 --- a/phpcs.xml.dist +++ b/phpcs.xml.dist @@ -3,7 +3,12 @@ benchmarks - functions src tests + + + + + + diff --git a/tests/Command/RouteListCommandTest.php b/tests/Command/RouteListCommandTest.php deleted file mode 100644 index 848b49a3..00000000 --- a/tests/Command/RouteListCommandTest.php +++ /dev/null @@ -1,101 +0,0 @@ -addRoute(...[ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]); - - $command = new RouteListCommand($router); - - $this->assertSame('router:route-list', $command->getName()); - - $commandTester = new CommandTester($command); - - $this->assertSame(0, $commandTester->execute([])); - } - - /** - * @return void - */ - public function testRunInheritedCommand() : void - { - $command = new class extends RouteListCommand - { - public function __construct() - { - parent::__construct(null); - } - - protected function getRouter() : Router - { - return new Router(); - } - }; - - $this->assertSame('router:route-list', $command->getName()); - - $commandTester = new CommandTester($command); - - $this->assertSame(0, $commandTester->execute([])); - } - - /** - * @return void - */ - public function testRunRenamedCommand() : void - { - $command = new class extends RouteListCommand - { - protected static $defaultName = 'foo'; - protected static $defaultDescription = 'bar'; - - public function __construct() - { - parent::__construct(new Router()); - } - }; - - $this->assertSame('foo', $command->getName()); - $this->assertSame('bar', $command->getDescription()); - - $commandTester = new CommandTester($command); - - $this->assertSame(0, $commandTester->execute([])); - } - - /** - * @return void - */ - public function testRunWithoutRouter() : void - { - $command = new RouteListCommand(); - $commandTester = new CommandTester($command); - - $this->expectException(RuntimeException::class); - - $commandTester->execute([]); - } -} diff --git a/tests/Fixtures/CacheAwareTrait.php b/tests/Fixtures/CacheAwareTrait.php deleted file mode 100644 index 1224f7ee..00000000 --- a/tests/Fixtures/CacheAwareTrait.php +++ /dev/null @@ -1,32 +0,0 @@ -createMock(CacheInterface::class); - $cache->storage = []; - - $cache->method('get')->will($this->returnCallback(function ($key) use ($cache) { - return $cache->storage[$key] ?? null; - })); - - $cache->method('has')->will($this->returnCallback(function ($key) use ($cache) { - return isset($cache->storage[$key]); - })); - - $cache->method('set')->will($this->returnCallback(function ($key, $value) use ($cache) { - $cache->storage[$key] = $value; - })); - - return $cache; - } -} diff --git a/tests/Fixtures/ContainerAwareTrait.php b/tests/Fixtures/ContainerAwareTrait.php deleted file mode 100644 index 31bc8498..00000000 --- a/tests/Fixtures/ContainerAwareTrait.php +++ /dev/null @@ -1,28 +0,0 @@ -createMock(ContainerInterface::class); - $container->storage = $definitions; - - $container->method('get')->will($this->returnCallback(function ($key) use ($container) { - return $container->storage[$key] ?? null; - })); - - $container->method('has')->will($this->returnCallback(function ($key) use ($container) { - return isset($container->storage[$key]); - })); - - return $container; - } -} diff --git a/tests/Fixtures/Controllers/AbstractController.php b/tests/Fixtures/Controllers/AbstractController.php deleted file mode 100644 index fb36ce4c..00000000 --- a/tests/Fixtures/Controllers/AbstractController.php +++ /dev/null @@ -1,57 +0,0 @@ -isRunned; - } - - /** - * Gets the request that was handled by the called method - * - * @return ServerRequestInterface|null - */ - public function getRequest() : ?ServerRequestInterface - { - return $this->request; - } - - /** - * {@inheritdoc} - */ - public function handle(ServerRequestInterface $request) : ResponseInterface - { - $this->isRunned = true; - $this->request = $request; - - return (new ResponseFactory)->createResponse(200); - } -} diff --git a/tests/Fixtures/Controllers/Annotated/AbstractAnnotatedController.php b/tests/Fixtures/Controllers/Annotated/AbstractAnnotatedController.php deleted file mode 100644 index 8a83239f..00000000 --- a/tests/Fixtures/Controllers/Annotated/AbstractAnnotatedController.php +++ /dev/null @@ -1,12 +0,0 @@ -handle($request); - } - - /** - * @Route("second-from-grouped-annotated-controller", path="/second") - * @Middleware("Sunrise\Http\Router\Tests\Fixtures\Middlewares\BlankMiddleware") - * @Middleware("Sunrise\Http\Router\Tests\Fixtures\Middlewares\BlankMiddleware") - * @Middleware("Sunrise\Http\Router\Tests\Fixtures\Middlewares\BlankMiddleware") - */ - public function second($request) - { - return $this->handle($request); - } - - /** - * @Route("third-from-grouped-annotated-controller", path="/third") - * @Middleware("Sunrise\Http\Router\Tests\Fixtures\Middlewares\BlankMiddleware") - * @Middleware("Sunrise\Http\Router\Tests\Fixtures\Middlewares\BlankMiddleware") - * @Middleware("Sunrise\Http\Router\Tests\Fixtures\Middlewares\BlankMiddleware") - */ - public function third($request) - { - return $this->handle($request); - } - - /** - * @Route("private-from-grouped-annotated-controller", path="/") - */ - private function privateAction() - { - } - - /** - * @Route("protected-from-grouped-annotated-controller", path="/") - */ - protected function protectedAction() - { - } - - /** - * @Route("static-from-grouped-annotated-controller", path="/") - */ - public static function staticAction() - { - } - - public function shouldBeIgnored() - { - } -} diff --git a/tests/Fixtures/Controllers/Annotated/Loadable/0/FirstLoadableAnnotatedController.php b/tests/Fixtures/Controllers/Annotated/Loadable/0/FirstLoadableAnnotatedController.php deleted file mode 100644 index 81972be7..00000000 --- a/tests/Fixtures/Controllers/Annotated/Loadable/0/FirstLoadableAnnotatedController.php +++ /dev/null @@ -1,16 +0,0 @@ -handle($request); - } - - #[Routing\Route('second-from-grouped-attributed-controller', path: '/second')] - #[Routing\Middleware(BlankMiddleware::class)] - #[Routing\Middleware(BlankMiddleware::class)] - #[Routing\Middleware(BlankMiddleware::class)] - public function second($request) - { - return $this->handle($request); - } - - #[Routing\Route('third-from-grouped-attributed-controller', path: '/third')] - #[Routing\Middleware(BlankMiddleware::class)] - #[Routing\Middleware(BlankMiddleware::class)] - #[Routing\Middleware(BlankMiddleware::class)] - public function third($request) - { - return $this->handle($request); - } -} diff --git a/tests/Fixtures/Controllers/Attributed/MaximallyAttributedController.php b/tests/Fixtures/Controllers/Attributed/MaximallyAttributedController.php deleted file mode 100644 index 27446c9f..00000000 --- a/tests/Fixtures/Controllers/Attributed/MaximallyAttributedController.php +++ /dev/null @@ -1,27 +0,0 @@ - 'bar', - ], - summary: 'Lorem ipsum', - description: 'Lorem ipsum dolor sit amet', - tags: ['foo', 'bar'], -)] -final class MaximallyAttributedController extends AbstractController -{ -} diff --git a/tests/Fixtures/Controllers/Attributed/MinimallyAttributedController.php b/tests/Fixtures/Controllers/Attributed/MinimallyAttributedController.php deleted file mode 100644 index ec8f7767..00000000 --- a/tests/Fixtures/Controllers/Attributed/MinimallyAttributedController.php +++ /dev/null @@ -1,15 +0,0 @@ -handle($request)->withStatus(305); - } -} diff --git a/tests/Fixtures/Middlewares/AbstractMiddleware.php b/tests/Fixtures/Middlewares/AbstractMiddleware.php deleted file mode 100644 index df27cc1d..00000000 --- a/tests/Fixtures/Middlewares/AbstractMiddleware.php +++ /dev/null @@ -1,79 +0,0 @@ -isBreakable = $isBreakable; - } - - /** - * Checks if the middleware was runned - * - * @return bool - */ - public function isRunned() : bool - { - return $this->isRunned; - } - - /** - * Gets the request that was handled by the called method - * - * @return ServerRequestInterface|null - */ - public function getRequest() : ?ServerRequestInterface - { - return $this->request; - } - - /** - * {@inheritdoc} - */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler) : ResponseInterface - { - $this->isRunned = true; - $this->request = $request; - - if ($this->isBreakable) { - return (new ResponseFactory)->createResponse(200); - } - - return $handler->handle($request); - } -} diff --git a/tests/Fixtures/Middlewares/BlankMiddleware.php b/tests/Fixtures/Middlewares/BlankMiddleware.php deleted file mode 100644 index 79b6e8e2..00000000 --- a/tests/Fixtures/Middlewares/BlankMiddleware.php +++ /dev/null @@ -1,24 +0,0 @@ -process($request, $handler)->withStatus(305); - } -} diff --git a/tests/Fixtures/Route.php b/tests/Fixtures/Route.php deleted file mode 100644 index 2fbd50f7..00000000 --- a/tests/Fixtures/Route.php +++ /dev/null @@ -1,34 +0,0 @@ -get('bar', '/bar', new BlankController()); diff --git a/tests/Fixtures/routes/foo.php b/tests/Fixtures/routes/foo.php deleted file mode 100644 index 1421ca93..00000000 --- a/tests/Fixtures/routes/foo.php +++ /dev/null @@ -1,7 +0,0 @@ -get('foo', '/foo', new BlankController()); diff --git a/tests/Fixtures/routes/resolvable/class-method-name.php b/tests/Fixtures/routes/resolvable/class-method-name.php deleted file mode 100644 index 78ebcf26..00000000 --- a/tests/Fixtures/routes/resolvable/class-method-name.php +++ /dev/null @@ -1,11 +0,0 @@ -get('resolvable-class-method-name-route', '/', $controller, [$middleware]); diff --git a/tests/Fixtures/routes/resolvable/class-name.php b/tests/Fixtures/routes/resolvable/class-name.php deleted file mode 100644 index 4abc3e73..00000000 --- a/tests/Fixtures/routes/resolvable/class-name.php +++ /dev/null @@ -1,11 +0,0 @@ -get('resolvable-class-name-route', '/', $controller, [$middleware]); diff --git a/tests/Fixtures/routes/resolvable/closure.php b/tests/Fixtures/routes/resolvable/closure.php deleted file mode 100644 index d625941c..00000000 --- a/tests/Fixtures/routes/resolvable/closure.php +++ /dev/null @@ -1,16 +0,0 @@ -handle($request); -}; - -$middleware = function ($request, $handler) { - return (new BlankMiddleware)->process($request, $handler); -}; - -$this->get('resolvable-closure-route', '/', $controller, [$middleware]); diff --git a/tests/Functions/FunctionPathBuildTest.php b/tests/Functions/FunctionPathBuildTest.php deleted file mode 100644 index b2c4d303..00000000 --- a/tests/Functions/FunctionPathBuildTest.php +++ /dev/null @@ -1,81 +0,0 @@ -}/quuuuux)/{quuuuuux}'; - $expected = '/foo/quux/quuux/quuuux/quuuuux/quuuuuux'; - - $this->assertSame($expected, path_build($path, [ - 'quuuux' => 'quuuux', - 'quuuuuux' => 'quuuuuux', - ])); - } - - /** - * @return void - */ - public function testBuildPathWithoutRequiredAttribute() : void - { - $path = '/foo/{bar}/{baz}'; - - $this->expectException(MissingAttributeValueException::class); - $this->expectExceptionMessage( - '[' . $path . '] build error: no value given for the attribute "baz".' - ); - - try { - path_build($path, [ - 'bar' => 'bar', - ]); - } catch (MissingAttributeValueException $e) { - $this->assertSame(['path', 'match'], array_keys($e->getContext())); - $this->assertSame($path, $e->fromContext('path')); - - throw $e; - } - } - - /** - * @return void - */ - public function testBuildPathWithInvalidAttribute() : void - { - $path = '/foo/{bar}/{baz<[a-z]+>}'; - - $this->expectException(InvalidAttributeValueException::class); - $this->expectExceptionMessage( - '[' . $path . '] build error: the given value for the attribute "baz" does not match its pattern.' - ); - - try { - path_build($path, [ - 'bar' => 'bar', - 'baz' => '42', - ], true); - } catch (InvalidAttributeValueException $e) { - $this->assertSame(['path', 'value', 'match'], array_keys($e->getContext())); - $this->assertSame($path, $e->fromContext('path')); - $this->assertSame('42', $e->fromContext('value')); - - throw $e; - } - } -} diff --git a/tests/Functions/FunctionPathMatchTest.php b/tests/Functions/FunctionPathMatchTest.php deleted file mode 100644 index bbff7847..00000000 --- a/tests/Functions/FunctionPathMatchTest.php +++ /dev/null @@ -1,36 +0,0 @@ -}(/)'; - - $this->assertTrue(path_match($path, '/foo/bar/baz/', $attributes)); - $this->assertSame([ - 'bar' => 'bar', - 'baz' => 'baz', - ], $attributes); - - $this->assertTrue(path_match($path, '/foo/baz', $attributes)); - $this->assertSame([ - 'baz' => 'baz', - ], $attributes); - - $this->assertFalse(path_match($path, '/foo/baz!', $attributes)); - $this->assertSame([], $attributes); - } -} diff --git a/tests/Functions/FunctionPathParseTest.php b/tests/Functions/FunctionPathParseTest.php deleted file mode 100644 index bd24454e..00000000 --- a/tests/Functions/FunctionPathParseTest.php +++ /dev/null @@ -1,307 +0,0 @@ -}/qux)/quux/{quuux<\d+>}/quuuux(/)'; - - $expected = [ - [ - 'raw' => '{foo}', - 'withParentheses' => null, - 'name' => 'foo', - 'pattern' => null, - 'isOptional' => false, - 'startPosition' => 1, - 'endPosition' => 5, - ], - [ - 'raw' => '{baz<\w+>}', - 'withParentheses' => '(/bar/{baz<\w+>}/qux)', - 'name' => 'baz', - 'pattern' => '\w+', - 'isOptional' => true, - 'startPosition' => 12, - 'endPosition' => 21, - ], - [ - 'raw' => '{quuux<\d+>}', - 'withParentheses' => null, - 'name' => 'quuux', - 'pattern' => '\d+', - 'isOptional' => false, - 'startPosition' => 33, - 'endPosition' => 44, - ], - ]; - - $this->assertSame($expected, path_parse($path)); - } - - /** - * @return void - */ - public function testNamedPatterns() : void - { - $path = '/{foo<@slug>}/{bar<@uuid>}'; - - $expected = [ - [ - 'raw' => '{foo<@slug>}', - 'withParentheses' => null, - 'name' => 'foo', - 'pattern' => Router::$patterns['@slug'], - 'isOptional' => false, - 'startPosition' => 1, - 'endPosition' => 12, - ], - [ - 'raw' => '{bar<@uuid>}', - 'withParentheses' => null, - 'name' => 'bar', - 'pattern' => Router::$patterns['@uuid'], - 'isOptional' => false, - 'startPosition' => 14, - 'endPosition' => 25, - ], - ]; - - $this->assertSame($expected, path_parse($path)); - } - - /** - * @return void - */ - public function testParenthesesInsideParentheses() : void - { - $path = '/test(/{foo}(/{bar}))'; - - $this->expectException(InvalidPathException::class); - $this->expectExceptionMessage('[' . $path . ':12] parentheses inside parentheses are not allowed.'); - - path_parse($path); - } - - /** - * @return void - */ - public function testBracesInsideAttributes() : void - { - $path = '/test/{foo{bar}}'; - - $this->expectException(InvalidPathException::class); - $this->expectExceptionMessage('[' . $path . ':10] braces inside attributes are not allowed.'); - - path_parse($path); - } - - /** - * @return void - */ - public function testMultipleAttributesInsideParentheses() : void - { - $path = '/test(/{foo}/{bar})'; - - $this->expectException(InvalidPathException::class); - $this->expectExceptionMessage('[' . $path . ':13] multiple attributes inside parentheses are not allowed.'); - - path_parse($path); - } - - /** - * @return void - */ - public function testLessThanCharInsidePatterns() : void - { - $path = '/test/{foo<(?\d+)-\w+>}'; - - $this->expectException(InvalidPathException::class); - $this->expectExceptionMessage('[' . $path . ':13] the char "<" inside patterns is not allowed.'); - - path_parse($path); - } - - /** - * @return void - */ - public function testGreaterThanCharInsidePatterns() : void - { - $path = '/test/{foo<[^>]+>}'; - - $this->expectException(InvalidPathException::class); - $this->expectExceptionMessage('[' . $path . ':16] at position 16 an extra char ">" was found.'); - - path_parse($path); - } - - /** - * @return void - */ - public function testEmptyPattern() : void - { - $path = '/test/{foo<>}'; - - $this->expectException(InvalidPathException::class); - $this->expectExceptionMessage('[' . $path . ':11] an attribute pattern is empty.'); - - path_parse($path); - } - - /** - * @return void - */ - public function testExtraClosingBrace() : void - { - $path = '/test/{foo}/bar}'; - - $this->expectException(InvalidPathException::class); - $this->expectExceptionMessage('[' . $path . ':15] at position 15 an extra closing brace was found.'); - - path_parse($path); - } - - /** - * @return void - */ - public function testEmptyAttributeName() : void - { - $path = '/test/{}'; - - $this->expectException(InvalidPathException::class); - $this->expectExceptionMessage('[' . $path . ':7] an attribute name is empty.'); - - path_parse($path); - } - - /** - * @return void - */ - public function testExtraClosingParenthesis() : void - { - $path = '/test(/{foo})/bar)'; - - $this->expectException(InvalidPathException::class); - $this->expectExceptionMessage('[' . $path . ':17] at position 17 an extra closing parenthesis was found.'); - - path_parse($path); - } - - /** - * @return void - * - * @dataProvider invalidFirstCharForAttributeNameDataProvider - */ - public function testInvalidFirstCharForAttributeName($char) : void - { - $path = '/test/{' . $char . '}'; - - $this->expectException(InvalidPathException::class); - $this->expectExceptionMessage('[' . $path . ':7] an attribute name must begin with "A-Za-z_".'); - - path_parse($path); - } - - /** - * @return void - * - * @dataProvider invalidSecondCharForAttributeNameDataProvider - */ - public function testInvalidSecondCharForAttributeName($char) : void - { - $path = '/test/{_' . $char . '}'; - - $this->expectException(InvalidPathException::class); - $this->expectExceptionMessage('[' . $path . ':8] an attribute name must contain only "0-9A-Za-z_".'); - - path_parse($path); - } - - /** - * @return void - */ - public function testNumberSignInPattern() : void - { - $path = '/test/{foo<#>}'; - - $this->expectException(InvalidPathException::class); - $this->expectExceptionMessage('[' . $path . ':11] unallowed character "#" in an attribute pattern.'); - - path_parse($path); - } - - /** - * @return void - */ - public function testNonClosedParentheses() : void - { - $path = '/test('; - - $this->expectException(InvalidPathException::class); - $this->expectExceptionMessage('[' . $path . '] the route path contains non-closed parentheses.'); - - path_parse($path); - } - - /** - * @return void - */ - public function testNonClosedAttribute() : void - { - $path = '/test{'; - - $this->expectException(InvalidPathException::class); - $this->expectExceptionMessage('[' . $path . '] the route path contains non-closed attribute.'); - - path_parse($path); - } - - /** - * @return array - */ - public function invalidFirstCharForAttributeNameDataProvider() : array - { - return [ - [chr(0)], [chr(1)], [chr(2)], [chr(3)], [chr(4)], [chr(5)], [chr(6)], [chr(7)], [chr(8)], [chr(9)], - [chr(10)], [chr(11)], [chr(12)], [chr(13)], [chr(14)], [chr(15)], [chr(16)], [chr(17)], [chr(18)], - [chr(19)], [chr(20)], [chr(21)], [chr(22)], [chr(23)], [chr(24)], [chr(25)], [chr(26)], [chr(27)], - [chr(28)], [chr(29)], [chr(30)], [chr(31)], [chr(32)], [chr(33)], [chr(34)], [chr(35)], [chr(36)], - [chr(37)], [chr(38)], [chr(39)], [chr(40)], [chr(41)], [chr(42)], [chr(43)], [chr(44)], [chr(45)], - [chr(46)], [chr(47)], [chr(48)], [chr(49)], [chr(50)], [chr(51)], [chr(52)], [chr(53)], [chr(54)], - [chr(55)], [chr(56)], [chr(57)], [chr(58)], [chr(59)], [chr(61)], [chr(63)], [chr(64)], [chr(91)], - [chr(92)], [chr(93)], [chr(94)], [chr(96)], [chr(124)], [chr(126)], [chr(127)], - ]; - } - - /** - * @return array - */ - public function invalidSecondCharForAttributeNameDataProvider() : array - { - return [ - [chr(0)], [chr(1)], [chr(2)], [chr(3)], [chr(4)], [chr(5)], [chr(6)], [chr(7)], [chr(8)], [chr(9)], - [chr(10)], [chr(11)], [chr(12)], [chr(13)], [chr(14)], [chr(15)], [chr(16)], [chr(17)], [chr(18)], - [chr(19)], [chr(20)], [chr(21)], [chr(22)], [chr(23)], [chr(24)], [chr(25)], [chr(26)], [chr(27)], - [chr(28)], [chr(29)], [chr(30)], [chr(31)], [chr(32)], [chr(33)], [chr(34)], [chr(35)], [chr(36)], - [chr(37)], [chr(38)], [chr(39)], [chr(40)], [chr(41)], [chr(42)], [chr(43)], [chr(44)], [chr(45)], - [chr(46)], [chr(47)], [chr(58)], [chr(59)], [chr(61)], [chr(63)], [chr(64)], [chr(91)], [chr(92)], - [chr(93)], [chr(94)], [chr(96)], [chr(124)], [chr(126)], [chr(127)], - ]; - } -} diff --git a/tests/Functions/FunctionPathPlainTest.php b/tests/Functions/FunctionPathPlainTest.php deleted file mode 100644 index 7cd4e862..00000000 --- a/tests/Functions/FunctionPathPlainTest.php +++ /dev/null @@ -1,25 +0,0 @@ -}(/)'; - $expected = '/foo/{bar}/{baz}/'; - - $this->assertSame($expected, path_plain($path)); - } -} diff --git a/tests/Functions/FunctionPathRegexTest.php b/tests/Functions/FunctionPathRegexTest.php deleted file mode 100644 index b47e6dcd..00000000 --- a/tests/Functions/FunctionPathRegexTest.php +++ /dev/null @@ -1,25 +0,0 @@ -}(/)'; - $expected = '#^/foo(?:/(?[^/]+))?/(?\w+)(?:/)?$#uD'; - - $this->assertSame($expected, path_regex($path)); - } -} diff --git a/tests/Helper/RouteParserTest.php b/tests/Helper/RouteParserTest.php new file mode 100644 index 00000000..77473f80 --- /dev/null +++ b/tests/Helper/RouteParserTest.php @@ -0,0 +1,70 @@ +assertEquals($expectedVariables, $actualVariables); + } + + public function validRouteDataProvider(): Generator + { + yield [ + '', + [], + ]; + + yield [ + '/', + [], + ]; + + yield [ + '/posts/{id}', + [ + ['name' => 'id', 'offset' => 7, 'length' => 4], + ], + ]; + + yield [ + '/posts/{id<\d+>}', + [ + ['name' => 'id', 'pattern' => '\d+', 'offset' => 7, 'length' => 9], + ], + ]; + + yield [ + '/posts(/{id<\d+>})', + [ + + ['name' => 'id', 'pattern' => '\d+', 'optional' => ['left' => '/', 'right' => ''], 'offset' => 8, 'length' => 9], + ], + ]; + + yield [ + '(/{lc<[a-z]{2}>})/posts/{id<\d+>}', + [ + ['name' => 'lc', 'pattern' => '[a-z]{2}', 'optional' => ['left' => '/', 'right' => ''], 'offset' => 2, 'length' => 14], + ['name' => 'id', 'pattern' => '\d+', 'offset' => 24, 'length' => 9], + ], + ]; + + yield [ + '/posts(/{id}.json)', + [ + ['name' => 'id', 'optional' => ['left' => '/', 'right' => '.json'], 'offset' => 8, 'length' => 4], + ], + ]; + } +} diff --git a/tests/Loader/ConfigLoaderTest.php b/tests/Loader/ConfigLoaderTest.php deleted file mode 100644 index b3d44c9d..00000000 --- a/tests/Loader/ConfigLoaderTest.php +++ /dev/null @@ -1,123 +0,0 @@ -assertInstanceOf(LoaderInterface::class, $loader); - } - - /** - * @return void - */ - public function testContainer() : void - { - $container = $this->getContainer(); - - $loader = new ConfigLoader(); - $this->assertNull($loader->getContainer()); - - $loader->setContainer($container); - $this->assertSame($container, $loader->getContainer()); - - $loader->setContainer(null); - $this->assertNull($loader->getContainer()); - } - - /** - * @return void - */ - public function testAttachInvalidResource() : void - { - $loader = new ConfigLoader(); - - $this->expectException(InvalidLoaderResourceException::class); - $this->expectExceptionMessage('The resource "undefined" is not found.'); - - $loader->attach('undefined'); - } - - /** - * @return void - */ - public function testAttachArrayWithInvalidResource() : void - { - $loader = new ConfigLoader(); - - $this->expectException(InvalidLoaderResourceException::class); - $this->expectExceptionMessage('The resource "undefined" is not found.'); - - $loader->attachArray(['undefined']); - } - - /** - * @return void - * - * @runInSeparateProcess - */ - public function testLoadFile() : void - { - $loader = new ConfigLoader(); - - $loader->attach(__DIR__ . '/../Fixtures/routes/foo.php'); - - $routes = $loader->load(); - - $this->assertTrue($routes->has('foo')); - } - - /** - * @return void - * - * @runInSeparateProcess - */ - public function testLoadSeveralFiles() : void - { - $loader = new ConfigLoader(); - - $loader->attachArray([ - __DIR__ . '/../Fixtures/routes/foo.php', - __DIR__ . '/../Fixtures/routes/bar.php', - ]); - - $routes = $loader->load(); - - $this->assertTrue($routes->has('foo')); - $this->assertTrue($routes->has('bar')); - } - - /** - * @return void - * - * @runInSeparateProcess - */ - public function testLoadDirectory() : void - { - $loader = new ConfigLoader(); - - $loader->attach(__DIR__ . '/../Fixtures/routes'); - - $routes = $loader->load(); - - $this->assertTrue($routes->has('foo')); - $this->assertTrue($routes->has('bar')); - } -} diff --git a/tests/Loader/DescriptorLoaderTest.php b/tests/Loader/DescriptorLoaderTest.php deleted file mode 100644 index c897210a..00000000 --- a/tests/Loader/DescriptorLoaderTest.php +++ /dev/null @@ -1,350 +0,0 @@ -assertInstanceOf(LoaderInterface::class, $loader); - } - - /** - * @return void - */ - public function testContainer() : void - { - $container = $this->getContainer(); - - $loader = new DescriptorLoader(); - $this->assertNull($loader->getContainer()); - - $loader->setContainer($container); - $this->assertSame($container, $loader->getContainer()); - - $loader->setContainer(null); - $this->assertNull($loader->getContainer()); - } - - /** - * @return void - */ - public function testCache() : void - { - $cache = $this->getCache(); - - $loader = new DescriptorLoader(); - $loader->attach(Fixtures\Controllers\Annotated\CacheableAnnotatedController::class); - - $this->assertNull($loader->getCache()); - $this->assertNull($loader->getCacheKey()); - - $loader->setCache($cache); - $this->assertSame($cache, $loader->getCache()); - - $loader->setCacheKey('foo'); - $this->assertSame('foo', $loader->getCacheKey()); - - $descriptor = new Route('controller-from-cached-descriptor', null, '/'); - $descriptor->holder = Fixtures\Controllers\BlankController::class; - - $cache->storage[$loader->getCacheKey()][0] = $descriptor; - - $routes = $loader->load(); - $this->assertTrue($routes->has($cache->storage[$loader->getCacheKey()][0]->name)); - - $loader->setCache(null); - $this->assertNull($loader->getCache()); - - $loader->setCacheKey(null); - $this->assertNull($loader->getCacheKey()); - } - - /** - * @return void - */ - public function testAttachInvalidResource() : void - { - $loader = new DescriptorLoader(); - - $this->expectException(InvalidLoaderResourceException::class); - $this->expectExceptionMessage('The resource "undefined" is not found.'); - - $loader->attach('undefined'); - } - - /** - * @return void - */ - public function testAttachArrayWithInvalidResource() : void - { - $loader = new DescriptorLoader(); - - $this->expectException(InvalidLoaderResourceException::class); - $this->expectExceptionMessage('The resource "undefined" is not found.'); - - $loader->attachArray(['undefined']); - } - - /** - * @return void - */ - public function testLoadMinimallyAnnotatedClass() : void - { - $class = Fixtures\Controllers\Annotated\MinimallyAnnotatedController::class; - - $loader = new DescriptorLoader(); - $loader->attach($class); - - $routes = $loader->load(); - $this->assertTrue($routes->has('minimally-annotated-controller')); - - $route = $routes->get('minimally-annotated-controller'); - $this->assertSame('minimally-annotated-controller', $route->getName()); - $this->assertSame('/', $route->getPath()); - $this->assertSame(['GET'], $route->getMethods()); - } - - /** - * @return void - */ - public function testLoadMinimallyAttributedClass() : void - { - if (8 > PHP_MAJOR_VERSION) { - $this->markTestSkipped('PHP 8 is required...'); - return; - } - - $class = Fixtures\Controllers\Attributed\MinimallyAttributedController::class; - - $loader = new DescriptorLoader(); - $loader->attach($class); - - $routes = $loader->load(); - $this->assertTrue($routes->has('minimally-attributed-controller')); - - $route = $routes->get('minimally-attributed-controller'); - $this->assertSame('minimally-attributed-controller', $route->getName()); - $this->assertSame('/', $route->getPath()); - $this->assertSame(['GET'], $route->getMethods()); - } - - /** - * @return void - */ - public function testLoadMaximallyAnnotatedClass() : void - { - $loader = new DescriptorLoader(); - $loader->attach(Fixtures\Controllers\Annotated\MaximallyAnnotatedController::class); - - $routes = $loader->load(); - $this->assertTrue($routes->has('maximally-annotated-controller')); - - $route = $routes->get('maximally-annotated-controller'); - $this->assertSame('maximally-annotated-controller', $route->getName()); - $this->assertSame('local', $route->getHost()); - $this->assertSame('/', $route->getPath()); - $this->assertSame(['HEAD', 'GET'], $route->getMethods()); - $this->assertCount(1, $route->getMiddlewares()); - $this->assertInstanceOf(Fixtures\Middlewares\BlankMiddleware::class, $route->getMiddlewares()[0]); - $this->assertSame(['foo' => 'bar'], $route->getAttributes()); - $this->assertSame('Lorem ipsum', $route->getSummary()); - $this->assertSame('Lorem ipsum dolor sit amet', $route->getDescription()); - $this->assertSame(['foo', 'bar'], $route->getTags()); - } - - /** - * @return void - */ - public function testLoadMaximallyAttributedClass() : void - { - if (8 > PHP_MAJOR_VERSION) { - $this->markTestSkipped('PHP 8 is required...'); - return; - } - - $loader = new DescriptorLoader(); - $loader->attach(Fixtures\Controllers\Attributed\MaximallyAttributedController::class); - - $routes = $loader->load(); - $this->assertTrue($routes->has('maximally-attributed-controller')); - - $route = $routes->get('maximally-attributed-controller'); - $this->assertSame('maximally-attributed-controller', $route->getName()); - $this->assertSame('local', $route->getHost()); - $this->assertSame('/', $route->getPath()); - $this->assertSame(['HEAD', 'GET'], $route->getMethods()); - $this->assertCount(1, $route->getMiddlewares()); - $this->assertInstanceOf(Fixtures\Middlewares\BlankMiddleware::class, $route->getMiddlewares()[0]); - $this->assertSame(['foo' => 'bar'], $route->getAttributes()); - $this->assertSame('Lorem ipsum', $route->getSummary()); - $this->assertSame('Lorem ipsum dolor sit amet', $route->getDescription()); - $this->assertSame(['foo', 'bar'], $route->getTags()); - } - - /** - * @return void - */ - public function testLoadGroupedAnnotatedClass() : void - { - $loader = new DescriptorLoader(); - $loader->attach(Fixtures\Controllers\Annotated\GroupedAnnotatedController::class); - - $routes = $loader->load(); - $this->assertTrue($routes->has('first-from-grouped-annotated-controller')); - $this->assertTrue($routes->has('second-from-grouped-annotated-controller')); - $this->assertTrue($routes->has('third-from-grouped-annotated-controller')); - - $route = $routes->get('first-from-grouped-annotated-controller'); - $this->assertSame('host', $route->getHost()); - $this->assertSame('/prefix/first.json', $route->getPath()); - $this->assertSame(['GET'], $route->getMethods()); - $this->assertCount(6, $route->getMiddlewares()); - - $route = $routes->get('second-from-grouped-annotated-controller'); - $this->assertSame('host', $route->getHost()); - $this->assertSame('/prefix/second.json', $route->getPath()); - $this->assertSame(['GET'], $route->getMethods()); - $this->assertCount(6, $route->getMiddlewares()); - - $route = $routes->get('third-from-grouped-annotated-controller'); - $this->assertSame('host', $route->getHost()); - $this->assertSame('/prefix/third.json', $route->getPath()); - $this->assertSame(['GET'], $route->getMethods()); - $this->assertCount(6, $route->getMiddlewares()); - - $this->assertFalse($routes->has('private-from-grouped-annotated-controller')); - $this->assertFalse($routes->has('protected-from-grouped-annotated-controller')); - $this->assertFalse($routes->has('static-from-grouped-annotated-controller')); - } - - /** - * @return void - */ - public function testLoadGroupedAttributedClass() : void - { - if (8 > PHP_MAJOR_VERSION) { - $this->markTestSkipped('PHP 8 is required...'); - return; - } - - $loader = new DescriptorLoader(); - $loader->attach(Fixtures\Controllers\Attributed\GroupedAttributedController::class); - - $routes = $loader->load(); - $this->assertTrue($routes->has('first-from-grouped-attributed-controller')); - $this->assertTrue($routes->has('second-from-grouped-attributed-controller')); - $this->assertTrue($routes->has('third-from-grouped-attributed-controller')); - - $route = $routes->get('first-from-grouped-attributed-controller'); - $this->assertSame('host', $route->getHost()); - $this->assertSame('/prefix/first.json', $route->getPath()); - $this->assertSame(['GET'], $route->getMethods()); - $this->assertCount(6, $route->getMiddlewares()); - - $route = $routes->get('second-from-grouped-attributed-controller'); - $this->assertSame('host', $route->getHost()); - $this->assertSame('/prefix/second.json', $route->getPath()); - $this->assertSame(['GET'], $route->getMethods()); - $this->assertCount(6, $route->getMiddlewares()); - - $route = $routes->get('third-from-grouped-attributed-controller'); - $this->assertSame('host', $route->getHost()); - $this->assertSame('/prefix/third.json', $route->getPath()); - $this->assertSame(['GET'], $route->getMethods()); - $this->assertCount(6, $route->getMiddlewares()); - } - - /** - * @return void - */ - public function testLoadSeveralAnnotatedClasses() : void - { - $loader = new DescriptorLoader(); - $loader->attachArray([ - Fixtures\Controllers\Annotated\MinimallyAnnotatedController::class, - Fixtures\Controllers\Annotated\MaximallyAnnotatedController::class, - ]); - - $routes = $loader->load(); - $this->assertTrue($routes->has('minimally-annotated-controller')); - $this->assertTrue($routes->has('maximally-annotated-controller')); - } - - /** - * @return void - */ - public function testLoadDirectoryWithAnnotatedClasses() : void - { - $loader = new DescriptorLoader(); - $loader->attach(__DIR__ . '/../Fixtures/Controllers/Annotated/Loadable'); - - $routes = $loader->load(); - $this->assertTrue($routes->has('first-loadable-annotated-controller')); - $this->assertTrue($routes->has('second-loadable-annotated-controller')); - } - - /** - * @return void - */ - public function testLoadSortableAnnotatedClasses() : void - { - $loader = new DescriptorLoader(); - $loader->attach(Fixtures\Controllers\Annotated\Sortable\FirstSortableAnnotatedController::class); - $loader->attach(Fixtures\Controllers\Annotated\Sortable\SecondSortableAnnotatedController::class); - $loader->attach(Fixtures\Controllers\Annotated\Sortable\ThirdSortableAnnotatedController::class); - - $routes = $loader->load(); - $this->assertTrue($routes->has('first-sortable-annotated-controller')); - $this->assertTrue($routes->has('second-sortable-annotated-controller')); - $this->assertTrue($routes->has('third-sortable-annotated-controller')); - - $this->assertSame([ - 'third-sortable-annotated-controller', - 'second-sortable-annotated-controller', - 'first-sortable-annotated-controller', - ], array_map(function ($route) { - return $route->getName(); - }, $routes->all())); - } - - /** - * @return void - */ - public function testLoadAbstractAnnotatedClass() : void - { - $loader = new DescriptorLoader(); - $loader->attach(Fixtures\Controllers\Annotated\AbstractAnnotatedController::class); - - $routes = $loader->load(); - $this->assertFalse($routes->has('abstract-annotated-controller')); - } -} diff --git a/tests/Middleware/CallableMiddlewareTest.php b/tests/Middleware/CallableMiddlewareTest.php deleted file mode 100644 index 5f31f972..00000000 --- a/tests/Middleware/CallableMiddlewareTest.php +++ /dev/null @@ -1,44 +0,0 @@ -assertInstanceOf(MiddlewareInterface::class, $middleware); - } - - /** - * @return void - */ - public function testRun() : void - { - $callback = new Fixtures\Middlewares\BlankMiddleware(); - $middleware = new CallbackMiddleware($callback); - - $this->assertSame($callback, $middleware->getCallback()); - - $request = $this->createMock(ServerRequestInterface::class); - $requestHandler = new Fixtures\Controllers\BlankController(); - $middleware->process($request, $requestHandler); - - $this->assertTrue($callback->isRunned()); - } -} diff --git a/tests/Middleware/JsonPayloadDecodingMiddlewareTest.php b/tests/Middleware/JsonPayloadDecodingMiddlewareTest.php deleted file mode 100644 index d3e1e8cc..00000000 --- a/tests/Middleware/JsonPayloadDecodingMiddlewareTest.php +++ /dev/null @@ -1,127 +0,0 @@ -assertInstanceOf(MiddlewareInterface::class, new JsonPayloadDecodingMiddleware()); - } - - /** - * @param string $mediaType - * - * @return void - * - * @dataProvider supportedMediaTypeProvider - */ - public function testProcessWithSupportedMediaType(string $mediaType) : void - { - $request = (new ServerRequestFactory)->createServerRequest('GET', '/') - ->withHeader('Content-Type', $mediaType); - - $request->getBody()->write('{"foo":"bar"}'); - - $handler = new Fixtures\Controllers\BlankController(); - - (new JsonPayloadDecodingMiddleware)->process($request, $handler); - - $this->assertSame(['foo' => 'bar'], $handler->getRequest()->getParsedBody()); - } - - /** - * @param string $mediaType - * - * @return void - * - * @dataProvider unsupportedMediaTypeProvider - */ - public function testProcessWithUnsupportedMediaType(string $mediaType) : void - { - $request = (new ServerRequestFactory)->createServerRequest('GET', '/') - ->withHeader('Content-Type', $mediaType); - - $request->getBody()->write('{"foo":"bar"}'); - - $handler = new Fixtures\Controllers\BlankController(); - - (new JsonPayloadDecodingMiddleware)->process($request, $handler); - - $this->assertNull($handler->getRequest()->getParsedBody()); - } - - /** - * @return void - */ - public function testProcessWithoutMediaType() : void - { - $request = (new ServerRequestFactory)->createServerRequest('GET', '/'); - $request->getBody()->write('{"foo":"bar"}'); - - $handler = new Fixtures\Controllers\BlankController(); - - (new JsonPayloadDecodingMiddleware)->process($request, $handler); - - $this->assertNull($handler->getRequest()->getParsedBody()); - } - - /** - * @return void - */ - public function testProcessWithInvalidPayload() : void - { - $request = (new ServerRequestFactory)->createServerRequest('GET', '/') - ->withHeader('Content-Type', 'application/json'); - - $request->getBody()->write('!'); - - $handler = new Fixtures\Controllers\BlankController(); - - $this->expectException(UndecodablePayloadException::class); - $this->expectExceptionMessage('Invalid Payload: Syntax error'); - - (new JsonPayloadDecodingMiddleware)->process($request, $handler); - } - - /** - * @return list - */ - public function supportedMediaTypeProvider() : array - { - return [ - ['application/json'], - ['application/json; foo=bar'], - ['application/json ; foo=bar'], - ]; - } - - /** - * @return list - */ - public function unsupportedMediaTypeProvider() : array - { - return [ - ['application/jsonx'], - ['application/json+x'], - ['application/jsonx; foo=bar'], - ['application/json+x; foo=bar'], - ['application/jsonx ; foo=bar'], - ['application/json+x ; foo=bar'], - ]; - } -} diff --git a/tests/ReferenceResolverTest.php b/tests/ReferenceResolverTest.php deleted file mode 100644 index 50f9526a..00000000 --- a/tests/ReferenceResolverTest.php +++ /dev/null @@ -1,166 +0,0 @@ -assertInstanceOf(ReferenceResolverInterface::class, $resolver); - } - - /** - * @return void - */ - public function testContainer() : void - { - $container = $this->getContainer([ - Fixtures\Controllers\BlankController::class => new Fixtures\Controllers\BlankController(), - Fixtures\Middlewares\BlankMiddleware::class => new Fixtures\Middlewares\BlankMiddleware(), - ]); - - $resolver = new ReferenceResolver(); - - $resolver->setContainer($container); - $this->assertSame($container, $resolver->getContainer()); - - $reference = Fixtures\Controllers\BlankController::class; - $requestHandler = $resolver->toRequestHandler($reference); - $this->assertSame($container->storage[Fixtures\Controllers\BlankController::class], $requestHandler); - - $reference = [Fixtures\Controllers\BlankController::class, '__invoke']; - $requestHandler = $resolver->toRequestHandler($reference); - $requestHandlerCallback = $requestHandler->getCallback(); - $this->assertSame($container->storage[Fixtures\Controllers\BlankController::class], $requestHandlerCallback[0]); - - $reference = Fixtures\Middlewares\BlankMiddleware::class; - $middleware = $resolver->toMiddleware($reference); - $this->assertSame($container->storage[Fixtures\Middlewares\BlankMiddleware::class], $middleware); - - $reference = [Fixtures\Middlewares\BlankMiddleware::class, '__invoke']; - $middleware = $resolver->toMiddleware($reference); - $middlewareCallback = $middleware->getCallback(); - $this->assertSame($container->storage[Fixtures\Middlewares\BlankMiddleware::class], $middlewareCallback[0]); - } - - /** - * @return void - */ - public function testRequestHandler() : void - { - $resolver = new ReferenceResolver(); - - $reference = new Fixtures\Controllers\BlankController(); - $requestHandler = $resolver->toRequestHandler($reference); - $this->assertSame($reference, $requestHandler); - - $reference = function () { - }; - - $requestHandler = $resolver->toRequestHandler($reference); - $this->assertSame($reference, $requestHandler->getCallback()); - - $reference = Fixtures\Controllers\BlankController::class; - $requestHandler = $resolver->toRequestHandler($reference); - $this->assertInstanceOf($reference, $requestHandler); - - $reference = [Fixtures\Controllers\BlankController::class, '__invoke']; - $requestHandler = $resolver->toRequestHandler($reference); - $this->assertInstanceOf($reference[0], $requestHandler->getCallback()[0]); - $this->assertSame($reference[1], $requestHandler->getCallback()[1]); - } - - /** - * @return void - */ - public function testMiddleware() : void - { - $resolver = new ReferenceResolver(); - - $reference = new Fixtures\Middlewares\BlankMiddleware(); - $requestHandler = $resolver->toMiddleware($reference); - $this->assertSame($reference, $requestHandler); - - $reference = function () { - }; - - $requestHandler = $resolver->toMiddleware($reference); - $this->assertSame($reference, $requestHandler->getCallback()); - - $reference = Fixtures\Middlewares\BlankMiddleware::class; - $requestHandler = $resolver->toMiddleware($reference); - $this->assertInstanceOf($reference, $requestHandler); - - $reference = [Fixtures\Middlewares\BlankMiddleware::class, '__invoke']; - $requestHandler = $resolver->toMiddleware($reference); - $this->assertInstanceOf($reference[0], $requestHandler->getCallback()[0]); - $this->assertSame($reference[1], $requestHandler->getCallback()[1]); - } - - /** - * @param mixed $reference - * - * @return void - * - * @dataProvider unresolvableRequestHandlerReferenceDataProvider - */ - public function testUnresolvableRequestHandler($reference) : void - { - $resolver = new ReferenceResolver(); - $this->expectException(UnresolvableReferenceException::class); - $resolver->toRequestHandler($reference); - } - - /** - * @param mixed $reference - * - * @return void - * - * @dataProvider unresolvableMiddlewareReferenceDataProvider - */ - public function testUnresolvableMiddleware($reference) : void - { - $resolver = new ReferenceResolver(); - $this->expectException(UnresolvableReferenceException::class); - $resolver->toMiddleware($reference); - } - - /** - * @return array - */ - public function unresolvableRequestHandlerReferenceDataProvider() : array - { - return [ - [['unknownClass', 'unknownMethod']], - ['unknownClass'], - [null], - ]; - } - - /** - * @return array - */ - public function unresolvableMiddlewareReferenceDataProvider() : array - { - return [ - [['unknownClass', 'unknownMethod']], - ['unknownClass'], - [null], - ]; - } -} diff --git a/tests/RequestHandler/CallableRequestHandlerTest.php b/tests/RequestHandler/CallableRequestHandlerTest.php deleted file mode 100644 index 9cbdba6f..00000000 --- a/tests/RequestHandler/CallableRequestHandlerTest.php +++ /dev/null @@ -1,43 +0,0 @@ -assertInstanceOf(RequestHandlerInterface::class, $requestHandler); - } - - /** - * @return void - */ - public function testRun() : void - { - $callback = new Fixtures\Controllers\BlankController(); - $requestHandler = new CallbackRequestHandler($callback); - - $this->assertSame($callback, $requestHandler->getCallback()); - - $request = $this->createMock(ServerRequestInterface::class); - $requestHandler->handle($request); - - $this->assertTrue($callback->isRunned()); - } -} diff --git a/tests/RequestHandler/QueueableRequestHandlerTest.php b/tests/RequestHandler/QueueableRequestHandlerTest.php deleted file mode 100644 index dddfbcb4..00000000 --- a/tests/RequestHandler/QueueableRequestHandlerTest.php +++ /dev/null @@ -1,89 +0,0 @@ -assertInstanceOf(RequestHandlerInterface::class, $requestHandler); - } - - /** - * @return void - */ - public function testRun() : void - { - $endpoint = new Fixtures\Controllers\BlankController(); - $requestHandler = new QueueableRequestHandler($endpoint); - - $request = $this->createMock(ServerRequestInterface::class); - $requestHandler->handle($request); - - $this->assertTrue($endpoint->isRunned()); - } - - /** - * @return void - */ - public function testRunWithMiddlewares() : void - { - $middlewares = [ - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - ]; - - $endpoint = new Fixtures\Controllers\BlankController(); - $requestHandler = new QueueableRequestHandler($endpoint); - $requestHandler->add(...$middlewares); - - $request = $this->createMock(ServerRequestInterface::class); - $requestHandler->handle($request); - - $this->assertTrue($middlewares[0]->isRunned()); - $this->assertTrue($middlewares[1]->isRunned()); - $this->assertTrue($middlewares[2]->isRunned()); - $this->assertTrue($endpoint->isRunned()); - } - - /** - * @return void - */ - public function testRunWithBrokenMiddleware() : void - { - $middlewares = [ - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(true), - new Fixtures\Middlewares\BlankMiddleware(), - ]; - - $endpoint = new Fixtures\Controllers\BlankController(); - $requestHandler = new QueueableRequestHandler($endpoint); - $requestHandler->add(...$middlewares); - - $request = $this->createMock(ServerRequestInterface::class); - $requestHandler->handle($request); - - $this->assertTrue($middlewares[0]->isRunned()); - $this->assertTrue($middlewares[1]->isRunned()); - $this->assertFalse($middlewares[2]->isRunned()); - $this->assertFalse($endpoint->isRunned()); - } -} diff --git a/tests/RouteCollectionFactoryTest.php b/tests/RouteCollectionFactoryTest.php deleted file mode 100644 index f64349df..00000000 --- a/tests/RouteCollectionFactoryTest.php +++ /dev/null @@ -1,51 +0,0 @@ -assertInstanceOf(RouteCollectionFactoryInterface::class, $factory); - } - - /** - * @return void - */ - public function testCreateCollection() : void - { - $collection = (new RouteCollectionFactory)->createCollection(); - - $this->assertInstanceOf(RouteCollectionInterface::class, $collection); - } - - /** - * @return void - */ - public function testCreateCollectionWithRoutes() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $collection = (new RouteCollectionFactory)->createCollection(...$routes); - - $this->assertSame($routes, $collection->all()); - } -} diff --git a/tests/RouteCollectionTest.php b/tests/RouteCollectionTest.php deleted file mode 100644 index aa45725b..00000000 --- a/tests/RouteCollectionTest.php +++ /dev/null @@ -1,327 +0,0 @@ -assertInstanceOf(RouteCollectionInterface::class, $collection); - } - - /** - * @return void - */ - public function testConstructor() : void - { - $collection = new RouteCollection(); - - $this->assertSame([], $collection->all()); - } - - /** - * @return void - */ - public function testConstructorWithRoutes() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $collection = new RouteCollection(...$routes); - - $this->assertSame($routes, $collection->all()); - } - - /** - * @return void - */ - public function testAdd() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $collection = new RouteCollection(); - $collection->add(...$routes); - - $this->assertSame($routes, $collection->all()); - } - - /** - * @return void - */ - public function testGet() : void - { - $route = new Fixtures\Route(); - $collection = new RouteCollection(); - - $this->assertNull($collection->get($route->getName())); - - $collection->add($route); - - $this->assertSame($route, $collection->get($route->getName())); - } - - /** - * @return void - */ - public function testHas() : void - { - $route = new Fixtures\Route(); - $collection = new RouteCollection(); - - $this->assertFalse($collection->has($route->getName())); - - $collection->add($route); - - $this->assertTrue($collection->has($route->getName())); - } - - /** - * @return void - */ - public function testSetHost() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $collection = new RouteCollection(...$routes); - $collection->setHost('google.com'); - - $this->assertSame('google.com', $routes[0]->getHost()); - $this->assertSame('google.com', $routes[1]->getHost()); - $this->assertSame('google.com', $routes[2]->getHost()); - } - - /** - * @return void - */ - public function testAddPrefix() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $routes[0]->setPath('/foo'); - $routes[1]->setPath('/bar'); - $routes[2]->setPath('/baz'); - - $collection = new RouteCollection(...$routes); - $collection->addPrefix('/api'); - - $this->assertSame('/api/foo', $routes[0]->getPath()); - $this->assertSame('/api/bar', $routes[1]->getPath()); - $this->assertSame('/api/baz', $routes[2]->getPath()); - } - - /** - * @return void - */ - public function testAddSuffix() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $routes[0]->setPath('/foo'); - $routes[1]->setPath('/bar'); - $routes[2]->setPath('/baz'); - - $collection = new RouteCollection(...$routes); - $collection->addSuffix('.json'); - - $this->assertSame('/foo.json', $routes[0]->getPath()); - $this->assertSame('/bar.json', $routes[1]->getPath()); - $this->assertSame('/baz.json', $routes[2]->getPath()); - } - - /** - * @return void - */ - public function testAddMethod() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $routes[0]->setMethods('FOO'); - $routes[1]->setMethods('BAR'); - $routes[2]->setMethods('BAZ'); - - $collection = new RouteCollection(...$routes); - $collection->addMethod('QUX', 'QUUX'); - - $this->assertSame(['FOO', 'QUX', 'QUUX'], $routes[0]->getMethods()); - $this->assertSame(['BAR', 'QUX', 'QUUX'], $routes[1]->getMethods()); - $this->assertSame(['BAZ', 'QUX', 'QUUX'], $routes[2]->getMethods()); - } - - /** - * @return void - */ - public function testAddMiddleware() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $middlewares = [ - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - ]; - - $additionals = [ - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - ]; - - $routes[0]->setMiddlewares(...$middlewares); - $routes[1]->setMiddlewares(...$middlewares); - $routes[2]->setMiddlewares(...$middlewares); - - $collection = new RouteCollection(...$routes); - $collection->addMiddleware(...$additionals); - - $this->assertSame(array_merge($middlewares, $additionals), $routes[0]->getMiddlewares()); - $this->assertSame(array_merge($middlewares, $additionals), $routes[1]->getMiddlewares()); - $this->assertSame(array_merge($middlewares, $additionals), $routes[2]->getMiddlewares()); - } - - /** - * @return void - */ - public function testAppendMiddleware() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $middlewares = [ - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - ]; - - $additionals = [ - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - ]; - - $routes[0]->setMiddlewares(...$middlewares); - $routes[1]->setMiddlewares(...$middlewares); - $routes[2]->setMiddlewares(...$middlewares); - - $collection = new RouteCollection(...$routes); - $collection->appendMiddleware(...$additionals); - - $this->assertSame(array_merge($middlewares, $additionals), $routes[0]->getMiddlewares()); - $this->assertSame(array_merge($middlewares, $additionals), $routes[1]->getMiddlewares()); - $this->assertSame(array_merge($middlewares, $additionals), $routes[2]->getMiddlewares()); - } - - /** - * @return void - */ - public function testPrependMiddleware() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $middlewares = [ - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - ]; - - $additionals = [ - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - ]; - - $routes[0]->setMiddlewares(...$middlewares); - $routes[1]->setMiddlewares(...$middlewares); - $routes[2]->setMiddlewares(...$middlewares); - - $collection = new RouteCollection(...$routes); - $collection->prependMiddleware(...$additionals); - - $this->assertSame(array_merge($additionals, $middlewares), $routes[0]->getMiddlewares()); - $this->assertSame(array_merge($additionals, $middlewares), $routes[1]->getMiddlewares()); - $this->assertSame(array_merge($additionals, $middlewares), $routes[2]->getMiddlewares()); - } - - /** - * @return void - */ - public function testUnshiftMiddleware() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $middlewares = [ - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - ]; - - $additionals = [ - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - ]; - - $routes[0]->setMiddlewares(...$middlewares); - $routes[1]->setMiddlewares(...$middlewares); - $routes[2]->setMiddlewares(...$middlewares); - - $collection = new RouteCollection(...$routes); - $collection->unshiftMiddleware(...$additionals); - - $this->assertSame(array_merge($additionals, $middlewares), $routes[0]->getMiddlewares()); - $this->assertSame(array_merge($additionals, $middlewares), $routes[1]->getMiddlewares()); - $this->assertSame(array_merge($additionals, $middlewares), $routes[2]->getMiddlewares()); - } -} diff --git a/tests/RouteCollectorTest.php b/tests/RouteCollectorTest.php deleted file mode 100644 index a559e654..00000000 --- a/tests/RouteCollectorTest.php +++ /dev/null @@ -1,350 +0,0 @@ -getContainer(); - - $collector = new RouteCollector(); - $this->assertNull($collector->getContainer()); - - $collector->setContainer($container); - $this->assertSame($container, $collector->getContainer()); - - $collector->setContainer(null); - $this->assertNull($collector->getContainer()); - } - - /** - * @return void - */ - public function testCreateRoute() : void - { - $name = 'foo'; - $path = '/foo'; - $methods = ['GET', 'POST']; - $handler = new Fixtures\Controllers\BlankController(); - $middlewares = []; - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $attributes = []; - $attributes['foo'] = 'bar'; - - $collector = new RouteCollector(); - - $route = $collector->route( - $name, - $path, - $methods, - $handler, - $middlewares, - $attributes - ); - - $this->assertInstanceOf(RouteInterface::class, $route); - $this->assertSame($name, $route->getName()); - $this->assertSame($path, $route->getPath()); - $this->assertSame($methods, $route->getMethods()); - $this->assertSame($handler, $route->getRequestHandler()); - $this->assertSame($middlewares, $route->getMiddlewares()); - $this->assertSame($attributes, $route->getAttributes()); - $this->assertTrue($collector->getRoutes()->has($route->getName())); - $this->assertSame($route, $collector->getRoutes()->get($route->getName())); - } - - /** - * @return void - */ - public function testCreateHeadRoute() : void - { - $name = 'foo'; - $path = '/foo'; - $handler = new Fixtures\Controllers\BlankController(); - $middlewares = []; - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $attributes = []; - $attributes['foo'] = 'bar'; - - $collector = new RouteCollector(); - - $route = $collector->head( - $name, - $path, - $handler, - $middlewares, - $attributes - ); - - $this->assertInstanceOf(RouteInterface::class, $route); - $this->assertSame($name, $route->getName()); - $this->assertSame($path, $route->getPath()); - $this->assertSame([Router::METHOD_HEAD], $route->getMethods()); - $this->assertSame($handler, $route->getRequestHandler()); - $this->assertSame($middlewares, $route->getMiddlewares()); - $this->assertSame($attributes, $route->getAttributes()); - $this->assertTrue($collector->getRoutes()->has($route->getName())); - $this->assertSame($route, $collector->getRoutes()->get($route->getName())); - } - - /** - * @return void - */ - public function testCreateGetRoute() : void - { - $name = 'foo'; - $path = '/foo'; - $handler = new Fixtures\Controllers\BlankController(); - $middlewares = []; - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $attributes = []; - $attributes['foo'] = 'bar'; - - $collector = new RouteCollector(); - - $route = $collector->get( - $name, - $path, - $handler, - $middlewares, - $attributes - ); - - $this->assertInstanceOf(RouteInterface::class, $route); - $this->assertSame($name, $route->getName()); - $this->assertSame($path, $route->getPath()); - $this->assertSame([Router::METHOD_GET], $route->getMethods()); - $this->assertSame($handler, $route->getRequestHandler()); - $this->assertSame($middlewares, $route->getMiddlewares()); - $this->assertSame($attributes, $route->getAttributes()); - $this->assertTrue($collector->getRoutes()->has($route->getName())); - $this->assertSame($route, $collector->getRoutes()->get($route->getName())); - } - - /** - * @return void - */ - public function testCreatePostRoute() : void - { - $name = 'foo'; - $path = '/foo'; - $handler = new Fixtures\Controllers\BlankController(); - $middlewares = []; - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $attributes = []; - $attributes['foo'] = 'bar'; - - $collector = new RouteCollector(); - - $route = $collector->post( - $name, - $path, - $handler, - $middlewares, - $attributes - ); - - $this->assertInstanceOf(RouteInterface::class, $route); - $this->assertSame($name, $route->getName()); - $this->assertSame($path, $route->getPath()); - $this->assertSame([Router::METHOD_POST], $route->getMethods()); - $this->assertSame($handler, $route->getRequestHandler()); - $this->assertSame($middlewares, $route->getMiddlewares()); - $this->assertSame($attributes, $route->getAttributes()); - $this->assertTrue($collector->getRoutes()->has($route->getName())); - $this->assertSame($route, $collector->getRoutes()->get($route->getName())); - } - - /** - * @return void - */ - public function testCreatePutRoute() : void - { - $name = 'foo'; - $path = '/foo'; - $handler = new Fixtures\Controllers\BlankController(); - $middlewares = []; - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $attributes = []; - $attributes['foo'] = 'bar'; - - $collector = new RouteCollector(); - - $route = $collector->put( - $name, - $path, - $handler, - $middlewares, - $attributes - ); - - $this->assertInstanceOf(RouteInterface::class, $route); - $this->assertSame($name, $route->getName()); - $this->assertSame($path, $route->getPath()); - $this->assertSame([Router::METHOD_PUT], $route->getMethods()); - $this->assertSame($handler, $route->getRequestHandler()); - $this->assertSame($middlewares, $route->getMiddlewares()); - $this->assertSame($attributes, $route->getAttributes()); - $this->assertTrue($collector->getRoutes()->has($route->getName())); - $this->assertSame($route, $collector->getRoutes()->get($route->getName())); - } - - /** - * @return void - */ - public function testCreatePatchRoute() : void - { - $name = 'foo'; - $path = '/foo'; - $handler = new Fixtures\Controllers\BlankController(); - $middlewares = []; - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $attributes = []; - $attributes['foo'] = 'bar'; - - $collector = new RouteCollector(); - - $route = $collector->patch( - $name, - $path, - $handler, - $middlewares, - $attributes - ); - - $this->assertInstanceOf(RouteInterface::class, $route); - $this->assertSame($name, $route->getName()); - $this->assertSame($path, $route->getPath()); - $this->assertSame([Router::METHOD_PATCH], $route->getMethods()); - $this->assertSame($handler, $route->getRequestHandler()); - $this->assertSame($middlewares, $route->getMiddlewares()); - $this->assertSame($attributes, $route->getAttributes()); - $this->assertTrue($collector->getRoutes()->has($route->getName())); - $this->assertSame($route, $collector->getRoutes()->get($route->getName())); - } - - /** - * @return void - */ - public function testCreateDeleteRoute() : void - { - $name = 'foo'; - $path = '/foo'; - $handler = new Fixtures\Controllers\BlankController(); - $middlewares = []; - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $attributes = []; - $attributes['foo'] = 'bar'; - - $collector = new RouteCollector(); - - $route = $collector->delete( - $name, - $path, - $handler, - $middlewares, - $attributes - ); - - $this->assertInstanceOf(RouteInterface::class, $route); - $this->assertSame($name, $route->getName()); - $this->assertSame($path, $route->getPath()); - $this->assertSame([Router::METHOD_DELETE], $route->getMethods()); - $this->assertSame($handler, $route->getRequestHandler()); - $this->assertSame($middlewares, $route->getMiddlewares()); - $this->assertSame($attributes, $route->getAttributes()); - $this->assertTrue($collector->getRoutes()->has($route->getName())); - $this->assertSame($route, $collector->getRoutes()->get($route->getName())); - } - - /** - * @return void - */ - public function testCreatePurgeRoute() : void - { - $name = 'foo'; - $path = '/foo'; - $handler = new Fixtures\Controllers\BlankController(); - $middlewares = []; - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $attributes = []; - $attributes['foo'] = 'bar'; - - $collector = new RouteCollector(); - - $route = $collector->purge( - $name, - $path, - $handler, - $middlewares, - $attributes - ); - - $this->assertInstanceOf(RouteInterface::class, $route); - $this->assertSame($name, $route->getName()); - $this->assertSame($path, $route->getPath()); - $this->assertSame([Router::METHOD_PURGE], $route->getMethods()); - $this->assertSame($handler, $route->getRequestHandler()); - $this->assertSame($middlewares, $route->getMiddlewares()); - $this->assertSame($attributes, $route->getAttributes()); - $this->assertTrue($collector->getRoutes()->has($route->getName())); - $this->assertSame($route, $collector->getRoutes()->get($route->getName())); - } - - /** - * @return void - */ - public function testGrouping() : void - { - $collector = new RouteCollector(); - - $middlewares = []; - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - - $groupCollection = $collector->group(function ($group) use ($middlewares) { - $this->assertInstanceOf(RouteCollector::class, $group); - - $group->get('foo', '/foo', new Fixtures\Controllers\BlankController()); - - $group->group(function ($subgroup) { - $subgroup->get('bar', '/bar', new Fixtures\Controllers\BlankController()); - - $subgroup->group(function ($deepgroup) { - $deepgroup->get('baz', '/baz', new Fixtures\Controllers\BlankController()); - }); - }, $middlewares); - }); - - $this->assertInstanceOf(RouteCollectionInterface::class, $groupCollection); - $this->assertTrue($collector->getRoutes()->has('foo')); - $this->assertSame([], $collector->getRoutes()->get('foo')->getMiddlewares()); - $this->assertTrue($collector->getRoutes()->has('bar')); - $this->assertSame($middlewares, $collector->getRoutes()->get('bar')->getMiddlewares()); - $this->assertTrue($collector->getRoutes()->has('baz')); - $this->assertSame($middlewares, $collector->getRoutes()->get('baz')->getMiddlewares()); - } -} diff --git a/tests/RouteFactoryTest.php b/tests/RouteFactoryTest.php deleted file mode 100644 index 48730cff..00000000 --- a/tests/RouteFactoryTest.php +++ /dev/null @@ -1,58 +0,0 @@ -assertInstanceOf(RouteFactoryInterface::class, $factory); - } - - /** - * @return void - */ - public function testCreateRoute() : void - { - $name = 'foo'; - $path = '/foo'; - $methods = ['GET', 'POST']; - $handler = new Fixtures\Controllers\BlankController(); - $middlewares = []; - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $attributes = ['foo' => 'bar']; - - $route = (new RouteFactory)->createRoute( - $name, - $path, - $methods, - $handler, - $middlewares, - $attributes - ); - - $this->assertInstanceOf(RouteInterface::class, $route); - $this->assertSame($name, $route->getName()); - $this->assertSame($path, $route->getPath()); - $this->assertSame($methods, $route->getMethods()); - $this->assertSame($handler, $route->getRequestHandler()); - $this->assertSame($middlewares, $route->getMiddlewares()); - $this->assertSame($attributes, $route->getAttributes()); - } -} diff --git a/tests/RouteTest.php b/tests/RouteTest.php deleted file mode 100644 index 20fe0a05..00000000 --- a/tests/RouteTest.php +++ /dev/null @@ -1,408 +0,0 @@ - 'bar']; - - $route = new Route( - $name, - $path, - $methods, - $handler, - $middlewares, - $attributes - ); - - $this->assertInstanceOf(RouteInterface::class, $route); - $this->assertSame($name, $route->getName()); - $this->assertSame($path, $route->getPath()); - $this->assertSame($methods, $route->getMethods()); - $this->assertSame($handler, $route->getRequestHandler()); - $this->assertSame($middlewares, $route->getMiddlewares()); - $this->assertSame($attributes, $route->getAttributes()); - } - - /** - * @return void - */ - public function testSetName() : void - { - $route = new Fixtures\Route(); - $name = 'foo'; - $this->assertNotSame($route->getName(), $name); - $this->assertSame($route, $route->setName($name)); - $this->assertSame($name, $route->getName()); - } - - /** - * @return void - */ - public function testSetHost() : void - { - $route = new Fixtures\Route(); - $host = 'localhost'; - $this->assertNull($route->getHost()); - $this->assertSame($route, $route->setHost($host)); - $this->assertSame($host, $route->getHost()); - } - - /** - * @return void - */ - public function testSetPath() : void - { - $route = new Fixtures\Route(); - $path = '/foo'; - $this->assertNotSame($route->getPath(), $path); - $this->assertSame($route, $route->setPath($path)); - $this->assertSame($path, $route->getPath()); - } - - /** - * @return void - */ - public function testSetMethods() : void - { - $route = new Fixtures\Route(); - $methods = ['GET', 'POST']; - $this->assertNotSame($route->getMethods(), $methods); - $this->assertSame($route, $route->setMethods(...$methods)); - $this->assertSame($methods, $route->getMethods()); - } - - /** - * @return void - */ - public function testSetRequestHandler() : void - { - $route = new Fixtures\Route(); - $handler = new Fixtures\Controllers\BlankController(); - $this->assertNotSame($route->getRequestHandler(), $handler); - $this->assertSame($route, $route->setRequestHandler($handler)); - $this->assertSame($handler, $route->getRequestHandler()); - } - - /** - * @return void - */ - public function testSetMiddlewares() : void - { - $route = new Fixtures\Route(); - $middlewares = []; - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $this->assertNotSame($route->getMiddlewares(), $middlewares); - $this->assertSame($route, $route->setMiddlewares(...$middlewares)); - $this->assertSame($middlewares, $route->getMiddlewares()); - } - - /** - * @return void - */ - public function testSetAttributes() : void - { - $route = new Fixtures\Route(); - $attributes = ['foo' => 'bar']; - $this->assertSame([], $route->getAttributes()); - $this->assertSame($route, $route->setAttributes($attributes)); - $this->assertSame($attributes, $route->getAttributes()); - } - - /** - * @return void - */ - public function testSetSummary() : void - { - $route = new Fixtures\Route(); - $summary = 'foo bar'; - $this->assertSame('', $route->getSummary()); - $this->assertSame($route, $route->setSummary($summary)); - $this->assertSame($summary, $route->getSummary()); - } - - /** - * @return void - */ - public function testSetDescription() : void - { - $route = new Fixtures\Route(); - $description = 'foo bar'; - $this->assertSame('', $route->getDescription()); - $this->assertSame($route, $route->setDescription($description)); - $this->assertSame($description, $route->getDescription()); - } - - /** - * @return void - */ - public function testSetTags() : void - { - $route = new Fixtures\Route(); - $tags = ['foo', 'bar']; - $this->assertSame([], $route->getTags()); - $this->assertSame($route, $route->setTags(...$tags)); - $this->assertSame($tags, $route->getTags()); - } - - /** - * @return void - */ - public function testAddPrefix() : void - { - $route = new Fixtures\Route(); - $route->setPath('/bar'); - $prefix = '/foo'; - $expected = $prefix . $route->getPath(); - $this->assertSame($route, $route->addPrefix($prefix)); - $this->assertSame($expected, $route->getPath()); - } - - /** - * @return void - */ - public function testAddSuffix() : void - { - $route = new Fixtures\Route(); - $route->setPath('/foo'); - $suffix = '.bar'; - $expected = $route->getPath() . $suffix; - $this->assertSame($route, $route->addSuffix($suffix)); - $this->assertSame($expected, $route->getPath()); - } - - /** - * @return void - */ - public function testAddMethod() : void - { - $route = new Fixtures\Route(); - $route->setMethods('FOO'); - $methods = ['BAR', 'BAZ']; - $expected = array_merge($route->getMethods(), $methods); - $this->assertSame($route, $route->addMethod(...$methods)); - $this->assertSame($expected, $route->getMethods()); - } - - /** - * @return void - */ - public function testAddMiddleware() : void - { - $route = new Fixtures\Route(); - $route->setMiddlewares(new Fixtures\Middlewares\BlankMiddleware()); - $middlewares = []; - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $expected = array_merge($route->getMiddlewares(), $middlewares); - $this->assertSame($route, $route->addMiddleware(...$middlewares)); - $this->assertSame($expected, $route->getMiddlewares()); - } - - /** - * @return void - */ - public function testWithAddedAttributes() : void - { - $route = new Fixtures\Route(); - $route->setAttributes(['foo' => 'bar']); - $attributes = ['bar' => 'baz']; - $expected = $route->getAttributes() + $attributes; - $clone = $route->withAddedAttributes($attributes); - $this->assertNotSame($expected, $route->getAttributes()); - $this->assertInstanceOf(RouteInterface::class, $clone); - $this->assertSame($expected, $clone->getAttributes()); - $this->assertNotSame($route, $clone); - } - - /** - * @return void - */ - public function testAddSlashEndingPrefix() : void - { - $route = new Fixtures\Route(); - $route->setPath('/bar'); - $route->addPrefix('/foo/'); - $this->assertSame('/foo/bar', $route->getPath()); - } - - /** - * @return void - */ - public function testSetLowercasedMethods() : void - { - $route = new Fixtures\Route(); - $route->setMethods('foo', 'bar'); - $this->assertSame(['FOO', 'BAR'], $route->getMethods()); - } - - /** - * @return void - */ - public function testAddLowercasedMethod() : void - { - $route = new Fixtures\Route(); - $route->setMethods(...[]); // clear previous methods... - $route->addMethod('foo', 'bar'); - $this->assertSame(['FOO', 'BAR'], $route->getMethods()); - } - - /** - * @return void - */ - public function testRun() : void - { - $route = new Fixtures\Route(); - $route->handle((new ServerRequestFactory)->createServerRequest('GET', '/')); - - $this->assertTrue($route->getRequestHandler()->isRunned()); - - $this->assertSame([ - Route::ATTR_NAME_FOR_ROUTE => $route, - Route::ATTR_NAME_FOR_ROUTE_NAME => $route->getName(), - ], $route->getRequestHandler()->getRequest()->getAttributes()); - } - - /** - * @return void - */ - public function testRunWithAttributes() : void - { - $route = new Fixtures\Route(); - $route->setAttributes(['foo' => 'bar']); - $route->handle((new ServerRequestFactory)->createServerRequest('GET', '/')); - - $this->assertTrue($route->getRequestHandler()->isRunned()); - - $this->assertSame([ - Route::ATTR_NAME_FOR_ROUTE => $route, - Route::ATTR_NAME_FOR_ROUTE_NAME => $route->getName(), - ] + $route->getAttributes(), $route->getRequestHandler()->getRequest()->getAttributes()); - } - - /** - * @return void - */ - public function testRunWithMiddlewares() : void - { - $route = new Fixtures\Route(); - $route->addMiddleware(new Fixtures\Middlewares\BlankMiddleware()); - $route->addMiddleware(new Fixtures\Middlewares\BlankMiddleware()); - $route->addMiddleware(new Fixtures\Middlewares\BlankMiddleware()); - $route->handle((new ServerRequestFactory)->createServerRequest('GET', '/')); - - $this->assertTrue($route->getMiddlewares()[0]->isRunned()); - $this->assertTrue($route->getMiddlewares()[1]->isRunned()); - $this->assertTrue($route->getMiddlewares()[2]->isRunned()); - $this->assertTrue($route->getRequestHandler()->isRunned()); - - $attributes = [ - Route::ATTR_NAME_FOR_ROUTE => $route, - Route::ATTR_NAME_FOR_ROUTE_NAME => $route->getName(), - ]; - - $this->assertSame($attributes, $route->getMiddlewares()[0]->getRequest()->getAttributes()); - $this->assertSame($attributes, $route->getMiddlewares()[1]->getRequest()->getAttributes()); - $this->assertSame($attributes, $route->getMiddlewares()[2]->getRequest()->getAttributes()); - $this->assertSame($attributes, $route->getRequestHandler()->getRequest()->getAttributes()); - } - - /** - * @return void - */ - public function testRunWithBrokenMiddleware() : void - { - $route = new Fixtures\Route(); - $route->addMiddleware(new Fixtures\Middlewares\BlankMiddleware()); - $route->addMiddleware(new Fixtures\Middlewares\BlankMiddleware(true)); - $route->addMiddleware(new Fixtures\Middlewares\BlankMiddleware()); - $route->handle((new ServerRequestFactory)->createServerRequest('GET', '/')); - - $this->assertTrue($route->getMiddlewares()[0]->isRunned()); - $this->assertTrue($route->getMiddlewares()[1]->isRunned()); - $this->assertFalse($route->getMiddlewares()[2]->isRunned()); - $this->assertFalse($route->getRequestHandler()->isRunned()); - - $attributes = [ - Route::ATTR_NAME_FOR_ROUTE => $route, - Route::ATTR_NAME_FOR_ROUTE_NAME => $route->getName(), - ]; - - $this->assertSame($attributes, $route->getMiddlewares()[0]->getRequest()->getAttributes()); - $this->assertSame($attributes, $route->getMiddlewares()[1]->getRequest()->getAttributes()); - $this->assertNull($route->getMiddlewares()[2]->getRequest()); - $this->assertNull($route->getRequestHandler()->getRequest()); - } - - /** - * @return void - */ - public function testGetClassHolder() : void - { - $class = new Fixtures\Controllers\BlankController(); - - $route = new Route('foo', '/foo', [], $class); - $holder = $route->getHolder(); - - $this->assertInstanceOf(\ReflectionClass::class, $holder); - $this->assertSame(\get_class($class), $holder->getName()); - } - - /** - * @return void - */ - public function testGetClosureHolder() : void - { - $callback = function () { - }; - - $route = new Route('foo', '/foo', [], new CallbackRequestHandler($callback)); - $holder = $route->getHolder(); - - $this->assertInstanceOf(\ReflectionFunction::class, $holder); - $this->assertSame($callback, $holder->getClosure()); - } - - /** - * @return void - */ - public function testGetMethodHolder() : void - { - $class = new Fixtures\Controllers\BlankController(); - $method = '__invoke'; - - $route = new Route('foo', '/foo', [], new CallbackRequestHandler([$class, $method])); - $holder = $route->getHolder(); - - $this->assertInstanceOf(\ReflectionMethod::class, $holder); - $this->assertSame(\get_class($class), $holder->getDeclaringClass()->getName()); - $this->assertSame($method, $holder->getName()); - } -} diff --git a/tests/RouterBuilderTest.php b/tests/RouterBuilderTest.php deleted file mode 100644 index ef46f86e..00000000 --- a/tests/RouterBuilderTest.php +++ /dev/null @@ -1,75 +0,0 @@ -getContainer(); - $cache = $this->getCache(); - - $middlewares = []; - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - $middlewares[] = new Fixtures\Middlewares\BlankMiddleware(); - - $patterns = []; - $patterns['foo'] = 'bar'; - $patterns['bar'] = 'baz'; - - $hosts = []; - $hosts['foo'] = ['foo.net']; - $hosts['bar'] = ['bar.net']; - $hosts['baz'] = ['baz.net']; - - $builder = (new RouterBuilder) - ->setEventDispatcher($eventDispatcher) - ->setContainer($container) - ->setCache($cache) - ->setCacheKey('foo') - ->useConfigLoader([ - __DIR__ . '/Fixtures/routes/foo.php', - __DIR__ . '/Fixtures/routes/bar.php', - ]) - ->useMetadataLoader([ - Fixtures\Controllers\Annotated\MinimallyAnnotatedController::class, - Fixtures\Controllers\Annotated\MaximallyAnnotatedController::class, - ]) - ->setPatterns($patterns) - ->setHosts($hosts) - ->setMiddlewares($middlewares); - - Router::$patterns = []; - - $router = $builder->build(); - - $this->assertInstanceOf(Router::class, $router); - $this->assertSame($patterns, Router::$patterns); - $this->assertSame($hosts, $router->getHosts()); - $this->assertSame($middlewares, $router->getMiddlewares()); - $this->assertSame($eventDispatcher, $router->getEventDispatcher()); - $this->assertTrue($router->hasRoute('foo')); - $this->assertTrue($router->hasRoute('bar')); - $this->assertTrue($router->hasRoute('minimally-annotated-controller')); - $this->assertTrue($router->hasRoute('maximally-annotated-controller')); - } -} diff --git a/tests/RouterTest.php b/tests/RouterTest.php deleted file mode 100644 index 81be7102..00000000 --- a/tests/RouterTest.php +++ /dev/null @@ -1,961 +0,0 @@ -assertInstanceOf(MiddlewareInterface::class, $router); - $this->assertInstanceOf(RequestHandlerInterface::class, $router); - } - - /** - * @return void - */ - public function testAddPatterns() : void - { - $backup = Router::$patterns; - - $router = new Router(); - - try { - Router::$patterns = []; - - $router->addPatterns([ - '@foo' => 'foo', - '@bar' => 'bar', - ]); - - $this->assertSame([ - '@foo' => 'foo', - '@bar' => 'bar', - ], Router::$patterns); - - $router->addPatterns([ - '@baz' => 'baz', - ]); - - $this->assertSame([ - '@foo' => 'foo', - '@bar' => 'bar', - '@baz' => 'baz', - ], Router::$patterns); - - $router->addPatterns([ - '@bar' => 'qux', - ]); - - $this->assertSame([ - '@foo' => 'foo', - '@bar' => 'qux', - '@baz' => 'baz', - ], Router::$patterns); - } finally { - Router::$patterns = $backup; - } - } - - /** - * @return void - */ - public function testAddHosts() : void - { - $router = new Router(); - - $this->assertSame([], $router->getHosts()); - - $router->addHosts([ - 'foo' => ['foo.com', 'www.foo.com'], - 'bar' => ['bar.com', 'www.bar.com'], - ]); - - $this->assertSame([ - 'foo' => ['foo.com', 'www.foo.com'], - 'bar' => ['bar.com', 'www.bar.com'], - ], $router->getHosts()); - - $router->addHosts([ - 'baz' => ['baz.com', 'www.baz.com'], - ]); - - $this->assertSame([ - 'foo' => ['foo.com', 'www.foo.com'], - 'bar' => ['bar.com', 'www.bar.com'], - 'baz' => ['baz.com', 'www.baz.com'], - ], $router->getHosts()); - - $router->addHosts([ - 'bar' => ['qux.com', 'www.qux.com'], - ]); - - $this->assertSame([ - 'foo' => ['foo.com', 'www.foo.com'], - 'bar' => ['qux.com', 'www.qux.com'], - 'baz' => ['baz.com', 'www.baz.com'], - ], $router->getHosts()); - } - - /** - * @return void - */ - public function testAddHost() : void - { - $router = new Router(); - - $this->assertSame([], $router->getHosts()); - - $router->addHost('google', 'google.com', 'www.google.com'); - - $this->assertSame([ - 'google' => ['google.com', 'www.google.com'], - ], $router->getHosts()); - - $router->addHost('yahoo', 'yahoo.com'); - - $this->assertSame([ - 'google' => ['google.com', 'www.google.com'], - 'yahoo' => ['yahoo.com'], - ], $router->getHosts()); - - $router->addHost('google', 'localhost'); - - $this->assertSame([ - 'google' => ['localhost'], - 'yahoo' => ['yahoo.com'], - ], $router->getHosts()); - } - - /** - * @return void - */ - public function testAddRoute() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $router = new Router(); - $router->addRoute(...$routes); - - $this->assertSame($routes, $router->getRoutes()); - } - - /** - * @return void - */ - public function testAddExistingRoute() : void - { - $route = new Fixtures\Route(); - - $router = new Router(); - $router->addRoute($route); - - $this->expectException(InvalidArgumentException::class); - - try { - $router->addRoute($route); - } catch (InvalidArgumentException $e) { - throw $e; - } - } - - /** - * @return void - */ - public function testAddMiddleware() : void - { - $middlewares = [ - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - ]; - - $router = new Router(); - $router->addMiddleware(...$middlewares); - - $this->assertSame($middlewares, $router->getMiddlewares()); - } - - /** - * @return void - */ - public function testAddExistingMiddleware() : void - { - $middleware = new Fixtures\Middlewares\BlankMiddleware(); - - $router = new Router(); - $router->addMiddleware($middleware); - - $this->expectException(InvalidArgumentException::class); - - try { - $router->addMiddleware($middleware); - } catch (InvalidArgumentException $e) { - throw $e; - } - } - - /** - * @return void - */ - public function testGetAllowedMethods() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $expected = array_unique(array_merge( - $routes[0]->getMethods(), - $routes[1]->getMethods(), - $routes[2]->getMethods() - )); - - $router = new Router(); - - $this->assertSame([], $router->getAllowedMethods()); - - $router->addRoute(...$routes); - - $this->assertSame($expected, $router->getAllowedMethods()); - } - - /** - * @return void - */ - public function testGetRoute() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $router = new Router(); - $router->addRoute(...$routes); - - $this->assertSame($routes[1], $router->getRoute($routes[1]->getName())); - } - - /** - * @return void - */ - public function testGetUndefinedRoute() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $router = new Router(); - $router->addRoute(...$routes); - - $this->expectException(RouteNotFoundException::class); - - try { - $router->getRoute('foo'); - } catch (RouteNotFoundException $e) { - throw $e; - } - } - - /** - * The test method only proxies the function path_build, - * the function should be tested separately. - * - * @return void - */ - public function testGenerateUri() : void - { - $route = new Fixtures\Route(); - - $router = new Router(); - $router->addRoute($route); - - $this->assertSame($route->getPath(), $router->generateUri($route->getName())); - } - - /** - * @return void - */ - public function testMatch() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $router = new Router(); - $router->addRoute(...$routes); - - $foundRoute = $router->match((new ServerRequestFactory) - ->createServerRequest( - $routes[2]->getMethods()[1], - $routes[2]->getPath() - )); - - $this->assertSame($routes[2]->getName(), $foundRoute->getName()); - } - - /** - * @return void - */ - public function testMatchWithUnallowedMethod() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $routes[1]->setPath('/foo'); - $routes[2]->setPath('/foo'); - $routes[3]->setPath('/foo'); - - $router = new Router(); - $router->addRoute(...$routes); - - $request = (new ServerRequestFactory) - ->createServerRequest('GET', '/foo'); - - $this->expectException(MethodNotAllowedException::class); - - try { - $router->match($request); - } catch (MethodNotAllowedException $e) { - $expected = array_unique(array_merge( - $routes[1]->getMethods(), - $routes[2]->getMethods(), - $routes[3]->getMethods() - )); - - $this->assertSame($request->getMethod(), $e->fromContext('method')); - $this->assertSame($request->getMethod(), $e->getMethod()); - - $this->assertSame($expected, $e->fromContext('allowed')); - $this->assertSame($expected, $e->getAllowedMethods()); - - throw $e; - } - } - - /** - * @return void - */ - public function testMatchWithUndefinedRoute() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $router = new Router(); - $router->addRoute(...$routes); - - $request = (new ServerRequestFactory) - ->createServerRequest($routes[0]->getMethods()[0], '/'); - - $this->expectException(RouteNotFoundException::class); - - try { - $router->match($request); - } catch (RouteNotFoundException $e) { - throw $e; - } - } - - /** - * @return void - */ - public function testRun() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $router = new Router(); - $router->addRoute(...$routes); - - $router->run((new ServerRequestFactory) - ->createServerRequest( - $routes[1]->getMethods()[1], - $routes[1]->getPath() - )); - - $this->assertNotNull($router->getMatchedRoute()); - $this->assertSame($routes[1]->getName(), $router->getMatchedRoute()->getName()); - $this->assertTrue($routes[1]->getRequestHandler()->isRunned()); - } - - /** - * @return void - */ - public function testRunWithUnallowedMethod() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $router = new Router(); - $router->addRoute(...$routes); - - $router->addMiddleware(new CallbackMiddleware(function ($request, $handler) { - try { - return $handler->handle($request); - } catch (MethodNotAllowedException $e) { - return (new ResponseFactory)->createResponse(405); - } - })); - - $response = $router->run((new ServerRequestFactory) - ->createServerRequest('UNALLOWED', $routes[1]->getPath())); - - $this->assertSame(405, $response->getStatusCode()); - } - - /** - * @return void - */ - public function testRunWithUndefinedRoute() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $router = new Router(); - $router->addRoute(...$routes); - - $router->addMiddleware(new CallbackMiddleware(function ($request, $handler) { - try { - return $handler->handle($request); - } catch (RouteNotFoundException $e) { - return (new ResponseFactory)->createResponse(404); - } - })); - - $response = $router->run((new ServerRequestFactory) - ->createServerRequest($routes[1]->getMethods()[1], '/undefined')); - - $this->assertSame(404, $response->getStatusCode()); - } - - /** - * @return void - */ - public function testHandle() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $router = new Router(); - $router->addRoute(...$routes); - - $router->handle((new ServerRequestFactory) - ->createServerRequest( - $routes[2]->getMethods()[1], - $routes[2]->getPath() - )); - - $this->assertNotNull($router->getMatchedRoute()); - $this->assertSame($routes[2]->getName(), $router->getMatchedRoute()->getName()); - $this->assertTrue($routes[2]->getRequestHandler()->isRunned()); - } - - /** - * @return void - */ - public function testHandleWithMiddlewares() : void - { - $route = new Fixtures\Route(); - - $middlewares = [ - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(), - ]; - - $router = new Router(); - $router->addRoute($route); - $router->addMiddleware(...$middlewares); - - $router->handle((new ServerRequestFactory) - ->createServerRequest( - $route->getMethods()[0], - $route->getPath() - )); - - $this->assertTrue($middlewares[0]->isRunned()); - $this->assertTrue($middlewares[1]->isRunned()); - $this->assertTrue($middlewares[2]->isRunned()); - $this->assertTrue($route->getRequestHandler()->isRunned()); - } - - /** - * @return void - */ - public function testHandleWithBrokenMiddleware() : void - { - $route = new Fixtures\Route(); - - $middlewares = [ - new Fixtures\Middlewares\BlankMiddleware(), - new Fixtures\Middlewares\BlankMiddleware(true), - new Fixtures\Middlewares\BlankMiddleware(), - ]; - - $router = new Router(); - $router->addRoute($route); - $router->addMiddleware(...$middlewares); - - $router->handle((new ServerRequestFactory) - ->createServerRequest( - $route->getMethods()[0], - $route->getPath() - )); - - $this->assertTrue($middlewares[0]->isRunned()); - $this->assertTrue($middlewares[1]->isRunned()); - $this->assertFalse($middlewares[2]->isRunned()); - $this->assertFalse($route->getRequestHandler()->isRunned()); - } - - /** - * @return void - */ - public function testHandleWithUnallowedMethod() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $router = new Router(); - $router->addRoute(...$routes); - - $request = (new ServerRequestFactory) - ->createServerRequest('GET', $routes[1]->getPath()); - - $this->expectException(MethodNotAllowedException::class); - - try { - $router->handle($request); - } catch (MethodNotAllowedException $e) { - $allowedMethods = $routes[1]->getMethods(); - - // $this->assertSame('GET', $e->fromContext('method')); - $this->assertSame($allowedMethods, $e->fromContext('allowed')); - $this->assertSame($allowedMethods, $e->getAllowedMethods()); - - throw $e; - } - } - - /** - * @return void - */ - public function testHandleWithUndefinedRoute() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $router = new Router(); - $router->addRoute(...$routes); - - $request = (new ServerRequestFactory) - ->createServerRequest($routes[0]->getMethods()[0], '/'); - - $this->expectException(RouteNotFoundException::class); - - try { - $router->handle($request); - } catch (RouteNotFoundException $e) { - throw $e; - } - } - - /** - * @return void - */ - public function testProcess() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $router = new Router(); - $router->addRoute(...$routes); - - $fallback = new Fixtures\Controllers\BlankController(); - - $router->process((new ServerRequestFactory) - ->createServerRequest( - $routes[2]->getMethods()[1], - $routes[2]->getPath() - ), $fallback); - - $this->assertTrue($routes[2]->getRequestHandler()->isRunned()); - $this->assertFalse($fallback->isRunned()); - } - - /** - * @return void - */ - public function testProcessWithUnallowedMethod() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $router = new Router(); - $router->addRoute(...$routes); - - $request = (new ServerRequestFactory) - ->createServerRequest('GET', $routes[0]->getPath()); - - $fallback = new Fixtures\Controllers\BlankController(); - - $router->process($request, $fallback); - - $this->assertInstanceOf( - MethodNotAllowedException::class, - $fallback->getRequest()->getAttribute(Router::ATTR_NAME_FOR_ROUTING_ERROR) - ); - - $this->assertTrue($fallback->isRunned()); - } - - /** - * @return void - */ - public function testProcessWithUndefinedRoute() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $router = new Router(); - $router->addRoute(...$routes); - - $request = (new ServerRequestFactory) - ->createServerRequest($routes[0]->getMethods()[0], '/'); - - $fallback = new Fixtures\Controllers\BlankController(); - - $router->process($request, $fallback); - - $this->assertInstanceOf( - RouteNotFoundException::class, - $fallback->getRequest()->getAttribute(Router::ATTR_NAME_FOR_ROUTING_ERROR) - ); - - $this->assertTrue($fallback->isRunned()); - } - - /** - * @return void - */ - public function testLoad() : void - { - $router = new Router(); - - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $loader = $this->createMock(LoaderInterface::class); - $loader->method('load') - ->willReturn(new RouteCollection(...$routes)); - - $router->load($loader); - - $this->assertSame($routes, $router->getRoutes()); - } - - /** - * @return void - */ - public function testMultipleLoad() : void - { - $router = new Router(); - - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $loaders = []; - - $loaders[0] = $this->createMock(LoaderInterface::class); - $loaders[0]->method('load') - ->willReturn(new RouteCollection($routes[0])); - - $loaders[1] = $this->createMock(LoaderInterface::class); - $loaders[1]->method('load') - ->willReturn(new RouteCollection($routes[1])); - - $loaders[2] = $this->createMock(LoaderInterface::class); - $loaders[2]->method('load') - ->willReturn(new RouteCollection($routes[2])); - - $router->load(...$loaders); - - $this->assertSame($routes, $router->getRoutes()); - } - - /** - * @return void - */ - public function testMatchWithHosts() : void - { - $requestHandler = new Fixtures\Controllers\BlankController(); - - $routes = [ - new Route('foo', '/ping', ['GET'], $requestHandler), - new Route('bar', '/ping', ['GET'], $requestHandler), - new Route('baz', '/ping', ['GET'], $requestHandler), - new Route('qux', '/ping', ['GET'], $requestHandler), - ]; - - $routes[0]->setHost('foo'); - $routes[1]->setHost('bar'); - $routes[2]->setHost('baz'); - - $router = new Router(); - $router->addHost('foo', 'foo.net'); - $router->addHost('bar', 'bar.net'); - $router->addHost('baz', 'baz.net'); - $router->addRoute(...$routes); - - // hosted route - $foundRoute = $router->match((new ServerRequestFactory) - ->createServerRequest('GET', 'http://foo.net/ping')); - $this->assertSame($routes[0]->getName(), $foundRoute->getName()); - - // hosted route - $foundRoute = $router->match((new ServerRequestFactory) - ->createServerRequest('GET', 'http://bar.net/ping')); - $this->assertSame($routes[1]->getName(), $foundRoute->getName()); - - // hosted route - $foundRoute = $router->match((new ServerRequestFactory) - ->createServerRequest('GET', 'http://baz.net/ping')); - $this->assertSame($routes[2]->getName(), $foundRoute->getName()); - - // non-hosted route - $foundRoute = $router->match((new ServerRequestFactory) - ->createServerRequest('GET', 'http://localhost/ping')); - $this->assertSame($routes[3]->getName(), $foundRoute->getName()); - } - - /** - * @return void - */ - public function testEventDispatcher() : void - { - $router = new Router(); - $this->assertNull($router->getEventDispatcher()); - - $eventDispatcher = new EventDispatcher(); - $router->setEventDispatcher($eventDispatcher); - $this->assertSame($eventDispatcher, $router->getEventDispatcher()); - - $router->setEventDispatcher(null); - $this->assertNull($router->getEventDispatcher()); - } - - /** - * @return void - */ - public function testRouteEvent() : void - { - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $request = (new ServerRequestFactory) - ->createServerRequest( - $routes[1]->getMethods()[1], - $routes[1]->getPath() - ); - - $eventDispatcher = new EventDispatcher(); - $eventDispatcher->addListener(RouteMatchedEvent::NAME, function (RouteMatchedEvent $event) use ($routes, $request) { - $this->assertSame($routes[1]->getName(), $event->getRoute()->getName()); - $this->assertSame($request, $event->getRequest()); - }); - - $router = new Router(); - $router->addRoute(...$routes); - $router->setEventDispatcher($eventDispatcher); - $router->run($request); - } - - /** - * @return void - */ - public function testRouteEventOverrideRequest() : void - { - $route = new Fixtures\Route(); - - $request = (new ServerRequestFactory) - ->createServerRequest( - $route->getMethods()[0], - $route->getPath() - ); - - $eventDispatcher = new EventDispatcher(); - $eventDispatcher->addListener(RouteMatchedEvent::NAME, function (RouteMatchedEvent $event) use ($request) { - $event->setRequest($request->withAttribute('foo', 'bar')); - $this->assertNotSame($request, $event->getRequest()); - }); - - $router = new Router(); - $router->addRoute($route); - $router->setEventDispatcher($eventDispatcher); - $router->handle($request); - } - - /** - * @return void - */ - public function testResolveHost() : void - { - $router = new Router(); - $router->addHost('foo', 'www1.foo.com', 'www2.foo.com'); - $router->addHost('bar', 'www1.bar.com', 'www2.bar.com'); - - $this->assertSame('foo', $router->resolveHostname('www1.foo.com')); - $this->assertSame('foo', $router->resolveHostname('www2.foo.com')); - $this->assertSame('bar', $router->resolveHostname('www1.bar.com')); - $this->assertSame('bar', $router->resolveHostname('www2.bar.com')); - $this->assertNull($router->resolveHostname('example.com')); - } - - /** - * @return void - */ - public function testGetRoutesByHostname() : void - { - $router = new Router(); - $router->addHost('foo', 'www1.foo.com', 'www2.foo.com'); - $router->addHost('bar', 'www1.bar.com', 'www2.bar.com'); - - $routes = [ - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - new Fixtures\Route(), - ]; - - $routes[0]->setHost('foo'); - $routes[2]->setHost('bar'); - $routes[4]->setHost('bar'); - - $router->addRoute(...$routes); - - $this->assertSame([ - $routes[0], - $routes[1], - $routes[3], - $routes[5], - ], $router->getRoutesByHostname('www1.foo.com')); - - $this->assertSame([ - $routes[0], - $routes[1], - $routes[3], - $routes[5], - ], $router->getRoutesByHostname('www2.foo.com')); - - $this->assertSame([ - $routes[1], - $routes[2], - $routes[3], - $routes[4], - $routes[5], - ], $router->getRoutesByHostname('www1.bar.com')); - - $this->assertSame([ - $routes[1], - $routes[2], - $routes[3], - $routes[4], - $routes[5], - ], $router->getRoutesByHostname('www2.bar.com')); - - $this->assertSame([ - $routes[1], - $routes[3], - $routes[5], - ], $router->getRoutesByHostname('localhost')); - } -} From 30846ab1f4065359303c27ce0a562de2d78ae4df Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Mon, 11 Mar 2024 02:47:51 +0100 Subject: [PATCH 131/180] v3 --- .scrutinizer.yml | 37 ++------- tests/Helper/RouteParserTest.php | 130 +++++++++++++++++++++++++++++-- 2 files changed, 130 insertions(+), 37 deletions(-) diff --git a/.scrutinizer.yml b/.scrutinizer.yml index 44be2791..a4b33801 100644 --- a/.scrutinizer.yml +++ b/.scrutinizer.yml @@ -3,52 +3,29 @@ build: nodes: analysis: environment: - php: 8.2 + php: 8.3 tests: override: - php-scrutinizer-run coverage: environment: - php: 8.2 + php: 8.3 tests: override: - command: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-clover coverage.xml coverage: file: coverage.xml format: clover - php81: - environment: - php: 8.1 - tests: - override: - - command: php vendor/bin/phpunit - php80: - environment: - php: 8.0 - tests: - override: - - command: php vendor/bin/phpunit - php74: + php82: environment: - php: 7.4 - tests: - override: - - command: php vendor/bin/phpunit - php73: - environment: - php: 7.3 - tests: - override: - - command: php vendor/bin/phpunit - php72: - environment: - php: 7.2 + php: 8.2 tests: override: - command: php vendor/bin/phpunit - php71: + + php81: environment: - php: 7.1 + php: 8.1 tests: override: - command: php vendor/bin/phpunit diff --git a/tests/Helper/RouteParserTest.php b/tests/Helper/RouteParserTest.php index 77473f80..dd86efac 100644 --- a/tests/Helper/RouteParserTest.php +++ b/tests/Helper/RouteParserTest.php @@ -1,12 +1,15 @@ assertEquals($expectedVariables, $actualVariables); } - public function validRouteDataProvider(): Generator + /** + * @dataProvider invalidRouteDataProvider + */ + public function testParseInvalidRoute(string $route, string $expectedMessage): void + { + $this->expectException(InvalidRouteParsingSubjectException::class); + $this->expectExceptionMessageMatches($expectedMessage); + + RouteParser::parseRoute($route); + } + + private function validRouteDataProvider(): Generator { yield [ '', @@ -44,6 +58,13 @@ public function validRouteDataProvider(): Generator ], ]; + yield [ + '/posts(/{id})', + [ + ['name' => 'id', 'optional' => ['left' => '/', 'right' => ''], 'offset' => 8, 'length' => 4], + ], + ]; + yield [ '/posts(/{id<\d+>})', [ @@ -53,18 +74,113 @@ public function validRouteDataProvider(): Generator ]; yield [ - '(/{lc<[a-z]{2}>})/posts/{id<\d+>}', + '/posts(/{id<\d+>}.json)', [ - ['name' => 'lc', 'pattern' => '[a-z]{2}', 'optional' => ['left' => '/', 'right' => ''], 'offset' => 2, 'length' => 14], - ['name' => 'id', 'pattern' => '\d+', 'offset' => 24, 'length' => 9], + ['name' => 'id', 'pattern' => '\d+', 'optional' => ['left' => '/', 'right' => '.json'], 'offset' => 8, 'length' => 9], + ], + ]; + + yield [ + '/posts/{id<\d+>}(.json)', + [ + ['name' => 'id', 'pattern' => '\d+', 'offset' => 7, 'length' => 9], ], ]; yield [ - '/posts(/{id}.json)', + '(/{lang<[a-z]{2}>})/posts(/{id<\d+>})', [ - ['name' => 'id', 'optional' => ['left' => '/', 'right' => '.json'], 'offset' => 8, 'length' => 4], + ['name' => 'lang', 'pattern' => '[a-z]{2}', 'optional' => ['left' => '/', 'right' => ''], 'offset' => 2, 'length' => 16], + ['name' => 'id', 'pattern' => '\d+', 'optional' => ['left' => '/', 'right' => ''], 'offset' => 27, 'length' => 9], ], ]; } + + private function invalidRouteDataProvider(): Generator + { + yield [ + '((', + '/nested optional parts are not supported/', + ]; + + yield [ + ')', + '/open optional part was not found/', + ]; + + yield [ + '{{', + '/nested variables are not supported/', + ]; + + yield [ + '({x}{', + '/more than one variable inside an optional part is not supported/', + ]; + + yield [ + '}', + '/open variable was not found/', + ]; + + yield [ + '{}', + '/name is required for its declaration/', + ]; + + yield [ + '{<<', + '/nested patterns are not supported/', + ]; + + yield [ + '{<.><', + '/pattern must be preceded by the variable name/', + ]; + + yield [ + '{>', + '/open pattern was not found/', + ]; + + yield [ + '{<>', + '/content is required for its declaration/', + ]; + + yield [ + '{0', + '/variable names cannot start with digits/', + ]; + + yield [ + '{!', + '/variable names must consist only of digits, letters and underscores/' + ]; + + yield [ + '{aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', + '/variable names must not exceed 32 characters/' + ]; + + yield [ + '/{<#/', + '/variable patterns cannot contain the # character/' + ]; + + yield [ + '{x<.>!}', + '/variable at this position must be closed/' + ]; + + yield [ + '(', + '/contains an unclosed optional part or variable/' + ]; + + yield [ + '{', + '/contains an unclosed optional part or variable/' + ]; + } } From 59065805f35c339ec89d5501804e399deda7866c Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Tue, 12 Mar 2024 02:34:25 +0100 Subject: [PATCH 132/180] v3 --- psalm.xml.dist | 1 + src/Command/RouteListCommand.php | 2 +- src/Dictionary/ErrorMessage.php | 16 ++--- src/Entity/Language/ClientLanguage.php | 2 +- src/Entity/Language/LanguageComparator.php | 2 +- src/Entity/MediaType/MediaTypeComparator.php | 2 +- src/Entity/MediaType/MediaTypeFactory.php | 30 ++++++++ src/Helper/FilesystemHelper.php | 3 - src/Helper/HeaderParser.php | 42 +++++------ src/Helper/RouteBuilder.php | 46 ++++++++---- src/Helper/RouteMatcher.php | 5 +- src/Helper/RouteParser.php | 72 +++++++++---------- src/Helper/RouteSimplifier.php | 2 + .../JsonPayloadDecodingMiddleware.php | 4 +- src/ReferenceResolver.php | 4 +- src/ServerRequest.php | 9 +-- 16 files changed, 145 insertions(+), 97 deletions(-) create mode 100644 src/Entity/MediaType/MediaTypeFactory.php diff --git a/psalm.xml.dist b/psalm.xml.dist index a71afc58..dfaf4f2f 100644 --- a/psalm.xml.dist +++ b/psalm.xml.dist @@ -16,5 +16,6 @@ + diff --git a/src/Command/RouteListCommand.php b/src/Command/RouteListCommand.php index 3d36122e..1ef33a19 100644 --- a/src/Command/RouteListCommand.php +++ b/src/Command/RouteListCommand.php @@ -50,7 +50,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int $table->addRow([ $route->getName(), $route->getPath(), - $route->getMethods() === [] ? 'Any' : join(', ', $route->getMethods()), + $route->getMethods() === [] ? 'ANY' : join(', ', $route->getMethods()), ]); } diff --git a/src/Dictionary/ErrorMessage.php b/src/Dictionary/ErrorMessage.php index bf872575..60271c72 100644 --- a/src/Dictionary/ErrorMessage.php +++ b/src/Dictionary/ErrorMessage.php @@ -18,19 +18,19 @@ */ final class ErrorMessage { - public const INVALID_URI = 'The requested URI is invalid and cannot be accepted by the server.'; - public const ROUTE_NOT_FOUND = 'The resource {{ request_uri }} was not found.'; - public const METHOD_NOT_ALLOWED = 'The method {{ request_method }} is not allowed; check the Allow response header for allowed methods.'; - public const MEDIA_TYPE_NOT_PROVIDED = 'The Content-Type header must be provided and must not be empty; check the Accept response header for supported media types.'; - public const MEDIA_TYPE_NOT_SUPPORTED = 'The media type {{ media_type }} is not supported; check the Accept response header for supported media types.'; - public const INVALID_VARIABLE = 'The variable {{ variable_name }} of the route {{ route_uri }} is invalid.'; + public const INVALID_URI = 'The request URI is invalid and cannot be accepted by the server.'; + public const ROUTE_NOT_FOUND = 'The requested resource at the URI {{ request_uri }} was not found.'; + public const METHOD_NOT_ALLOWED = 'The requested method {{ request_method }} is not allowed; please check the Allow response header for allowed methods.'; + public const MEDIA_TYPE_NOT_PROVIDED = 'The Content-Type header must be provided and cannot be empty; please check the Accept response header for supported media types.'; + public const MEDIA_TYPE_NOT_SUPPORTED = 'The media type {{ media_type }} is not supported; please check the Accept response header for supported media types.'; + public const INVALID_VARIABLE = 'The variable {{ variable_name }} in the URI {{ route_uri }} is invalid.'; public const INVALID_QUERY = 'The query parameters are invalid.'; public const MISSING_HEADER = 'The header {{ header_name }} must be provided.'; public const INVALID_HEADER = 'The header {{ header_name }} is invalid.'; public const MISSING_COOKIE = 'The cookie {{ cookie_name }} must be provided.'; public const INVALID_COOKIE = 'The cookie {{ cookie_name }} is invalid.'; public const INVALID_BODY = 'The request body is invalid.'; - public const EMPTY_JSON_PAYLOAD = 'The JSON payload must not be empty.'; - public const INVALID_JSON_PAYLOAD = 'The JSON payload is invalid and could not be decoded.'; + public const EMPTY_JSON_PAYLOAD = 'The JSON payload cannot be empty.'; + public const INVALID_JSON_PAYLOAD = 'The JSON payload is invalid.'; public const INVALID_JSON_PAYLOAD_FORM = 'The JSON payload must be in the form of an array or an object.'; } diff --git a/src/Entity/Language/ClientLanguage.php b/src/Entity/Language/ClientLanguage.php index df0ed9c0..71ca2287 100644 --- a/src/Entity/Language/ClientLanguage.php +++ b/src/Entity/Language/ClientLanguage.php @@ -20,7 +20,7 @@ final class ClientLanguage implements LanguageInterface { public function __construct( private readonly string $code, - // One of the Accept-Language header's identifiers + // One of the Accept-Language header's identifiers: // https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.5 private readonly string $locale, /** @var array */ diff --git a/src/Entity/Language/LanguageComparator.php b/src/Entity/Language/LanguageComparator.php index d2e9ab4c..eba1e3e5 100644 --- a/src/Entity/Language/LanguageComparator.php +++ b/src/Entity/Language/LanguageComparator.php @@ -18,7 +18,7 @@ */ final class LanguageComparator { - public function equals(LanguageInterface $a, LanguageInterface $b): bool + public static function equals(LanguageInterface $a, LanguageInterface $b): bool { return $a->getCode() === $b->getCode() || $a->getCode() === '*' || $b->getCode() === '*'; } diff --git a/src/Entity/MediaType/MediaTypeComparator.php b/src/Entity/MediaType/MediaTypeComparator.php index 5b2e3246..938d6de8 100644 --- a/src/Entity/MediaType/MediaTypeComparator.php +++ b/src/Entity/MediaType/MediaTypeComparator.php @@ -18,7 +18,7 @@ */ final class MediaTypeComparator { - public function equals(MediaTypeInterface $a, MediaTypeInterface $b): bool + public static function equals(MediaTypeInterface $a, MediaTypeInterface $b): bool { return ($a->getType() === $b->getType() || $a->getType() === '*' || $b->getType() === '*') && ($a->getSubtype() === $b->getSubtype() || $a->getSubtype() === '*' || $b->getSubtype() === '*'); diff --git a/src/Entity/MediaType/MediaTypeFactory.php b/src/Entity/MediaType/MediaTypeFactory.php new file mode 100644 index 00000000..ea47298a --- /dev/null +++ b/src/Entity/MediaType/MediaTypeFactory.php @@ -0,0 +1,30 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Entity\MediaType; + +use Generator; + +/** + * @since 3.0.0 + */ +final class MediaTypeFactory +{ + /** + * @return Generator + */ + public static function json(): Generator + { + yield new ServerMediaType('application', 'json'); + } +} diff --git a/src/Helper/FilesystemHelper.php b/src/Helper/FilesystemHelper.php index 4d6fbc01..2dce82bd 100644 --- a/src/Helper/FilesystemHelper.php +++ b/src/Helper/FilesystemHelper.php @@ -64,7 +64,6 @@ public static function getDirClasses(string $dirname): Generator foreach ($filenames as $filename) { (static function (string $filename): void { - /** @psalm-suppress UnresolvableInclude */ require_once $filename; })($filename); } @@ -92,9 +91,7 @@ public static function getFileClasses(string $filename): Generator } $filename = realpath($filename); - (static function (string $filename): void { - /** @psalm-suppress UnresolvableInclude */ require_once $filename; })($filename); diff --git a/src/Helper/HeaderParser.php b/src/Helper/HeaderParser.php index da6d241a..2be2801d 100644 --- a/src/Helper/HeaderParser.php +++ b/src/Helper/HeaderParser.php @@ -22,18 +22,18 @@ */ final class HeaderParser { + private const IN_IDENTIFIER = 1; + private const IN_PARAMETER_NAME = 2; + private const IN_PARAMETER_VALUE = 4; + private const IN_QUOTED_STRING = 8; + private const IN_QUOTED_PAIR = 16; + /** * @return array, array{0: string, 1: array}> */ public static function parseHeader(string $header): array { - $inIdentifier = 1; - $inParameterName = 2; - $inParameterValue = 4; - $inQuotedString = 8; - $inQuotedPair = 16; - - $cursor = $inIdentifier; + $cursor = self::IN_IDENTIFIER; $value = 0; $param = -1; $values = []; @@ -43,44 +43,44 @@ public static function parseHeader(string $header): array continue; } - if ($header[$offset] === ',' && !($cursor & $inQuotedString)) { - $cursor = $inIdentifier; + if ($header[$offset] === ',' && !($cursor & self::IN_QUOTED_STRING)) { + $cursor = self::IN_IDENTIFIER; $value++; $param = -1; continue; } - if ($header[$offset] === ';' && !($cursor & $inQuotedString)) { - $cursor = $inParameterName; + if ($header[$offset] === ';' && !($cursor & self::IN_QUOTED_STRING)) { + $cursor = self::IN_PARAMETER_NAME; $param++; continue; } - if ($header[$offset] === '=' && ($cursor & $inParameterName)) { - $cursor = $inParameterValue; + if ($header[$offset] === '=' && ($cursor & self::IN_PARAMETER_NAME)) { + $cursor = self::IN_PARAMETER_VALUE; continue; } - if ($header[$offset] === '"' && ($cursor & $inParameterValue) && !($cursor & $inQuotedPair)) { - $cursor ^= $inQuotedString; + if ($header[$offset] === '"' && ($cursor & self::IN_PARAMETER_VALUE) && !($cursor & self::IN_QUOTED_PAIR)) { + $cursor ^= self::IN_QUOTED_STRING; continue; } - if ($header[$offset] === '\\' && ($cursor & $inQuotedString) && !($cursor & $inQuotedPair)) { - $cursor |= $inQuotedPair; + if ($header[$offset] === '\\' && ($cursor & self::IN_QUOTED_STRING) && !($cursor & self::IN_QUOTED_PAIR)) { + $cursor |= self::IN_QUOTED_PAIR; continue; } - if ($cursor & $inIdentifier) { + if ($cursor & self::IN_IDENTIFIER) { $values[$value][0] ??= ''; $values[$value][0] .= $header[$offset]; continue; } - if ($cursor & $inParameterName) { + if ($cursor & self::IN_PARAMETER_NAME) { $values[$value][1][$param][0] ??= ''; $values[$value][1][$param][0] .= $header[$offset]; continue; } - if ($cursor & $inParameterValue) { + if ($cursor & self::IN_PARAMETER_VALUE) { $values[$value][1][$param][1] ??= ''; $values[$value][1][$param][1] .= $header[$offset]; - $cursor &= ~$inQuotedPair; + $cursor &= ~self::IN_QUOTED_PAIR; continue; } } diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index 6c30afc5..2c3e8033 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router\Helper; use BackedEnum; +use InvalidArgumentException; use Stringable; use Sunrise\Http\Router\Exception\InvalidRouteBuildingValueException; use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; @@ -46,21 +47,15 @@ public static function buildRoute(string $route, array $values = []): string if (isset($values[$variable['name']])) { $value = $values[$variable['name']]; - if (is_int($value)) { - $value = (string) $value; - } elseif ($value instanceof BackedEnum) { - $value = (string) $value->value; - } elseif ($value instanceof Stringable) { - $value = (string) $value; - } - - if (!is_string($value)) { + try { + $value = self::stringifyValue($value); + } catch (InvalidArgumentException $e) { throw new InvalidRouteBuildingValueException(sprintf( - 'The route %s could not be built because the value assigned to the variable %s has an unsupported type: %s.', + 'The route %s could not be built with an invalid value for the variable %s due to: %s', $route, $variable['name'], - get_debug_type($value), - )); + $e->getMessage(), + ), previous: $e); } $search[] = $statement; @@ -81,9 +76,36 @@ public static function buildRoute(string $route, array $values = []): string )); } + // will be replaced by an empty string: + // https://github.com/php/php-src/blob/a04577fb4ab5e1ebc7779608523b95ddf01e6c7f/ext/standard/string.c#L4406-L4408 $search[] = '('; $search[] = ')'; return str_replace($search, $replace, $route); } + + /** + * @throws InvalidArgumentException + */ + private static function stringifyValue(mixed $value): string + { + if (is_string($value)) { + return $value; + } + if (is_int($value)) { + return (string) $value; + } + if ($value instanceof BackedEnum) { + return (string) $value->value; + } + if ($value instanceof Stringable) { + return $value->__toString(); + } + + throw new InvalidArgumentException(sprintf( + 'The %s value could not be converted to a string; ' . + 'supported types: string, integer, backed enum and stringable object.', + get_debug_type($value), + )); + } } diff --git a/src/Helper/RouteMatcher.php b/src/Helper/RouteMatcher.php index 43a3489c..6eb280d5 100644 --- a/src/Helper/RouteMatcher.php +++ b/src/Helper/RouteMatcher.php @@ -66,7 +66,7 @@ public static function matchPattern(string $route, string $pattern, string $subj // a client side error; must be handled as 4xx error. if (preg_last_error() === PREG_BAD_UTF8_ERROR) { throw new InvalidRouteMatchingSubjectException(sprintf( - 'The route %s could not be matched due to: %s.', + 'The route %s could not be matched with an invalid subject due to: %s.', RouteSimplifier::simplifyRoute($route), preg_last_error_msg(), )); @@ -76,8 +76,7 @@ public static function matchPattern(string $route, string $pattern, string $subj throw new InvalidRouteMatchingPatternException(sprintf( 'The route %s could not be matched due to: %s; ' . 'most likely, this problem is related to one of the route patterns. ' . - 'Please refer to the official documentation: ' . - 'https://www.php.net/preg_last_error', + 'Please refer to the official documentation: https://www.php.net/preg_last_error', $route, preg_last_error_msg(), ), preg_last_error()); diff --git a/src/Helper/RouteParser.php b/src/Helper/RouteParser.php index 1ae75ac3..9a570a67 100644 --- a/src/Helper/RouteParser.php +++ b/src/Helper/RouteParser.php @@ -23,6 +23,12 @@ */ final class RouteParser { + private const IN_VARIABLE = 1; + private const IN_VARIABLE_NAME = 2; + private const IN_VARIABLE_PATTERN = 8; + private const IN_OPTIONAL_PART = 16; + private const IN_OCCUPIED_PART = 32; + /** * Parses the given route and returns its variables * @@ -32,12 +38,6 @@ final class RouteParser */ public static function parseRoute(string $route): array { - $inVariable = 1; - $inVariableName = 2; - $inVariablePattern = 8; - $inOptionalPart = 16; - $inOccupiedPart = 32; - $cursor = 0; $variable = -1; $variables = []; @@ -45,8 +45,8 @@ public static function parseRoute(string $route): array $left = $right = ''; for ($offset = 0; isset($route[$offset]); $offset++) { - if ($route[$offset] === '(' && !($cursor & $inVariable)) { - if (($cursor & $inOptionalPart)) { + if ($route[$offset] === '(' && !($cursor & self::IN_VARIABLE)) { + if (($cursor & self::IN_OPTIONAL_PART)) { throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to open an optional part at position %d has failed ' . @@ -56,11 +56,11 @@ public static function parseRoute(string $route): array )); } - $cursor |= $inOptionalPart; + $cursor |= self::IN_OPTIONAL_PART; continue; } - if ($route[$offset] === ')' && !($cursor & $inVariable)) { - if (!($cursor & $inOptionalPart)) { + if ($route[$offset] === ')' && !($cursor & self::IN_VARIABLE)) { + if (!($cursor & self::IN_OPTIONAL_PART)) { throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to close an optional part at position %d has failed ' . @@ -70,19 +70,19 @@ public static function parseRoute(string $route): array )); } - if (($cursor & $inOccupiedPart)) { - $cursor &= ~$inOccupiedPart; + if (($cursor & self::IN_OCCUPIED_PART)) { + $cursor &= ~self::IN_OCCUPIED_PART; $variables[$variable]['optional']['left'] = $left; $variables[$variable]['optional']['right'] = $right; } - $cursor &= ~$inOptionalPart; + $cursor &= ~self::IN_OPTIONAL_PART; $left = $right = ''; continue; } - if ($route[$offset] === '{' && !($cursor & $inVariablePattern)) { - if (($cursor & $inVariable)) { + if ($route[$offset] === '{' && !($cursor & self::IN_VARIABLE_PATTERN)) { + if (($cursor & self::IN_VARIABLE)) { throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to open a variable at position %d has failed ' . @@ -91,7 +91,7 @@ public static function parseRoute(string $route): array $offset, )); } - if (($cursor & $inOccupiedPart)) { + if (($cursor & self::IN_OCCUPIED_PART)) { throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to open a variable at position %d has failed ' . @@ -103,16 +103,16 @@ public static function parseRoute(string $route): array $variable++; - if (($cursor & $inOptionalPart)) { - $cursor |= $inOccupiedPart; + if (($cursor & self::IN_OPTIONAL_PART)) { + $cursor |= self::IN_OCCUPIED_PART; } - $cursor |= $inVariable | $inVariableName; + $cursor |= self::IN_VARIABLE | self::IN_VARIABLE_NAME; $variables[$variable]['offset'] = $offset; continue; } - if ($route[$offset] === '}' && !($cursor & $inVariablePattern)) { - if (!($cursor & $inVariable)) { + if ($route[$offset] === '}' && !($cursor & self::IN_VARIABLE_PATTERN)) { + if (!($cursor & self::IN_VARIABLE)) { throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to close a variable at position %d has failed ' . @@ -131,14 +131,14 @@ public static function parseRoute(string $route): array )); } - $cursor &= ~($inVariable | $inVariableName); + $cursor &= ~(self::IN_VARIABLE | self::IN_VARIABLE_NAME); /** @psalm-suppress PossiblyUndefinedArrayOffset */ $variables[$variable]['length'] = $offset - $variables[$variable]['offset'] + 1; continue; } - if ($route[$offset] === '<' && ($cursor & $inVariable)) { - if (($cursor & $inVariablePattern)) { + if ($route[$offset] === '<' && ($cursor & self::IN_VARIABLE)) { + if (($cursor & self::IN_VARIABLE_PATTERN)) { throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to open a variable pattern at position %d has failed ' . @@ -147,7 +147,7 @@ public static function parseRoute(string $route): array $offset, )); } - if (!($cursor & $inVariableName)) { + if (!($cursor & self::IN_VARIABLE_NAME)) { throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to open a variable pattern at position %d has failed ' . @@ -157,11 +157,11 @@ public static function parseRoute(string $route): array )); } - $cursor = ($cursor | $inVariablePattern) & ~$inVariableName; + $cursor = ($cursor | self::IN_VARIABLE_PATTERN) & ~self::IN_VARIABLE_NAME; continue; } - if ($route[$offset] === '>' && ($cursor & $inVariable)) { - if (!($cursor & $inVariablePattern)) { + if ($route[$offset] === '>' && ($cursor & self::IN_VARIABLE)) { + if (!($cursor & self::IN_VARIABLE_PATTERN)) { throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to close a variable pattern at position %d has failed ' . @@ -180,14 +180,14 @@ public static function parseRoute(string $route): array )); } - $cursor &= ~$inVariablePattern; + $cursor &= ~self::IN_VARIABLE_PATTERN; continue; } // (left{foo}right) // ~^^^^~~~~~^^^^^~ - if (($cursor & $inOptionalPart) && !($cursor & $inVariable)) { - if (!($cursor & $inOccupiedPart)) { + if (($cursor & self::IN_OPTIONAL_PART) && !($cursor & self::IN_VARIABLE)) { + if (!($cursor & self::IN_OCCUPIED_PART)) { $left .= $route[$offset]; } else { $right .= $route[$offset]; @@ -197,7 +197,7 @@ public static function parseRoute(string $route): array } // https://www.pcre.org/original/doc/html/pcrepattern.html#SEC16 - if (($cursor & $inVariableName)) { + if (($cursor & self::IN_VARIABLE_NAME)) { if (!isset($variables[$variable]['name']) && $route[$offset] >= '0' && $route[$offset] <= '9') { throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . @@ -231,7 +231,7 @@ public static function parseRoute(string $route): array continue; } - if (($cursor & $inVariablePattern)) { + if (($cursor & self::IN_VARIABLE_PATTERN)) { if ($route[$offset] === RouteCompiler::PATTERN_DELIMITER) { throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . @@ -251,7 +251,7 @@ public static function parseRoute(string $route): array // {foo<\w+>xxx} // ~~~~~~~~~^^^~ - if (($cursor & $inVariable)) { + if (($cursor & self::IN_VARIABLE)) { throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An unexpected character was found at position %d; a variable at this position must be closed.', @@ -261,7 +261,7 @@ public static function parseRoute(string $route): array } } - if (($cursor & $inVariable) || ($cursor & $inOptionalPart)) { + if (($cursor & self::IN_VARIABLE) || ($cursor & self::IN_OPTIONAL_PART)) { throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An attempt to parse the route has failed because it contains an unclosed optional part or variable.', diff --git a/src/Helper/RouteSimplifier.php b/src/Helper/RouteSimplifier.php index ec1288ad..17318be9 100644 --- a/src/Helper/RouteSimplifier.php +++ b/src/Helper/RouteSimplifier.php @@ -37,6 +37,8 @@ public static function simplifyRoute(string $route): string $replace[] = '{' . $variable['name'] . '}'; } + // will be replaced by an empty string: + // https://github.com/php/php-src/blob/a04577fb4ab5e1ebc7779608523b95ddf01e6c7f/ext/standard/string.c#L4406-L4408 $search[] = '('; $search[] = ')'; diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 61a39b63..84ad846e 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -18,7 +18,7 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\ServerRequest; @@ -43,7 +43,7 @@ final class JsonPayloadDecodingMiddleware implements MiddlewareInterface */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if (ServerRequest::create($request)->clientProducesMediaType(new ServerMediaType('application', 'json'))) { + if (ServerRequest::create($request)->clientProducesMediaType(...MediaTypeFactory::json())) { $request = $request->withParsedBody($this->decodePayload($request->getBody()->__toString())); } diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index aef333ea..2109d85f 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -46,7 +46,7 @@ public function __construct( } /** - * @throws InvalidReferenceException If the requst handler couldn't be resolved. + * @throws InvalidReferenceException */ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface { @@ -84,7 +84,7 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface } /** - * @throws InvalidReferenceException If the middleware couldn't be resolved. + * @throws InvalidReferenceException */ public function resolveMiddleware(mixed $reference): MiddlewareInterface { diff --git a/src/ServerRequest.php b/src/ServerRequest.php index d4cb200f..179790ed 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -138,10 +138,9 @@ public function getClientPreferredMediaType(MediaTypeInterface ...$serverProduce return null; } - $mediaTypeComparator = new MediaTypeComparator(); foreach ($this->getClientConsumedMediaTypes() as $clientConsumedMediaType) { foreach ($serverProducedMediaTypes as $serverProducedMediaType) { - if ($mediaTypeComparator->equals($clientConsumedMediaType, $serverProducedMediaType)) { + if (MediaTypeComparator::equals($clientConsumedMediaType, $serverProducedMediaType)) { return $clientConsumedMediaType; } } @@ -156,10 +155,9 @@ public function getClientPreferredLanguage(LanguageInterface ...$serverProducedL return null; } - $languageComparator = new LanguageComparator(); foreach ($this->getClientConsumedLanguages() as $clientConsumedLanguage) { foreach ($serverProducedLanguages as $serverProducedLanguage) { - if ($languageComparator->equals($clientConsumedLanguage, $serverProducedLanguage)) { + if (LanguageComparator::equals($clientConsumedLanguage, $serverProducedLanguage)) { return $clientConsumedLanguage; } } @@ -180,9 +178,8 @@ public function clientProducesMediaType(MediaTypeInterface ...$serverConsumedMed return false; } - $mediaTypeComparator = new MediaTypeComparator(); foreach ($serverConsumedMediaTypes as $serverConsumedMediaType) { - if ($mediaTypeComparator->equals($clientProducedMediaType, $serverConsumedMediaType)) { + if (MediaTypeComparator::equals($clientProducedMediaType, $serverConsumedMediaType)) { return true; } } From d56bcc9625e318581630402f8f1429b3aeefec9f Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Tue, 12 Mar 2024 04:47:26 +0100 Subject: [PATCH 133/180] v3 --- src/Helper/FilesystemHelper.php | 10 ++-------- src/Helper/RouteBuilder.php | 2 +- src/Helper/RouteMatcher.php | 6 +++--- .../JsonPayloadDecodingMiddleware.php | 18 ++++++++++++++++-- .../PayloadMediaTypeNegotiationMiddleware.php | 16 ++++++++++------ src/Router.php | 3 ++- src/ServerRequest.php | 2 +- tests/Helper/RouteParserTest.php | 4 ++-- 8 files changed, 37 insertions(+), 24 deletions(-) diff --git a/src/Helper/FilesystemHelper.php b/src/Helper/FilesystemHelper.php index 2dce82bd..75f5eed4 100644 --- a/src/Helper/FilesystemHelper.php +++ b/src/Helper/FilesystemHelper.php @@ -41,10 +41,7 @@ final class FilesystemHelper public static function getDirClasses(string $dirname): Generator { if (!is_dir($dirname)) { - throw new InvalidArgumentException(sprintf( - 'The directory %s does not exist.', - $dirname, - )); + throw new InvalidArgumentException(sprintf('The directory %s does not exist.', $dirname)); } /** @var array $filenames */ @@ -84,10 +81,7 @@ public static function getDirClasses(string $dirname): Generator public static function getFileClasses(string $filename): Generator { if (!is_file($filename)) { - throw new InvalidArgumentException(sprintf( - 'The file %s does not exist.', - $filename, - )); + throw new InvalidArgumentException(sprintf('The file %s does not exist.', $filename)); } $filename = realpath($filename); diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index 2c3e8033..97a1a27b 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -87,7 +87,7 @@ public static function buildRoute(string $route, array $values = []): string /** * @throws InvalidArgumentException */ - private static function stringifyValue(mixed $value): string + public static function stringifyValue(mixed $value): string { if (is_string($value)) { return $value; diff --git a/src/Helper/RouteMatcher.php b/src/Helper/RouteMatcher.php index 6eb280d5..ce8dda24 100644 --- a/src/Helper/RouteMatcher.php +++ b/src/Helper/RouteMatcher.php @@ -62,14 +62,14 @@ public static function matchPattern(string $route, string $pattern, string $subj if (($result = @preg_match($pattern, $subject, $matches, PREG_UNMATCHED_AS_NULL)) === false) { throw new ErrorException(preg_last_error_msg(), preg_last_error(), E_WARNING); } - } catch (Throwable) { + } catch (Throwable $e) { // a client side error; must be handled as 4xx error. if (preg_last_error() === PREG_BAD_UTF8_ERROR) { throw new InvalidRouteMatchingSubjectException(sprintf( 'The route %s could not be matched with an invalid subject due to: %s.', RouteSimplifier::simplifyRoute($route), preg_last_error_msg(), - )); + ), preg_last_error(), $e); } // a server side error; must be handled as 5xx error. @@ -79,7 +79,7 @@ public static function matchPattern(string $route, string $pattern, string $subj 'Please refer to the official documentation: https://www.php.net/preg_last_error', $route, preg_last_error_msg(), - ), preg_last_error()); + ), preg_last_error(), $e); } foreach ($matches as $key => $match) { diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 84ad846e..cb16e47d 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -36,6 +36,18 @@ */ final class JsonPayloadDecodingMiddleware implements MiddlewareInterface { + public const DEFAULT_DECODING_FLAGS = JSON_BIGINT_AS_STRING; + public const DEFAULT_DECODING_DEPTH = 512; + + /** + * @since 3.0.0 + */ + public function __construct( + private readonly int $decodingFlags = self::DEFAULT_DECODING_FLAGS, + private readonly int $decodingDepth = self::DEFAULT_DECODING_DEPTH, + ) { + } + /** * @inheritDoc * @@ -62,9 +74,11 @@ private function decodePayload(string $payload): array } try { - $data = json_decode($payload, true, flags: JSON_BIGINT_AS_STRING | JSON_THROW_ON_ERROR); + /** @psalm-suppress ArgumentTypeCoercion */ + $data = json_decode($payload, true, $this->decodingDepth, $this->decodingFlags | JSON_THROW_ON_ERROR); } catch (JsonException $e) { - throw HttpExceptionFactory::invalidJsonPayload(previous: $e); + throw HttpExceptionFactory::invalidJsonPayload(previous: $e) + ->addMessagePlaceholder('{{ details }}', $e->getMessage()); } if (is_array($data) === false) { diff --git a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php index 4d67c023..c13d489f 100644 --- a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php +++ b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php @@ -37,13 +37,17 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface { $serverRequest = ServerRequest::create($request); $serverConsumedMediaTypes = array_values($serverRequest->getRoute()->getConsumedMediaTypes()); - if (! $serverRequest->clientProducesMediaType(...$serverConsumedMediaTypes)) { - $clientProducedMediaType = $serverRequest->getClientProducedMediaType(); - if ($clientProducedMediaType === null) { - throw HttpExceptionFactory::mediaTypeNotProvided() - ->addHeaderField('Accept', ...$serverConsumedMediaTypes); - } + if ($serverConsumedMediaTypes === []) { + return $handler->handle($request); + } + + $clientProducedMediaType = $serverRequest->getClientProducedMediaType(); + if ($clientProducedMediaType === null) { + throw HttpExceptionFactory::mediaTypeNotProvided() + ->addHeaderField('Accept', ...$serverConsumedMediaTypes); + } + if (! $serverRequest->clientProducesMediaType(...$serverConsumedMediaTypes)) { throw HttpExceptionFactory::mediaTypeNotSupported() ->addMessagePlaceholder('{{ media_type }}', $clientProducedMediaType) ->addHeaderField('Accept', ...$serverConsumedMediaTypes); diff --git a/src/Router.php b/src/Router.php index 1493f4be..2cb27a4a 100644 --- a/src/Router.php +++ b/src/Router.php @@ -145,7 +145,8 @@ public function match(ServerRequestInterface $request): RouteInterface try { $isRouteMatched = RouteMatcher::matchPattern($route->getPath(), $routePattern, $requestPath, $matches); } catch (InvalidRouteMatchingSubjectException $e) { - throw HttpExceptionFactory::invalidUri(previous: $e); + throw HttpExceptionFactory::invalidUri(previous: $e) + ->addMessagePlaceholder('{{ details }}', $e->getPrevious()?->getMessage()); } if (!$isRouteMatched) { diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 179790ed..cf409740 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -41,7 +41,7 @@ public function __construct(private ServerRequestInterface $request) public static function create(ServerRequestInterface $request): self { - return new self($request); + return $request instanceof self ? $request : new self($request); } /** diff --git a/tests/Helper/RouteParserTest.php b/tests/Helper/RouteParserTest.php index dd86efac..5b7dda71 100644 --- a/tests/Helper/RouteParserTest.php +++ b/tests/Helper/RouteParserTest.php @@ -24,10 +24,10 @@ public function testParseValidRoute(string $route, array $expectedVariables): vo /** * @dataProvider invalidRouteDataProvider */ - public function testParseInvalidRoute(string $route, string $expectedMessage): void + public function testParseInvalidRoute(string $route, string $expectedMessageRegex): void { $this->expectException(InvalidRouteParsingSubjectException::class); - $this->expectExceptionMessageMatches($expectedMessage); + $this->expectExceptionMessageMatches($expectedMessageRegex); RouteParser::parseRoute($route); } From fd091ea4605773c25efd5e8a1260e490f6f35afa Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Tue, 12 Mar 2024 21:20:40 +0100 Subject: [PATCH 134/180] v3 --- src/Command/RouteListCommand.php | 2 +- src/Dictionary/ErrorMessage.php | 22 +++++++------- src/Entity/MediaType/MediaTypeFactory.php | 30 ------------------- src/Exception/HttpExceptionFactory.php | 12 ++++---- src/Helper/FilesystemHelper.php | 1 + src/Helper/RouteBuilder.php | 11 ++++--- src/Helper/RouteMatcher.php | 12 ++++---- src/Loader/DescriptorLoader.php | 4 +-- .../JsonPayloadDecodingMiddleware.php | 9 +++--- .../PayloadMediaTypeNegotiationMiddleware.php | 4 +-- src/ParameterResolver.php | 7 +++++ .../DependencyInjectionParameterResolver.php | 5 ++++ .../ObjectInjectionParameterResolver.php | 5 ++++ .../ParameterResolverInterface.php | 2 ++ .../RequestBodyParameterResolver.php | 5 ++++ .../RequestCookieParameterResolver.php | 5 ++++ .../RequestHeaderParameterResolver.php | 5 ++++ .../RequestQueryParameterResolver.php | 5 ++++ .../RequestVariableParameterResolver.php | 5 ++++ src/ReferenceResolver.php | 28 ++++++++++++++--- src/Router.php | 16 ++++------ 21 files changed, 111 insertions(+), 84 deletions(-) delete mode 100644 src/Entity/MediaType/MediaTypeFactory.php diff --git a/src/Command/RouteListCommand.php b/src/Command/RouteListCommand.php index 1ef33a19..285162c7 100644 --- a/src/Command/RouteListCommand.php +++ b/src/Command/RouteListCommand.php @@ -50,7 +50,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int $table->addRow([ $route->getName(), $route->getPath(), - $route->getMethods() === [] ? 'ANY' : join(', ', $route->getMethods()), + $route->getMethods() === [] ? '*' : join(', ', $route->getMethods()), ]); } diff --git a/src/Dictionary/ErrorMessage.php b/src/Dictionary/ErrorMessage.php index 60271c72..4f628f7f 100644 --- a/src/Dictionary/ErrorMessage.php +++ b/src/Dictionary/ErrorMessage.php @@ -18,18 +18,18 @@ */ final class ErrorMessage { - public const INVALID_URI = 'The request URI is invalid and cannot be accepted by the server.'; - public const ROUTE_NOT_FOUND = 'The requested resource at the URI {{ request_uri }} was not found.'; - public const METHOD_NOT_ALLOWED = 'The requested method {{ request_method }} is not allowed; please check the Allow response header for allowed methods.'; - public const MEDIA_TYPE_NOT_PROVIDED = 'The Content-Type header must be provided and cannot be empty; please check the Accept response header for supported media types.'; - public const MEDIA_TYPE_NOT_SUPPORTED = 'The media type {{ media_type }} is not supported; please check the Accept response header for supported media types.'; - public const INVALID_VARIABLE = 'The variable {{ variable_name }} in the URI {{ route_uri }} is invalid.'; - public const INVALID_QUERY = 'The query parameters are invalid.'; - public const MISSING_HEADER = 'The header {{ header_name }} must be provided.'; - public const INVALID_HEADER = 'The header {{ header_name }} is invalid.'; - public const MISSING_COOKIE = 'The cookie {{ cookie_name }} must be provided.'; + public const INVALID_URI = 'The provided request URI is invalid and cannot be accepted by the server.'; + public const RESOURCE_NOT_FOUND = 'The requested resource could not be found for this URI.'; + public const METHOD_NOT_ALLOWED = 'The requested method is not allowed for this resource; Please check the Allow response header for allowed methods.'; + public const MISSING_MEDIA_TYPE = 'The Content-Type request header must be provided and cannot be empty; Please check the Accept response header for supported media types.'; + public const UNSUPPORTED_MEDIA_TYPE = 'The media type {{ media_type }} is not supported; Check the Accept response header for supported media types.'; + public const INVALID_VARIABLE = 'The provided value of the variable {{ variable_name }} in the URI pattern {{ route_uri }} is invalid.'; + public const INVALID_QUERY = 'The provided request query parameters are invalid.'; + public const MISSING_HEADER = 'The request header {{ header_name }} must be provided.'; + public const INVALID_HEADER = 'The provided request header {{ header_name }} is invalid.'; + public const MISSING_COOKIE = 'The cookie {{ cookie_name }} is missing.'; public const INVALID_COOKIE = 'The cookie {{ cookie_name }} is invalid.'; - public const INVALID_BODY = 'The request body is invalid.'; + public const INVALID_BODY = 'The provided request body is invalid.'; public const EMPTY_JSON_PAYLOAD = 'The JSON payload cannot be empty.'; public const INVALID_JSON_PAYLOAD = 'The JSON payload is invalid.'; public const INVALID_JSON_PAYLOAD_FORM = 'The JSON payload must be in the form of an array or an object.'; diff --git a/src/Entity/MediaType/MediaTypeFactory.php b/src/Entity/MediaType/MediaTypeFactory.php deleted file mode 100644 index ea47298a..00000000 --- a/src/Entity/MediaType/MediaTypeFactory.php +++ /dev/null @@ -1,30 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Entity\MediaType; - -use Generator; - -/** - * @since 3.0.0 - */ -final class MediaTypeFactory -{ - /** - * @return Generator - */ - public static function json(): Generator - { - yield new ServerMediaType('application', 'json'); - } -} diff --git a/src/Exception/HttpExceptionFactory.php b/src/Exception/HttpExceptionFactory.php index b1e99038..455c7c10 100644 --- a/src/Exception/HttpExceptionFactory.php +++ b/src/Exception/HttpExceptionFactory.php @@ -34,13 +34,13 @@ public static function invalidUri( ); } - public static function routeNotFound( + public static function resourceNotFound( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::ROUTE_NOT_FOUND, + message: $message ?? ErrorMessage::RESOURCE_NOT_FOUND, code: $code ?? StatusCodeInterface::STATUS_NOT_FOUND, previous: $previous, ); @@ -58,25 +58,25 @@ public static function methodNotAllowed( ); } - public static function mediaTypeNotProvided( + public static function missingMediaType( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::MEDIA_TYPE_NOT_PROVIDED, + message: $message ?? ErrorMessage::MISSING_MEDIA_TYPE, code: $code ?? StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE, previous: $previous, ); } - public static function mediaTypeNotSupported( + public static function unsupportedMediaType( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::MEDIA_TYPE_NOT_SUPPORTED, + message: $message ?? ErrorMessage::UNSUPPORTED_MEDIA_TYPE, code: $code ?? StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE, previous: $previous, ); diff --git a/src/Helper/FilesystemHelper.php b/src/Helper/FilesystemHelper.php index 75f5eed4..4c6af9b7 100644 --- a/src/Helper/FilesystemHelper.php +++ b/src/Helper/FilesystemHelper.php @@ -85,6 +85,7 @@ public static function getFileClasses(string $filename): Generator } $filename = realpath($filename); + (static function (string $filename): void { require_once $filename; })($filename); diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index 97a1a27b..e2ca8cf5 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router\Helper; use BackedEnum; -use InvalidArgumentException; use Stringable; use Sunrise\Http\Router\Exception\InvalidRouteBuildingValueException; use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; @@ -49,13 +48,13 @@ public static function buildRoute(string $route, array $values = []): string try { $value = self::stringifyValue($value); - } catch (InvalidArgumentException $e) { + } catch (InvalidRouteBuildingValueException $e) { throw new InvalidRouteBuildingValueException(sprintf( 'The route %s could not be built with an invalid value for the variable %s due to: %s', $route, $variable['name'], $e->getMessage(), - ), previous: $e); + )); } $search[] = $statement; @@ -85,9 +84,9 @@ public static function buildRoute(string $route, array $values = []): string } /** - * @throws InvalidArgumentException + * @throws InvalidRouteBuildingValueException */ - public static function stringifyValue(mixed $value): string + private static function stringifyValue(mixed $value): string { if (is_string($value)) { return $value; @@ -102,7 +101,7 @@ public static function stringifyValue(mixed $value): string return $value->__toString(); } - throw new InvalidArgumentException(sprintf( + throw new InvalidRouteBuildingValueException(sprintf( 'The %s value could not be converted to a string; ' . 'supported types: string, integer, backed enum and stringable object.', get_debug_type($value), diff --git a/src/Helper/RouteMatcher.php b/src/Helper/RouteMatcher.php index ce8dda24..4ee64144 100644 --- a/src/Helper/RouteMatcher.php +++ b/src/Helper/RouteMatcher.php @@ -38,9 +38,9 @@ final class RouteMatcher * @param array $patterns * @param-out array $matches * + * @throws InvalidRouteParsingSubjectException * @throws InvalidRouteMatchingPatternException * @throws InvalidRouteMatchingSubjectException - * @throws InvalidRouteParsingSubjectException */ public static function matchRoute(string $route, array $patterns, string $subject, ?array &$matches = null): bool { @@ -62,24 +62,22 @@ public static function matchPattern(string $route, string $pattern, string $subj if (($result = @preg_match($pattern, $subject, $matches, PREG_UNMATCHED_AS_NULL)) === false) { throw new ErrorException(preg_last_error_msg(), preg_last_error(), E_WARNING); } - } catch (Throwable $e) { - // a client side error; must be handled as 4xx error. + } catch (Throwable) { if (preg_last_error() === PREG_BAD_UTF8_ERROR) { throw new InvalidRouteMatchingSubjectException(sprintf( 'The route %s could not be matched with an invalid subject due to: %s.', - RouteSimplifier::simplifyRoute($route), + $route, preg_last_error_msg(), - ), preg_last_error(), $e); + )); } - // a server side error; must be handled as 5xx error. throw new InvalidRouteMatchingPatternException(sprintf( 'The route %s could not be matched due to: %s; ' . 'most likely, this problem is related to one of the route patterns. ' . 'Please refer to the official documentation: https://www.php.net/preg_last_error', $route, preg_last_error_msg(), - ), preg_last_error(), $e); + ), preg_last_error()); } foreach ($matches as $key => $match) { diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index aa57e8d9..f414cfe3 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -66,9 +66,9 @@ public function __construct( /** * @inheritDoc * + * @throws CacheException * @throws InvalidRouteLoadingResourceException * @throws InvalidRouteParsingSubjectException - * @throws CacheException */ public function load(): Generator { @@ -96,9 +96,9 @@ public function load(): Generator /** * @return list * + * @throws CacheException * @throws InvalidRouteLoadingResourceException * @throws InvalidRouteParsingSubjectException - * @throws CacheException */ private function getDescriptors(): array { diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index cb16e47d..b4f2f821 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -18,7 +18,7 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\ServerRequest; @@ -55,7 +55,7 @@ public function __construct( */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if (ServerRequest::create($request)->clientProducesMediaType(...MediaTypeFactory::json())) { + if (ServerRequest::create($request)->clientProducesMediaType(new ServerMediaType('application', 'json'))) { $request = $request->withParsedBody($this->decodePayload($request->getBody()->__toString())); } @@ -77,11 +77,10 @@ private function decodePayload(string $payload): array /** @psalm-suppress ArgumentTypeCoercion */ $data = json_decode($payload, true, $this->decodingDepth, $this->decodingFlags | JSON_THROW_ON_ERROR); } catch (JsonException $e) { - throw HttpExceptionFactory::invalidJsonPayload(previous: $e) - ->addMessagePlaceholder('{{ details }}', $e->getMessage()); + throw HttpExceptionFactory::invalidJsonPayload(previous: $e); } - if (is_array($data) === false) { + if (!is_array($data)) { throw HttpExceptionFactory::invalidJsonPayloadForm(); } diff --git a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php index c13d489f..f268ece5 100644 --- a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php +++ b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php @@ -43,12 +43,12 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface $clientProducedMediaType = $serverRequest->getClientProducedMediaType(); if ($clientProducedMediaType === null) { - throw HttpExceptionFactory::mediaTypeNotProvided() + throw HttpExceptionFactory::missingMediaType() ->addHeaderField('Accept', ...$serverConsumedMediaTypes); } if (! $serverRequest->clientProducesMediaType(...$serverConsumedMediaTypes)) { - throw HttpExceptionFactory::mediaTypeNotSupported() + throw HttpExceptionFactory::unsupportedMediaType() ->addMessagePlaceholder('{{ media_type }}', $clientProducedMediaType) ->addHeaderField('Accept', ...$serverConsumedMediaTypes); } diff --git a/src/ParameterResolver.php b/src/ParameterResolver.php index e57bc083..70c2a43a 100644 --- a/src/ParameterResolver.php +++ b/src/ParameterResolver.php @@ -23,6 +23,7 @@ use function array_unshift; use function sprintf; +use function usort; /** * @since 3.0.0 @@ -35,6 +36,12 @@ public function __construct( /** @var ParameterResolverInterface[] */ private array $resolvers, ) { + usort($this->resolvers, static fn( + ParameterResolverInterface $a, + ParameterResolverInterface $b, + ): int => ( + $b->getWeight() <=> $a->getWeight() + )); } public function withRequest(ServerRequestInterface $request): self diff --git a/src/ParameterResolver/DependencyInjectionParameterResolver.php b/src/ParameterResolver/DependencyInjectionParameterResolver.php index df116b7f..315029e9 100644 --- a/src/ParameterResolver/DependencyInjectionParameterResolver.php +++ b/src/ParameterResolver/DependencyInjectionParameterResolver.php @@ -46,4 +46,9 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI yield $this->container->get($typeName); } } + + public function getWeight(): int + { + return -100; + } } diff --git a/src/ParameterResolver/ObjectInjectionParameterResolver.php b/src/ParameterResolver/ObjectInjectionParameterResolver.php index 46d00d79..c0549bbd 100644 --- a/src/ParameterResolver/ObjectInjectionParameterResolver.php +++ b/src/ParameterResolver/ObjectInjectionParameterResolver.php @@ -43,4 +43,9 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI yield $this->object; } } + + public function getWeight(): int + { + return 0; + } } diff --git a/src/ParameterResolver/ParameterResolverInterface.php b/src/ParameterResolver/ParameterResolverInterface.php index 6aa0d920..e1771b77 100644 --- a/src/ParameterResolver/ParameterResolverInterface.php +++ b/src/ParameterResolver/ParameterResolverInterface.php @@ -26,4 +26,6 @@ interface ParameterResolverInterface * @return Generator */ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator; + + public function getWeight(): int; } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 0fa75498..7434e2f4 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -92,4 +92,9 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI yield $argument; } + + public function getWeight(): int + { + return 90; + } } diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index cece5874..e1ab84ae 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -100,4 +100,9 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI yield $argument; } + + public function getWeight(): int + { + return 60; + } } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index bcf54a3b..80548191 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -98,4 +98,9 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI yield $argument; } + + public function getWeight(): int + { + return 70; + } } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 2bf4e644..3e9a42bd 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -92,4 +92,9 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI yield $argument; } + + public function getWeight(): int + { + return 80; + } } diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index b5625a66..e770941a 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -114,4 +114,9 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI yield $argument; } + + public function getWeight(): int + { + return 100; + } } diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index 2109d85f..1147a09a 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -14,6 +14,9 @@ namespace Sunrise\Http\Router; use Closure; +use InvalidArgumentException; +use Psr\Container\ContainerExceptionInterface; +use Psr\Container\ContainerInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; @@ -42,6 +45,7 @@ public function __construct( private readonly ClassResolver $classResolver, private readonly ParameterResolver $parameterResolver, private readonly ResponseResolver $responseResolver, + private readonly ?ContainerInterface $container, ) { } @@ -63,7 +67,7 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface /** @var array{0: string|object, 1: string} $reference */ if (is_string($reference[0]) && class_exists($reference[0])) { - $reference[0] = $this->classResolver->resolveClass($reference[0]); + $reference[0] = $this->resolveClass($reference[0]); } if (is_callable($reference)) { @@ -74,7 +78,7 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface } if (is_string($reference) && is_subclass_of($reference, RequestHandlerInterface::class)) { - return $this->classResolver->resolveClass($reference); + return $this->resolveClass($reference); } throw new InvalidReferenceException(sprintf( @@ -97,7 +101,7 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface } if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { - return $this->classResolver->resolveClass($reference); + return $this->resolveClass($reference); } // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 @@ -105,7 +109,7 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface /** @var array{0: string|object, 1: string} $reference */ if (is_string($reference[0]) && class_exists($reference[0])) { - $reference[0] = $this->classResolver->resolveClass($reference[0]); + $reference[0] = $this->resolveClass($reference[0]); } if (is_callable($reference)) { @@ -168,6 +172,22 @@ private function createMiddlewareCallback( ); } + /** + * @param class-string $className + * + * @return T + * + * @template T of object + * + * @throws InvalidArgumentException + * @throws ContainerExceptionInterface + */ + private function resolveClass(string $className): object + { + /** @var T */ + return $this->container?->has($className) ? $this->container->get($className) : $this->classResolver->resolveClass($className); + } + private static function stringifyReference(mixed $reference): string { return is_callable($reference, true, $result) ? $result : get_debug_type($reference); diff --git a/src/Router.php b/src/Router.php index 2cb27a4a..da9a0f64 100644 --- a/src/Router.php +++ b/src/Router.php @@ -13,6 +13,7 @@ namespace Sunrise\Http\Router; +use Psr\Container\ContainerInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; @@ -61,18 +62,17 @@ class Router implements RequestHandlerInterface private array $routeRequestHandlers = []; /** + * @param MiddlewareInterface[] $middlewares * @param ParameterResolverInterface[] $parameterResolvers * @param ResponseResolverInterface[] $responseResolvers - * @param LoaderInterface[] $loaders * * @since 3.0.0 */ public function __construct( - /** @var MiddlewareInterface[] */ private readonly array $middlewares = [], array $parameterResolvers = [], array $responseResolvers = [], - array $loaders = [], + ?ContainerInterface $container = null, ) { $parameterResolver = new ParameterResolver($parameterResolvers); $responseResolver = new ResponseResolver($responseResolvers); @@ -82,11 +82,8 @@ public function __construct( classResolver: $classResolver, parameterResolver: $parameterResolver, responseResolver: $responseResolver, + container: $container, ); - - foreach ($loaders as $loader) { - $this->load($loader); - } } /** @@ -145,8 +142,7 @@ public function match(ServerRequestInterface $request): RouteInterface try { $isRouteMatched = RouteMatcher::matchPattern($route->getPath(), $routePattern, $requestPath, $matches); } catch (InvalidRouteMatchingSubjectException $e) { - throw HttpExceptionFactory::invalidUri(previous: $e) - ->addMessagePlaceholder('{{ details }}', $e->getPrevious()?->getMessage()); + throw HttpExceptionFactory::invalidUri(previous: $e); } if (!$isRouteMatched) { @@ -167,7 +163,7 @@ public function match(ServerRequestInterface $request): RouteInterface ->addHeaderField('Allow', ...array_keys($allowedMethods)); } - throw HttpExceptionFactory::routeNotFound() + throw HttpExceptionFactory::resourceNotFound() ->addMessagePlaceholder('{{ request_uri }}', $requestPath); } From 964c8a9d637f7ac88bad6ee59cd37154bf0f74a9 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Wed, 13 Mar 2024 06:15:45 +0100 Subject: [PATCH 135/180] v3 --- src/ClassResolver.php | 32 +++++++++-------- ...anguage.php => ClassResolverInterface.php} | 23 ++++++------ src/Dictionary/ErrorMessage.php | 2 +- src/Entity/MediaType/MediaTypeFactory.php | 35 +++++++++++++++++++ src/Helper/RouteBuilder.php | 4 +-- src/Loader/DescriptorLoader.php | 4 --- .../JsonPayloadDecodingMiddleware.php | 4 +-- .../RequestVariableParameterResolver.php | 2 +- src/ReferenceResolver.php | 2 +- src/Router.php | 5 ++- 10 files changed, 76 insertions(+), 37 deletions(-) rename src/{Entity/Language/ServerLanguage.php => ClassResolverInterface.php} (55%) create mode 100644 src/Entity/MediaType/MediaTypeFactory.php diff --git a/src/ClassResolver.php b/src/ClassResolver.php index 2449e672..6462bd7d 100644 --- a/src/ClassResolver.php +++ b/src/ClassResolver.php @@ -22,7 +22,7 @@ /** * @since 3.0.0 */ -final class ClassResolver +final class ClassResolver implements ClassResolverInterface { /** * @var array @@ -35,7 +35,9 @@ public function __construct( } /** - * @param class-string $fqn + * {@inheritDoc} + * + * @param class-string $className * * @return T * @@ -43,28 +45,30 @@ public function __construct( * * @throws InvalidArgumentException If the class cannot be resolved. */ - public function resolveClass(string $fqn): object + public function resolveClass(string $className): object { - if (isset($this->resolvedClasses[$fqn])) { + if (isset($this->resolvedClasses[$className])) { /** @var T */ - return $this->resolvedClasses[$fqn]; + return $this->resolvedClasses[$className]; } - if (!class_exists($fqn)) { - throw new InvalidArgumentException(sprintf('The class %s does not exist.', $fqn)); + if (!class_exists($className)) { + throw new InvalidArgumentException(sprintf('The class %s does not exist.', $className)); } - /** @var ReflectionClass $reflection */ - $reflection = new ReflectionClass($fqn); + /** @var ReflectionClass $classReflection */ + $classReflection = new ReflectionClass($className); - if (!$reflection->isInstantiable()) { - throw new InvalidArgumentException(sprintf('The class %s is not instantiable.', $fqn)); + if (!$classReflection->isInstantiable()) { + throw new InvalidArgumentException(sprintf('The class %s is not instantiable.', $className)); } - $arguments = $this->parameterResolver->resolveParameters( - ...($reflection->getConstructor()?->getParameters() ?? []) + $this->resolvedClasses[$className] = $classReflection->newInstance( + ...$this->parameterResolver->resolveParameters( + ...($classReflection->getConstructor()?->getParameters() ?? []) + ) ); - return $this->resolvedClasses[$fqn] = $reflection->newInstance(...$arguments); + return $this->resolvedClasses[$className]; } } diff --git a/src/Entity/Language/ServerLanguage.php b/src/ClassResolverInterface.php similarity index 55% rename from src/Entity/Language/ServerLanguage.php rename to src/ClassResolverInterface.php index ef184b41..73410d6e 100644 --- a/src/Entity/Language/ServerLanguage.php +++ b/src/ClassResolverInterface.php @@ -11,20 +11,21 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Entity\Language; +namespace Sunrise\Http\Router; /** * @since 3.0.0 */ -final class ServerLanguage implements LanguageInterface +interface ClassResolverInterface { - public function __construct( - private readonly string $code, - ) { - } - - public function getCode(): string - { - return $this->code; - } + /** + * Tries to resolve the given named class + * + * @param class-string $className + * + * @return T + * + * @template T of object + */ + public function resolveClass(string $className): object; } diff --git a/src/Dictionary/ErrorMessage.php b/src/Dictionary/ErrorMessage.php index 4f628f7f..4cb72b01 100644 --- a/src/Dictionary/ErrorMessage.php +++ b/src/Dictionary/ErrorMessage.php @@ -23,7 +23,7 @@ final class ErrorMessage public const METHOD_NOT_ALLOWED = 'The requested method is not allowed for this resource; Please check the Allow response header for allowed methods.'; public const MISSING_MEDIA_TYPE = 'The Content-Type request header must be provided and cannot be empty; Please check the Accept response header for supported media types.'; public const UNSUPPORTED_MEDIA_TYPE = 'The media type {{ media_type }} is not supported; Check the Accept response header for supported media types.'; - public const INVALID_VARIABLE = 'The provided value of the variable {{ variable_name }} in the URI pattern {{ route_uri }} is invalid.'; + public const INVALID_VARIABLE = 'The provided value of the variable {{{ variable_name }}} in the URI pattern {{ route_uri }} is invalid.'; public const INVALID_QUERY = 'The provided request query parameters are invalid.'; public const MISSING_HEADER = 'The request header {{ header_name }} must be provided.'; public const INVALID_HEADER = 'The provided request header {{ header_name }} is invalid.'; diff --git a/src/Entity/MediaType/MediaTypeFactory.php b/src/Entity/MediaType/MediaTypeFactory.php new file mode 100644 index 00000000..ce7bd6b1 --- /dev/null +++ b/src/Entity/MediaType/MediaTypeFactory.php @@ -0,0 +1,35 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Entity\MediaType; + +/** + * @since 3.0.0 + */ +final class MediaTypeFactory +{ + public static function json(): MediaTypeInterface + { + return new ServerMediaType('application', 'json'); + } + + public static function xml(): MediaTypeInterface + { + return new ServerMediaType('application', 'xml'); + } + + public static function html(): MediaTypeInterface + { + return new ServerMediaType('text', 'html'); + } +} diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index e2ca8cf5..0dee43b7 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -50,7 +50,7 @@ public static function buildRoute(string $route, array $values = []): string $value = self::stringifyValue($value); } catch (InvalidRouteBuildingValueException $e) { throw new InvalidRouteBuildingValueException(sprintf( - 'The route %s could not be built with an invalid value for the variable %s due to: %s', + 'The route %s could not be built with an invalid value for the variable {%s} due to: %s', $route, $variable['name'], $e->getMessage(), @@ -69,7 +69,7 @@ public static function buildRoute(string $route, array $values = []): string } throw new InvalidRouteBuildingValueException(sprintf( - 'The route %s could not be built without a required value for the variable %s.', + 'The route %s could not be built without a required value for the variable {%s}.', $route, $variable['name'], )); diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index f414cfe3..ec54f6cf 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -42,13 +42,11 @@ use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Route; -use function array_map; use function class_exists; use function is_dir; use function is_file; use function join; use function sprintf; -use function strtoupper; use function usort; final class DescriptorLoader implements LoaderInterface @@ -325,8 +323,6 @@ private function completeDescriptor(Descriptor $descriptor): void { $descriptor->path = join($descriptor->prefixes) . $descriptor->path; - $descriptor->methods = array_map(strtoupper(...), $descriptor->methods); - $descriptor->pattern = RouteCompiler::compileRoute($descriptor->path, $descriptor->patterns); } } diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index b4f2f821..bd9f866e 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -18,7 +18,7 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\ServerRequest; @@ -55,7 +55,7 @@ public function __construct( */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if (ServerRequest::create($request)->clientProducesMediaType(new ServerMediaType('application', 'json'))) { + if (ServerRequest::create($request)->clientProducesMediaType(MediaTypeFactory::json())) { $request = $request->withParsedBody($this->decodePayload($request->getBody()->__toString())); } diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index e770941a..be2252d4 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -78,7 +78,7 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI } throw new InvalidParameterException(sprintf( - 'The parameter %s expects a value of the variable %s from the route %s ' . + 'The parameter %s expects a value of the variable {%s} from the route %s ' . 'which is not present in the request, most likely, because the variable is optional. ' . 'To resolve this issue, assign the default value to the parameter.', ParameterResolver::stringifyParameter($parameter), diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index 1147a09a..9168fa8a 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -42,9 +42,9 @@ final class ReferenceResolver { public function __construct( - private readonly ClassResolver $classResolver, private readonly ParameterResolver $parameterResolver, private readonly ResponseResolver $responseResolver, + private readonly ClassResolverInterface $classResolver, private readonly ?ContainerInterface $container, ) { } diff --git a/src/Router.php b/src/Router.php index da9a0f64..55e8beea 100644 --- a/src/Router.php +++ b/src/Router.php @@ -30,6 +30,7 @@ use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Helper\RouteMatcher; use Sunrise\Http\Router\Loader\LoaderInterface; +use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; @@ -74,14 +75,16 @@ public function __construct( array $responseResolvers = [], ?ContainerInterface $container = null, ) { + $parameterResolvers[] = new ObjectInjectionParameterResolver($this); + $parameterResolver = new ParameterResolver($parameterResolvers); $responseResolver = new ResponseResolver($responseResolvers); $classResolver = new ClassResolver($parameterResolver); $this->referenceResolver = new ReferenceResolver( - classResolver: $classResolver, parameterResolver: $parameterResolver, responseResolver: $responseResolver, + classResolver: $classResolver, container: $container, ); } From 74cccde6b13cd0c51a275862d8034befcc18c91d Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Wed, 13 Mar 2024 18:55:41 +0100 Subject: [PATCH 136/180] v3 --- src/ClassResolver.php | 5 +- src/ClassResolverInterface.php | 11 +- ...esolver.php => ParameterResolverChain.php} | 12 +- src/ReferenceResolver.php | 195 ------------------ ...Resolver.php => ResponseResolverChain.php} | 4 +- 5 files changed, 12 insertions(+), 215 deletions(-) rename src/{ParameterResolver.php => ParameterResolverChain.php} (92%) delete mode 100644 src/ReferenceResolver.php rename src/{ResponseResolver.php => ResponseResolverChain.php} (94%) diff --git a/src/ClassResolver.php b/src/ClassResolver.php index 6462bd7d..22352290 100644 --- a/src/ClassResolver.php +++ b/src/ClassResolver.php @@ -11,10 +11,11 @@ declare(strict_types=1); -namespace Sunrise\Http\Router; +namespace Sunrise\Http\Router\ClassResolver; use InvalidArgumentException; use ReflectionClass; +use Sunrise\Http\Router\ParameterResolverChain; use function class_exists; use function sprintf; @@ -30,7 +31,7 @@ final class ClassResolver implements ClassResolverInterface private array $resolvedClasses = []; public function __construct( - private readonly ParameterResolver $parameterResolver, + private readonly ParameterResolverChain $parameterResolver, ) { } diff --git a/src/ClassResolverInterface.php b/src/ClassResolverInterface.php index 73410d6e..a36a3cb4 100644 --- a/src/ClassResolverInterface.php +++ b/src/ClassResolverInterface.php @@ -11,21 +11,12 @@ declare(strict_types=1); -namespace Sunrise\Http\Router; +namespace Sunrise\Http\Router\ClassResolver; /** * @since 3.0.0 */ interface ClassResolverInterface { - /** - * Tries to resolve the given named class - * - * @param class-string $className - * - * @return T - * - * @template T of object - */ public function resolveClass(string $className): object; } diff --git a/src/ParameterResolver.php b/src/ParameterResolverChain.php similarity index 92% rename from src/ParameterResolver.php rename to src/ParameterResolverChain.php index 70c2a43a..c9c735ea 100644 --- a/src/ParameterResolver.php +++ b/src/ParameterResolverChain.php @@ -28,9 +28,9 @@ /** * @since 3.0.0 */ -final class ParameterResolver +final class ParameterResolver implements ParameterResolverChainInterface { - private ?ServerRequestInterface $request = null; + private mixed $context = null; public function __construct( /** @var ParameterResolverInterface[] */ @@ -44,15 +44,15 @@ public function __construct( )); } - public function withRequest(ServerRequestInterface $request): self + public function withContext(mixed $context): static { $clone = clone $this; - $clone->request = $request; + $clone->context = $context; return $clone; } - public function withPriorityResolver(ParameterResolverInterface ...$resolvers): self + public function withPriorityResolver(ParameterResolverInterface ...$resolvers): static { $clone = clone $this; @@ -70,7 +70,7 @@ public function withPriorityResolver(ParameterResolverInterface ...$resolvers): public function resolveParameters(ReflectionParameter ...$parameters): Generator { foreach ($parameters as $parameter) { - yield from $this->resolveParameter($parameter, $this->request); + yield from $this->resolveParameter($parameter, $this->context); } } diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php deleted file mode 100644 index 9168fa8a..00000000 --- a/src/ReferenceResolver.php +++ /dev/null @@ -1,195 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router; - -use Closure; -use InvalidArgumentException; -use Psr\Container\ContainerExceptionInterface; -use Psr\Container\ContainerInterface; -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; -use ReflectionFunction; -use ReflectionMethod; -use Sunrise\Http\Router\Exception\InvalidReferenceException; -use Sunrise\Http\Router\Middleware\CallableMiddleware; -use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; -use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; - -use function class_exists; -use function get_debug_type; -use function is_array; -use function is_callable; -use function is_string; -use function is_subclass_of; -use function sprintf; - -/** - * @since 2.10.0 - */ -final class ReferenceResolver -{ - public function __construct( - private readonly ParameterResolver $parameterResolver, - private readonly ResponseResolver $responseResolver, - private readonly ClassResolverInterface $classResolver, - private readonly ?ContainerInterface $container, - ) { - } - - /** - * @throws InvalidReferenceException - */ - public function resolveRequestHandler(mixed $reference): RequestHandlerInterface - { - if ($reference instanceof RequestHandlerInterface) { - return $reference; - } - - if ($reference instanceof Closure) { - return new CallableRequestHandler($this->createRequestHandlerCallback($reference, new ReflectionFunction($reference))); - } - - // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 - if (is_array($reference) && is_callable($reference, true)) { - /** @var array{0: string|object, 1: string} $reference */ - - if (is_string($reference[0]) && class_exists($reference[0])) { - $reference[0] = $this->resolveClass($reference[0]); - } - - if (is_callable($reference)) { - /** @var array{0: class-string|object, 1: non-empty-string} $reference */ - - return new CallableRequestHandler($this->createRequestHandlerCallback($reference, new ReflectionMethod($reference[0], $reference[1]))); - } - } - - if (is_string($reference) && is_subclass_of($reference, RequestHandlerInterface::class)) { - return $this->resolveClass($reference); - } - - throw new InvalidReferenceException(sprintf( - 'The request handler reference %s could not be resolved.', - self::stringifyReference($reference), - )); - } - - /** - * @throws InvalidReferenceException - */ - public function resolveMiddleware(mixed $reference): MiddlewareInterface - { - if ($reference instanceof MiddlewareInterface) { - return $reference; - } - - if ($reference instanceof Closure) { - return new CallableMiddleware($this->createMiddlewareCallback($reference, new ReflectionFunction($reference))); - } - - if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { - return $this->resolveClass($reference); - } - - // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 - if (is_array($reference) && is_callable($reference, true)) { - /** @var array{0: string|object, 1: string} $reference */ - - if (is_string($reference[0]) && class_exists($reference[0])) { - $reference[0] = $this->resolveClass($reference[0]); - } - - if (is_callable($reference)) { - /** @var array{0: class-string|object, 1: non-empty-string} $reference */ - - return new CallableMiddleware($this->createMiddlewareCallback($reference, new ReflectionMethod($reference[0], $reference[1]))); - } - } - - throw new InvalidReferenceException(sprintf( - 'The middleware reference %s could not be resolved.', - self::stringifyReference($reference), - )); - } - - /** - * @return Closure(ServerRequestInterface=): ResponseInterface - */ - private function createRequestHandlerCallback( - callable $callback, - ReflectionMethod|ReflectionFunction $reflection, - ): Closure { - return fn(ServerRequestInterface $request): ResponseInterface => ( - $this->responseResolver->resolveResponse( - $callback( - ...$this->parameterResolver - ->withRequest($request) - ->withPriorityResolver( - new ObjectInjectionParameterResolver($request), - ) - ->resolveParameters(...$reflection->getParameters()) - ), - $reflection, - $request, - ) - ); - } - - /** - * @return Closure(ServerRequestInterface=, RequestHandlerInterface=): ResponseInterface - */ - private function createMiddlewareCallback( - callable $callback, - ReflectionMethod|ReflectionFunction $reflection, - ): Closure { - return fn(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface => ( - $this->responseResolver->resolveResponse( - $callback( - ...$this->parameterResolver - ->withRequest($request) - ->withPriorityResolver( - new ObjectInjectionParameterResolver($request), - new ObjectInjectionParameterResolver($handler), - ) - ->resolveParameters(...$reflection->getParameters()) - ), - $reflection, - $request, - ) - ); - } - - /** - * @param class-string $className - * - * @return T - * - * @template T of object - * - * @throws InvalidArgumentException - * @throws ContainerExceptionInterface - */ - private function resolveClass(string $className): object - { - /** @var T */ - return $this->container?->has($className) ? $this->container->get($className) : $this->classResolver->resolveClass($className); - } - - private static function stringifyReference(mixed $reference): string - { - return is_callable($reference, true, $result) ? $result : get_debug_type($reference); - } -} diff --git a/src/ResponseResolver.php b/src/ResponseResolverChain.php similarity index 94% rename from src/ResponseResolver.php rename to src/ResponseResolverChain.php index fa12d3d8..307bc6f3 100644 --- a/src/ResponseResolver.php +++ b/src/ResponseResolverChain.php @@ -29,7 +29,7 @@ /** * @since 3.0.0 */ -final class ResponseResolver +final class ResponseResolver implements ResponseResolverChainInterface { public function __construct( /** @var ResponseResolverInterface[] */ @@ -58,7 +58,7 @@ public function resolveResponse( } throw new UnsupportedResponseException(sprintf( - 'The responder %s returned an unsupported response.', + 'The responder %s returned an unsupported response that cannot be resolved.', self::stringifyResponder($responder), )); } From 9502a881f0fb453739ad9abe5f1ccc4d4200a435 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Wed, 13 Mar 2024 19:02:08 +0100 Subject: [PATCH 137/180] v3 --- src/ClassResolver.php | 12 ++- src/ClassResolverInterface.php | 11 ++- src/Middleware/CallbackMiddleware.php | 62 +++++++++++++ src/MiddlewareResolver.php | 91 +++++++++++++++++++ src/MiddlewareResolverInterface.php | 24 +++++ .../DefaultValueParameterResolver.php | 38 ++++++++ .../DependencyInjectionParameterResolver.php | 3 +- .../ObjectInjectionParameterResolver.php | 5 +- .../ParameterResolverInterface.php | 3 +- .../RequestBodyParameterResolver.php | 12 +-- .../RequestCookieParameterResolver.php | 8 +- .../RequestHeaderParameterResolver.php | 10 +- .../RequestQueryParameterResolver.php | 12 +-- .../RequestVariableParameterResolver.php | 12 +-- src/ParameterResolverChain.php | 18 ++-- src/ParameterResolverChainInterface.php | 33 +++++++ src/RequestHandler/CallbackRequestHandler.php | 60 ++++++++++++ src/RequestHandlerResolver.php | 91 +++++++++++++++++++ src/RequestHandlerResolverInterface.php | 24 +++++ .../EmptyResponseResolver.php | 5 + src/ResponseResolver/JsonResponseResolver.php | 9 +- .../ResponseResolverInterface.php | 2 + src/ResponseResolverChain.php | 9 +- src/ResponseResolverChainInterface.php | 31 +++++++ src/Router.php | 42 ++++----- 25 files changed, 552 insertions(+), 75 deletions(-) create mode 100644 src/Middleware/CallbackMiddleware.php create mode 100644 src/MiddlewareResolver.php create mode 100644 src/MiddlewareResolverInterface.php create mode 100644 src/ParameterResolver/DefaultValueParameterResolver.php create mode 100644 src/ParameterResolverChainInterface.php create mode 100644 src/RequestHandler/CallbackRequestHandler.php create mode 100644 src/RequestHandlerResolver.php create mode 100644 src/RequestHandlerResolverInterface.php create mode 100644 src/ResponseResolverChainInterface.php diff --git a/src/ClassResolver.php b/src/ClassResolver.php index 22352290..6880f8f5 100644 --- a/src/ClassResolver.php +++ b/src/ClassResolver.php @@ -11,11 +11,11 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ClassResolver; +namespace Sunrise\Http\Router; use InvalidArgumentException; +use Psr\Container\ContainerInterface; use ReflectionClass; -use Sunrise\Http\Router\ParameterResolverChain; use function class_exists; use function sprintf; @@ -31,7 +31,8 @@ final class ClassResolver implements ClassResolverInterface private array $resolvedClasses = []; public function __construct( - private readonly ParameterResolverChain $parameterResolver, + private readonly ParameterResolverChainInterface $parameterResolver, + private readonly ?ContainerInterface $container = null, ) { } @@ -53,6 +54,11 @@ public function resolveClass(string $className): object return $this->resolvedClasses[$className]; } + if ($this->container?->has($className)) { + /** @var T */ + return $this->container->get($className); + } + if (!class_exists($className)) { throw new InvalidArgumentException(sprintf('The class %s does not exist.', $className)); } diff --git a/src/ClassResolverInterface.php b/src/ClassResolverInterface.php index a36a3cb4..73410d6e 100644 --- a/src/ClassResolverInterface.php +++ b/src/ClassResolverInterface.php @@ -11,12 +11,21 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ClassResolver; +namespace Sunrise\Http\Router; /** * @since 3.0.0 */ interface ClassResolverInterface { + /** + * Tries to resolve the given named class + * + * @param class-string $className + * + * @return T + * + * @template T of object + */ public function resolveClass(string $className): object; } diff --git a/src/Middleware/CallbackMiddleware.php b/src/Middleware/CallbackMiddleware.php new file mode 100644 index 00000000..feedacfb --- /dev/null +++ b/src/Middleware/CallbackMiddleware.php @@ -0,0 +1,62 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Middleware; + +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; +use ReflectionFunction; +use ReflectionMethod; +use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; +use Sunrise\Http\Router\ParameterResolverChainInterface; +use Sunrise\Http\Router\ResponseResolverChainInterface; + +/** + * @since 3.0.0 + */ +final class CallbackMiddleware implements MiddlewareInterface +{ + /** @var callable */ + private $callback; + + public function __construct( + callable $callback, + private readonly ReflectionMethod|ReflectionFunction $callbackReflection, + private readonly ParameterResolverChainInterface $parameterResolver, + private readonly ResponseResolverChainInterface $responseResolver, + ) { + $this->callback = $callback; + } + + /** + * @inheritDoc + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + $arguments = $this->parameterResolver + ->withContext($request) + ->withPriorityResolver( + new ObjectInjectionParameterResolver($request), + new ObjectInjectionParameterResolver($handler), + ) + ->resolveParameters(...$this->callbackReflection->getParameters()); + + return $this->responseResolver->resolveResponse( + ($this->callback)(...$arguments), + $this->callbackReflection, + $request, + ); + } +} diff --git a/src/MiddlewareResolver.php b/src/MiddlewareResolver.php new file mode 100644 index 00000000..5d4bd9ec --- /dev/null +++ b/src/MiddlewareResolver.php @@ -0,0 +1,91 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router; + +use Closure; +use Psr\Http\Server\MiddlewareInterface; +use ReflectionFunction; +use ReflectionMethod; +use Sunrise\Http\Router\Exception\InvalidReferenceException; +use Sunrise\Http\Router\Middleware\CallbackMiddleware; + +use function class_exists; +use function is_array; +use function is_callable; +use function is_string; +use function is_subclass_of; +use function sprintf; + +/** + * @since 3.0.0 + */ +final class MiddlewareResolver implements MiddlewareResolverInterface +{ + public function __construct( + private readonly ClassResolverInterface $classResolver, + private readonly ParameterResolverChainInterface $parameterResolver, + private readonly ResponseResolverChainInterface $responseResolver, + ) { + } + + public function resolveMiddleware(mixed $reference): MiddlewareInterface + { + if ($reference instanceof MiddlewareInterface) { + return $reference; + } + + if ($reference instanceof Closure) { + return new CallbackMiddleware( + $reference, + new ReflectionFunction($reference), + $this->parameterResolver, + $this->responseResolver, + ); + } + + if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { + return $this->classResolver->resolveClass($reference); + } + + // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 + if (is_array($reference) && is_callable($reference, true)) { + /** @var array{0: string|object, 1: string} $reference */ + + if (is_string($reference[0]) && class_exists($reference[0])) { + $reference[0] = $this->classResolver->resolveClass($reference[0]); + } + + if (is_callable($reference)) { + /** @var array{0: class-string|object, 1: non-empty-string} $reference */ + + return new CallbackMiddleware( + $reference, + new ReflectionMethod($reference[0], $reference[1]), + $this->parameterResolver, + $this->responseResolver, + ); + } + } + + throw new InvalidReferenceException(sprintf( + 'The middleware reference %s could not be resolved.', + self::stringifyReference($reference), + )); + } + + private static function stringifyReference(mixed $reference): string + { + return is_callable($reference, true, $result) ? $result : get_debug_type($reference); + } +} diff --git a/src/MiddlewareResolverInterface.php b/src/MiddlewareResolverInterface.php new file mode 100644 index 00000000..c49e3cd1 --- /dev/null +++ b/src/MiddlewareResolverInterface.php @@ -0,0 +1,24 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router; + +use Psr\Http\Server\MiddlewareInterface; + +/** + * @since 3.0.0 + */ +interface MiddlewareResolverInterface +{ + public function resolveMiddleware(mixed $reference): MiddlewareInterface; +} diff --git a/src/ParameterResolver/DefaultValueParameterResolver.php b/src/ParameterResolver/DefaultValueParameterResolver.php new file mode 100644 index 00000000..95bcebb3 --- /dev/null +++ b/src/ParameterResolver/DefaultValueParameterResolver.php @@ -0,0 +1,38 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ParameterResolver; + +use Generator; +use ReflectionParameter; + +/** + * @since 3.0.0 + */ +final class DefaultValueParameterResolver implements ParameterResolverInterface +{ + /** + * @inheritDoc + */ + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + { + if ($parameter->isDefaultValueAvailable()) { + yield $parameter->getDefaultValue(); + } + } + + public function getWeight(): int + { + return -1000; + } +} diff --git a/src/ParameterResolver/DependencyInjectionParameterResolver.php b/src/ParameterResolver/DependencyInjectionParameterResolver.php index 315029e9..aaf19068 100644 --- a/src/ParameterResolver/DependencyInjectionParameterResolver.php +++ b/src/ParameterResolver/DependencyInjectionParameterResolver.php @@ -16,7 +16,6 @@ use Generator; use Psr\Container\ContainerExceptionInterface; use Psr\Container\ContainerInterface; -use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; @@ -34,7 +33,7 @@ public function __construct(private readonly ContainerInterface $container) * * @throws ContainerExceptionInterface */ - public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { diff --git a/src/ParameterResolver/ObjectInjectionParameterResolver.php b/src/ParameterResolver/ObjectInjectionParameterResolver.php index c0549bbd..21377618 100644 --- a/src/ParameterResolver/ObjectInjectionParameterResolver.php +++ b/src/ParameterResolver/ObjectInjectionParameterResolver.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router\ParameterResolver; use Generator; -use Psr\Http\Message\ServerRequestInterface; use ReflectionNamedType; use ReflectionParameter; @@ -32,7 +31,7 @@ public function __construct(private readonly object $object) /** * @inheritDoc */ - public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { @@ -46,6 +45,6 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI public function getWeight(): int { - return 0; + return -10; } } diff --git a/src/ParameterResolver/ParameterResolverInterface.php b/src/ParameterResolver/ParameterResolverInterface.php index e1771b77..25647632 100644 --- a/src/ParameterResolver/ParameterResolverInterface.php +++ b/src/ParameterResolver/ParameterResolverInterface.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router\ParameterResolver; use Generator; -use Psr\Http\Message\ServerRequestInterface; use ReflectionParameter; /** @@ -25,7 +24,7 @@ interface ParameterResolverInterface /** * @return Generator */ - public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator; + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator; public function getWeight(): int; } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 7434e2f4..95c1d3fe 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -22,7 +22,7 @@ use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\InvalidParameterException; -use Sunrise\Http\Router\ParameterResolver; +use Sunrise\Http\Router\ParameterResolverChain; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; @@ -52,9 +52,9 @@ public function __construct( * @throws InvalidObjectException * @throws InvalidParameterException */ - public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - if ($request === null) { + if (! $context instanceof ServerRequestInterface) { return; } @@ -68,7 +68,7 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { throw new InvalidParameterException(sprintf( 'To use the #[RequestBody] annotation, the parameter %s must be typed with an object.', - ParameterResolver::stringifyParameter($parameter), + ParameterResolverChain::stringifyParameter($parameter), )); } @@ -77,7 +77,7 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; try { - $argument = $this->hydrator->hydrate($type->getName(), (array) $request->getParsedBody()); + $argument = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidBody($processParams->errorMessage, $errorStatusCode, previous: $e) ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $e->getExceptions())); @@ -95,6 +95,6 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI public function getWeight(): int { - return 90; + return 0; } } diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index e1ab84ae..e86f1f9a 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -49,9 +49,9 @@ public function __construct( * * @throws HttpException */ - public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - if ($request === null) { + if (! $context instanceof ServerRequestInterface) { return; } @@ -61,7 +61,7 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI return; } - $request = ServerRequest::create($request); + $request = ServerRequest::create($context); $processParams = $annotations[0]->newInstance(); $cookieName = $processParams->cookieName; @@ -103,6 +103,6 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI public function getWeight(): int { - return 60; + return 0; } } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 80548191..47853bf9 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -48,9 +48,9 @@ public function __construct( * * @throws HttpException */ - public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - if ($request === null) { + if (! $context instanceof ServerRequestInterface) { return; } @@ -65,7 +65,7 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI $headerName = $processParams->headerName; $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; - if (!$request->hasHeader($headerName)) { + if (!$context->hasHeader($headerName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } @@ -75,7 +75,7 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI } try { - $argument = $this->hydrator->castValue($request->getHeaderLine($headerName), Type::fromParameter($parameter), path: [$headerName]); + $argument = $this->hydrator->castValue($context->getHeaderLine($headerName), Type::fromParameter($parameter), path: [$headerName]); } catch (InvalidValueException $e) { throw HttpExceptionFactory::invalidHeader($processParams->errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ header_name }}', $headerName) @@ -101,6 +101,6 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI public function getWeight(): int { - return 70; + return 0; } } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 3e9a42bd..c6dc9792 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -22,7 +22,7 @@ use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\InvalidParameterException; -use Sunrise\Http\Router\ParameterResolver; +use Sunrise\Http\Router\ParameterResolverChain; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; @@ -52,9 +52,9 @@ public function __construct( * @throws InvalidObjectException * @throws InvalidParameterException */ - public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - if ($request === null) { + if (! $context instanceof ServerRequestInterface) { return; } @@ -68,7 +68,7 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { throw new InvalidParameterException(sprintf( 'To use the #[RequestQuery] annotation, the parameter %s must be typed with an object.', - ParameterResolver::stringifyParameter($parameter), + ParameterResolverChain::stringifyParameter($parameter), )); } @@ -77,7 +77,7 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; try { - $argument = $this->hydrator->hydrate($type->getName(), $request->getQueryParams()); + $argument = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidQuery($processParams->errorMessage, $errorStatusCode, previous: $e) ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $e->getExceptions())); @@ -95,6 +95,6 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI public function getWeight(): int { - return 80; + return 0; } } diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index be2252d4..408d7e39 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -23,7 +23,7 @@ use Sunrise\Http\Router\Exception\InvalidParameterException; use Sunrise\Http\Router\Helper\RouteSimplifier; use Sunrise\Http\Router\Helper\ValidatorHelper; -use Sunrise\Http\Router\ParameterResolver; +use Sunrise\Http\Router\ParameterResolverChain; use Sunrise\Http\Router\ServerRequest; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; @@ -54,9 +54,9 @@ public function __construct( * @throws HttpException * @throws InvalidParameterException */ - public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { - if ($request === null) { + if (! $context instanceof ServerRequestInterface) { return; } @@ -66,7 +66,7 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI return; } - $route = ServerRequest::create($request)->getRoute(); + $route = ServerRequest::create($context)->getRoute(); $processParams = $annotations[0]->newInstance(); $variableName = $processParams->variableName ?? $parameter->getName(); @@ -81,7 +81,7 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI 'The parameter %s expects a value of the variable {%s} from the route %s ' . 'which is not present in the request, most likely, because the variable is optional. ' . 'To resolve this issue, assign the default value to the parameter.', - ParameterResolver::stringifyParameter($parameter), + ParameterResolverChain::stringifyParameter($parameter), $variableName, $route->getName(), )); @@ -117,6 +117,6 @@ public function resolveParameter(ReflectionParameter $parameter, ?ServerRequestI public function getWeight(): int { - return 100; + return 0; } } diff --git a/src/ParameterResolverChain.php b/src/ParameterResolverChain.php index c9c735ea..7314f6eb 100644 --- a/src/ParameterResolverChain.php +++ b/src/ParameterResolverChain.php @@ -14,10 +14,8 @@ namespace Sunrise\Http\Router; use Generator; -use Psr\Http\Message\ServerRequestInterface; use ReflectionMethod; use ReflectionParameter; -use Sunrise\Http\Router\Exception\InvalidParameterException; use Sunrise\Http\Router\Exception\UnsupportedParameterException; use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; @@ -28,7 +26,7 @@ /** * @since 3.0.0 */ -final class ParameterResolver implements ParameterResolverChainInterface +final class ParameterResolverChain implements ParameterResolverChainInterface { private mixed $context = null; @@ -39,9 +37,7 @@ public function __construct( usort($this->resolvers, static fn( ParameterResolverInterface $a, ParameterResolverInterface $b, - ): int => ( - $b->getWeight() <=> $a->getWeight() - )); + ): int => $b->getWeight() <=> $a->getWeight()); } public function withContext(mixed $context): static @@ -62,9 +58,8 @@ public function withPriorityResolver(ParameterResolverInterface ...$resolvers): } /** - * @return Generator + * @inheritDoc * - * @throws InvalidParameterException * @throws UnsupportedParameterException */ public function resolveParameters(ReflectionParameter ...$parameters): Generator @@ -77,20 +72,19 @@ public function resolveParameters(ReflectionParameter ...$parameters): Generator /** * @return Generator * - * @throws InvalidParameterException * @throws UnsupportedParameterException */ - private function resolveParameter(ReflectionParameter $parameter, ?ServerRequestInterface $request): Generator + private function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { foreach ($this->resolvers as $resolver) { - $arguments = $resolver->resolveParameter($parameter, $request); + $arguments = $resolver->resolveParameter($parameter, $context); if ($arguments->valid()) { return yield from $arguments; } } throw new UnsupportedParameterException(sprintf( - 'The parameter %s is not supported.', + 'The parameter %s is not supported and cannot be resolved.', self::stringifyParameter($parameter), )); } diff --git a/src/ParameterResolverChainInterface.php b/src/ParameterResolverChainInterface.php new file mode 100644 index 00000000..d39e0b4f --- /dev/null +++ b/src/ParameterResolverChainInterface.php @@ -0,0 +1,33 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router; + +use Generator; +use ReflectionParameter; +use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; + +/** + * @since 3.0.0 + */ +interface ParameterResolverChainInterface +{ + public function withContext(mixed $context): static; + + public function withPriorityResolver(ParameterResolverInterface ...$resolvers): static; + + /** + * @return Generator + */ + public function resolveParameters(ReflectionParameter ...$parameters): Generator; +} diff --git a/src/RequestHandler/CallbackRequestHandler.php b/src/RequestHandler/CallbackRequestHandler.php new file mode 100644 index 00000000..ec9d1d32 --- /dev/null +++ b/src/RequestHandler/CallbackRequestHandler.php @@ -0,0 +1,60 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\RequestHandler; + +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\RequestHandlerInterface; +use ReflectionFunction; +use ReflectionMethod; +use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; +use Sunrise\Http\Router\ParameterResolverChainInterface; +use Sunrise\Http\Router\ResponseResolverChainInterface; + +/** + * @since 3.0.0 + */ +final class CallbackRequestHandler implements RequestHandlerInterface +{ + /** @var callable */ + private $callback; + + public function __construct( + callable $callback, + private readonly ReflectionMethod|ReflectionFunction $callbackReflection, + private readonly ParameterResolverChainInterface $parameterResolver, + private readonly ResponseResolverChainInterface $responseResolver, + ) { + $this->callback = $callback; + } + + /** + * @inheritDoc + */ + public function handle(ServerRequestInterface $request): ResponseInterface + { + $arguments = $this->parameterResolver + ->withContext($request) + ->withPriorityResolver( + new ObjectInjectionParameterResolver($request) + ) + ->resolveParameters(...$this->callbackReflection->getParameters()); + + return $this->responseResolver->resolveResponse( + ($this->callback)(...$arguments), + $this->callbackReflection, + $request, + ); + } +} diff --git a/src/RequestHandlerResolver.php b/src/RequestHandlerResolver.php new file mode 100644 index 00000000..ea51a0cb --- /dev/null +++ b/src/RequestHandlerResolver.php @@ -0,0 +1,91 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router; + +use Closure; +use Psr\Http\Server\RequestHandlerInterface; +use ReflectionFunction; +use ReflectionMethod; +use Sunrise\Http\Router\Exception\InvalidReferenceException; +use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; + +use function class_exists; +use function is_array; +use function is_callable; +use function is_string; +use function is_subclass_of; +use function sprintf; + +/** + * @since 3.0.0 + */ +final class RequestHandlerResolver implements RequestHandlerResolverInterface +{ + public function __construct( + private readonly ClassResolverInterface $classResolver, + private readonly ParameterResolverChainInterface $parameterResolver, + private readonly ResponseResolverChainInterface $responseResolver, + ) { + } + + public function resolveRequestHandler(mixed $reference): RequestHandlerInterface + { + if ($reference instanceof RequestHandlerInterface) { + return $reference; + } + + if ($reference instanceof Closure) { + return new CallbackRequestHandler( + $reference, + new ReflectionFunction($reference), + $this->parameterResolver, + $this->responseResolver, + ); + } + + // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 + if (is_array($reference) && is_callable($reference, true)) { + /** @var array{0: string|object, 1: string} $reference */ + + if (is_string($reference[0]) && class_exists($reference[0])) { + $reference[0] = $this->classResolver->resolveClass($reference[0]); + } + + if (is_callable($reference)) { + /** @var array{0: class-string|object, 1: non-empty-string} $reference */ + + return new CallbackRequestHandler( + $reference, + new ReflectionMethod($reference[0], $reference[1]), + $this->parameterResolver, + $this->responseResolver, + ); + } + } + + if (is_string($reference) && is_subclass_of($reference, RequestHandlerInterface::class)) { + return $this->classResolver->resolveClass($reference); + } + + throw new InvalidReferenceException(sprintf( + 'The request handler reference %s could not be resolved.', + self::stringifyReference($reference), + )); + } + + private static function stringifyReference(mixed $reference): string + { + return is_callable($reference, true, $result) ? $result : get_debug_type($reference); + } +} diff --git a/src/RequestHandlerResolverInterface.php b/src/RequestHandlerResolverInterface.php new file mode 100644 index 00000000..8b1fde8b --- /dev/null +++ b/src/RequestHandlerResolverInterface.php @@ -0,0 +1,24 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router; + +use Psr\Http\Server\RequestHandlerInterface; + +/** + * @since 3.0.0 + */ +interface RequestHandlerResolverInterface +{ + public function resolveRequestHandler(mixed $reference): RequestHandlerInterface; +} diff --git a/src/ResponseResolver/EmptyResponseResolver.php b/src/ResponseResolver/EmptyResponseResolver.php index 3cd5e7ce..a190b69d 100644 --- a/src/ResponseResolver/EmptyResponseResolver.php +++ b/src/ResponseResolver/EmptyResponseResolver.php @@ -41,4 +41,9 @@ public function resolveResponse( return $this->responseFactory->createResponse(StatusCodeInterface::STATUS_NO_CONTENT); } + + public function getWeight(): int + { + return 0; + } } diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index 9e09d1bd..5b40075d 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -23,7 +23,7 @@ use ReflectionMethod; use Sunrise\Http\Router\Annotation\JsonResponse; use Sunrise\Http\Router\Exception\InvalidResponseException; -use Sunrise\Http\Router\ResponseResolver; +use Sunrise\Http\Router\ResponseResolverChain; use function json_encode; use function sprintf; @@ -70,7 +70,7 @@ public function resolveResponse( } catch (JsonException $e) { throw new InvalidResponseException(sprintf( 'The responder %s returned a response that could not be encoded to JSON due to: %s', - ResponseResolver::stringifyResponder($responder), + ResponseResolverChain::stringifyResponder($responder), $e->getMessage(), ), previous: $e); } @@ -82,4 +82,9 @@ public function resolveResponse( return $jsonResponse; } + + public function getWeight(): int + { + return 0; + } } diff --git a/src/ResponseResolver/ResponseResolverInterface.php b/src/ResponseResolver/ResponseResolverInterface.php index 9bb74077..e5e66c04 100644 --- a/src/ResponseResolver/ResponseResolverInterface.php +++ b/src/ResponseResolver/ResponseResolverInterface.php @@ -28,4 +28,6 @@ public function resolveResponse( ReflectionMethod|ReflectionFunction $responder, ServerRequestInterface $request, ): ?ResponseInterface; + + public function getWeight(): int; } diff --git a/src/ResponseResolverChain.php b/src/ResponseResolverChain.php index 307bc6f3..74e36786 100644 --- a/src/ResponseResolverChain.php +++ b/src/ResponseResolverChain.php @@ -25,16 +25,21 @@ use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; use function sprintf; +use function usort; /** * @since 3.0.0 */ -final class ResponseResolver implements ResponseResolverChainInterface +final class ResponseResolverChain implements ResponseResolverChainInterface { public function __construct( /** @var ResponseResolverInterface[] */ - private readonly array $resolvers, + private array $resolvers, ) { + usort($this->resolvers, static fn( + ResponseResolverInterface $a, + ResponseResolverInterface $b, + ): int => $b->getWeight() <=> $a->getWeight()); } /** diff --git a/src/ResponseResolverChainInterface.php b/src/ResponseResolverChainInterface.php new file mode 100644 index 00000000..e917d1b5 --- /dev/null +++ b/src/ResponseResolverChainInterface.php @@ -0,0 +1,31 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router; + +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionFunction; +use ReflectionMethod; + +/** + * @since 3.0.0 + */ +interface ResponseResolverChainInterface +{ + public function resolveResponse( + mixed $response, + ReflectionMethod|ReflectionFunction $responder, + ServerRequestInterface $request, + ): ResponseInterface; +} diff --git a/src/Router.php b/src/Router.php index 55e8beea..ef195b1d 100644 --- a/src/Router.php +++ b/src/Router.php @@ -30,6 +30,7 @@ use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Helper\RouteMatcher; use Sunrise\Http\Router\Loader\LoaderInterface; +use Sunrise\Http\Router\ParameterResolver\DefaultValueParameterResolver; use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; @@ -43,7 +44,9 @@ class Router implements RequestHandlerInterface { - private readonly ReferenceResolver $referenceResolver; + private readonly RequestHandlerResolverInterface $requestHandlerResolver; + + private readonly MiddlewareResolverInterface $middlewareResolver; private ?RequestHandlerInterface $requestHandler = null; @@ -76,17 +79,14 @@ public function __construct( ?ContainerInterface $container = null, ) { $parameterResolvers[] = new ObjectInjectionParameterResolver($this); + $parameterResolvers[] = new DefaultValueParameterResolver(); - $parameterResolver = new ParameterResolver($parameterResolvers); - $responseResolver = new ResponseResolver($responseResolvers); - $classResolver = new ClassResolver($parameterResolver); + $parameterResolver = new ParameterResolverChain($parameterResolvers); + $responseResolver = new ResponseResolverChain($responseResolvers); + $classResolver = new ClassResolver($parameterResolver, $container); - $this->referenceResolver = new ReferenceResolver( - parameterResolver: $parameterResolver, - responseResolver: $responseResolver, - classResolver: $classResolver, - container: $container, - ); + $this->requestHandlerResolver = new RequestHandlerResolver($classResolver, $parameterResolver, $responseResolver); + $this->middlewareResolver = new MiddlewareResolver($classResolver, $parameterResolver, $responseResolver); } /** @@ -249,22 +249,22 @@ public function getRouteRequestHandler(RouteInterface|string $route): RequestHan $route = $this->getRoute($route); } - $routeName = $route->getName(); - if (isset($this->routeRequestHandlers[$routeName])) { - return $this->routeRequestHandlers[$routeName]; + $name = $route->getName(); + if (isset($this->routeRequestHandlers[$name])) { + return $this->routeRequestHandlers[$name]; } - $this->routeRequestHandlers[$routeName] = $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()); + $this->routeRequestHandlers[$name] = $this->requestHandlerResolver->resolveRequestHandler($route->getRequestHandler()); - $routeMiddlewares = $route->getMiddlewares(); - if (!empty($routeMiddlewares)) { - $this->routeRequestHandlers[$routeName] = new QueueableRequestHandler($this->routeRequestHandlers[$routeName]); - foreach ($routeMiddlewares as $routeMiddleware) { - $this->routeRequestHandlers[$routeName]->enqueue($this->referenceResolver->resolveMiddleware($routeMiddleware)); + $middlewares = $route->getMiddlewares(); + if (!empty($middlewares)) { + $this->routeRequestHandlers[$name] = new QueueableRequestHandler($this->routeRequestHandlers[$name]); + foreach ($middlewares as $middleware) { + $this->routeRequestHandlers[$name]->enqueue($this->middlewareResolver->resolveMiddleware($middleware)); } } - return $this->routeRequestHandlers[$routeName]; + return $this->routeRequestHandlers[$name]; } /** @@ -287,7 +287,7 @@ public function getRequestHandler(): RequestHandlerInterface if (!empty($this->middlewares)) { $this->requestHandler = new QueueableRequestHandler($this->requestHandler); foreach ($this->middlewares as $middleware) { - $this->requestHandler->enqueue($this->referenceResolver->resolveMiddleware($middleware)); + $this->requestHandler->enqueue($this->middlewareResolver->resolveMiddleware($middleware)); } } From 03e7c1490331a344e996a0ee57952996d2001a84 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 15 Mar 2024 12:08:57 +0100 Subject: [PATCH 138/180] v3 --- resources/definitions/router.php | 5 ++ resources/translations/ru.php | 23 +++++ resources/translations/sr.php | 23 +++++ src/Annotation/Pattern.php | 2 +- src/Annotation/Route.php | 43 ++++----- src/ClassResolver.php | 4 +- src/Dictionary/ErrorMessage.php | 18 ++-- src/Entity/Language/ClientLanguage.php | 2 - src/Entity/MediaType/MediaTypeInterface.php | 3 + src/Exception/HttpExceptionFactory.php | 8 +- src/Helper/RouteBuilder.php | 35 +------- src/Helper/Stringifier.php | 88 +++++++++++++++++++ src/Helper/ValidatorHelper.php | 10 +++ src/Loader/DescriptorLoader.php | 2 +- src/Middleware/CallbackMiddleware.php | 17 ++-- .../JsonPayloadDecodingMiddleware.php | 2 +- .../PayloadMediaTypeNegotiationMiddleware.php | 4 +- src/MiddlewareResolver.php | 20 ++--- .../RequestBodyParameterResolver.php | 4 +- .../RequestQueryParameterResolver.php | 4 +- .../RequestVariableParameterResolver.php | 4 +- src/ParameterResolverChain.php | 17 +--- src/ReferenceResolver.php | 60 +++++++++++++ src/ReferenceResolverInterface.php | 21 +++++ src/RequestHandler/CallbackRequestHandler.php | 17 ++-- src/RequestHandlerResolver.php | 20 ++--- src/ResponseResolver/JsonResponseResolver.php | 4 +- src/ResponseResolverChain.php | 14 +-- src/Router.php | 63 ++++++------- .../ValidatorConstraintViolationProxy.php | 5 +- 30 files changed, 361 insertions(+), 181 deletions(-) create mode 100644 resources/definitions/router.php create mode 100644 resources/translations/ru.php create mode 100644 resources/translations/sr.php create mode 100644 src/Helper/Stringifier.php create mode 100644 src/ReferenceResolver.php create mode 100644 src/ReferenceResolverInterface.php diff --git a/resources/definitions/router.php b/resources/definitions/router.php new file mode 100644 index 00000000..0dae23de --- /dev/null +++ b/resources/definitions/router.php @@ -0,0 +1,5 @@ + 'URI запроса невалиден и не может быть принят сервером.', + ErrorMessage::RESOURCE_NOT_FOUND => 'Запрашиваемый ресурс не найден для данного URI.', + ErrorMessage::METHOD_NOT_ALLOWED => 'Запрашиваемый метод не разрешен для данного ресурса; Проверьте заголовок ответа "Allow" на разрешенные методы.', + ErrorMessage::MISSING_CONTENT_TYPE => 'Заголовок запроса Content-Type должен быть предоставлен и не может быть пустым; Проверьте заголовок ответа "Accept" на поддерживаемые типы медиа.', + ErrorMessage::UNSUPPORTED_MEDIA_TYPE => 'Тип медиа {{ media_type }} не поддерживается; Проверьте заголовок ответа "Accept" на поддерживаемые типы медиа.', + ErrorMessage::INVALID_VARIABLE => 'Значение переменной {{{ variable_name }}} в URI запроса {{ route_uri }} невалидно.', + ErrorMessage::INVALID_QUERY => 'Параметры запроса невалидны.', + ErrorMessage::MISSING_HEADER => 'Заголовок запроса {{ header_name }} должен быть предоставлен.', + ErrorMessage::INVALID_HEADER => 'Заголовок запроса {{ header_name }} невалиден.', + ErrorMessage::MISSING_COOKIE => 'Отсутствует cookie {{ cookie_name }}.', + ErrorMessage::INVALID_COOKIE => 'Cookie {{ cookie_name }} невалидно.', + ErrorMessage::INVALID_BODY => 'Тело запроса невалидно.', + ErrorMessage::EMPTY_JSON_PAYLOAD => 'JSON payload не может быть пустым.', + ErrorMessage::INVALID_JSON_PAYLOAD => 'JSON payload невалидно.', + ErrorMessage::INVALID_JSON_PAYLOAD_FORMAT => 'JSON payload должен быть в формате массива или объекта.', +]; diff --git a/resources/translations/sr.php b/resources/translations/sr.php new file mode 100644 index 00000000..fc8cb916 --- /dev/null +++ b/resources/translations/sr.php @@ -0,0 +1,23 @@ + 'URI zahtev je nevažeći i ne može biti prihvaćen od strane servera.', + ErrorMessage::RESOURCE_NOT_FOUND => 'Zatraženi resurs nije pronađen za ovaj URI.', + ErrorMessage::METHOD_NOT_ALLOWED => 'Zatražena metoda nije dozvoljena za ovaj resurs; Proverite zaglavlje odgovora "Allow" za dozvoljene metode.', + ErrorMessage::MISSING_CONTENT_TYPE => 'Zaglavlje zahteva Content-Type mora biti navedeno i ne može biti prazno; Proverite zaglavlje odgovora "Accept" za podržane tipove medija.', + ErrorMessage::UNSUPPORTED_MEDIA_TYPE => 'Tip medija {{ media_type }} nije podržan; Proverite zaglavlje odgovora "Accept" za podržane tipove medija.', + ErrorMessage::INVALID_VARIABLE => 'Vrednost promenljive {{{ variable_name }}} u URI zahtevu {{ route_uri }} nije validna.', + ErrorMessage::INVALID_QUERY => 'Parametri upita zahteva nisu validni.', + ErrorMessage::MISSING_HEADER => 'Zaglavlje zahteva {{ header_name }} mora biti navedeno.', + ErrorMessage::INVALID_HEADER => 'Zaglavlje zahteva {{ header_name }} nije validno.', + ErrorMessage::MISSING_COOKIE => 'Kolačić {{ cookie_name }} nedostaje.', + ErrorMessage::INVALID_COOKIE => 'Kolačić {{ cookie_name }} nije validan.', + ErrorMessage::INVALID_BODY => 'Telo zahteva nije validno.', + ErrorMessage::EMPTY_JSON_PAYLOAD => 'JSON sadržaj ne može biti prazan.', + ErrorMessage::INVALID_JSON_PAYLOAD => 'JSON sadržaj nije validan.', + ErrorMessage::INVALID_JSON_PAYLOAD_FORMAT => 'JSON sadržaj mora biti u formatu niza ili objekta.', +]; diff --git a/src/Annotation/Pattern.php b/src/Annotation/Pattern.php index 74a5d1a7..63b9c0d1 100644 --- a/src/Annotation/Pattern.php +++ b/src/Annotation/Pattern.php @@ -25,7 +25,7 @@ final class Pattern { public function __construct( - public readonly string $name, + public readonly string $variableName, public readonly string $value, ) { } diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index 6c1cc534..a3e5a0ca 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; +use Sunrise\Http\Router\Annotation as Routing; use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] @@ -25,90 +26,90 @@ final class Route public mixed $holder = null; /** - * Use the {@see Prefix} annotation. + * Use the {@see Routing\Prefix} annotation. * - * @var list + * @var array */ public array $prefixes = []; /** - * Use the {@see Pattern} annotation. + * Use the {@see Routing\Pattern} annotation. * * @var array */ public array $patterns = []; /** - * Use the {@see Method} annotation. + * Use the {@see Routing\Method} annotation. * - * @var list + * @var array */ public array $methods = []; /** - * Use the {@see \Sunrise\Http\Router\Annotation\Attribute} annotation. + * Use the {@see Routing\Attribute} annotation. * * @var array */ public array $attributes = []; /** - * Use the {@see Middleware} annotation. + * Use the {@see Routing\Middleware} annotation. * - * @var list + * @var array */ public array $middlewares = []; /** - * Use the {@see Constraint} annotation. + * Use the {@see Routing\Constraint} annotation. * - * @var list + * @var array */ public array $constraints = []; /** - * Use the {@see Consumes} annotation. + * Use the {@see Routing\Consumes} annotation. * - * @var list + * @var array */ public array $consumes = []; /** - * Use the {@see Produces} annotation. + * Use the {@see Routing\Produces} annotation. * - * @var list + * @var array */ public array $produces = []; /** - * Use the {@see Tag} annotation. + * Use the {@see Routing\Tag} annotation. * - * @var list + * @var array */ public array $tags = []; /** - * Use the {@see Summary} annotation. + * Use the {@see Routing\Summary} annotation. */ public string $summary = ''; /** - * Use the {@see Description} annotation. + * Use the {@see Routing\Description} annotation. */ public string $description = ''; /** - * Use the {@see Deprecated} annotation. + * Use the {@see Routing\Deprecated} annotation. */ public bool $isDeprecated = false; /** - * Use the {@see Priority} annotation. + * Use the {@see Routing\Priority} annotation. */ public int $priority = 0; /** - * The route compilation result. + * The route's compilation pattern. * * @var non-empty-string|null */ diff --git a/src/ClassResolver.php b/src/ClassResolver.php index 6880f8f5..45172f37 100644 --- a/src/ClassResolver.php +++ b/src/ClassResolver.php @@ -31,7 +31,7 @@ final class ClassResolver implements ClassResolverInterface private array $resolvedClasses = []; public function __construct( - private readonly ParameterResolverChainInterface $parameterResolver, + private readonly ParameterResolverChainInterface $parameterResolverChain, private readonly ?ContainerInterface $container = null, ) { } @@ -71,7 +71,7 @@ public function resolveClass(string $className): object } $this->resolvedClasses[$className] = $classReflection->newInstance( - ...$this->parameterResolver->resolveParameters( + ...$this->parameterResolverChain->resolveParameters( ...($classReflection->getConstructor()?->getParameters() ?? []) ) ); diff --git a/src/Dictionary/ErrorMessage.php b/src/Dictionary/ErrorMessage.php index 4cb72b01..0312b502 100644 --- a/src/Dictionary/ErrorMessage.php +++ b/src/Dictionary/ErrorMessage.php @@ -18,19 +18,19 @@ */ final class ErrorMessage { - public const INVALID_URI = 'The provided request URI is invalid and cannot be accepted by the server.'; - public const RESOURCE_NOT_FOUND = 'The requested resource could not be found for this URI.'; - public const METHOD_NOT_ALLOWED = 'The requested method is not allowed for this resource; Please check the Allow response header for allowed methods.'; - public const MISSING_MEDIA_TYPE = 'The Content-Type request header must be provided and cannot be empty; Please check the Accept response header for supported media types.'; + public const INVALID_URI = 'The request URI is invalid and cannot be accepted by the server.'; + public const RESOURCE_NOT_FOUND = 'The requested resource was not found for this URI.'; + public const METHOD_NOT_ALLOWED = 'The requested method is not allowed for this resource; Check the Allow response header for allowed methods.'; + public const MISSING_CONTENT_TYPE = 'The request header Content-Type must be provided and cannot be empty; Check the Accept response header for supported media types.'; public const UNSUPPORTED_MEDIA_TYPE = 'The media type {{ media_type }} is not supported; Check the Accept response header for supported media types.'; - public const INVALID_VARIABLE = 'The provided value of the variable {{{ variable_name }}} in the URI pattern {{ route_uri }} is invalid.'; - public const INVALID_QUERY = 'The provided request query parameters are invalid.'; + public const INVALID_VARIABLE = 'The value of the variable {{{ variable_name }}} in the request URI {{ route_uri }} is invalid.'; + public const INVALID_QUERY = 'The request query parameters are invalid.'; public const MISSING_HEADER = 'The request header {{ header_name }} must be provided.'; - public const INVALID_HEADER = 'The provided request header {{ header_name }} is invalid.'; + public const INVALID_HEADER = 'The request header {{ header_name }} is invalid.'; public const MISSING_COOKIE = 'The cookie {{ cookie_name }} is missing.'; public const INVALID_COOKIE = 'The cookie {{ cookie_name }} is invalid.'; - public const INVALID_BODY = 'The provided request body is invalid.'; + public const INVALID_BODY = 'The request body is invalid.'; public const EMPTY_JSON_PAYLOAD = 'The JSON payload cannot be empty.'; public const INVALID_JSON_PAYLOAD = 'The JSON payload is invalid.'; - public const INVALID_JSON_PAYLOAD_FORM = 'The JSON payload must be in the form of an array or an object.'; + public const INVALID_JSON_PAYLOAD_FORMAT = 'The JSON payload must be in the format of an array or an object.'; } diff --git a/src/Entity/Language/ClientLanguage.php b/src/Entity/Language/ClientLanguage.php index 71ca2287..b1b22afd 100644 --- a/src/Entity/Language/ClientLanguage.php +++ b/src/Entity/Language/ClientLanguage.php @@ -20,8 +20,6 @@ final class ClientLanguage implements LanguageInterface { public function __construct( private readonly string $code, - // One of the Accept-Language header's identifiers: - // https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.5 private readonly string $locale, /** @var array */ private readonly array $parameters, diff --git a/src/Entity/MediaType/MediaTypeInterface.php b/src/Entity/MediaType/MediaTypeInterface.php index 91bc5b94..339f39bb 100644 --- a/src/Entity/MediaType/MediaTypeInterface.php +++ b/src/Entity/MediaType/MediaTypeInterface.php @@ -20,6 +20,9 @@ */ interface MediaTypeInterface extends Stringable { + /** + * @link https://datatracker.ietf.org/doc/html/rfc2046 + */ final public const SEPARATOR = '/'; public function getType(): string; diff --git a/src/Exception/HttpExceptionFactory.php b/src/Exception/HttpExceptionFactory.php index 455c7c10..88003b57 100644 --- a/src/Exception/HttpExceptionFactory.php +++ b/src/Exception/HttpExceptionFactory.php @@ -58,13 +58,13 @@ public static function methodNotAllowed( ); } - public static function missingMediaType( + public static function missingContentType( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::MISSING_MEDIA_TYPE, + message: $message ?? ErrorMessage::MISSING_CONTENT_TYPE, code: $code ?? StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE, previous: $previous, ); @@ -190,13 +190,13 @@ public static function invalidJsonPayload( ); } - public static function invalidJsonPayloadForm( + public static function invalidJsonPayloadFormat( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::INVALID_JSON_PAYLOAD_FORM, + message: $message ?? ErrorMessage::INVALID_JSON_PAYLOAD_FORMAT, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, previous: $previous, ); diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index 0dee43b7..06e46897 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -13,14 +13,10 @@ namespace Sunrise\Http\Router\Helper; -use BackedEnum; -use Stringable; +use InvalidArgumentException; use Sunrise\Http\Router\Exception\InvalidRouteBuildingValueException; use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; -use function get_debug_type; -use function is_int; -use function is_string; use function sprintf; use function str_replace; use function substr; @@ -47,8 +43,8 @@ public static function buildRoute(string $route, array $values = []): string $value = $values[$variable['name']]; try { - $value = self::stringifyValue($value); - } catch (InvalidRouteBuildingValueException $e) { + $value = Stringifier::stringifyValue($value); + } catch (InvalidArgumentException $e) { throw new InvalidRouteBuildingValueException(sprintf( 'The route %s could not be built with an invalid value for the variable {%s} due to: %s', $route, @@ -82,29 +78,4 @@ public static function buildRoute(string $route, array $values = []): string return str_replace($search, $replace, $route); } - - /** - * @throws InvalidRouteBuildingValueException - */ - private static function stringifyValue(mixed $value): string - { - if (is_string($value)) { - return $value; - } - if (is_int($value)) { - return (string) $value; - } - if ($value instanceof BackedEnum) { - return (string) $value->value; - } - if ($value instanceof Stringable) { - return $value->__toString(); - } - - throw new InvalidRouteBuildingValueException(sprintf( - 'The %s value could not be converted to a string; ' . - 'supported types: string, integer, backed enum and stringable object.', - get_debug_type($value), - )); - } } diff --git a/src/Helper/Stringifier.php b/src/Helper/Stringifier.php new file mode 100644 index 00000000..706474d6 --- /dev/null +++ b/src/Helper/Stringifier.php @@ -0,0 +1,88 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Helper; + +use BackedEnum; +use InvalidArgumentException; +use ReflectionFunction; +use ReflectionMethod; +use ReflectionParameter; +use Stringable; + +use function get_debug_type; +use function is_callable; +use function is_int; +use function is_string; +use function sprintf; + +/** + * @since 3.0.0 + */ +final class Stringifier +{ + /** + * @throws InvalidArgumentException + */ + public static function stringifyValue(mixed $value): string + { + if (is_string($value)) { + return $value; + } + if (is_int($value)) { + return (string) $value; + } + if ($value instanceof BackedEnum) { + return (string) $value->value; + } + if ($value instanceof Stringable) { + return $value->__toString(); + } + + throw new InvalidArgumentException(sprintf( + 'The %s value could not be converted to a string; ' . + 'supported types: string, integer, backed enum and stringable object.', + get_debug_type($value), + )); + } + + public static function stringifyReference(mixed $reference): string + { + // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 + if (is_callable($reference, true, $result)) { + return $result; + } + + return get_debug_type($reference); + } + + public static function stringifyParameter(ReflectionParameter $parameter): string + { + $function = $parameter->getDeclaringFunction(); + + if ($function instanceof ReflectionMethod) { + return sprintf('%s::%s($%s[%d])', $function->getDeclaringClass()->getName(), $function->getName(), $parameter->getName(), $parameter->getPosition()); + } + + return sprintf('%s($%s[%d])', $function->getName(), $parameter->getName(), $parameter->getPosition()); + } + + public static function stringifyResponder(ReflectionMethod|ReflectionFunction $responder): string + { + if ($responder instanceof ReflectionMethod) { + return sprintf('%s::%s()', $responder->getDeclaringClass()->getName(), $responder->getName()); + } + + return sprintf('%s()', $responder->getName()); + } +} diff --git a/src/Helper/ValidatorHelper.php b/src/Helper/ValidatorHelper.php index d6de6e30..9a810186 100644 --- a/src/Helper/ValidatorHelper.php +++ b/src/Helper/ValidatorHelper.php @@ -19,6 +19,9 @@ use Sunrise\Http\Router\Annotation\Constraint as RouterConstraint; use Symfony\Component\Validator\Constraint as ValidatorConstraint; +use function ltrim; +use function preg_replace; + /** * @since 3.0.0 */ @@ -37,4 +40,11 @@ public static function getParameterConstraints(ReflectionParameter $parameter): } } } + + public static function adaptPropertyPath(string $propertyPath): string + { + $propertyPath = preg_replace('/\x5b([^\x5b\x5d]+)\x5d/', '.$1', $propertyPath); + + return ltrim($propertyPath, '.'); + } } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index ec54f6cf..670fb6da 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -236,7 +236,7 @@ private function supplementDescriptorFromClassOrMethod(Descriptor $descriptor, R $annotations = $classOrMethod->getAttributes(Pattern::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->patterns[$annotation->name] = $annotation->value; + $descriptor->patterns[$annotation->variableName] = $annotation->value; } /** @var list> $annotations */ diff --git a/src/Middleware/CallbackMiddleware.php b/src/Middleware/CallbackMiddleware.php index feedacfb..a3c88f83 100644 --- a/src/Middleware/CallbackMiddleware.php +++ b/src/Middleware/CallbackMiddleware.php @@ -34,18 +34,23 @@ final class CallbackMiddleware implements MiddlewareInterface public function __construct( callable $callback, private readonly ReflectionMethod|ReflectionFunction $callbackReflection, - private readonly ParameterResolverChainInterface $parameterResolver, - private readonly ResponseResolverChainInterface $responseResolver, + private readonly ParameterResolverChainInterface $parameterResolverChain, + private readonly ResponseResolverChainInterface $responseResolverChain, ) { $this->callback = $callback; } + public function getCallbackReflection(): ReflectionMethod|ReflectionFunction + { + return $this->callbackReflection; + } + /** * @inheritDoc */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - $arguments = $this->parameterResolver + $arguments = $this->parameterResolverChain ->withContext($request) ->withPriorityResolver( new ObjectInjectionParameterResolver($request), @@ -53,10 +58,6 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface ) ->resolveParameters(...$this->callbackReflection->getParameters()); - return $this->responseResolver->resolveResponse( - ($this->callback)(...$arguments), - $this->callbackReflection, - $request, - ); + return $this->responseResolverChain->resolveResponse(($this->callback)(...$arguments), $this->callbackReflection, $request); } } diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index bd9f866e..ff6b2f17 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -81,7 +81,7 @@ private function decodePayload(string $payload): array } if (!is_array($data)) { - throw HttpExceptionFactory::invalidJsonPayloadForm(); + throw HttpExceptionFactory::invalidJsonPayloadFormat(); } return $data; diff --git a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php index f268ece5..6d66bc1c 100644 --- a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php +++ b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php @@ -43,11 +43,11 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface $clientProducedMediaType = $serverRequest->getClientProducedMediaType(); if ($clientProducedMediaType === null) { - throw HttpExceptionFactory::missingMediaType() + throw HttpExceptionFactory::missingContentType() ->addHeaderField('Accept', ...$serverConsumedMediaTypes); } - if (! $serverRequest->clientProducesMediaType(...$serverConsumedMediaTypes)) { + if (!$serverRequest->clientProducesMediaType(...$serverConsumedMediaTypes)) { throw HttpExceptionFactory::unsupportedMediaType() ->addMessagePlaceholder('{{ media_type }}', $clientProducedMediaType) ->addHeaderField('Accept', ...$serverConsumedMediaTypes); diff --git a/src/MiddlewareResolver.php b/src/MiddlewareResolver.php index 5d4bd9ec..85b3cd72 100644 --- a/src/MiddlewareResolver.php +++ b/src/MiddlewareResolver.php @@ -18,6 +18,7 @@ use ReflectionFunction; use ReflectionMethod; use Sunrise\Http\Router\Exception\InvalidReferenceException; +use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Http\Router\Middleware\CallbackMiddleware; use function class_exists; @@ -34,8 +35,8 @@ final class MiddlewareResolver implements MiddlewareResolverInterface { public function __construct( private readonly ClassResolverInterface $classResolver, - private readonly ParameterResolverChainInterface $parameterResolver, - private readonly ResponseResolverChainInterface $responseResolver, + private readonly ParameterResolverChainInterface $parameterResolverChain, + private readonly ResponseResolverChainInterface $responseResolverChain, ) { } @@ -49,8 +50,8 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface return new CallbackMiddleware( $reference, new ReflectionFunction($reference), - $this->parameterResolver, - $this->responseResolver, + $this->parameterResolverChain, + $this->responseResolverChain, ); } @@ -72,20 +73,15 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface return new CallbackMiddleware( $reference, new ReflectionMethod($reference[0], $reference[1]), - $this->parameterResolver, - $this->responseResolver, + $this->parameterResolverChain, + $this->responseResolverChain, ); } } throw new InvalidReferenceException(sprintf( 'The middleware reference %s could not be resolved.', - self::stringifyReference($reference), + Stringifier::stringifyReference($reference), )); } - - private static function stringifyReference(mixed $reference): string - { - return is_callable($reference, true, $result) ? $result : get_debug_type($reference); - } } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 95c1d3fe..272be822 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -22,7 +22,7 @@ use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\InvalidParameterException; -use Sunrise\Http\Router\ParameterResolverChain; +use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; @@ -68,7 +68,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { throw new InvalidParameterException(sprintf( 'To use the #[RequestBody] annotation, the parameter %s must be typed with an object.', - ParameterResolverChain::stringifyParameter($parameter), + Stringifier::stringifyParameter($parameter), )); } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index c6dc9792..46421494 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -22,7 +22,7 @@ use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\InvalidParameterException; -use Sunrise\Http\Router\ParameterResolverChain; +use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; use Sunrise\Hydrator\Exception\InvalidDataException; @@ -68,7 +68,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { throw new InvalidParameterException(sprintf( 'To use the #[RequestQuery] annotation, the parameter %s must be typed with an object.', - ParameterResolverChain::stringifyParameter($parameter), + Stringifier::stringifyParameter($parameter), )); } diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index 408d7e39..402a0f52 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -22,8 +22,8 @@ use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\InvalidParameterException; use Sunrise\Http\Router\Helper\RouteSimplifier; +use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Http\Router\Helper\ValidatorHelper; -use Sunrise\Http\Router\ParameterResolverChain; use Sunrise\Http\Router\ServerRequest; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; @@ -81,7 +81,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) 'The parameter %s expects a value of the variable {%s} from the route %s ' . 'which is not present in the request, most likely, because the variable is optional. ' . 'To resolve this issue, assign the default value to the parameter.', - ParameterResolverChain::stringifyParameter($parameter), + Stringifier::stringifyParameter($parameter), $variableName, $route->getName(), )); diff --git a/src/ParameterResolverChain.php b/src/ParameterResolverChain.php index 7314f6eb..96f02e1b 100644 --- a/src/ParameterResolverChain.php +++ b/src/ParameterResolverChain.php @@ -14,9 +14,9 @@ namespace Sunrise\Http\Router; use Generator; -use ReflectionMethod; use ReflectionParameter; use Sunrise\Http\Router\Exception\UnsupportedParameterException; +use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; use function array_unshift; @@ -32,7 +32,7 @@ final class ParameterResolverChain implements ParameterResolverChainInterface public function __construct( /** @var ParameterResolverInterface[] */ - private array $resolvers, + private array $resolvers = [], ) { usort($this->resolvers, static fn( ParameterResolverInterface $a, @@ -85,18 +85,7 @@ private function resolveParameter(ReflectionParameter $parameter, mixed $context throw new UnsupportedParameterException(sprintf( 'The parameter %s is not supported and cannot be resolved.', - self::stringifyParameter($parameter), + Stringifier::stringifyParameter($parameter), )); } - - public static function stringifyParameter(ReflectionParameter $parameter): string - { - $function = $parameter->getDeclaringFunction(); - - if ($function instanceof ReflectionMethod) { - return sprintf('%s::%s($%s[%d])', $function->getDeclaringClass()->getName(), $function->getName(), $parameter->getName(), $parameter->getPosition()); - } - - return sprintf('%s($%s[%d])', $function->getName(), $parameter->getName(), $parameter->getPosition()); - } } diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php new file mode 100644 index 00000000..b7945292 --- /dev/null +++ b/src/ReferenceResolver.php @@ -0,0 +1,60 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router; + +use Psr\Container\ContainerInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; +use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; + +/** + * @since 2.10.0 + */ +final class ReferenceResolver implements ReferenceResolverInterface +{ + public function __construct( + private readonly MiddlewareResolverInterface $middlewareResolver, + private readonly RequestHandlerResolverInterface $requestHandlerResolver, + ) { + } + + /** + * @param ParameterResolverInterface[] $parameterResolvers + * @param ResponseResolverInterface[] $responseResolvers + */ + public static function build( + ?ContainerInterface $container = null, + array $parameterResolvers = [], + array $responseResolvers = [], + ): ReferenceResolverInterface { + $parameterResolverChain = new ParameterResolverChain($parameterResolvers); + $responseResolverChain = new ResponseResolverChain($responseResolvers); + $classResolver = new ClassResolver($parameterResolverChain, $container); + $middlewareResolver = new MiddlewareResolver($classResolver, $parameterResolverChain, $responseResolverChain); + $requestHandlerResolver = new RequestHandlerResolver($classResolver, $parameterResolverChain, $responseResolverChain); + + return new self($middlewareResolver, $requestHandlerResolver); + } + + public function resolveMiddleware(mixed $reference): MiddlewareInterface + { + return $this->middlewareResolver->resolveMiddleware($reference); + } + + public function resolveRequestHandler(mixed $reference): RequestHandlerInterface + { + return $this->requestHandlerResolver->resolveRequestHandler($reference); + } +} diff --git a/src/ReferenceResolverInterface.php b/src/ReferenceResolverInterface.php new file mode 100644 index 00000000..15760d5b --- /dev/null +++ b/src/ReferenceResolverInterface.php @@ -0,0 +1,21 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router; + +/** + * @since 2.10.0 + */ +interface ReferenceResolverInterface extends MiddlewareResolverInterface, RequestHandlerResolverInterface +{ +} diff --git a/src/RequestHandler/CallbackRequestHandler.php b/src/RequestHandler/CallbackRequestHandler.php index ec9d1d32..6e327773 100644 --- a/src/RequestHandler/CallbackRequestHandler.php +++ b/src/RequestHandler/CallbackRequestHandler.php @@ -33,28 +33,29 @@ final class CallbackRequestHandler implements RequestHandlerInterface public function __construct( callable $callback, private readonly ReflectionMethod|ReflectionFunction $callbackReflection, - private readonly ParameterResolverChainInterface $parameterResolver, - private readonly ResponseResolverChainInterface $responseResolver, + private readonly ParameterResolverChainInterface $parameterResolverChain, + private readonly ResponseResolverChainInterface $responseResolverChain, ) { $this->callback = $callback; } + public function getCallbackReflection(): ReflectionMethod|ReflectionFunction + { + return $this->callbackReflection; + } + /** * @inheritDoc */ public function handle(ServerRequestInterface $request): ResponseInterface { - $arguments = $this->parameterResolver + $arguments = $this->parameterResolverChain ->withContext($request) ->withPriorityResolver( new ObjectInjectionParameterResolver($request) ) ->resolveParameters(...$this->callbackReflection->getParameters()); - return $this->responseResolver->resolveResponse( - ($this->callback)(...$arguments), - $this->callbackReflection, - $request, - ); + return $this->responseResolverChain->resolveResponse(($this->callback)(...$arguments), $this->callbackReflection, $request); } } diff --git a/src/RequestHandlerResolver.php b/src/RequestHandlerResolver.php index ea51a0cb..73cdf2b0 100644 --- a/src/RequestHandlerResolver.php +++ b/src/RequestHandlerResolver.php @@ -18,6 +18,7 @@ use ReflectionFunction; use ReflectionMethod; use Sunrise\Http\Router\Exception\InvalidReferenceException; +use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; use function class_exists; @@ -34,8 +35,8 @@ final class RequestHandlerResolver implements RequestHandlerResolverInterface { public function __construct( private readonly ClassResolverInterface $classResolver, - private readonly ParameterResolverChainInterface $parameterResolver, - private readonly ResponseResolverChainInterface $responseResolver, + private readonly ParameterResolverChainInterface $parameterResolverChain, + private readonly ResponseResolverChainInterface $responseResolverChain, ) { } @@ -49,8 +50,8 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface return new CallbackRequestHandler( $reference, new ReflectionFunction($reference), - $this->parameterResolver, - $this->responseResolver, + $this->parameterResolverChain, + $this->responseResolverChain, ); } @@ -68,8 +69,8 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface return new CallbackRequestHandler( $reference, new ReflectionMethod($reference[0], $reference[1]), - $this->parameterResolver, - $this->responseResolver, + $this->parameterResolverChain, + $this->responseResolverChain, ); } } @@ -80,12 +81,7 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface throw new InvalidReferenceException(sprintf( 'The request handler reference %s could not be resolved.', - self::stringifyReference($reference), + Stringifier::stringifyReference($reference), )); } - - private static function stringifyReference(mixed $reference): string - { - return is_callable($reference, true, $result) ? $result : get_debug_type($reference); - } } diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index 5b40075d..534b5b6f 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -23,7 +23,7 @@ use ReflectionMethod; use Sunrise\Http\Router\Annotation\JsonResponse; use Sunrise\Http\Router\Exception\InvalidResponseException; -use Sunrise\Http\Router\ResponseResolverChain; +use Sunrise\Http\Router\Helper\Stringifier; use function json_encode; use function sprintf; @@ -70,7 +70,7 @@ public function resolveResponse( } catch (JsonException $e) { throw new InvalidResponseException(sprintf( 'The responder %s returned a response that could not be encoded to JSON due to: %s', - ResponseResolverChain::stringifyResponder($responder), + Stringifier::stringifyResponder($responder), $e->getMessage(), ), previous: $e); } diff --git a/src/ResponseResolverChain.php b/src/ResponseResolverChain.php index 74e36786..53619d16 100644 --- a/src/ResponseResolverChain.php +++ b/src/ResponseResolverChain.php @@ -22,6 +22,7 @@ use Sunrise\Http\Router\Annotation\ResponseStatus; use Sunrise\Http\Router\Exception\InvalidResponseException; use Sunrise\Http\Router\Exception\UnsupportedResponseException; +use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; use function sprintf; @@ -34,7 +35,7 @@ final class ResponseResolverChain implements ResponseResolverChainInterface { public function __construct( /** @var ResponseResolverInterface[] */ - private array $resolvers, + private array $resolvers = [], ) { usort($this->resolvers, static fn( ResponseResolverInterface $a, @@ -64,7 +65,7 @@ public function resolveResponse( throw new UnsupportedResponseException(sprintf( 'The responder %s returned an unsupported response that cannot be resolved.', - self::stringifyResponder($responder), + Stringifier::stringifyResponder($responder), )); } @@ -88,13 +89,4 @@ private function completeResponse( return $response; } - - public static function stringifyResponder(ReflectionMethod|ReflectionFunction $responder): string - { - if ($responder instanceof ReflectionMethod) { - return sprintf('%s::%s()', $responder->getDeclaringClass()->getName(), $responder->getName()); - } - - return sprintf('%s()', $responder->getName()); - } } diff --git a/src/Router.php b/src/Router.php index ef195b1d..02bfef00 100644 --- a/src/Router.php +++ b/src/Router.php @@ -13,7 +13,6 @@ namespace Sunrise\Http\Router; -use Psr\Container\ContainerInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; @@ -30,12 +29,8 @@ use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Helper\RouteMatcher; use Sunrise\Http\Router\Loader\LoaderInterface; -use Sunrise\Http\Router\ParameterResolver\DefaultValueParameterResolver; -use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; -use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; -use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; use function array_flip; use function array_keys; @@ -44,9 +39,7 @@ class Router implements RequestHandlerInterface { - private readonly RequestHandlerResolverInterface $requestHandlerResolver; - - private readonly MiddlewareResolverInterface $middlewareResolver; + private readonly ReferenceResolverInterface $referenceResolver; private ?RequestHandlerInterface $requestHandler = null; @@ -66,27 +59,14 @@ class Router implements RequestHandlerInterface private array $routeRequestHandlers = []; /** - * @param MiddlewareInterface[] $middlewares - * @param ParameterResolverInterface[] $parameterResolvers - * @param ResponseResolverInterface[] $responseResolvers - * * @since 3.0.0 */ public function __construct( + /** @var MiddlewareInterface[] */ private readonly array $middlewares = [], - array $parameterResolvers = [], - array $responseResolvers = [], - ?ContainerInterface $container = null, + ReferenceResolverInterface $referenceResolver = null, ) { - $parameterResolvers[] = new ObjectInjectionParameterResolver($this); - $parameterResolvers[] = new DefaultValueParameterResolver(); - - $parameterResolver = new ParameterResolverChain($parameterResolvers); - $responseResolver = new ResponseResolverChain($responseResolvers); - $classResolver = new ClassResolver($parameterResolver, $container); - - $this->requestHandlerResolver = new RequestHandlerResolver($classResolver, $parameterResolver, $responseResolver); - $this->middlewareResolver = new MiddlewareResolver($classResolver, $parameterResolver, $responseResolver); + $this->referenceResolver = $referenceResolver ?? ReferenceResolver::build(); } /** @@ -124,9 +104,7 @@ public function addRoute(RouteInterface ...$routes): void public function load(LoaderInterface ...$loaders): void { foreach ($loaders as $loader) { - foreach ($loader->load() as $route) { - $this->routes[$route->getName()] = $route; - } + $this->addRoute(...$loader->load()); } } @@ -220,6 +198,31 @@ public function buildRoute(RouteInterface|string $route, array $values = []): st return RouteBuilder::buildRoute($route->getPath(), $values + $route->getAttributes()); } + /** + * @throws RouteNotFoundException + * @throws InvalidRouteBuildingValueException + * @throws InvalidRouteParsingSubjectException + * + * @since 3.0.0 + */ + public function strictBuildRoute(RouteInterface|string $route, array $values = []): string + { + if (! $route instanceof RouteInterface) { + $route = $this->getRoute($route); + } + + $result = $this->buildRoute($route, $values); + + if (!RouteMatcher::matchPattern($route->getPath(), $this->compileRoute($route), $result)) { + throw new InvalidRouteBuildingValueException(sprintf( + 'The route %s could not be built because one of the values does not match its pattern.', + $route->getName(), + )); + } + + return $result; + } + /** * @return non-empty-string * @@ -254,13 +257,13 @@ public function getRouteRequestHandler(RouteInterface|string $route): RequestHan return $this->routeRequestHandlers[$name]; } - $this->routeRequestHandlers[$name] = $this->requestHandlerResolver->resolveRequestHandler($route->getRequestHandler()); + $this->routeRequestHandlers[$name] = $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()); $middlewares = $route->getMiddlewares(); if (!empty($middlewares)) { $this->routeRequestHandlers[$name] = new QueueableRequestHandler($this->routeRequestHandlers[$name]); foreach ($middlewares as $middleware) { - $this->routeRequestHandlers[$name]->enqueue($this->middlewareResolver->resolveMiddleware($middleware)); + $this->routeRequestHandlers[$name]->enqueue($this->referenceResolver->resolveMiddleware($middleware)); } } @@ -287,7 +290,7 @@ public function getRequestHandler(): RequestHandlerInterface if (!empty($this->middlewares)) { $this->requestHandler = new QueueableRequestHandler($this->requestHandler); foreach ($this->middlewares as $middleware) { - $this->requestHandler->enqueue($this->middlewareResolver->resolveMiddleware($middleware)); + $this->requestHandler->enqueue($this->referenceResolver->resolveMiddleware($middleware)); } } diff --git a/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php b/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php index 34c89667..39da7478 100644 --- a/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php +++ b/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php @@ -13,11 +13,10 @@ namespace Sunrise\Http\Router\Validation\ConstraintViolation; +use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\Validation\ConstraintViolationInterface as RouterConstraintViolationInterface; use Symfony\Component\Validator\ConstraintViolationInterface as ValidatorConstraintViolationInterface; -use function preg_replace; - /** * @since 3.0.0 */ @@ -49,7 +48,7 @@ public function getMessagePlaceholders(): array public function getPropertyPath(): string { - return preg_replace(['/\x5b([^\x5b\x5d]+)\x5d/', '/^\x2e/'], ['.$1'], $this->validatorConstraintViolation->getPropertyPath()); + return ValidatorHelper::adaptPropertyPath($this->validatorConstraintViolation->getPropertyPath()); } public function getCode(): ?string From 13a8f7abdbdc40d7a7e2fb5e82f9d14ce1da485a Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 15 Mar 2024 12:48:31 +0100 Subject: [PATCH 139/180] v3 --- resources/definitions/router.php | 67 +++++++++++++++++++++++++++++++- src/Router.php | 17 ++++++-- 2 files changed, 80 insertions(+), 4 deletions(-) diff --git a/resources/definitions/router.php b/resources/definitions/router.php index 0dae23de..0461e2a0 100644 --- a/resources/definitions/router.php +++ b/resources/definitions/router.php @@ -2,4 +2,69 @@ declare(strict_types=1); -return []; +use Psr\Container\ContainerInterface; +use Sunrise\Http\Router\ClassResolver; +use Sunrise\Http\Router\ClassResolverInterface; +use Sunrise\Http\Router\MiddlewareResolver; +use Sunrise\Http\Router\MiddlewareResolverInterface; +use Sunrise\Http\Router\ParameterResolverChain; +use Sunrise\Http\Router\ParameterResolverChainInterface; +use Sunrise\Http\Router\ReferenceResolver; +use Sunrise\Http\Router\ReferenceResolverInterface; +use Sunrise\Http\Router\RequestHandlerResolver; +use Sunrise\Http\Router\RequestHandlerResolverInterface; +use Sunrise\Http\Router\ResponseResolverChain; +use Sunrise\Http\Router\ResponseResolverChainInterface; +use Sunrise\Http\Router\Router; + +use function DI\create; +use function DI\get; + +return [ + 'router.loaders' => [], + + 'router.middlewares' => [], + + ParameterResolverChainInterface::class => create(ParameterResolverChain::class) + ->constructor( + get('router.parameter_resolvers'), + ), + + ResponseResolverChainInterface::class => create(ResponseResolverChain::class) + ->constructor( + get('router.response_resolvers'), + ), + + ClassResolverInterface::class => create(ClassResolver::class) + ->constructor( + get(ParameterResolverChainInterface::class), + get(ContainerInterface::class), + ), + + MiddlewareResolverInterface::class => create(MiddlewareResolver::class) + ->constructor( + get(ClassResolverInterface::class), + get(ParameterResolverChainInterface::class), + get(ResponseResolverChainInterface::class), + ), + + RequestHandlerResolverInterface::class => create(RequestHandlerResolver::class) + ->constructor( + get(ClassResolverInterface::class), + get(ParameterResolverChainInterface::class), + get(ResponseResolverChainInterface::class), + ), + + ReferenceResolverInterface::class => create(ReferenceResolver::class) + ->constructor( + get(MiddlewareResolverInterface::class), + get(RequestHandlerResolverInterface::class), + ), + + Router::class => create() + ->constructor( + get('router.loaders'), + get('router.middlewares'), + get(ReferenceResolverInterface::class), + ), +]; diff --git a/src/Router.php b/src/Router.php index 02bfef00..fbbe7b49 100644 --- a/src/Router.php +++ b/src/Router.php @@ -41,7 +41,7 @@ class Router implements RequestHandlerInterface { private readonly ReferenceResolverInterface $referenceResolver; - private ?RequestHandlerInterface $requestHandler = null; + private array $middlewares; /** * @var array @@ -58,14 +58,25 @@ class Router implements RequestHandlerInterface */ private array $routeRequestHandlers = []; + private ?RequestHandlerInterface $requestHandler = null; + /** + * @param LoaderInterface[] $loaders + * @param MiddlewareInterface[] $middlewares + * * @since 3.0.0 */ public function __construct( - /** @var MiddlewareInterface[] */ - private readonly array $middlewares = [], + array $loaders = [], + array $middlewares = [], ReferenceResolverInterface $referenceResolver = null, ) { + foreach ($loaders as $loader) { + $this->load($loader); + } + + $this->middlewares = $middlewares; + $this->referenceResolver = $referenceResolver ?? ReferenceResolver::build(); } From f71cbe63acbd417a3429152cdde8a59ef1ff4765 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 15 Mar 2024 19:37:34 +0100 Subject: [PATCH 140/180] v3 --- src/Entity/Language/LanguageComparator.php | 4 +- .../Language/LanguageComparatorInterface.php | 22 +++++++++ src/Entity/MediaType/MediaTypeComparator.php | 4 +- .../MediaTypeComparatorInterface.php | 22 +++++++++ src/Exception/HttpException.php | 4 +- src/Helper/RouteParser.php | 2 +- src/Loader/DescriptorLoader.php | 8 ++-- src/ReferenceResolver.php | 2 +- src/ServerRequest.php | 46 +++++++++++++++++-- 9 files changed, 100 insertions(+), 14 deletions(-) create mode 100644 src/Entity/Language/LanguageComparatorInterface.php create mode 100644 src/Entity/MediaType/MediaTypeComparatorInterface.php diff --git a/src/Entity/Language/LanguageComparator.php b/src/Entity/Language/LanguageComparator.php index eba1e3e5..d1cf328c 100644 --- a/src/Entity/Language/LanguageComparator.php +++ b/src/Entity/Language/LanguageComparator.php @@ -16,9 +16,9 @@ /** * @since 3.0.0 */ -final class LanguageComparator +final class LanguageComparator implements LanguageComparatorInterface { - public static function equals(LanguageInterface $a, LanguageInterface $b): bool + public function equals(LanguageInterface $a, LanguageInterface $b): bool { return $a->getCode() === $b->getCode() || $a->getCode() === '*' || $b->getCode() === '*'; } diff --git a/src/Entity/Language/LanguageComparatorInterface.php b/src/Entity/Language/LanguageComparatorInterface.php new file mode 100644 index 00000000..8eafb7e6 --- /dev/null +++ b/src/Entity/Language/LanguageComparatorInterface.php @@ -0,0 +1,22 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Entity\Language; + +/** + * @since 3.0.0 + */ +interface LanguageComparatorInterface +{ + public function equals(LanguageInterface $a, LanguageInterface $b): bool; +} diff --git a/src/Entity/MediaType/MediaTypeComparator.php b/src/Entity/MediaType/MediaTypeComparator.php index 938d6de8..96fd18f8 100644 --- a/src/Entity/MediaType/MediaTypeComparator.php +++ b/src/Entity/MediaType/MediaTypeComparator.php @@ -16,9 +16,9 @@ /** * @since 3.0.0 */ -final class MediaTypeComparator +final class MediaTypeComparator implements MediaTypeComparatorInterface { - public static function equals(MediaTypeInterface $a, MediaTypeInterface $b): bool + public function equals(MediaTypeInterface $a, MediaTypeInterface $b): bool { return ($a->getType() === $b->getType() || $a->getType() === '*' || $b->getType() === '*') && ($a->getSubtype() === $b->getSubtype() || $a->getSubtype() === '*' || $b->getSubtype() === '*'); diff --git a/src/Entity/MediaType/MediaTypeComparatorInterface.php b/src/Entity/MediaType/MediaTypeComparatorInterface.php new file mode 100644 index 00000000..14300d69 --- /dev/null +++ b/src/Entity/MediaType/MediaTypeComparatorInterface.php @@ -0,0 +1,22 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Entity\MediaType; + +/** + * @since 3.0.0 + */ +interface MediaTypeComparatorInterface +{ + public function equals(MediaTypeInterface $a, MediaTypeInterface $b): bool; +} diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index 2380637b..fcd55f1b 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -87,9 +87,9 @@ final public function getConstraintViolations(): array final public function addMessagePlaceholder(string $placeholder, mixed $replacement): static { - $this->messagePlaceholders[$placeholder] = $replacement; + $this->message = strtr($this->message, [$placeholder => $replacement]); - $this->message = strtr($this->messageTemplate, $this->messagePlaceholders); + $this->messagePlaceholders[$placeholder] = $replacement; return $this; } diff --git a/src/Helper/RouteParser.php b/src/Helper/RouteParser.php index 9a570a67..57fc2fb5 100644 --- a/src/Helper/RouteParser.php +++ b/src/Helper/RouteParser.php @@ -236,7 +236,7 @@ public static function parseRoute(string $route): array throw new InvalidRouteParsingSubjectException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An invalid character was found at position %d. ' . - 'Please note that variable patterns cannot contain the %s character; ' . + 'Please note that variable patterns cannot contain the character %s; ' . 'use an octal or hexadecimal sequence instead.', $route, $offset, diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 670fb6da..bc609768 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -57,7 +57,7 @@ public function __construct( /** @var array */ private readonly array $resources, private readonly ?CacheInterface $cache = null, - private readonly string $cacheKey = self::DEFAULT_CACHE_KEY, + private readonly ?string $cacheKey = null, ) { } @@ -100,8 +100,10 @@ public function load(): Generator */ private function getDescriptors(): array { + $cacheKey = $this->cacheKey ?? self::DEFAULT_CACHE_KEY; + /** @var list|null $descriptors */ - $descriptors = $this->cache?->get($this->cacheKey); + $descriptors = $this->cache?->get($cacheKey); if (isset($descriptors)) { return $descriptors; } @@ -115,7 +117,7 @@ private function getDescriptors(): array usort($descriptors, static fn(Descriptor $a, Descriptor $b): int => $b->priority <=> $a->priority); - $this->cache?->set($this->cacheKey, $descriptors); + $this->cache?->set($cacheKey, $descriptors); return $descriptors; } diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index b7945292..ec9e33ad 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -35,9 +35,9 @@ public function __construct( * @param ResponseResolverInterface[] $responseResolvers */ public static function build( - ?ContainerInterface $container = null, array $parameterResolvers = [], array $responseResolvers = [], + ContainerInterface|null $container = null, ): ReferenceResolverInterface { $parameterResolverChain = new ParameterResolverChain($parameterResolvers); $responseResolverChain = new ResponseResolverChain($responseResolvers); diff --git a/src/ServerRequest.php b/src/ServerRequest.php index cf409740..b7f47db4 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -20,9 +20,11 @@ use Psr\Http\Message\UriInterface; use Sunrise\Http\Router\Entity\Language\ClientLanguage; use Sunrise\Http\Router\Entity\Language\LanguageComparator; +use Sunrise\Http\Router\Entity\Language\LanguageComparatorInterface; use Sunrise\Http\Router\Entity\Language\LanguageInterface; use Sunrise\Http\Router\Entity\MediaType\ClientMediaType; use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparatorInterface; use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; use Sunrise\Http\Router\Helper\HeaderParser; @@ -35,6 +37,10 @@ */ final class ServerRequest implements ServerRequestInterface { + private ?LanguageComparatorInterface $languageComparator = null; + + private ?MediaTypeComparatorInterface $mediaTypeComparator = null; + public function __construct(private ServerRequestInterface $request) { } @@ -44,6 +50,37 @@ public static function create(ServerRequestInterface $request): self return $request instanceof self ? $request : new self($request); } + public function getOriginalRequest(): ServerRequestInterface + { + return $this->request; + } + + public function getLanguageComparator(): LanguageComparatorInterface + { + return $this->languageComparator ??= new LanguageComparator(); + } + + public function withLanguageComparator(LanguageComparatorInterface $languageComparator): self + { + $clone = clone $this; + $clone->languageComparator = $languageComparator; + + return $clone; + } + + public function getMediaTypeComparator(): MediaTypeComparatorInterface + { + return $this->mediaTypeComparator ??= new MediaTypeComparator(); + } + + public function withMediaTypeComparator(MediaTypeComparatorInterface $mediaTypeComparator): self + { + $clone = clone $this; + $clone->mediaTypeComparator = $mediaTypeComparator; + + return $clone; + } + /** * @throws LogicException If the request doesn't contain a route. */ @@ -138,9 +175,10 @@ public function getClientPreferredMediaType(MediaTypeInterface ...$serverProduce return null; } + $mediaTypeComparator = $this->getMediaTypeComparator(); foreach ($this->getClientConsumedMediaTypes() as $clientConsumedMediaType) { foreach ($serverProducedMediaTypes as $serverProducedMediaType) { - if (MediaTypeComparator::equals($clientConsumedMediaType, $serverProducedMediaType)) { + if ($mediaTypeComparator->equals($clientConsumedMediaType, $serverProducedMediaType)) { return $clientConsumedMediaType; } } @@ -155,9 +193,10 @@ public function getClientPreferredLanguage(LanguageInterface ...$serverProducedL return null; } + $languageComparator = $this->getLanguageComparator(); foreach ($this->getClientConsumedLanguages() as $clientConsumedLanguage) { foreach ($serverProducedLanguages as $serverProducedLanguage) { - if (LanguageComparator::equals($clientConsumedLanguage, $serverProducedLanguage)) { + if ($languageComparator->equals($clientConsumedLanguage, $serverProducedLanguage)) { return $clientConsumedLanguage; } } @@ -178,8 +217,9 @@ public function clientProducesMediaType(MediaTypeInterface ...$serverConsumedMed return false; } + $mediaTypeComparator = $this->getMediaTypeComparator(); foreach ($serverConsumedMediaTypes as $serverConsumedMediaType) { - if (MediaTypeComparator::equals($clientProducedMediaType, $serverConsumedMediaType)) { + if ($mediaTypeComparator->equals($clientProducedMediaType, $serverConsumedMediaType)) { return true; } } From ad0016f2662b0e6fac38e19a10f6a7e6fcab26dd Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 15 Mar 2024 19:59:06 +0100 Subject: [PATCH 141/180] v3 --- tests/Helper/RouteParserTest.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/Helper/RouteParserTest.php b/tests/Helper/RouteParserTest.php index 5b7dda71..4ca96c70 100644 --- a/tests/Helper/RouteParserTest.php +++ b/tests/Helper/RouteParserTest.php @@ -165,7 +165,7 @@ private function invalidRouteDataProvider(): Generator yield [ '/{<#/', - '/variable patterns cannot contain the # character/' + '/variable patterns cannot contain the character #/' ]; yield [ From 9f501f4f0411f0d4669e51e7b35c1867b42dab33 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 16 Mar 2024 06:16:38 +0100 Subject: [PATCH 142/180] v3 --- src/Annotation/Route.php | 30 ++++--- src/ClassResolver.php | 4 +- src/Command/RouteListCommand.php | 5 +- src/Dictionary/Charset.php | 18 ++-- src/Exception/ExceptionInterface.php | 3 + src/Exception/HttpException.php | 4 +- src/Exception/RouteNotFoundException.php | 2 +- src/Helper/RouteBuilder.php | 34 ++++++- src/Helper/Stringifier.php | 88 ------------------- src/Loader/DescriptorLoader.php | 3 + src/Loader/LoaderInterface.php | 5 +- src/Middleware/CallbackMiddleware.php | 63 ------------- .../JsonPayloadDecodingMiddleware.php | 17 ++-- .../PayloadMediaTypeNegotiationMiddleware.php | 10 ++- src/MiddlewareResolver.php | 54 ++++++++---- .../DependencyInjectionParameterResolver.php | 5 +- .../ObjectInjectionParameterResolver.php | 7 +- .../RequestBodyParameterResolver.php | 20 +++-- .../RequestCookieParameterResolver.php | 21 +++-- .../RequestHeaderParameterResolver.php | 22 ++--- .../RequestQueryParameterResolver.php | 20 +++-- .../RequestVariableParameterResolver.php | 24 ++--- src/ParameterResolverChain.php | 42 ++++++--- src/ParameterResolverChainInterface.php | 2 +- src/ReferenceResolver.php | 19 +++- src/RequestHandler/CallableRequestHandler.php | 2 + src/RequestHandler/CallbackRequestHandler.php | 61 ------------- .../QueueableRequestHandler.php | 2 + src/RequestHandlerResolver.php | 42 +++++---- .../EmptyResponseResolver.php | 14 ++- src/ResponseResolver/JsonResponseResolver.php | 26 ++++-- src/ResponseResolverChain.php | 29 ++++-- src/RouteInterface.php | 45 ++++++++++ src/Router.php | 10 +-- ...xy.php => HydratorConstraintViolation.php} | 21 ++--- .../ValidatorConstraintViolation.php | 57 ++++++++++++ .../ValidatorConstraintViolationProxy.php | 58 ------------ 37 files changed, 445 insertions(+), 444 deletions(-) delete mode 100644 src/Helper/Stringifier.php delete mode 100644 src/Middleware/CallbackMiddleware.php delete mode 100644 src/RequestHandler/CallbackRequestHandler.php rename src/Validation/ConstraintViolation/{HydratorConstraintViolationProxy.php => HydratorConstraintViolation.php} (55%) create mode 100644 src/Validation/ConstraintViolation/ValidatorConstraintViolation.php delete mode 100644 src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index a3e5a0ca..593808da 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -14,9 +14,11 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Annotation as Routing; use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; +/** + * @since 2.0.0 + */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] final class Route { @@ -26,85 +28,85 @@ final class Route public mixed $holder = null; /** - * Use the {@see Routing\Prefix} annotation. + * Use the {@see Prefix} annotation. * * @var array */ public array $prefixes = []; /** - * Use the {@see Routing\Pattern} annotation. + * Use the {@see Pattern} annotation. * * @var array */ public array $patterns = []; /** - * Use the {@see Routing\Method} annotation. + * Use the {@see Method} annotation. * * @var array */ public array $methods = []; /** - * Use the {@see Routing\Attribute} annotation. + * Use the {@see \Sunrise\Http\Router\Annotation\Attribute} annotation. * * @var array */ public array $attributes = []; /** - * Use the {@see Routing\Middleware} annotation. + * Use the {@see Middleware} annotation. * * @var array */ public array $middlewares = []; /** - * Use the {@see Routing\Constraint} annotation. + * Use the {@see Constraint} annotation. * * @var array */ public array $constraints = []; /** - * Use the {@see Routing\Consumes} annotation. + * Use the {@see Consumes} annotation. * * @var array */ public array $consumes = []; /** - * Use the {@see Routing\Produces} annotation. + * Use the {@see Produces} annotation. * * @var array */ public array $produces = []; /** - * Use the {@see Routing\Tag} annotation. + * Use the {@see Tag} annotation. * * @var array */ public array $tags = []; /** - * Use the {@see Routing\Summary} annotation. + * Use the {@see Summary} annotation. */ public string $summary = ''; /** - * Use the {@see Routing\Description} annotation. + * Use the {@see Description} annotation. */ public string $description = ''; /** - * Use the {@see Routing\Deprecated} annotation. + * Use the {@see Deprecated} annotation. */ public bool $isDeprecated = false; /** - * Use the {@see Routing\Priority} annotation. + * Use the {@see Priority} annotation. */ public int $priority = 0; diff --git a/src/ClassResolver.php b/src/ClassResolver.php index 45172f37..c80f27ec 100644 --- a/src/ClassResolver.php +++ b/src/ClassResolver.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router; use InvalidArgumentException; +use Psr\Container\ContainerExceptionInterface; use Psr\Container\ContainerInterface; use ReflectionClass; @@ -45,7 +46,8 @@ public function __construct( * * @template T of object * - * @throws InvalidArgumentException If the class cannot be resolved. + * @throws InvalidArgumentException If the named class cannot be resolved. + * @throws ContainerExceptionInterface If something went wrong while working with the container. */ public function resolveClass(string $className): object { diff --git a/src/Command/RouteListCommand.php b/src/Command/RouteListCommand.php index 285162c7..81a0902c 100644 --- a/src/Command/RouteListCommand.php +++ b/src/Command/RouteListCommand.php @@ -28,8 +28,9 @@ #[AsCommand('router:route-list', 'Lists all routes.')] final class RouteListCommand extends Command { - public function __construct(private readonly Router $router) - { + public function __construct( + private readonly Router $router, + ) { parent::__construct(); } diff --git a/src/Dictionary/Charset.php b/src/Dictionary/Charset.php index 35d2f2e1..141dde84 100644 --- a/src/Dictionary/Charset.php +++ b/src/Dictionary/Charset.php @@ -30,15 +30,15 @@ final class Charset */ public const RFC7230_TOKEN = [ "\x21" => 1, "\x23" => 1, "\x24" => 1, "\x25" => 1, "\x26" => 1, "\x27" => 1, "\x2a" => 1, "\x2b" => 1, - "\x2d" => 1, "\x2e" => 1, "\x5e" => 1, "\x5f" => 1, "\x60" => 1, "\x7c" => 1, "\x7e" => 1, "\x30" => 1, - "\x31" => 1, "\x32" => 1, "\x33" => 1, "\x34" => 1, "\x35" => 1, "\x36" => 1, "\x37" => 1, "\x38" => 1, - "\x39" => 1, "\x41" => 1, "\x42" => 1, "\x43" => 1, "\x44" => 1, "\x45" => 1, "\x46" => 1, "\x47" => 1, - "\x48" => 1, "\x49" => 1, "\x4a" => 1, "\x4b" => 1, "\x4c" => 1, "\x4d" => 1, "\x4e" => 1, "\x4f" => 1, - "\x50" => 1, "\x51" => 1, "\x52" => 1, "\x53" => 1, "\x54" => 1, "\x55" => 1, "\x56" => 1, "\x57" => 1, - "\x58" => 1, "\x59" => 1, "\x5a" => 1, "\x61" => 1, "\x62" => 1, "\x63" => 1, "\x64" => 1, "\x65" => 1, - "\x66" => 1, "\x67" => 1, "\x68" => 1, "\x69" => 1, "\x6a" => 1, "\x6b" => 1, "\x6c" => 1, "\x6d" => 1, - "\x6e" => 1, "\x6f" => 1, "\x70" => 1, "\x71" => 1, "\x72" => 1, "\x73" => 1, "\x74" => 1, "\x75" => 1, - "\x76" => 1, "\x77" => 1, "\x78" => 1, "\x79" => 1, "\x7a" => 1, + "\x2d" => 1, "\x2e" => 1, "\x30" => 1, "\x31" => 1, "\x32" => 1, "\x33" => 1, "\x34" => 1, "\x35" => 1, + "\x36" => 1, "\x37" => 1, "\x38" => 1, "\x39" => 1, "\x41" => 1, "\x42" => 1, "\x43" => 1, "\x44" => 1, + "\x45" => 1, "\x46" => 1, "\x47" => 1, "\x48" => 1, "\x49" => 1, "\x4a" => 1, "\x4b" => 1, "\x4c" => 1, + "\x4d" => 1, "\x4e" => 1, "\x4f" => 1, "\x50" => 1, "\x51" => 1, "\x52" => 1, "\x53" => 1, "\x54" => 1, + "\x55" => 1, "\x56" => 1, "\x57" => 1, "\x58" => 1, "\x59" => 1, "\x5a" => 1, "\x5e" => 1, "\x5f" => 1, + "\x60" => 1, "\x61" => 1, "\x62" => 1, "\x63" => 1, "\x64" => 1, "\x65" => 1, "\x66" => 1, "\x67" => 1, + "\x68" => 1, "\x69" => 1, "\x6a" => 1, "\x6b" => 1, "\x6c" => 1, "\x6d" => 1, "\x6e" => 1, "\x6f" => 1, + "\x70" => 1, "\x71" => 1, "\x72" => 1, "\x73" => 1, "\x74" => 1, "\x75" => 1, "\x76" => 1, "\x77" => 1, + "\x78" => 1, "\x79" => 1, "\x7a" => 1, "\x7c" => 1, "\x7e" => 1, ]; /** diff --git a/src/Exception/ExceptionInterface.php b/src/Exception/ExceptionInterface.php index fa81edd9..27c430aa 100644 --- a/src/Exception/ExceptionInterface.php +++ b/src/Exception/ExceptionInterface.php @@ -15,6 +15,9 @@ use Throwable; +/** + * @since 2.0.0 + */ interface ExceptionInterface extends Throwable { } diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index fcd55f1b..e78d0d0e 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -37,12 +37,12 @@ class HttpException extends RuntimeException implements HttpExceptionInterface private array $messagePlaceholders = []; /** - * @var list + * @var array */ private array $headerFields = []; /** - * @var list + * @var array */ private array $constraintViolations = []; diff --git a/src/Exception/RouteNotFoundException.php b/src/Exception/RouteNotFoundException.php index 17e6aaed..6b7209fb 100644 --- a/src/Exception/RouteNotFoundException.php +++ b/src/Exception/RouteNotFoundException.php @@ -16,7 +16,7 @@ use InvalidArgumentException; /** - * @since 3.0.0 + * @since 2.0.0 */ final class RouteNotFoundException extends InvalidArgumentException implements ExceptionInterface { diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index 06e46897..e553a041 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -13,10 +13,15 @@ namespace Sunrise\Http\Router\Helper; +use BackedEnum; use InvalidArgumentException; +use Stringable; use Sunrise\Http\Router\Exception\InvalidRouteBuildingValueException; use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; +use function get_debug_type; +use function is_int; +use function is_string; use function sprintf; use function str_replace; use function substr; @@ -43,7 +48,7 @@ public static function buildRoute(string $route, array $values = []): string $value = $values[$variable['name']]; try { - $value = Stringifier::stringifyValue($value); + $value = self::stringifyValue($value); } catch (InvalidArgumentException $e) { throw new InvalidRouteBuildingValueException(sprintf( 'The route %s could not be built with an invalid value for the variable {%s} due to: %s', @@ -78,4 +83,31 @@ public static function buildRoute(string $route, array $values = []): string return str_replace($search, $replace, $route); } + + /** + * Tries to cast the given value to the string type + * + * @throws InvalidArgumentException + */ + public static function stringifyValue(mixed $value): string + { + if (is_string($value)) { + return $value; + } + if (is_int($value)) { + return (string) $value; + } + if ($value instanceof BackedEnum) { + return (string) $value->value; + } + if ($value instanceof Stringable) { + return $value->__toString(); + } + + throw new InvalidArgumentException(sprintf( + 'The %s value could not be converted to a string; ' . + 'supported types: string, integer, backed enum and stringable object.', + get_debug_type($value), + )); + } } diff --git a/src/Helper/Stringifier.php b/src/Helper/Stringifier.php deleted file mode 100644 index 706474d6..00000000 --- a/src/Helper/Stringifier.php +++ /dev/null @@ -1,88 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Helper; - -use BackedEnum; -use InvalidArgumentException; -use ReflectionFunction; -use ReflectionMethod; -use ReflectionParameter; -use Stringable; - -use function get_debug_type; -use function is_callable; -use function is_int; -use function is_string; -use function sprintf; - -/** - * @since 3.0.0 - */ -final class Stringifier -{ - /** - * @throws InvalidArgumentException - */ - public static function stringifyValue(mixed $value): string - { - if (is_string($value)) { - return $value; - } - if (is_int($value)) { - return (string) $value; - } - if ($value instanceof BackedEnum) { - return (string) $value->value; - } - if ($value instanceof Stringable) { - return $value->__toString(); - } - - throw new InvalidArgumentException(sprintf( - 'The %s value could not be converted to a string; ' . - 'supported types: string, integer, backed enum and stringable object.', - get_debug_type($value), - )); - } - - public static function stringifyReference(mixed $reference): string - { - // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 - if (is_callable($reference, true, $result)) { - return $result; - } - - return get_debug_type($reference); - } - - public static function stringifyParameter(ReflectionParameter $parameter): string - { - $function = $parameter->getDeclaringFunction(); - - if ($function instanceof ReflectionMethod) { - return sprintf('%s::%s($%s[%d])', $function->getDeclaringClass()->getName(), $function->getName(), $parameter->getName(), $parameter->getPosition()); - } - - return sprintf('%s($%s[%d])', $function->getName(), $parameter->getName(), $parameter->getPosition()); - } - - public static function stringifyResponder(ReflectionMethod|ReflectionFunction $responder): string - { - if ($responder instanceof ReflectionMethod) { - return sprintf('%s::%s()', $responder->getDeclaringClass()->getName(), $responder->getName()); - } - - return sprintf('%s()', $responder->getName()); - } -} diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index bc609768..e9e4c181 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -49,6 +49,9 @@ use function sprintf; use function usort; +/** + * @since 2.10.0 + */ final class DescriptorLoader implements LoaderInterface { public const DEFAULT_CACHE_KEY = 'router_descriptors'; diff --git a/src/Loader/LoaderInterface.php b/src/Loader/LoaderInterface.php index e17222d5..fc2086d5 100644 --- a/src/Loader/LoaderInterface.php +++ b/src/Loader/LoaderInterface.php @@ -15,10 +15,13 @@ use Sunrise\Http\Router\RouteInterface; +/** + * @since 2.0.0 + */ interface LoaderInterface { /** - * @return iterable + * @return iterable */ public function load(): iterable; } diff --git a/src/Middleware/CallbackMiddleware.php b/src/Middleware/CallbackMiddleware.php deleted file mode 100644 index a3c88f83..00000000 --- a/src/Middleware/CallbackMiddleware.php +++ /dev/null @@ -1,63 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Middleware; - -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; -use Psr\Http\Server\RequestHandlerInterface; -use ReflectionFunction; -use ReflectionMethod; -use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; -use Sunrise\Http\Router\ParameterResolverChainInterface; -use Sunrise\Http\Router\ResponseResolverChainInterface; - -/** - * @since 3.0.0 - */ -final class CallbackMiddleware implements MiddlewareInterface -{ - /** @var callable */ - private $callback; - - public function __construct( - callable $callback, - private readonly ReflectionMethod|ReflectionFunction $callbackReflection, - private readonly ParameterResolverChainInterface $parameterResolverChain, - private readonly ResponseResolverChainInterface $responseResolverChain, - ) { - $this->callback = $callback; - } - - public function getCallbackReflection(): ReflectionMethod|ReflectionFunction - { - return $this->callbackReflection; - } - - /** - * @inheritDoc - */ - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface - { - $arguments = $this->parameterResolverChain - ->withContext($request) - ->withPriorityResolver( - new ObjectInjectionParameterResolver($request), - new ObjectInjectionParameterResolver($handler), - ) - ->resolveParameters(...$this->callbackReflection->getParameters()); - - return $this->responseResolverChain->resolveResponse(($this->callback)(...$arguments), $this->callbackReflection, $request); - } -} diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index ff6b2f17..dbf8c2b8 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -43,8 +43,10 @@ final class JsonPayloadDecodingMiddleware implements MiddlewareInterface * @since 3.0.0 */ public function __construct( - private readonly int $decodingFlags = self::DEFAULT_DECODING_FLAGS, - private readonly int $decodingDepth = self::DEFAULT_DECODING_DEPTH, + private readonly ?int $decodingFlags = null, + private readonly ?int $decodingDepth = null, + private readonly ?int $errorStatusCode = null, + private readonly ?string $errorMessage = null, ) { } @@ -70,18 +72,21 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface private function decodePayload(string $payload): array { if ($payload === '') { - throw HttpExceptionFactory::emptyJsonPayload(); + throw HttpExceptionFactory::emptyJsonPayload($this->errorMessage, $this->errorStatusCode); } + $decodingFlags = $this->decodingFlags ?? self::DEFAULT_DECODING_FLAGS; + $decodingDepth = $this->decodingDepth ?? self::DEFAULT_DECODING_DEPTH; + try { /** @psalm-suppress ArgumentTypeCoercion */ - $data = json_decode($payload, true, $this->decodingDepth, $this->decodingFlags | JSON_THROW_ON_ERROR); + $data = json_decode($payload, true, $decodingDepth, $decodingFlags | JSON_THROW_ON_ERROR); } catch (JsonException $e) { - throw HttpExceptionFactory::invalidJsonPayload(previous: $e); + throw HttpExceptionFactory::invalidJsonPayload($this->errorMessage, $this->errorStatusCode, previous: $e); } if (!is_array($data)) { - throw HttpExceptionFactory::invalidJsonPayloadFormat(); + throw HttpExceptionFactory::invalidJsonPayloadFormat($this->errorMessage, $this->errorStatusCode); } return $data; diff --git a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php index 6d66bc1c..8aa9c75e 100644 --- a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php +++ b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php @@ -28,6 +28,12 @@ */ final class PayloadMediaTypeNegotiationMiddleware implements MiddlewareInterface { + public function __construct( + private readonly ?int $errorStatusCode = null, + private readonly ?string $errorMessage = null, + ) { + } + /** * @inheritDoc * @@ -43,12 +49,12 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface $clientProducedMediaType = $serverRequest->getClientProducedMediaType(); if ($clientProducedMediaType === null) { - throw HttpExceptionFactory::missingContentType() + throw HttpExceptionFactory::missingContentType($this->errorMessage, $this->errorStatusCode) ->addHeaderField('Accept', ...$serverConsumedMediaTypes); } if (!$serverRequest->clientProducesMediaType(...$serverConsumedMediaTypes)) { - throw HttpExceptionFactory::unsupportedMediaType() + throw HttpExceptionFactory::unsupportedMediaType($this->errorMessage, $this->errorStatusCode) ->addMessagePlaceholder('{{ media_type }}', $clientProducedMediaType) ->addHeaderField('Accept', ...$serverConsumedMediaTypes); } diff --git a/src/MiddlewareResolver.php b/src/MiddlewareResolver.php index 85b3cd72..398856e8 100644 --- a/src/MiddlewareResolver.php +++ b/src/MiddlewareResolver.php @@ -14,18 +14,22 @@ namespace Sunrise\Http\Router; use Closure; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; use ReflectionFunction; use ReflectionMethod; use Sunrise\Http\Router\Exception\InvalidReferenceException; -use Sunrise\Http\Router\Helper\Stringifier; -use Sunrise\Http\Router\Middleware\CallbackMiddleware; +use Sunrise\Http\Router\Middleware\CallableMiddleware; +use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; use function class_exists; use function is_array; use function is_callable; use function is_string; use function is_subclass_of; +use function method_exists; use function sprintf; /** @@ -47,18 +51,22 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface } if ($reference instanceof Closure) { - return new CallbackMiddleware( - $reference, - new ReflectionFunction($reference), - $this->parameterResolverChain, - $this->responseResolverChain, - ); + return $this->createCallbackMiddleware($reference, new ReflectionFunction($reference)); } if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { return $this->classResolver->resolveClass($reference); } + /** @psalm-suppress ArgumentTypeCoercion */ + // https://github.com/php/php-src/blob/fcdcfe924a9a1973b24d75bd17660d52c32ef9f7/Zend/zend_builtin_functions.c#L897-L900 + if (is_string($reference) && method_exists($reference, '__invoke')) { + return $this->createCallbackMiddleware( + $this->classResolver->resolveClass($reference), + new ReflectionMethod($reference, '__invoke'), + ); + } + // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 if (is_array($reference) && is_callable($reference, true)) { /** @var array{0: string|object, 1: string} $reference */ @@ -70,18 +78,34 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface if (is_callable($reference)) { /** @var array{0: class-string|object, 1: non-empty-string} $reference */ - return new CallbackMiddleware( - $reference, - new ReflectionMethod($reference[0], $reference[1]), - $this->parameterResolverChain, - $this->responseResolverChain, - ); + return $this->createCallbackMiddleware($reference, new ReflectionMethod($reference[0], $reference[1])); } } throw new InvalidReferenceException(sprintf( 'The middleware reference %s could not be resolved.', - Stringifier::stringifyReference($reference), + ReferenceResolver::stringifyReference($reference), )); } + + private function createCallbackMiddleware(callable $callback, ReflectionMethod|ReflectionFunction $reflection): MiddlewareInterface + { + return new CallableMiddleware( + fn(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface => ( + $this->responseResolverChain->resolveResponse( + $callback(...( + $this->parameterResolverChain + ->withContext($request) + ->withResolver( + new ObjectInjectionParameterResolver($request), + new ObjectInjectionParameterResolver($handler), + ) + ->resolveParameters(...$reflection->getParameters()) + )), + $reflection, + $request, + ) + ) + ); + } } diff --git a/src/ParameterResolver/DependencyInjectionParameterResolver.php b/src/ParameterResolver/DependencyInjectionParameterResolver.php index aaf19068..4277cd59 100644 --- a/src/ParameterResolver/DependencyInjectionParameterResolver.php +++ b/src/ParameterResolver/DependencyInjectionParameterResolver.php @@ -24,8 +24,9 @@ */ final class DependencyInjectionParameterResolver implements ParameterResolverInterface { - public function __construct(private readonly ContainerInterface $container) - { + public function __construct( + private readonly ContainerInterface $container, + ) { } /** diff --git a/src/ParameterResolver/ObjectInjectionParameterResolver.php b/src/ParameterResolver/ObjectInjectionParameterResolver.php index 21377618..09bc52eb 100644 --- a/src/ParameterResolver/ObjectInjectionParameterResolver.php +++ b/src/ParameterResolver/ObjectInjectionParameterResolver.php @@ -24,8 +24,9 @@ */ final class ObjectInjectionParameterResolver implements ParameterResolverInterface { - public function __construct(private readonly object $object) - { + public function __construct( + private readonly object $object, + ) { } /** @@ -45,6 +46,6 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) public function getWeight(): int { - return -10; + return 100; } } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 272be822..bd1c79ec 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -22,9 +22,9 @@ use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\InvalidParameterException; -use Sunrise\Http\Router\Helper\Stringifier; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; +use Sunrise\Http\Router\ParameterResolverChain; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolation; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolation; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; @@ -42,6 +42,7 @@ public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, private readonly ?int $defaultErrorStatusCode = null, + private readonly ?string $defaultErrorMessage = null, ) { } @@ -68,25 +69,26 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { throw new InvalidParameterException(sprintf( 'To use the #[RequestBody] annotation, the parameter %s must be typed with an object.', - Stringifier::stringifyParameter($parameter), + ParameterResolverChain::stringifyParameter($parameter), )); } $processParams = $annotations[0]->newInstance(); $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; + $errorMessage = $processParams->errorMessage ?? $this->defaultErrorMessage; try { $argument = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidDataException $e) { - throw HttpExceptionFactory::invalidBody($processParams->errorMessage, $errorStatusCode, previous: $e) - ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $e->getExceptions())); + throw HttpExceptionFactory::invalidBody($errorMessage, $errorStatusCode, previous: $e) + ->addConstraintViolation(...array_map(HydratorConstraintViolation::create(...), $e->getExceptions())); } if (isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { - throw HttpExceptionFactory::invalidBody($processParams->errorMessage, $errorStatusCode) - ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); + throw HttpExceptionFactory::invalidBody($errorMessage, $errorStatusCode) + ->addConstraintViolation(...array_map(ValidatorConstraintViolation::create(...), [...$violations])); } } @@ -95,6 +97,6 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) public function getWeight(): int { - return 0; + return 40; } } diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index e86f1f9a..1e20b853 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -22,8 +22,9 @@ use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ServerRequest; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolation; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolation; +use Sunrise\Http\Router\Validation\ValidatorProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; @@ -41,6 +42,7 @@ public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, private readonly ?int $defaultErrorStatusCode = null, + private readonly ?string $defaultErrorMessage = null, ) { } @@ -66,26 +68,27 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $cookieName = $processParams->cookieName; $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; + $errorMessage = $processParams->errorMessage ?? $this->defaultErrorMessage; if (!$request->hasCookieParam($cookieName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } - throw HttpExceptionFactory::missingCookie($processParams->errorMessage, $errorStatusCode) + throw HttpExceptionFactory::missingCookie($errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ cookie_name }}', $cookieName); } try { $argument = $this->hydrator->castValue($request->getCookieParam($cookieName), Type::fromParameter($parameter), path: [$cookieName]); } catch (InvalidValueException $e) { - throw HttpExceptionFactory::invalidCookie($processParams->errorMessage, $errorStatusCode, previous: $e) + throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ cookie_name }}', $cookieName) - ->addConstraintViolation(HydratorConstraintViolationProxy::create($e)); + ->addConstraintViolation(HydratorConstraintViolation::create($e)); } catch (InvalidDataException $e) { - throw HttpExceptionFactory::invalidCookie($processParams->errorMessage, $errorStatusCode, previous: $e) + throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ cookie_name }}', $cookieName) - ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $e->getExceptions())); + ->addConstraintViolation(...array_map(HydratorConstraintViolation::create(...), $e->getExceptions())); } if (isset($this->validator)) { @@ -93,7 +96,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { throw HttpExceptionFactory::invalidCookie($processParams->errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ cookie_name }}', $cookieName) - ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); + ->addConstraintViolation(...array_map(ValidatorConstraintViolation::create(...), [...$violations])); } } } @@ -103,6 +106,6 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) public function getWeight(): int { - return 0; + return 10; } } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 47853bf9..012d1555 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -21,8 +21,8 @@ use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Helper\ValidatorHelper; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolation; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolation; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; @@ -40,6 +40,7 @@ public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, private readonly ?int $defaultErrorStatusCode = null, + private readonly ?string $defaultErrorMessage = null, ) { } @@ -64,34 +65,35 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $headerName = $processParams->headerName; $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; + $errorMessage = $processParams->errorMessage ?? $this->defaultErrorMessage; if (!$context->hasHeader($headerName)) { if ($parameter->isDefaultValueAvailable()) { return yield $parameter->getDefaultValue(); } - throw HttpExceptionFactory::missingHeader($processParams->errorMessage, $errorStatusCode) + throw HttpExceptionFactory::missingHeader($errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ header_name }}', $headerName); } try { $argument = $this->hydrator->castValue($context->getHeaderLine($headerName), Type::fromParameter($parameter), path: [$headerName]); } catch (InvalidValueException $e) { - throw HttpExceptionFactory::invalidHeader($processParams->errorMessage, $errorStatusCode, previous: $e) + throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ header_name }}', $headerName) - ->addConstraintViolation(HydratorConstraintViolationProxy::create($e)); + ->addConstraintViolation(HydratorConstraintViolation::create($e)); } catch (InvalidDataException $e) { - throw HttpExceptionFactory::invalidHeader($processParams->errorMessage, $errorStatusCode, previous: $e) + throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ header_name }}', $headerName) - ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $e->getExceptions())); + ->addConstraintViolation(...array_map(HydratorConstraintViolation::create(...), $e->getExceptions())); } if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpExceptionFactory::invalidHeader($processParams->errorMessage, $errorStatusCode) + throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ header_name }}', $headerName) - ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); + ->addConstraintViolation(...array_map(ValidatorConstraintViolation::create(...), [...$violations])); } } } @@ -101,6 +103,6 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) public function getWeight(): int { - return 0; + return 20; } } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 46421494..f8877f24 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -22,9 +22,9 @@ use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\InvalidParameterException; -use Sunrise\Http\Router\Helper\Stringifier; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; +use Sunrise\Http\Router\ParameterResolverChain; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolation; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolation; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; @@ -42,6 +42,7 @@ public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, private readonly ?int $defaultErrorStatusCode = null, + private readonly ?string $defaultErrorMessage = null, ) { } @@ -68,25 +69,26 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { throw new InvalidParameterException(sprintf( 'To use the #[RequestQuery] annotation, the parameter %s must be typed with an object.', - Stringifier::stringifyParameter($parameter), + ParameterResolverChain::stringifyParameter($parameter), )); } $processParams = $annotations[0]->newInstance(); $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; + $errorMessage = $processParams->errorMessage ?? $this->defaultErrorMessage; try { $argument = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { - throw HttpExceptionFactory::invalidQuery($processParams->errorMessage, $errorStatusCode, previous: $e) - ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $e->getExceptions())); + throw HttpExceptionFactory::invalidQuery($errorMessage, $errorStatusCode, previous: $e) + ->addConstraintViolation(...array_map(HydratorConstraintViolation::create(...), $e->getExceptions())); } if (isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { - throw HttpExceptionFactory::invalidQuery($processParams->errorMessage, $errorStatusCode) - ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); + throw HttpExceptionFactory::invalidQuery($errorMessage, $errorStatusCode) + ->addConstraintViolation(...array_map(ValidatorConstraintViolation::create(...), [...$violations])); } } @@ -95,6 +97,6 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) public function getWeight(): int { - return 0; + return 30; } } diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index 402a0f52..d5157fd2 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -22,11 +22,11 @@ use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\InvalidParameterException; use Sunrise\Http\Router\Helper\RouteSimplifier; -use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Http\Router\Helper\ValidatorHelper; +use Sunrise\Http\Router\ParameterResolverChain; use Sunrise\Http\Router\ServerRequest; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationProxy; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationProxy; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolation; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolation; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; @@ -45,6 +45,7 @@ public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, private readonly ?int $defaultErrorStatusCode = null, + private readonly ?string $defaultErrorMessage = null, ) { } @@ -71,6 +72,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $variableName = $processParams->variableName ?? $parameter->getName(); $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; + $errorMessage = $processParams->errorMessage ?? $this->defaultErrorMessage; if (!$route->hasAttribute($variableName)) { if ($parameter->isDefaultValueAvailable()) { @@ -81,7 +83,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) 'The parameter %s expects a value of the variable {%s} from the route %s ' . 'which is not present in the request, most likely, because the variable is optional. ' . 'To resolve this issue, assign the default value to the parameter.', - Stringifier::stringifyParameter($parameter), + ParameterResolverChain::stringifyParameter($parameter), $variableName, $route->getName(), )); @@ -90,24 +92,24 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) try { $argument = $this->hydrator->castValue($route->getAttribute($variableName), Type::fromParameter($parameter), path: [$variableName]); } catch (InvalidValueException $e) { - throw HttpExceptionFactory::invalidVariable($processParams->errorMessage, $errorStatusCode, previous: $e) + throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ variable_name }}', $variableName) ->addMessagePlaceholder('{{ route_uri }}', RouteSimplifier::simplifyRoute($route->getPath())) - ->addConstraintViolation(HydratorConstraintViolationProxy::create($e)); + ->addConstraintViolation(HydratorConstraintViolation::create($e)); } catch (InvalidDataException $e) { - throw HttpExceptionFactory::invalidVariable($processParams->errorMessage, $errorStatusCode, previous: $e) + throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder('{{ variable_name }}', $variableName) ->addMessagePlaceholder('{{ route_uri }}', RouteSimplifier::simplifyRoute($route->getPath())) - ->addConstraintViolation(...array_map(HydratorConstraintViolationProxy::create(...), $e->getExceptions())); + ->addConstraintViolation(...array_map(HydratorConstraintViolation::create(...), $e->getExceptions())); } if (isset($this->validator)) { if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpExceptionFactory::invalidVariable($processParams->errorMessage, $errorStatusCode) + throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode) ->addMessagePlaceholder('{{ variable_name }}', $variableName) ->addMessagePlaceholder('{{ route_uri }}', RouteSimplifier::simplifyRoute($route->getPath())) - ->addConstraintViolation(...array_map(ValidatorConstraintViolationProxy::create(...), [...$violations])); + ->addConstraintViolation(...array_map(ValidatorConstraintViolation::create(...), [...$violations])); } } } @@ -117,6 +119,6 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) public function getWeight(): int { - return 0; + return 50; } } diff --git a/src/ParameterResolverChain.php b/src/ParameterResolverChain.php index 96f02e1b..4c8c4c33 100644 --- a/src/ParameterResolverChain.php +++ b/src/ParameterResolverChain.php @@ -14,12 +14,11 @@ namespace Sunrise\Http\Router; use Generator; +use ReflectionMethod; use ReflectionParameter; use Sunrise\Http\Router\Exception\UnsupportedParameterException; -use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; -use function array_unshift; use function sprintf; use function usort; @@ -28,16 +27,14 @@ */ final class ParameterResolverChain implements ParameterResolverChainInterface { + private bool $isSorted = false; + private mixed $context = null; public function __construct( - /** @var ParameterResolverInterface[] */ + /** @var array */ private array $resolvers = [], ) { - usort($this->resolvers, static fn( - ParameterResolverInterface $a, - ParameterResolverInterface $b, - ): int => $b->getWeight() <=> $a->getWeight()); } public function withContext(mixed $context): static @@ -48,11 +45,13 @@ public function withContext(mixed $context): static return $clone; } - public function withPriorityResolver(ParameterResolverInterface ...$resolvers): static + public function withResolver(ParameterResolverInterface ...$resolvers): static { $clone = clone $this; - - array_unshift($clone->resolvers, ...$resolvers); + $clone->isSorted = false; + foreach ($resolvers as $resolver) { + $clone->resolvers[] = $resolver; + } return $clone; } @@ -64,6 +63,8 @@ public function withPriorityResolver(ParameterResolverInterface ...$resolvers): */ public function resolveParameters(ReflectionParameter ...$parameters): Generator { + $this->isSorted or $this->sortResolvers(); + foreach ($parameters as $parameter) { yield from $this->resolveParameter($parameter, $this->context); } @@ -85,7 +86,26 @@ private function resolveParameter(ReflectionParameter $parameter, mixed $context throw new UnsupportedParameterException(sprintf( 'The parameter %s is not supported and cannot be resolved.', - Stringifier::stringifyParameter($parameter), + self::stringifyParameter($parameter), )); } + + private function sortResolvers(): void + { + $this->isSorted = usort($this->resolvers, static fn( + ParameterResolverInterface $a, + ParameterResolverInterface $b, + ) => $b->getWeight() <=> $a->getWeight()); + } + + public static function stringifyParameter(ReflectionParameter $parameter): string + { + $function = $parameter->getDeclaringFunction(); + + if ($function instanceof ReflectionMethod) { + return sprintf('%s::%s($%s[%d])', $function->getDeclaringClass()->getName(), $function->getName(), $parameter->getName(), $parameter->getPosition()); + } + + return sprintf('%s($%s[%d])', $function->getName(), $parameter->getName(), $parameter->getPosition()); + } } diff --git a/src/ParameterResolverChainInterface.php b/src/ParameterResolverChainInterface.php index d39e0b4f..2cba4244 100644 --- a/src/ParameterResolverChainInterface.php +++ b/src/ParameterResolverChainInterface.php @@ -24,7 +24,7 @@ interface ParameterResolverChainInterface { public function withContext(mixed $context): static; - public function withPriorityResolver(ParameterResolverInterface ...$resolvers): static; + public function withResolver(ParameterResolverInterface ...$resolvers): static; /** * @return Generator diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index ec9e33ad..555f2883 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -19,6 +19,9 @@ use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; +use function get_debug_type; +use function is_callable; + /** * @since 2.10.0 */ @@ -31,13 +34,13 @@ public function __construct( } /** - * @param ParameterResolverInterface[] $parameterResolvers - * @param ResponseResolverInterface[] $responseResolvers + * @param array $parameterResolvers + * @param array $responseResolvers */ public static function build( array $parameterResolvers = [], array $responseResolvers = [], - ContainerInterface|null $container = null, + ?ContainerInterface $container = null, ): ReferenceResolverInterface { $parameterResolverChain = new ParameterResolverChain($parameterResolvers); $responseResolverChain = new ResponseResolverChain($responseResolvers); @@ -57,4 +60,14 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface { return $this->requestHandlerResolver->resolveRequestHandler($reference); } + + public static function stringifyReference(mixed $reference): string + { + // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 + if (is_callable($reference, true, $result)) { + return $result; + } + + return get_debug_type($reference); + } } diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index e603c119..d80067f6 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -18,6 +18,8 @@ use Psr\Http\Server\RequestHandlerInterface; /** + * @since 2.0.0 + * * @template T as callable(ServerRequestInterface=): ResponseInterface */ final class CallableRequestHandler implements RequestHandlerInterface diff --git a/src/RequestHandler/CallbackRequestHandler.php b/src/RequestHandler/CallbackRequestHandler.php deleted file mode 100644 index 6e327773..00000000 --- a/src/RequestHandler/CallbackRequestHandler.php +++ /dev/null @@ -1,61 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\RequestHandler; - -use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\RequestHandlerInterface; -use ReflectionFunction; -use ReflectionMethod; -use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; -use Sunrise\Http\Router\ParameterResolverChainInterface; -use Sunrise\Http\Router\ResponseResolverChainInterface; - -/** - * @since 3.0.0 - */ -final class CallbackRequestHandler implements RequestHandlerInterface -{ - /** @var callable */ - private $callback; - - public function __construct( - callable $callback, - private readonly ReflectionMethod|ReflectionFunction $callbackReflection, - private readonly ParameterResolverChainInterface $parameterResolverChain, - private readonly ResponseResolverChainInterface $responseResolverChain, - ) { - $this->callback = $callback; - } - - public function getCallbackReflection(): ReflectionMethod|ReflectionFunction - { - return $this->callbackReflection; - } - - /** - * @inheritDoc - */ - public function handle(ServerRequestInterface $request): ResponseInterface - { - $arguments = $this->parameterResolverChain - ->withContext($request) - ->withPriorityResolver( - new ObjectInjectionParameterResolver($request) - ) - ->resolveParameters(...$this->callbackReflection->getParameters()); - - return $this->responseResolverChain->resolveResponse(($this->callback)(...$arguments), $this->callbackReflection, $request); - } -} diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index c71a9057..0360df14 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -20,6 +20,8 @@ use SplQueue; /** + * @since 2.0.0 + * * @extends SplQueue */ final class QueueableRequestHandler extends SplQueue implements RequestHandlerInterface diff --git a/src/RequestHandlerResolver.php b/src/RequestHandlerResolver.php index 73cdf2b0..a0702048 100644 --- a/src/RequestHandlerResolver.php +++ b/src/RequestHandlerResolver.php @@ -14,12 +14,14 @@ namespace Sunrise\Http\Router; use Closure; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; use ReflectionFunction; use ReflectionMethod; use Sunrise\Http\Router\Exception\InvalidReferenceException; -use Sunrise\Http\Router\Helper\Stringifier; -use Sunrise\Http\Router\RequestHandler\CallbackRequestHandler; +use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; +use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use function class_exists; use function is_array; @@ -47,12 +49,7 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface } if ($reference instanceof Closure) { - return new CallbackRequestHandler( - $reference, - new ReflectionFunction($reference), - $this->parameterResolverChain, - $this->responseResolverChain, - ); + return $this->createRequestHandlerCallback($reference, new ReflectionFunction($reference)); } // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 @@ -66,12 +63,7 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface if (is_callable($reference)) { /** @var array{0: class-string|object, 1: non-empty-string} $reference */ - return new CallbackRequestHandler( - $reference, - new ReflectionMethod($reference[0], $reference[1]), - $this->parameterResolverChain, - $this->responseResolverChain, - ); + return $this->createRequestHandlerCallback($reference, new ReflectionMethod($reference[0], $reference[1])); } } @@ -81,7 +73,27 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface throw new InvalidReferenceException(sprintf( 'The request handler reference %s could not be resolved.', - Stringifier::stringifyReference($reference), + ReferenceResolver::stringifyReference($reference), )); } + + private function createRequestHandlerCallback(callable $callback, ReflectionMethod|ReflectionFunction $reflection): RequestHandlerInterface + { + return new CallableRequestHandler( + fn(ServerRequestInterface $request): ResponseInterface => ( + $this->responseResolverChain->resolveResponse( + $callback(...( + $this->parameterResolverChain + ->withContext($request) + ->withResolver( + new ObjectInjectionParameterResolver($request), + ) + ->resolveParameters(...$reflection->getParameters()) + )), + $reflection, + $request, + ) + ) + ); + } } diff --git a/src/ResponseResolver/EmptyResponseResolver.php b/src/ResponseResolver/EmptyResponseResolver.php index a190b69d..c8445473 100644 --- a/src/ResponseResolver/EmptyResponseResolver.php +++ b/src/ResponseResolver/EmptyResponseResolver.php @@ -26,8 +26,12 @@ */ final class EmptyResponseResolver implements ResponseResolverInterface { - public function __construct(private readonly ResponseFactoryInterface $responseFactory) - { + public const DEFAULT_STATUS_CODE = StatusCodeInterface::STATUS_NO_CONTENT; + + public function __construct( + private readonly ResponseFactoryInterface $responseFactory, + private readonly ?int $defaultStatusCode = null, + ) { } public function resolveResponse( @@ -39,11 +43,13 @@ public function resolveResponse( return null; } - return $this->responseFactory->createResponse(StatusCodeInterface::STATUS_NO_CONTENT); + $statusCode = $this->defaultStatusCode ?? self::DEFAULT_STATUS_CODE; + + return $this->responseFactory->createResponse($statusCode); } public function getWeight(): int { - return 0; + return 10; } } diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index 534b5b6f..416e6b37 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -23,7 +23,7 @@ use ReflectionMethod; use Sunrise\Http\Router\Annotation\JsonResponse; use Sunrise\Http\Router\Exception\InvalidResponseException; -use Sunrise\Http\Router\Helper\Stringifier; +use Sunrise\Http\Router\ResponseResolverChain; use function json_encode; use function sprintf; @@ -38,10 +38,15 @@ final class JsonResponseResolver implements ResponseResolverInterface public const DEFAULT_ENCODING_FLAGS = 0; public const DEFAULT_ENCODING_DEPTH = 512; + public const DEFAULT_STATUS_CODE = StatusCodeInterface::STATUS_OK; + public const DEFAULT_CONTENT_TYPE = 'application/json; charset=UTF-8'; + public function __construct( private readonly ResponseFactoryInterface $responseFactory, - private readonly int $defaultEncodingFlags = self::DEFAULT_ENCODING_FLAGS, - private readonly int $defaultEncodingDepth = self::DEFAULT_ENCODING_DEPTH, + private readonly ?int $defaultEncodingFlags = null, + private readonly ?int $defaultEncodingDepth = null, + private readonly ?int $defaultStatusCode = null, + private readonly ?string $defaultContentType = null, ) { } @@ -61,8 +66,8 @@ public function resolveResponse( $processParams = $annotations[0]->newInstance(); - $encodingFlags = $processParams->encodingFlags ?? $this->defaultEncodingFlags; - $encodingDepth = $processParams->encodingDepth ?? $this->defaultEncodingDepth; + $encodingFlags = $processParams->encodingFlags ?? $this->defaultEncodingFlags ?? self::DEFAULT_ENCODING_FLAGS; + $encodingDepth = $processParams->encodingDepth ?? $this->defaultEncodingDepth ?? self::DEFAULT_ENCODING_DEPTH; try { /** @psalm-suppress ArgumentTypeCoercion */ @@ -70,13 +75,16 @@ public function resolveResponse( } catch (JsonException $e) { throw new InvalidResponseException(sprintf( 'The responder %s returned a response that could not be encoded to JSON due to: %s', - Stringifier::stringifyResponder($responder), + ResponseResolverChain::stringifyResponder($responder), $e->getMessage(), ), previous: $e); } - $jsonResponse = $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK) - ->withHeader('Content-Type', 'application/json; charset=UTF-8'); + $statusCode = $this->defaultStatusCode ?? self::DEFAULT_STATUS_CODE; + $contentType = $this->defaultContentType ?? self::DEFAULT_CONTENT_TYPE; + + $jsonResponse = $this->responseFactory->createResponse($statusCode) + ->withHeader('Content-Type', $contentType); $jsonResponse->getBody()->write($payload); @@ -85,6 +93,6 @@ public function resolveResponse( public function getWeight(): int { - return 0; + return 20; } } diff --git a/src/ResponseResolverChain.php b/src/ResponseResolverChain.php index 53619d16..b148f67d 100644 --- a/src/ResponseResolverChain.php +++ b/src/ResponseResolverChain.php @@ -22,7 +22,6 @@ use Sunrise\Http\Router\Annotation\ResponseStatus; use Sunrise\Http\Router\Exception\InvalidResponseException; use Sunrise\Http\Router\Exception\UnsupportedResponseException; -use Sunrise\Http\Router\Helper\Stringifier; use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; use function sprintf; @@ -33,14 +32,12 @@ */ final class ResponseResolverChain implements ResponseResolverChainInterface { + private bool $isSorted = false; + public function __construct( - /** @var ResponseResolverInterface[] */ + /** @var array */ private array $resolvers = [], ) { - usort($this->resolvers, static fn( - ResponseResolverInterface $a, - ResponseResolverInterface $b, - ): int => $b->getWeight() <=> $a->getWeight()); } /** @@ -56,6 +53,7 @@ public function resolveResponse( return $response; } + $this->isSorted or $this->sortResolvers(); foreach ($this->resolvers as $resolver) { $resolvedResponse = $resolver->resolveResponse($response, $responder, $request); if ($resolvedResponse instanceof ResponseInterface) { @@ -65,7 +63,7 @@ public function resolveResponse( throw new UnsupportedResponseException(sprintf( 'The responder %s returned an unsupported response that cannot be resolved.', - Stringifier::stringifyResponder($responder), + self::stringifyResponder($responder), )); } @@ -89,4 +87,21 @@ private function completeResponse( return $response; } + + private function sortResolvers(): void + { + $this->isSorted = usort($this->resolvers, static fn( + ResponseResolverInterface $a, + ResponseResolverInterface $b, + ): int => $b->getWeight() <=> $a->getWeight()); + } + + public static function stringifyResponder(ReflectionMethod|ReflectionFunction $responder): string + { + if ($responder instanceof ReflectionMethod) { + return sprintf('%s::%s()', $responder->getDeclaringClass()->getName(), $responder->getName()); + } + + return sprintf('%s()', $responder->getName()); + } } diff --git a/src/RouteInterface.php b/src/RouteInterface.php index f61c1991..71247275 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -15,16 +15,27 @@ use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; +/** + * @since 1.0.0 + */ interface RouteInterface { + /** + * @since 2.0.0 + */ public function getName(): string; public function getPath(): string; + /** + * @since 2.0.0 + */ public function getRequestHandler(): mixed; /** * @return array + * + * @since 3.0.0 */ public function getPatterns(): array; @@ -33,6 +44,9 @@ public function getPatterns(): array; */ public function getMethods(): array; + /** + * @since 3.0.0 + */ public function allowsMethod(string $method): bool; /** @@ -40,53 +54,84 @@ public function allowsMethod(string $method): bool; */ public function getAttributes(): array; + /** + * @since 3.0.0 + */ public function getAttribute(string $name, mixed $default = null): mixed; + /** + * @since 3.0.0 + */ public function hasAttribute(string $name): bool; /** * @param array $attributes + * + * @since 3.0.0 */ public function withAttributes(array $attributes): static; /** * @param array $attributes + * + * @since 2.0.0 */ public function withAddedAttributes(array $attributes): static; /** * @return array + * + * @since 2.0.0 */ public function getMiddlewares(): array; /** * @return array + * + * @since 3.0.0 */ public function getConstraints(): array; /** * @return array + * + * @since 3.0.0 */ public function getConsumedMediaTypes(): array; /** * @return array + * + * @since 3.0.0 */ public function getProducedMediaTypes(): array; /** * @return array + * + * @since 2.4.0 */ public function getTags(): array; + /** + * @since 2.4.0 + */ public function getSummary(): string; + /** + * @since 2.4.0 + */ public function getDescription(): string; + /** + * @since 3.0.0 + */ public function isDeprecated(): bool; /** * @return non-empty-string|null + * + * @since 3.0.0 */ public function getPattern(): ?string; } diff --git a/src/Router.php b/src/Router.php index fbbe7b49..537342fd 100644 --- a/src/Router.php +++ b/src/Router.php @@ -15,7 +15,6 @@ use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; -use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\HttpExceptionInterface; @@ -61,19 +60,16 @@ class Router implements RequestHandlerInterface private ?RequestHandlerInterface $requestHandler = null; /** - * @param LoaderInterface[] $loaders - * @param MiddlewareInterface[] $middlewares + * @param list $loaders * * @since 3.0.0 */ public function __construct( array $loaders = [], array $middlewares = [], - ReferenceResolverInterface $referenceResolver = null, + ?ReferenceResolverInterface $referenceResolver = null, ) { - foreach ($loaders as $loader) { - $this->load($loader); - } + $this->load(...$loaders); $this->middlewares = $middlewares; diff --git a/src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php b/src/Validation/ConstraintViolation/HydratorConstraintViolation.php similarity index 55% rename from src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php rename to src/Validation/ConstraintViolation/HydratorConstraintViolation.php index adb5e759..a092cb40 100644 --- a/src/Validation/ConstraintViolation/HydratorConstraintViolationProxy.php +++ b/src/Validation/ConstraintViolation/HydratorConstraintViolation.php @@ -19,39 +19,40 @@ /** * @since 3.0.0 */ -final class HydratorConstraintViolationProxy implements ConstraintViolationInterface +final class HydratorConstraintViolation implements ConstraintViolationInterface { - public function __construct(private readonly InvalidValueException $hydratorConstraintViolation) - { + public function __construct( + private readonly InvalidValueException $constraintViolation, + ) { } - public static function create(InvalidValueException $hydratorConstraintViolation): self + public static function create(InvalidValueException $constraintViolation): self { - return new self($hydratorConstraintViolation); + return new self($constraintViolation); } public function getMessage(): string { - return $this->hydratorConstraintViolation->getMessage(); + return $this->constraintViolation->getMessage(); } public function getMessageTemplate(): string { - return $this->hydratorConstraintViolation->getMessageTemplate(); + return $this->constraintViolation->getMessageTemplate(); } public function getMessagePlaceholders(): array { - return $this->hydratorConstraintViolation->getMessagePlaceholders(); + return $this->constraintViolation->getMessagePlaceholders(); } public function getPropertyPath(): string { - return $this->hydratorConstraintViolation->getPropertyPath(); + return $this->constraintViolation->getPropertyPath(); } public function getCode(): ?string { - return $this->hydratorConstraintViolation->getErrorCode(); + return $this->constraintViolation->getErrorCode(); } } diff --git a/src/Validation/ConstraintViolation/ValidatorConstraintViolation.php b/src/Validation/ConstraintViolation/ValidatorConstraintViolation.php new file mode 100644 index 00000000..b88857c1 --- /dev/null +++ b/src/Validation/ConstraintViolation/ValidatorConstraintViolation.php @@ -0,0 +1,57 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Validation\ConstraintViolation; + +use Sunrise\Http\Router\Helper\ValidatorHelper; + +/** + * @since 3.0.0 + */ +final class ValidatorConstraintViolation implements \Sunrise\Http\Router\Validation\ConstraintViolationInterface +{ + public function __construct( + private readonly \Symfony\Component\Validator\ConstraintViolationInterface $constraintViolation, + ) { + } + + public static function create(\Symfony\Component\Validator\ConstraintViolationInterface $constraintViolation): self + { + return new self($constraintViolation); + } + + public function getMessage(): string + { + return (string) $this->constraintViolation->getMessage(); + } + + public function getMessageTemplate(): string + { + return $this->constraintViolation->getMessageTemplate(); + } + + public function getMessagePlaceholders(): array + { + return $this->constraintViolation->getParameters(); + } + + public function getPropertyPath(): string + { + return ValidatorHelper::adaptPropertyPath($this->constraintViolation->getPropertyPath()); + } + + public function getCode(): ?string + { + return $this->constraintViolation->getCode(); + } +} diff --git a/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php b/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php deleted file mode 100644 index 39da7478..00000000 --- a/src/Validation/ConstraintViolation/ValidatorConstraintViolationProxy.php +++ /dev/null @@ -1,58 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Validation\ConstraintViolation; - -use Sunrise\Http\Router\Helper\ValidatorHelper; -use Sunrise\Http\Router\Validation\ConstraintViolationInterface as RouterConstraintViolationInterface; -use Symfony\Component\Validator\ConstraintViolationInterface as ValidatorConstraintViolationInterface; - -/** - * @since 3.0.0 - */ -final class ValidatorConstraintViolationProxy implements RouterConstraintViolationInterface -{ - public function __construct(private readonly ValidatorConstraintViolationInterface $validatorConstraintViolation) - { - } - - public static function create(ValidatorConstraintViolationInterface $validatorConstraintViolation): self - { - return new self($validatorConstraintViolation); - } - - public function getMessage(): string - { - return (string) $this->validatorConstraintViolation->getMessage(); - } - - public function getMessageTemplate(): string - { - return $this->validatorConstraintViolation->getMessageTemplate(); - } - - public function getMessagePlaceholders(): array - { - return $this->validatorConstraintViolation->getParameters(); - } - - public function getPropertyPath(): string - { - return ValidatorHelper::adaptPropertyPath($this->validatorConstraintViolation->getPropertyPath()); - } - - public function getCode(): ?string - { - return $this->validatorConstraintViolation->getCode(); - } -} From 0feaa28cd4934fae06443a4537075ff24720dd3f Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 16 Mar 2024 06:18:16 +0100 Subject: [PATCH 143/180] v3 --- src/ParameterResolver/RequestCookieParameterResolver.php | 1 - 1 file changed, 1 deletion(-) diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index 1e20b853..b48c54c9 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -24,7 +24,6 @@ use Sunrise\Http\Router\ServerRequest; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolation; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolation; -use Sunrise\Http\Router\Validation\ValidatorProxy; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; From 7e3feed345176c55a3247b0f430062a3f34bddf3 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 17 Mar 2024 16:37:06 +0100 Subject: [PATCH 144/180] v3 --- README.md | 2 +- phpunit.xml.dist | 1 - src/Annotation/Method.php | 3 - src/Annotation/RequestCookie.php | 2 +- src/Annotation/RequestHeader.php | 2 +- src/Annotation/RequestVariable.php | 2 +- src/Command/RouteListCommand.php | 5 +- src/Dictionary/RequestMethod.php | 29 --------- src/Dictionary/VariablePattern.php | 8 --- src/Entity/Language/ClientLanguage.php | 7 +- src/Entity/Language/LanguageComparator.php | 8 ++- .../Language/LanguageComparatorInterface.php | 2 +- src/Entity/MediaType/ClientMediaType.php | 2 +- src/Entity/MediaType/MediaTypeComparator.php | 10 ++- .../MediaTypeComparatorInterface.php | 2 +- src/Entity/MediaType/MediaTypeInterface.php | 5 -- src/Entity/MediaType/ServerMediaType.php | 2 +- src/Helper/ValidatorHelper.php | 50 -------------- src/MiddlewareResolver.php | 16 +---- .../RequestBodyParameterResolver.php | 10 +-- .../RequestCookieParameterResolver.php | 32 ++++----- .../RequestHeaderParameterResolver.php | 32 ++++----- .../RequestQueryParameterResolver.php | 10 +-- .../RequestVariableParameterResolver.php | 37 ++++++----- src/ParameterResolverChain.php | 7 +- src/RequestHandlerResolver.php | 6 +- .../EmptyResponseResolver.php | 2 +- src/ResponseResolver/JsonResponseResolver.php | 2 +- src/ResponseResolverChain.php | 7 +- src/Route.php | 17 ++--- src/RouteInterface.php | 7 -- src/ServerRequest.php | 6 +- .../Constraint/ArgumentConstraint.php | 35 ++++++++++ .../ArgumentConstraintValidator.php | 54 +++++++++++++++ ...=> HydratorConstraintViolationAdapter.php} | 18 ++--- .../ValidatorConstraintViolation.php | 57 ---------------- .../ValidatorConstraintViolationAdapter.php | 65 +++++++++++++++++++ 37 files changed, 276 insertions(+), 286 deletions(-) delete mode 100644 src/Dictionary/RequestMethod.php delete mode 100644 src/Helper/ValidatorHelper.php create mode 100644 src/Validation/Constraint/ArgumentConstraint.php create mode 100644 src/Validation/Constraint/ArgumentConstraintValidator.php rename src/Validation/ConstraintViolation/{HydratorConstraintViolation.php => HydratorConstraintViolationAdapter.php} (57%) delete mode 100644 src/Validation/ConstraintViolation/ValidatorConstraintViolation.php create mode 100644 src/Validation/ConstraintViolation/ValidatorConstraintViolationAdapter.php diff --git a/README.md b/README.md index 6dcfdf22..d33ac903 100644 --- a/README.md +++ b/README.md @@ -1 +1 @@ -# Work In Progress +# Very soon... diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 0ac15159..66c8dba8 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -5,7 +5,6 @@ > - ./functions ./src diff --git a/src/Annotation/Method.php b/src/Annotation/Method.php index b9769206..1ae7f34a 100644 --- a/src/Annotation/Method.php +++ b/src/Annotation/Method.php @@ -14,11 +14,8 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Dictionary\RequestMethod; /** - * Pay attention to the {@see RequestMethod} dictionary. - * * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] diff --git a/src/Annotation/RequestCookie.php b/src/Annotation/RequestCookie.php index fdb2c667..aa73328c 100644 --- a/src/Annotation/RequestCookie.php +++ b/src/Annotation/RequestCookie.php @@ -22,7 +22,7 @@ final class RequestCookie { public function __construct( - public readonly string $cookieName, + public readonly string $name, public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, ) { diff --git a/src/Annotation/RequestHeader.php b/src/Annotation/RequestHeader.php index cbe451ec..c088085a 100644 --- a/src/Annotation/RequestHeader.php +++ b/src/Annotation/RequestHeader.php @@ -22,7 +22,7 @@ final class RequestHeader { public function __construct( - public readonly string $headerName, + public readonly string $name, public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, ) { diff --git a/src/Annotation/RequestVariable.php b/src/Annotation/RequestVariable.php index 1dde6f6b..24a1ff16 100644 --- a/src/Annotation/RequestVariable.php +++ b/src/Annotation/RequestVariable.php @@ -22,7 +22,7 @@ final class RequestVariable { public function __construct( - public readonly ?string $variableName = null, + public readonly ?string $name = null, public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, ) { diff --git a/src/Command/RouteListCommand.php b/src/Command/RouteListCommand.php index 81a0902c..285162c7 100644 --- a/src/Command/RouteListCommand.php +++ b/src/Command/RouteListCommand.php @@ -28,9 +28,8 @@ #[AsCommand('router:route-list', 'Lists all routes.')] final class RouteListCommand extends Command { - public function __construct( - private readonly Router $router, - ) { + public function __construct(private readonly Router $router) + { parent::__construct(); } diff --git a/src/Dictionary/RequestMethod.php b/src/Dictionary/RequestMethod.php deleted file mode 100644 index 335af52d..00000000 --- a/src/Dictionary/RequestMethod.php +++ /dev/null @@ -1,29 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Dictionary; - -/** - * @since 3.0.0 - */ -final class RequestMethod -{ - public const OPTIONS = 'OPTIONS'; - public const HEAD = 'HEAD'; - public const GET = 'GET'; - public const POST = 'POST'; - public const PUT = 'PUT'; - public const PATCH = 'PATCH'; - public const DELETE = 'DELETE'; - public const PURGE = 'PURGE'; -} diff --git a/src/Dictionary/VariablePattern.php b/src/Dictionary/VariablePattern.php index ca3c4dd0..69532fff 100644 --- a/src/Dictionary/VariablePattern.php +++ b/src/Dictionary/VariablePattern.php @@ -18,13 +18,5 @@ */ final class VariablePattern { - public const ALNUM = '[0-9A-Za-z]+'; - public const ALPHA = '[A-Za-z]+'; - public const DIGIT = '[0-9]+'; - public const LOWER = '[a-z]+'; - public const UPPER = '[A-Z]+'; - public const WORD = '[0-9A-Za-z_]+'; - public const SLUG = '[0-9A-Za-z-]+'; public const UUID = '[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}'; - public const LANG = '[a-z]{2}'; } diff --git a/src/Entity/Language/ClientLanguage.php b/src/Entity/Language/ClientLanguage.php index b1b22afd..92632eee 100644 --- a/src/Entity/Language/ClientLanguage.php +++ b/src/Entity/Language/ClientLanguage.php @@ -20,7 +20,8 @@ final class ClientLanguage implements LanguageInterface { public function __construct( private readonly string $code, - private readonly string $locale, + // One of the Accept-Language header's identifier. + private readonly string $identifier, /** @var array */ private readonly array $parameters, ) { @@ -31,9 +32,9 @@ public function getCode(): string return $this->code; } - public function getLocale(): string + public function getIdentifier(): string { - return $this->locale; + return $this->identifier; } /** diff --git a/src/Entity/Language/LanguageComparator.php b/src/Entity/Language/LanguageComparator.php index d1cf328c..fd5ce6bf 100644 --- a/src/Entity/Language/LanguageComparator.php +++ b/src/Entity/Language/LanguageComparator.php @@ -18,8 +18,12 @@ */ final class LanguageComparator implements LanguageComparatorInterface { - public function equals(LanguageInterface $a, LanguageInterface $b): bool + public function compare(LanguageInterface $a, LanguageInterface $b): int { - return $a->getCode() === $b->getCode() || $a->getCode() === '*' || $b->getCode() === '*'; + if ($a->getCode() === $b->getCode() || $a->getCode() === '*' || $b->getCode() === '*') { + return 0; + } + + return $a->getCode() <=> $b->getCode(); } } diff --git a/src/Entity/Language/LanguageComparatorInterface.php b/src/Entity/Language/LanguageComparatorInterface.php index 8eafb7e6..293a5f27 100644 --- a/src/Entity/Language/LanguageComparatorInterface.php +++ b/src/Entity/Language/LanguageComparatorInterface.php @@ -18,5 +18,5 @@ */ interface LanguageComparatorInterface { - public function equals(LanguageInterface $a, LanguageInterface $b): bool; + public function compare(LanguageInterface $a, LanguageInterface $b): int; } diff --git a/src/Entity/MediaType/ClientMediaType.php b/src/Entity/MediaType/ClientMediaType.php index c1062ea4..57350951 100644 --- a/src/Entity/MediaType/ClientMediaType.php +++ b/src/Entity/MediaType/ClientMediaType.php @@ -46,6 +46,6 @@ public function getParameters(): array public function __toString(): string { - return $this->type . $this::SEPARATOR . $this->subtype; + return $this->type . '/' . $this->subtype; } } diff --git a/src/Entity/MediaType/MediaTypeComparator.php b/src/Entity/MediaType/MediaTypeComparator.php index 96fd18f8..25ec94e3 100644 --- a/src/Entity/MediaType/MediaTypeComparator.php +++ b/src/Entity/MediaType/MediaTypeComparator.php @@ -18,9 +18,13 @@ */ final class MediaTypeComparator implements MediaTypeComparatorInterface { - public function equals(MediaTypeInterface $a, MediaTypeInterface $b): bool + public function compare(MediaTypeInterface $a, MediaTypeInterface $b): int { - return ($a->getType() === $b->getType() || $a->getType() === '*' || $b->getType() === '*') - && ($a->getSubtype() === $b->getSubtype() || $a->getSubtype() === '*' || $b->getSubtype() === '*'); + if (($a->getType() === $b->getType() || $a->getType() === '*' || $b->getType() === '*') && + ($a->getSubtype() === $b->getSubtype() || $a->getSubtype() === '*' || $b->getSubtype() === '*')) { + return 0; + } + + return $a->__toString() <=> $b->__toString(); } } diff --git a/src/Entity/MediaType/MediaTypeComparatorInterface.php b/src/Entity/MediaType/MediaTypeComparatorInterface.php index 14300d69..ff89facb 100644 --- a/src/Entity/MediaType/MediaTypeComparatorInterface.php +++ b/src/Entity/MediaType/MediaTypeComparatorInterface.php @@ -18,5 +18,5 @@ */ interface MediaTypeComparatorInterface { - public function equals(MediaTypeInterface $a, MediaTypeInterface $b): bool; + public function compare(MediaTypeInterface $a, MediaTypeInterface $b): int; } diff --git a/src/Entity/MediaType/MediaTypeInterface.php b/src/Entity/MediaType/MediaTypeInterface.php index 339f39bb..3f1a2bc4 100644 --- a/src/Entity/MediaType/MediaTypeInterface.php +++ b/src/Entity/MediaType/MediaTypeInterface.php @@ -20,11 +20,6 @@ */ interface MediaTypeInterface extends Stringable { - /** - * @link https://datatracker.ietf.org/doc/html/rfc2046 - */ - final public const SEPARATOR = '/'; - public function getType(): string; public function getSubtype(): string; diff --git a/src/Entity/MediaType/ServerMediaType.php b/src/Entity/MediaType/ServerMediaType.php index 0e1f1b9e..cbf08778 100644 --- a/src/Entity/MediaType/ServerMediaType.php +++ b/src/Entity/MediaType/ServerMediaType.php @@ -36,6 +36,6 @@ public function getSubtype(): string public function __toString(): string { - return $this->type . $this::SEPARATOR . $this->subtype; + return $this->type . '/' . $this->subtype; } } diff --git a/src/Helper/ValidatorHelper.php b/src/Helper/ValidatorHelper.php deleted file mode 100644 index 9a810186..00000000 --- a/src/Helper/ValidatorHelper.php +++ /dev/null @@ -1,50 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Helper; - -use Generator; -use ReflectionAttribute; -use ReflectionParameter; -use Sunrise\Http\Router\Annotation\Constraint as RouterConstraint; -use Symfony\Component\Validator\Constraint as ValidatorConstraint; - -use function ltrim; -use function preg_replace; - -/** - * @since 3.0.0 - */ -final class ValidatorHelper -{ - /** - * @return Generator - */ - public static function getParameterConstraints(ReflectionParameter $parameter): Generator - { - /** @var ReflectionAttribute $annotation */ - foreach ($parameter->getAttributes(RouterConstraint::class) as $annotation) { - $routerConstraint = $annotation->newInstance(); - if ($routerConstraint->value instanceof ValidatorConstraint) { - yield $routerConstraint->value; - } - } - } - - public static function adaptPropertyPath(string $propertyPath): string - { - $propertyPath = preg_replace('/\x5b([^\x5b\x5d]+)\x5d/', '.$1', $propertyPath); - - return ltrim($propertyPath, '.'); - } -} diff --git a/src/MiddlewareResolver.php b/src/MiddlewareResolver.php index 398856e8..5b59b997 100644 --- a/src/MiddlewareResolver.php +++ b/src/MiddlewareResolver.php @@ -29,7 +29,6 @@ use function is_callable; use function is_string; use function is_subclass_of; -use function method_exists; use function sprintf; /** @@ -58,15 +57,6 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface return $this->classResolver->resolveClass($reference); } - /** @psalm-suppress ArgumentTypeCoercion */ - // https://github.com/php/php-src/blob/fcdcfe924a9a1973b24d75bd17660d52c32ef9f7/Zend/zend_builtin_functions.c#L897-L900 - if (is_string($reference) && method_exists($reference, '__invoke')) { - return $this->createCallbackMiddleware( - $this->classResolver->resolveClass($reference), - new ReflectionMethod($reference, '__invoke'), - ); - } - // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 if (is_array($reference) && is_callable($reference, true)) { /** @var array{0: string|object, 1: string} $reference */ @@ -93,15 +83,15 @@ private function createCallbackMiddleware(callable $callback, ReflectionMethod|R return new CallableMiddleware( fn(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface => ( $this->responseResolverChain->resolveResponse( - $callback(...( - $this->parameterResolverChain + $callback( + ...$this->parameterResolverChain ->withContext($request) ->withResolver( new ObjectInjectionParameterResolver($request), new ObjectInjectionParameterResolver($handler), ) ->resolveParameters(...$reflection->getParameters()) - )), + ), $reflection, $request, ) diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index bd1c79ec..bdd83c7a 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -23,8 +23,8 @@ use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\InvalidParameterException; use Sunrise\Http\Router\ParameterResolverChain; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolation; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolation; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; @@ -82,13 +82,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidBody($errorMessage, $errorStatusCode, previous: $e) - ->addConstraintViolation(...array_map(HydratorConstraintViolation::create(...), $e->getExceptions())); + ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); } if (isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { throw HttpExceptionFactory::invalidBody($errorMessage, $errorStatusCode) - ->addConstraintViolation(...array_map(ValidatorConstraintViolation::create(...), [...$violations])); + ->addConstraintViolation(...array_map(ValidatorConstraintViolationAdapter::create(...), [...$violations])); } } @@ -97,6 +97,6 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) public function getWeight(): int { - return 40; + return 0; } } diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index b48c54c9..12d97a6c 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -20,10 +20,10 @@ use Sunrise\Http\Router\Annotation\RequestCookie; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ServerRequest; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolation; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolation; +use Sunrise\Http\Router\Validation\Constraint\ArgumentConstraint; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; @@ -37,6 +37,8 @@ */ final class RequestCookieParameterResolver implements ParameterResolverInterface { + private const PLACEHOLDER_COOKIE_NAME = '{{ cookie_name }}'; + public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, @@ -65,7 +67,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $request = ServerRequest::create($context); $processParams = $annotations[0]->newInstance(); - $cookieName = $processParams->cookieName; + $cookieName = $processParams->name; $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; $errorMessage = $processParams->errorMessage ?? $this->defaultErrorMessage; @@ -75,28 +77,26 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } throw HttpExceptionFactory::missingCookie($errorMessage, $errorStatusCode) - ->addMessagePlaceholder('{{ cookie_name }}', $cookieName); + ->addMessagePlaceholder(self::PLACEHOLDER_COOKIE_NAME, $cookieName); } try { $argument = $this->hydrator->castValue($request->getCookieParam($cookieName), Type::fromParameter($parameter), path: [$cookieName]); } catch (InvalidValueException $e) { throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder('{{ cookie_name }}', $cookieName) - ->addConstraintViolation(HydratorConstraintViolation::create($e)); + ->addMessagePlaceholder(self::PLACEHOLDER_COOKIE_NAME, $cookieName) + ->addConstraintViolation(HydratorConstraintViolationAdapter::create($e)); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder('{{ cookie_name }}', $cookieName) - ->addConstraintViolation(...array_map(HydratorConstraintViolation::create(...), $e->getExceptions())); + ->addMessagePlaceholder(self::PLACEHOLDER_COOKIE_NAME, $cookieName) + ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); } if (isset($this->validator)) { - if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { - if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpExceptionFactory::invalidCookie($processParams->errorMessage, $errorStatusCode) - ->addMessagePlaceholder('{{ cookie_name }}', $cookieName) - ->addConstraintViolation(...array_map(ValidatorConstraintViolation::create(...), [...$violations])); - } + if (($violations = $this->validator->startContext()->atPath($cookieName)->validate($argument, new ArgumentConstraint($parameter))->getViolations())->count() > 0) { + throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode) + ->addMessagePlaceholder(self::PLACEHOLDER_COOKIE_NAME, $cookieName) + ->addConstraintViolation(...array_map(ValidatorConstraintViolationAdapter::create(...), [...$violations])); } } @@ -105,6 +105,6 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) public function getWeight(): int { - return 10; + return 0; } } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 012d1555..537c16a8 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -20,9 +20,9 @@ use Sunrise\Http\Router\Annotation\RequestHeader; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Helper\ValidatorHelper; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolation; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolation; +use Sunrise\Http\Router\Validation\Constraint\ArgumentConstraint; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; @@ -36,6 +36,8 @@ */ final class RequestHeaderParameterResolver implements ParameterResolverInterface { + private const PLACEHOLDER_HEADER_NAME = '{{ header_name }}'; + public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, @@ -63,7 +65,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $processParams = $annotations[0]->newInstance(); - $headerName = $processParams->headerName; + $headerName = $processParams->name; $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; $errorMessage = $processParams->errorMessage ?? $this->defaultErrorMessage; @@ -73,28 +75,26 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } throw HttpExceptionFactory::missingHeader($errorMessage, $errorStatusCode) - ->addMessagePlaceholder('{{ header_name }}', $headerName); + ->addMessagePlaceholder(self::PLACEHOLDER_HEADER_NAME, $headerName); } try { $argument = $this->hydrator->castValue($context->getHeaderLine($headerName), Type::fromParameter($parameter), path: [$headerName]); } catch (InvalidValueException $e) { throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder('{{ header_name }}', $headerName) - ->addConstraintViolation(HydratorConstraintViolation::create($e)); + ->addMessagePlaceholder(self::PLACEHOLDER_HEADER_NAME, $headerName) + ->addConstraintViolation(HydratorConstraintViolationAdapter::create($e)); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder('{{ header_name }}', $headerName) - ->addConstraintViolation(...array_map(HydratorConstraintViolation::create(...), $e->getExceptions())); + ->addMessagePlaceholder(self::PLACEHOLDER_HEADER_NAME, $headerName) + ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); } if (isset($this->validator)) { - if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { - if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode) - ->addMessagePlaceholder('{{ header_name }}', $headerName) - ->addConstraintViolation(...array_map(ValidatorConstraintViolation::create(...), [...$violations])); - } + if (($violations = $this->validator->startContext()->atPath($headerName)->validate($argument, new ArgumentConstraint($parameter))->getViolations())->count() > 0) { + throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode) + ->addMessagePlaceholder(self::PLACEHOLDER_HEADER_NAME, $headerName) + ->addConstraintViolation(...array_map(ValidatorConstraintViolationAdapter::create(...), [...$violations])); } } @@ -103,6 +103,6 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) public function getWeight(): int { - return 20; + return 0; } } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index f8877f24..8cdead5b 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -23,8 +23,8 @@ use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\InvalidParameterException; use Sunrise\Http\Router\ParameterResolverChain; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolation; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolation; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; @@ -82,13 +82,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidQuery($errorMessage, $errorStatusCode, previous: $e) - ->addConstraintViolation(...array_map(HydratorConstraintViolation::create(...), $e->getExceptions())); + ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); } if (isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { throw HttpExceptionFactory::invalidQuery($errorMessage, $errorStatusCode) - ->addConstraintViolation(...array_map(ValidatorConstraintViolation::create(...), [...$violations])); + ->addConstraintViolation(...array_map(ValidatorConstraintViolationAdapter::create(...), [...$violations])); } } @@ -97,6 +97,6 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) public function getWeight(): int { - return 30; + return 0; } } diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index d5157fd2..37083c61 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -22,11 +22,11 @@ use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\InvalidParameterException; use Sunrise\Http\Router\Helper\RouteSimplifier; -use Sunrise\Http\Router\Helper\ValidatorHelper; use Sunrise\Http\Router\ParameterResolverChain; use Sunrise\Http\Router\ServerRequest; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolation; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolation; +use Sunrise\Http\Router\Validation\Constraint\ArgumentConstraint; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; @@ -41,6 +41,9 @@ */ final class RequestVariableParameterResolver implements ParameterResolverInterface { + private const PLACEHOLDER_VARIABLE_NAME = '{{ variable_name }}'; + private const PLACEHOLDER_ROUTE_URI = '{{ route_uri }}'; + public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, @@ -70,7 +73,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $route = ServerRequest::create($context)->getRoute(); $processParams = $annotations[0]->newInstance(); - $variableName = $processParams->variableName ?? $parameter->getName(); + $variableName = $processParams->name ?? $parameter->getName(); $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; $errorMessage = $processParams->errorMessage ?? $this->defaultErrorMessage; @@ -93,24 +96,22 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->castValue($route->getAttribute($variableName), Type::fromParameter($parameter), path: [$variableName]); } catch (InvalidValueException $e) { throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder('{{ variable_name }}', $variableName) - ->addMessagePlaceholder('{{ route_uri }}', RouteSimplifier::simplifyRoute($route->getPath())) - ->addConstraintViolation(HydratorConstraintViolation::create($e)); + ->addMessagePlaceholder(self::PLACEHOLDER_VARIABLE_NAME, $variableName) + ->addMessagePlaceholder(self::PLACEHOLDER_ROUTE_URI, RouteSimplifier::simplifyRoute($route->getPath())) + ->addConstraintViolation(HydratorConstraintViolationAdapter::create($e)); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder('{{ variable_name }}', $variableName) - ->addMessagePlaceholder('{{ route_uri }}', RouteSimplifier::simplifyRoute($route->getPath())) - ->addConstraintViolation(...array_map(HydratorConstraintViolation::create(...), $e->getExceptions())); + ->addMessagePlaceholder(self::PLACEHOLDER_VARIABLE_NAME, $variableName) + ->addMessagePlaceholder(self::PLACEHOLDER_ROUTE_URI, RouteSimplifier::simplifyRoute($route->getPath())) + ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); } if (isset($this->validator)) { - if (($constraints = ValidatorHelper::getParameterConstraints($parameter))->valid()) { - if (($violations = $this->validator->validate($argument, [...$constraints]))->count() > 0) { - throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode) - ->addMessagePlaceholder('{{ variable_name }}', $variableName) - ->addMessagePlaceholder('{{ route_uri }}', RouteSimplifier::simplifyRoute($route->getPath())) - ->addConstraintViolation(...array_map(ValidatorConstraintViolation::create(...), [...$violations])); - } + if (($violations = $this->validator->startContext()->atPath($variableName)->validate($argument, new ArgumentConstraint($parameter))->getViolations())->count() > 0) { + throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode) + ->addMessagePlaceholder(self::PLACEHOLDER_VARIABLE_NAME, $variableName) + ->addMessagePlaceholder(self::PLACEHOLDER_ROUTE_URI, RouteSimplifier::simplifyRoute($route->getPath())) + ->addConstraintViolation(...array_map(ValidatorConstraintViolationAdapter::create(...), [...$violations])); } } @@ -119,6 +120,6 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) public function getWeight(): int { - return 50; + return 0; } } diff --git a/src/ParameterResolverChain.php b/src/ParameterResolverChain.php index 4c8c4c33..185de52d 100644 --- a/src/ParameterResolverChain.php +++ b/src/ParameterResolverChain.php @@ -16,6 +16,7 @@ use Generator; use ReflectionMethod; use ReflectionParameter; +use Sunrise\Http\Router\Exception\InvalidParameterException; use Sunrise\Http\Router\Exception\UnsupportedParameterException; use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; @@ -27,10 +28,10 @@ */ final class ParameterResolverChain implements ParameterResolverChainInterface { - private bool $isSorted = false; - private mixed $context = null; + private bool $isSorted = false; + public function __construct( /** @var array */ private array $resolvers = [], @@ -59,6 +60,7 @@ public function withResolver(ParameterResolverInterface ...$resolvers): static /** * @inheritDoc * + * @throws InvalidParameterException * @throws UnsupportedParameterException */ public function resolveParameters(ReflectionParameter ...$parameters): Generator @@ -73,6 +75,7 @@ public function resolveParameters(ReflectionParameter ...$parameters): Generator /** * @return Generator * + * @throws InvalidParameterException * @throws UnsupportedParameterException */ private function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator diff --git a/src/RequestHandlerResolver.php b/src/RequestHandlerResolver.php index a0702048..74217416 100644 --- a/src/RequestHandlerResolver.php +++ b/src/RequestHandlerResolver.php @@ -82,14 +82,14 @@ private function createRequestHandlerCallback(callable $callback, ReflectionMeth return new CallableRequestHandler( fn(ServerRequestInterface $request): ResponseInterface => ( $this->responseResolverChain->resolveResponse( - $callback(...( - $this->parameterResolverChain + $callback( + ...$this->parameterResolverChain ->withContext($request) ->withResolver( new ObjectInjectionParameterResolver($request), ) ->resolveParameters(...$reflection->getParameters()) - )), + ), $reflection, $request, ) diff --git a/src/ResponseResolver/EmptyResponseResolver.php b/src/ResponseResolver/EmptyResponseResolver.php index c8445473..afd334a0 100644 --- a/src/ResponseResolver/EmptyResponseResolver.php +++ b/src/ResponseResolver/EmptyResponseResolver.php @@ -50,6 +50,6 @@ public function resolveResponse( public function getWeight(): int { - return 10; + return 0; } } diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index 416e6b37..94c39b3a 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -93,6 +93,6 @@ public function resolveResponse( public function getWeight(): int { - return 20; + return 0; } } diff --git a/src/ResponseResolverChain.php b/src/ResponseResolverChain.php index b148f67d..058d2b23 100644 --- a/src/ResponseResolverChain.php +++ b/src/ResponseResolverChain.php @@ -54,10 +54,11 @@ public function resolveResponse( } $this->isSorted or $this->sortResolvers(); + foreach ($this->resolvers as $resolver) { - $resolvedResponse = $resolver->resolveResponse($response, $responder, $request); - if ($resolvedResponse instanceof ResponseInterface) { - return $this->completeResponse($resolvedResponse, $responder); + $result = $resolver->resolveResponse($response, $responder, $request); + if ($result instanceof ResponseInterface) { + return $this->completeResponse($result, $responder); } } diff --git a/src/Route.php b/src/Route.php index 969b1924..963cd9f0 100644 --- a/src/Route.php +++ b/src/Route.php @@ -15,8 +15,12 @@ use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; +use function array_key_exists; use function in_array; +/** + * @since 1.0.0 + */ final class Route implements RouteInterface { public function __construct( @@ -102,18 +106,7 @@ public function getAttribute(string $name, mixed $default = null): mixed public function hasAttribute(string $name): bool { - return isset($this->attributes[$name]); - } - - /** - * @inheritDoc - */ - public function withAttributes(array $attributes): static - { - $clone = clone $this; - $clone->attributes = $attributes; - - return $clone; + return array_key_exists($name, $this->attributes); } /** diff --git a/src/RouteInterface.php b/src/RouteInterface.php index 71247275..b30d70aa 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -64,13 +64,6 @@ public function getAttribute(string $name, mixed $default = null): mixed; */ public function hasAttribute(string $name): bool; - /** - * @param array $attributes - * - * @since 3.0.0 - */ - public function withAttributes(array $attributes): static; - /** * @param array $attributes * diff --git a/src/ServerRequest.php b/src/ServerRequest.php index b7f47db4..6cf99387 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -178,7 +178,7 @@ public function getClientPreferredMediaType(MediaTypeInterface ...$serverProduce $mediaTypeComparator = $this->getMediaTypeComparator(); foreach ($this->getClientConsumedMediaTypes() as $clientConsumedMediaType) { foreach ($serverProducedMediaTypes as $serverProducedMediaType) { - if ($mediaTypeComparator->equals($clientConsumedMediaType, $serverProducedMediaType)) { + if ($mediaTypeComparator->compare($clientConsumedMediaType, $serverProducedMediaType) === 0) { return $clientConsumedMediaType; } } @@ -196,7 +196,7 @@ public function getClientPreferredLanguage(LanguageInterface ...$serverProducedL $languageComparator = $this->getLanguageComparator(); foreach ($this->getClientConsumedLanguages() as $clientConsumedLanguage) { foreach ($serverProducedLanguages as $serverProducedLanguage) { - if ($languageComparator->equals($clientConsumedLanguage, $serverProducedLanguage)) { + if ($languageComparator->compare($clientConsumedLanguage, $serverProducedLanguage) === 0) { return $clientConsumedLanguage; } } @@ -219,7 +219,7 @@ public function clientProducesMediaType(MediaTypeInterface ...$serverConsumedMed $mediaTypeComparator = $this->getMediaTypeComparator(); foreach ($serverConsumedMediaTypes as $serverConsumedMediaType) { - if ($mediaTypeComparator->equals($clientProducedMediaType, $serverConsumedMediaType)) { + if ($mediaTypeComparator->compare($clientProducedMediaType, $serverConsumedMediaType) === 0) { return true; } } diff --git a/src/Validation/Constraint/ArgumentConstraint.php b/src/Validation/Constraint/ArgumentConstraint.php new file mode 100644 index 00000000..8684917f --- /dev/null +++ b/src/Validation/Constraint/ArgumentConstraint.php @@ -0,0 +1,35 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Validation\Constraint; + +use ReflectionParameter; +use Symfony\Component\Validator\Constraint; + +/** + * @since 3.0.0 + * + * @psalm-suppress PropertyNotSetInConstructor https://github.com/symfony/validator/blob/33e1f3bb76ef70e3170e12f878aefb9c69b0fc4c/Constraint.php#L71 + */ +final class ArgumentConstraint extends Constraint +{ + public function __construct(private readonly ReflectionParameter $parameter) + { + parent::__construct(); + } + + public function getParameter(): ReflectionParameter + { + return $this->parameter; + } +} diff --git a/src/Validation/Constraint/ArgumentConstraintValidator.php b/src/Validation/Constraint/ArgumentConstraintValidator.php new file mode 100644 index 00000000..bc3d9abe --- /dev/null +++ b/src/Validation/Constraint/ArgumentConstraintValidator.php @@ -0,0 +1,54 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Validation\Constraint; + +use ReflectionAttribute; +use Sunrise\Http\Router\Annotation\Constraint as ParameterConstraint; +use Symfony\Component\Validator\Constraint; +use Symfony\Component\Validator\ConstraintValidator; +use Symfony\Component\Validator\Exception\UnexpectedTypeException; + +/** + * @since 3.0.0 + */ +final class ArgumentConstraintValidator extends ConstraintValidator +{ + /** + * @inheritDoc + * + * @throws UnexpectedTypeException + */ + public function validate(mixed $value, Constraint $constraint): void + { + if (! $constraint instanceof ArgumentConstraint) { + throw new UnexpectedTypeException($constraint, ArgumentConstraint::class); + } + + $constraints = []; + /** @var list> $parameterAnnotations */ + $parameterAnnotations = $constraint->getParameter()->getAttributes(ParameterConstraint::class); + foreach ($parameterAnnotations as $parameterAnnotation) { + $parameterConstraint = $parameterAnnotation->newInstance(); + if ($parameterConstraint->value instanceof Constraint) { + $constraints[] = $parameterConstraint->value; + } + } + + if ($constraints === []) { + return; + } + + $this->context->getValidator()->inContext($this->context)->validate($value, $constraints); + } +} diff --git a/src/Validation/ConstraintViolation/HydratorConstraintViolation.php b/src/Validation/ConstraintViolation/HydratorConstraintViolationAdapter.php similarity index 57% rename from src/Validation/ConstraintViolation/HydratorConstraintViolation.php rename to src/Validation/ConstraintViolation/HydratorConstraintViolationAdapter.php index a092cb40..86bad0b0 100644 --- a/src/Validation/ConstraintViolation/HydratorConstraintViolation.php +++ b/src/Validation/ConstraintViolation/HydratorConstraintViolationAdapter.php @@ -19,40 +19,40 @@ /** * @since 3.0.0 */ -final class HydratorConstraintViolation implements ConstraintViolationInterface +final class HydratorConstraintViolationAdapter implements ConstraintViolationInterface { public function __construct( - private readonly InvalidValueException $constraintViolation, + private readonly InvalidValueException $hydratorConstraintViolation, ) { } - public static function create(InvalidValueException $constraintViolation): self + public static function create(InvalidValueException $hydratorConstraintViolation): self { - return new self($constraintViolation); + return new self($hydratorConstraintViolation); } public function getMessage(): string { - return $this->constraintViolation->getMessage(); + return $this->hydratorConstraintViolation->getMessage(); } public function getMessageTemplate(): string { - return $this->constraintViolation->getMessageTemplate(); + return $this->hydratorConstraintViolation->getMessageTemplate(); } public function getMessagePlaceholders(): array { - return $this->constraintViolation->getMessagePlaceholders(); + return $this->hydratorConstraintViolation->getMessagePlaceholders(); } public function getPropertyPath(): string { - return $this->constraintViolation->getPropertyPath(); + return $this->hydratorConstraintViolation->getPropertyPath(); } public function getCode(): ?string { - return $this->constraintViolation->getErrorCode(); + return $this->hydratorConstraintViolation->getErrorCode(); } } diff --git a/src/Validation/ConstraintViolation/ValidatorConstraintViolation.php b/src/Validation/ConstraintViolation/ValidatorConstraintViolation.php deleted file mode 100644 index b88857c1..00000000 --- a/src/Validation/ConstraintViolation/ValidatorConstraintViolation.php +++ /dev/null @@ -1,57 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Validation\ConstraintViolation; - -use Sunrise\Http\Router\Helper\ValidatorHelper; - -/** - * @since 3.0.0 - */ -final class ValidatorConstraintViolation implements \Sunrise\Http\Router\Validation\ConstraintViolationInterface -{ - public function __construct( - private readonly \Symfony\Component\Validator\ConstraintViolationInterface $constraintViolation, - ) { - } - - public static function create(\Symfony\Component\Validator\ConstraintViolationInterface $constraintViolation): self - { - return new self($constraintViolation); - } - - public function getMessage(): string - { - return (string) $this->constraintViolation->getMessage(); - } - - public function getMessageTemplate(): string - { - return $this->constraintViolation->getMessageTemplate(); - } - - public function getMessagePlaceholders(): array - { - return $this->constraintViolation->getParameters(); - } - - public function getPropertyPath(): string - { - return ValidatorHelper::adaptPropertyPath($this->constraintViolation->getPropertyPath()); - } - - public function getCode(): ?string - { - return $this->constraintViolation->getCode(); - } -} diff --git a/src/Validation/ConstraintViolation/ValidatorConstraintViolationAdapter.php b/src/Validation/ConstraintViolation/ValidatorConstraintViolationAdapter.php new file mode 100644 index 00000000..c6ae2739 --- /dev/null +++ b/src/Validation/ConstraintViolation/ValidatorConstraintViolationAdapter.php @@ -0,0 +1,65 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Validation\ConstraintViolation; + +use Sunrise\Http\Router\Validation\ConstraintViolationInterface as RouterConstraintViolationInterface; +use Symfony\Component\Validator\ConstraintViolationInterface as ValidatorConstraintViolationInterface; + +use function preg_replace; + +/** + * @since 3.0.0 + */ +final class ValidatorConstraintViolationAdapter implements RouterConstraintViolationInterface +{ + public function __construct( + private readonly ValidatorConstraintViolationInterface $validatorConstraintViolation, + ) { + } + + public static function create(ValidatorConstraintViolationInterface $validatorConstraintViolation): self + { + return new self($validatorConstraintViolation); + } + + public function getMessage(): string + { + return (string) $this->validatorConstraintViolation->getMessage(); + } + + public function getMessageTemplate(): string + { + return $this->validatorConstraintViolation->getMessageTemplate(); + } + + public function getMessagePlaceholders(): array + { + return $this->validatorConstraintViolation->getParameters(); + } + + public function getPropertyPath(): string + { + return $this->adaptPropertyPath($this->validatorConstraintViolation->getPropertyPath()); + } + + public function getCode(): ?string + { + return $this->validatorConstraintViolation->getCode(); + } + + private function adaptPropertyPath(string $propertyPath): string + { + return preg_replace(['/\x5b([^\x5b\x5d]+)\x5d/', '/^\x2e/'], ['.$1'], $propertyPath); + } +} From 9c978240c3cd6b5ab255b67e79499d65b61e54d9 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 17 Mar 2024 16:41:38 +0100 Subject: [PATCH 145/180] v3 --- src/ParameterResolver/DefaultValueParameterResolver.php | 1 + src/ParameterResolver/DependencyInjectionParameterResolver.php | 1 + src/ParameterResolver/ObjectInjectionParameterResolver.php | 1 + src/ParameterResolver/RequestBodyParameterResolver.php | 1 + src/ParameterResolver/RequestCookieParameterResolver.php | 1 + src/ParameterResolver/RequestHeaderParameterResolver.php | 1 + src/ParameterResolver/RequestQueryParameterResolver.php | 1 + src/ParameterResolver/RequestVariableParameterResolver.php | 1 + src/ParameterResolverChain.php | 1 - src/ParameterResolverChainInterface.php | 1 - src/{ParameterResolver => }/ParameterResolverInterface.php | 2 +- src/ReferenceResolver.php | 2 -- src/ResponseResolver/EmptyResponseResolver.php | 1 + src/ResponseResolver/JsonResponseResolver.php | 1 + src/ResponseResolverChain.php | 1 - src/{ResponseResolver => }/ResponseResolverInterface.php | 2 +- 16 files changed, 12 insertions(+), 7 deletions(-) rename src/{ParameterResolver => }/ParameterResolverInterface.php (92%) rename src/{ResponseResolver => }/ResponseResolverInterface.php (94%) diff --git a/src/ParameterResolver/DefaultValueParameterResolver.php b/src/ParameterResolver/DefaultValueParameterResolver.php index 95bcebb3..5542ee2c 100644 --- a/src/ParameterResolver/DefaultValueParameterResolver.php +++ b/src/ParameterResolver/DefaultValueParameterResolver.php @@ -15,6 +15,7 @@ use Generator; use ReflectionParameter; +use Sunrise\Http\Router\ParameterResolverInterface; /** * @since 3.0.0 diff --git a/src/ParameterResolver/DependencyInjectionParameterResolver.php b/src/ParameterResolver/DependencyInjectionParameterResolver.php index 4277cd59..887ef4c6 100644 --- a/src/ParameterResolver/DependencyInjectionParameterResolver.php +++ b/src/ParameterResolver/DependencyInjectionParameterResolver.php @@ -18,6 +18,7 @@ use Psr\Container\ContainerInterface; use ReflectionNamedType; use ReflectionParameter; +use Sunrise\Http\Router\ParameterResolverInterface; /** * @since 3.0.0 diff --git a/src/ParameterResolver/ObjectInjectionParameterResolver.php b/src/ParameterResolver/ObjectInjectionParameterResolver.php index 09bc52eb..bc9b741b 100644 --- a/src/ParameterResolver/ObjectInjectionParameterResolver.php +++ b/src/ParameterResolver/ObjectInjectionParameterResolver.php @@ -16,6 +16,7 @@ use Generator; use ReflectionNamedType; use ReflectionParameter; +use Sunrise\Http\Router\ParameterResolverInterface; use function is_a; diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index bdd83c7a..12f7d668 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -23,6 +23,7 @@ use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\InvalidParameterException; use Sunrise\Http\Router\ParameterResolverChain; +use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index 12d97a6c..e69bf442 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -20,6 +20,7 @@ use Sunrise\Http\Router\Annotation\RequestCookie; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; +use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ServerRequest; use Sunrise\Http\Router\Validation\Constraint\ArgumentConstraint; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 537c16a8..0d37edc3 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -20,6 +20,7 @@ use Sunrise\Http\Router\Annotation\RequestHeader; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; +use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\Validation\Constraint\ArgumentConstraint; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 8cdead5b..b3262605 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -23,6 +23,7 @@ use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\InvalidParameterException; use Sunrise\Http\Router\ParameterResolverChain; +use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index 37083c61..e7426f97 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -23,6 +23,7 @@ use Sunrise\Http\Router\Exception\InvalidParameterException; use Sunrise\Http\Router\Helper\RouteSimplifier; use Sunrise\Http\Router\ParameterResolverChain; +use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ServerRequest; use Sunrise\Http\Router\Validation\Constraint\ArgumentConstraint; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; diff --git a/src/ParameterResolverChain.php b/src/ParameterResolverChain.php index 185de52d..f7853849 100644 --- a/src/ParameterResolverChain.php +++ b/src/ParameterResolverChain.php @@ -18,7 +18,6 @@ use ReflectionParameter; use Sunrise\Http\Router\Exception\InvalidParameterException; use Sunrise\Http\Router\Exception\UnsupportedParameterException; -use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; use function sprintf; use function usort; diff --git a/src/ParameterResolverChainInterface.php b/src/ParameterResolverChainInterface.php index 2cba4244..a1d0f8b2 100644 --- a/src/ParameterResolverChainInterface.php +++ b/src/ParameterResolverChainInterface.php @@ -15,7 +15,6 @@ use Generator; use ReflectionParameter; -use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; /** * @since 3.0.0 diff --git a/src/ParameterResolver/ParameterResolverInterface.php b/src/ParameterResolverInterface.php similarity index 92% rename from src/ParameterResolver/ParameterResolverInterface.php rename to src/ParameterResolverInterface.php index 25647632..25ec7f55 100644 --- a/src/ParameterResolver/ParameterResolverInterface.php +++ b/src/ParameterResolverInterface.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ParameterResolver; +namespace Sunrise\Http\Router; use Generator; use ReflectionParameter; diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index 555f2883..aa9e9395 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -16,8 +16,6 @@ use Psr\Container\ContainerInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\ParameterResolver\ParameterResolverInterface; -use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; use function get_debug_type; use function is_callable; diff --git a/src/ResponseResolver/EmptyResponseResolver.php b/src/ResponseResolver/EmptyResponseResolver.php index afd334a0..29309b19 100644 --- a/src/ResponseResolver/EmptyResponseResolver.php +++ b/src/ResponseResolver/EmptyResponseResolver.php @@ -20,6 +20,7 @@ use ReflectionFunction; use ReflectionMethod; use Sunrise\Http\Router\Annotation\EmptyResponse; +use Sunrise\Http\Router\ResponseResolverInterface; /** * @since 3.0.0 diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index 94c39b3a..2847b5a5 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -24,6 +24,7 @@ use Sunrise\Http\Router\Annotation\JsonResponse; use Sunrise\Http\Router\Exception\InvalidResponseException; use Sunrise\Http\Router\ResponseResolverChain; +use Sunrise\Http\Router\ResponseResolverInterface; use function json_encode; use function sprintf; diff --git a/src/ResponseResolverChain.php b/src/ResponseResolverChain.php index 058d2b23..18836c5c 100644 --- a/src/ResponseResolverChain.php +++ b/src/ResponseResolverChain.php @@ -22,7 +22,6 @@ use Sunrise\Http\Router\Annotation\ResponseStatus; use Sunrise\Http\Router\Exception\InvalidResponseException; use Sunrise\Http\Router\Exception\UnsupportedResponseException; -use Sunrise\Http\Router\ResponseResolver\ResponseResolverInterface; use function sprintf; use function usort; diff --git a/src/ResponseResolver/ResponseResolverInterface.php b/src/ResponseResolverInterface.php similarity index 94% rename from src/ResponseResolver/ResponseResolverInterface.php rename to src/ResponseResolverInterface.php index e5e66c04..19883b53 100644 --- a/src/ResponseResolver/ResponseResolverInterface.php +++ b/src/ResponseResolverInterface.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\ResponseResolver; +namespace Sunrise\Http\Router; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; From 7968ca24f14f762ded7b7e58c8b5a8f781446965 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 17 Mar 2024 17:10:35 +0100 Subject: [PATCH 146/180] v3 --- src/Router.php | 10 +++++++--- src/ServerRequest.php | 23 ++++------------------- 2 files changed, 11 insertions(+), 22 deletions(-) diff --git a/src/Router.php b/src/Router.php index 537342fd..3bb48915 100644 --- a/src/Router.php +++ b/src/Router.php @@ -40,7 +40,10 @@ class Router implements RequestHandlerInterface { private readonly ReferenceResolverInterface $referenceResolver; - private array $middlewares; + /** + * The router's middlewares + */ + private readonly array $middlewares; /** * @var array @@ -57,6 +60,9 @@ class Router implements RequestHandlerInterface */ private array $routeRequestHandlers = []; + /** + * The router's request handler + */ private ?RequestHandlerInterface $requestHandler = null; /** @@ -70,9 +76,7 @@ public function __construct( ?ReferenceResolverInterface $referenceResolver = null, ) { $this->load(...$loaders); - $this->middlewares = $middlewares; - $this->referenceResolver = $referenceResolver ?? ReferenceResolver::build(); } diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 6cf99387..527c9073 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -47,7 +47,7 @@ public function __construct(private ServerRequestInterface $request) public static function create(ServerRequestInterface $request): self { - return $request instanceof self ? $request : new self($request); + return new self($request); } public function getOriginalRequest(): ServerRequestInterface @@ -96,12 +96,7 @@ public function getRoute(): RouteInterface public function getClientProducedMediaType(): ?ClientMediaType { - $header = $this->request->getHeaderLine('Content-Type'); - if ($header === '') { - return null; - } - - $values = HeaderParser::parseHeader($header); + $values = HeaderParser::parseHeader($this->request->getHeaderLine('Content-Type')); if ($values === []) { return null; } @@ -120,12 +115,7 @@ public function getClientProducedMediaType(): ?ClientMediaType */ public function getClientConsumedMediaTypes(): Generator { - $header = $this->request->getHeaderLine('Accept'); - if ($header === '') { - return; - } - - $values = HeaderParser::parseHeader($header); + $values = HeaderParser::parseHeader($this->request->getHeaderLine('Accept')); if ($values === []) { return; } @@ -147,12 +137,7 @@ public function getClientConsumedMediaTypes(): Generator */ public function getClientConsumedLanguages(): Generator { - $header = $this->request->getHeaderLine('Accept-Language'); - if ($header === '') { - return; - } - - $values = HeaderParser::parseHeader($header); + $values = HeaderParser::parseHeader($this->request->getHeaderLine('Accept-Language')); if ($values === []) { return; } From 29c49bf7ee5b23df72dcd5c95a686d043c599606 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 17 Mar 2024 18:29:16 +0100 Subject: [PATCH 147/180] v3 --- src/Helper/FilesystemHelper.php | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/src/Helper/FilesystemHelper.php b/src/Helper/FilesystemHelper.php index 4c6af9b7..fa3bcdbb 100644 --- a/src/Helper/FilesystemHelper.php +++ b/src/Helper/FilesystemHelper.php @@ -20,11 +20,11 @@ use RecursiveIteratorIterator; use ReflectionClass; use RegexIterator; +use SplFileInfo; use function get_declared_classes; use function is_dir; use function is_file; -use function iterator_to_array; use function realpath; use function sprintf; @@ -44,25 +44,27 @@ public static function getDirClasses(string $dirname): Generator throw new InvalidArgumentException(sprintf('The directory %s does not exist.', $dirname)); } - /** @var array $filenames */ - $filenames = iterator_to_array( - new RegexIterator( - new RecursiveIteratorIterator( - new RecursiveDirectoryIterator( - $dirname, - FilesystemIterator::KEY_AS_PATHNAME - | FilesystemIterator::CURRENT_AS_PATHNAME - | FilesystemIterator::SKIP_DOTS, - ), + /** @var iterable $directory */ + $directory = new RegexIterator( + new RecursiveIteratorIterator( + new RecursiveDirectoryIterator( + $dirname, + FilesystemIterator::KEY_AS_FILENAME + | FilesystemIterator::CURRENT_AS_FILEINFO + | FilesystemIterator::SKIP_DOTS, ), - '/\.php$/', - ) + ), + '/\.php$/', ); - foreach ($filenames as $filename) { + /** @var array $filenames */ + $filenames = []; + foreach ($directory as $file) { + $filenames[$file->getRealPath()] = true; + (static function (string $filename): void { require_once $filename; - })($filename); + })($file->getRealPath()); } foreach (get_declared_classes() as $className) { From fdcaf9b05c52d40bfc3cd487b0391350ed48b959 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Wed, 20 Mar 2024 04:57:31 +0100 Subject: [PATCH 148/180] v3 --- resources/definitions/router.php | 3 +- src/Entity/MediaType/MediaTypeFactory.php | 35 ------------------ .../{FilesystemHelper.php => ClassFinder.php} | 30 ++++++++------- src/Loader/DescriptorLoader.php | 37 +++++++------------ .../JsonPayloadDecodingMiddleware.php | 4 +- src/ServerRequest.php | 6 +-- 6 files changed, 37 insertions(+), 78 deletions(-) delete mode 100644 src/Entity/MediaType/MediaTypeFactory.php rename src/Helper/{FilesystemHelper.php => ClassFinder.php} (82%) diff --git a/resources/definitions/router.php b/resources/definitions/router.php index 0461e2a0..797a22d9 100644 --- a/resources/definitions/router.php +++ b/resources/definitions/router.php @@ -22,8 +22,9 @@ return [ 'router.loaders' => [], - 'router.middlewares' => [], + 'router.parameter_resolvers' => [], + 'router.response_resolvers' => [], ParameterResolverChainInterface::class => create(ParameterResolverChain::class) ->constructor( diff --git a/src/Entity/MediaType/MediaTypeFactory.php b/src/Entity/MediaType/MediaTypeFactory.php deleted file mode 100644 index ce7bd6b1..00000000 --- a/src/Entity/MediaType/MediaTypeFactory.php +++ /dev/null @@ -1,35 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Entity\MediaType; - -/** - * @since 3.0.0 - */ -final class MediaTypeFactory -{ - public static function json(): MediaTypeInterface - { - return new ServerMediaType('application', 'json'); - } - - public static function xml(): MediaTypeInterface - { - return new ServerMediaType('application', 'xml'); - } - - public static function html(): MediaTypeInterface - { - return new ServerMediaType('text', 'html'); - } -} diff --git a/src/Helper/FilesystemHelper.php b/src/Helper/ClassFinder.php similarity index 82% rename from src/Helper/FilesystemHelper.php rename to src/Helper/ClassFinder.php index fa3bcdbb..23c6a858 100644 --- a/src/Helper/FilesystemHelper.php +++ b/src/Helper/ClassFinder.php @@ -13,7 +13,6 @@ namespace Sunrise\Http\Router\Helper; -use FilesystemIterator; use Generator; use InvalidArgumentException; use RecursiveDirectoryIterator; @@ -21,6 +20,7 @@ use ReflectionClass; use RegexIterator; use SplFileInfo; +use SplStack; use function get_declared_classes; use function is_dir; @@ -31,7 +31,7 @@ /** * @since 3.0.0 */ -final class FilesystemHelper +final class ClassFinder { /** * @return Generator @@ -45,17 +45,7 @@ public static function getDirClasses(string $dirname): Generator } /** @var iterable $directory */ - $directory = new RegexIterator( - new RecursiveIteratorIterator( - new RecursiveDirectoryIterator( - $dirname, - FilesystemIterator::KEY_AS_FILENAME - | FilesystemIterator::CURRENT_AS_FILEINFO - | FilesystemIterator::SKIP_DOTS, - ), - ), - '/\.php$/', - ); + $directory = new RegexIterator(new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dirname)), '/\.php$/'); /** @var array $filenames */ $filenames = []; @@ -99,4 +89,18 @@ public static function getFileClasses(string $filename): Generator } } } + + /** + * @return SplStack + */ + public static function getParentClasses(ReflectionClass $class): SplStack + { + /** @var SplStack $parents */ + $parents = new SplStack(); + while ($class = $class->getParentClass()) { + $parents->push($class); + } + + return $parents; + } } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index e9e4c181..7206cbde 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -20,7 +20,6 @@ use ReflectionAttribute; use ReflectionClass; use ReflectionMethod; -use SplStack; use Sunrise\Http\Router\Annotation\Attribute; use Sunrise\Http\Router\Annotation\Constraint; use Sunrise\Http\Router\Annotation\Consumes; @@ -38,7 +37,7 @@ use Sunrise\Http\Router\Annotation\Tag; use Sunrise\Http\Router\Exception\InvalidRouteLoadingResourceException; use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; -use Sunrise\Http\Router\Helper\FilesystemHelper; +use Sunrise\Http\Router\Helper\ClassFinder; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Route; @@ -134,7 +133,7 @@ private function getDescriptors(): array private function getResourceDescriptors(string $resource): Generator { if (is_dir($resource)) { - foreach (FilesystemHelper::getDirClasses($resource) as $class) { + foreach (ClassFinder::getDirClasses($resource) as $class) { yield from $this->getClassDescriptors($class); } @@ -142,7 +141,7 @@ private function getResourceDescriptors(string $resource): Generator } if (is_file($resource)) { - foreach (FilesystemHelper::getFileClasses($resource) as $class) { + foreach (ClassFinder::getFileClasses($resource) as $class) { yield from $this->getClassDescriptors($class); } @@ -150,11 +149,7 @@ private function getResourceDescriptors(string $resource): Generator } if (class_exists($resource)) { - yield from $this->getClassDescriptors( - new ReflectionClass($resource) - ); - - return; + return yield from $this->getClassDescriptors(new ReflectionClass($resource)); } throw new InvalidRouteLoadingResourceException(sprintf( @@ -182,8 +177,8 @@ private function getClassDescriptors(ReflectionClass $class): Generator if (isset($annotations[0])) { $descriptor = $annotations[0]->newInstance(); $descriptor->holder = $class->getName(); - $this->supplementDescriptorFromParentClasses($descriptor, $class); - $this->supplementDescriptorFromClassOrMethod($descriptor, $class); + $this->enrichDescriptorFromParentClasses($descriptor, $class); + $this->enrichDescriptorFromClassOrMethod($descriptor, $class); $this->completeDescriptor($descriptor); yield $descriptor; } @@ -199,29 +194,23 @@ private function getClassDescriptors(ReflectionClass $class): Generator if (isset($annotations[0])) { $descriptor = $annotations[0]->newInstance(); $descriptor->holder = [$class->getName(), $method->getName()]; - $this->supplementDescriptorFromParentClasses($descriptor, $class); - $this->supplementDescriptorFromClassOrMethod($descriptor, $class); - $this->supplementDescriptorFromClassOrMethod($descriptor, $method); + $this->enrichDescriptorFromParentClasses($descriptor, $class); + $this->enrichDescriptorFromClassOrMethod($descriptor, $class); + $this->enrichDescriptorFromClassOrMethod($descriptor, $method); $this->completeDescriptor($descriptor); yield $descriptor; } } } - private function supplementDescriptorFromParentClasses(Descriptor $descriptor, ReflectionClass $class): void + private function enrichDescriptorFromParentClasses(Descriptor $descriptor, ReflectionClass $class): void { - /** @var SplStack $parents */ - $parents = new SplStack(); - while ($class = $class->getParentClass()) { - $parents->push($class); - } - - foreach ($parents as $parent) { - $this->supplementDescriptorFromClassOrMethod($descriptor, $parent); + foreach (ClassFinder::getParentClasses($class) as $parent) { + $this->enrichDescriptorFromClassOrMethod($descriptor, $parent); } } - private function supplementDescriptorFromClassOrMethod(Descriptor $descriptor, ReflectionClass|ReflectionMethod $classOrMethod): void + private function enrichDescriptorFromClassOrMethod(Descriptor $descriptor, ReflectionClass|ReflectionMethod $classOrMethod): void { /** @var list> $annotations */ $annotations = $classOrMethod->getAttributes(Prefix::class); diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index dbf8c2b8..a41a6753 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -18,7 +18,7 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\ServerRequest; @@ -57,7 +57,7 @@ public function __construct( */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if (ServerRequest::create($request)->clientProducesMediaType(MediaTypeFactory::json())) { + if (ServerRequest::create($request)->clientProducesMediaType(new ServerMediaType('application', 'json'))) { $request = $request->withParsedBody($this->decodePayload($request->getBody()->__toString())); } diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 527c9073..61e0692e 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -103,7 +103,7 @@ public function getClientProducedMediaType(): ?ClientMediaType [$identifier, $parameters] = current($values); - if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier, $matches)) { + if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier, $matches) === 1) { return new ClientMediaType($matches[1], $matches[2], $parameters); } @@ -126,7 +126,7 @@ public function getClientConsumedMediaTypes(): Generator )); foreach ($values as $index => [$identifier, $parameters]) { - if (preg_match('|^([^/]+)/([^/]+)$|', $identifier, $matches)) { + if (preg_match('|^([^/]+)/([^/]+)$|', $identifier, $matches) === 1) { yield $index => new ClientMediaType($matches[1], $matches[2], $parameters); } } @@ -148,7 +148,7 @@ public function getClientConsumedLanguages(): Generator )); foreach ($values as $index => [$identifier, $parameters]) { - if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches)) { + if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches) === 1) { yield $index => new ClientLanguage($matches[1], $identifier, $parameters); } } From 88ee93a411709a8dff35ceb40da294f1842de83d Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 21 Mar 2024 04:10:17 +0100 Subject: [PATCH 149/180] v3 --- resources/translations/ru.php | 2 +- resources/translations/sr.php | 2 +- src/Annotation/Route.php | 113 ++++-------------- src/Dictionary/ErrorMessage.php | 2 +- src/Entity/MediaType/ClientMediaType.php | 2 +- src/Entity/MediaType/MediaTypeInterface.php | 2 + src/Entity/MediaType/ServerMediaType.php | 2 +- src/Exception/HttpExceptionFactory.php | 4 +- ...xception.php => NoRouteFoundException.php} | 2 +- src/Exception/NoRoutesRegisteredException.php | 23 ++++ src/Helper/ClassFinder.php | 6 +- src/Helper/RouteMatcher.php | 4 +- src/Loader/DescriptorLoader.php | 4 +- .../RequestCookieParameterResolver.php | 3 +- .../RequestHeaderParameterResolver.php | 3 +- .../RequestVariableParameterResolver.php | 3 +- src/ParameterResolverChain.php | 2 +- src/ResponseResolver/JsonResponseResolver.php | 12 +- src/Router.php | 98 ++++++++------- src/ServerRequest.php | 2 +- 20 files changed, 131 insertions(+), 160 deletions(-) rename src/Exception/{RouteNotFoundException.php => NoRouteFoundException.php} (81%) create mode 100644 src/Exception/NoRoutesRegisteredException.php diff --git a/resources/translations/ru.php b/resources/translations/ru.php index 610bb6df..4c8e8480 100644 --- a/resources/translations/ru.php +++ b/resources/translations/ru.php @@ -5,7 +5,7 @@ use Sunrise\Http\Router\Dictionary\ErrorMessage; return [ - ErrorMessage::INVALID_URI => 'URI запроса невалиден и не может быть принят сервером.', + ErrorMessage::MALFORMED_URI => 'URI запроса невалиден и не может быть принят сервером.', ErrorMessage::RESOURCE_NOT_FOUND => 'Запрашиваемый ресурс не найден для данного URI.', ErrorMessage::METHOD_NOT_ALLOWED => 'Запрашиваемый метод не разрешен для данного ресурса; Проверьте заголовок ответа "Allow" на разрешенные методы.', ErrorMessage::MISSING_CONTENT_TYPE => 'Заголовок запроса Content-Type должен быть предоставлен и не может быть пустым; Проверьте заголовок ответа "Accept" на поддерживаемые типы медиа.', diff --git a/resources/translations/sr.php b/resources/translations/sr.php index fc8cb916..eb441816 100644 --- a/resources/translations/sr.php +++ b/resources/translations/sr.php @@ -5,7 +5,7 @@ use Sunrise\Http\Router\Dictionary\ErrorMessage; return [ - ErrorMessage::INVALID_URI => 'URI zahtev je nevažeći i ne može biti prihvaćen od strane servera.', + ErrorMessage::MALFORMED_URI => 'URI zahtev je nevažeći i ne može biti prihvaćen od strane servera.', ErrorMessage::RESOURCE_NOT_FOUND => 'Zatraženi resurs nije pronađen za ovaj URI.', ErrorMessage::METHOD_NOT_ALLOWED => 'Zatražena metoda nije dozvoljena za ovaj resurs; Proverite zaglavlje odgovora "Allow" za dozvoljene metode.', ErrorMessage::MISSING_CONTENT_TYPE => 'Zaglavlje zahteva Content-Type mora biti navedeno i ne može biti prazno; Proverite zaglavlje odgovora "Accept" za podržane tipove medija.', diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index 593808da..1f5d3a27 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -22,104 +22,37 @@ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] final class Route { - /** - * The route's request handler. - */ public mixed $holder = null; - /** - * Use the {@see Prefix} annotation. - * - * @var array - */ + /** @var array */ public array $prefixes = []; - /** - * Use the {@see Pattern} annotation. - * - * @var array - */ - public array $patterns = []; - - /** - * Use the {@see Method} annotation. - * - * @var array - */ - public array $methods = []; - - /** - * Use the {@see \Sunrise\Http\Router\Annotation\Attribute} annotation. - * - * @var array - */ - public array $attributes = []; - - /** - * Use the {@see Middleware} annotation. - * - * @var array - */ - public array $middlewares = []; - - /** - * Use the {@see Constraint} annotation. - * - * @var array - */ - public array $constraints = []; - - /** - * Use the {@see Consumes} annotation. - * - * @var array - */ - public array $consumes = []; - - /** - * Use the {@see Produces} annotation. - * - * @var array - */ - public array $produces = []; - - /** - * Use the {@see Tag} annotation. - * - * @var array - */ - public array $tags = []; - - /** - * Use the {@see Summary} annotation. - */ - public string $summary = ''; - - /** - * Use the {@see Description} annotation. - */ - public string $description = ''; - - /** - * Use the {@see Deprecated} annotation. - */ - public bool $isDeprecated = false; - - /** - * Use the {@see Priority} annotation. - */ - public int $priority = 0; - - /** - * The route's compilation pattern. - * - * @var non-empty-string|null - */ - public string|null $pattern = null; + /** @var non-empty-string|null */ + public ?string $pattern = null; public function __construct( public readonly string $name, public string $path, + /** @var array */ + public array $patterns = [], + /** @var array */ + public array $methods = [], + /** @var array */ + public array $attributes = [], + /** @var array */ + public array $middlewares = [], + /** @var array */ + public array $constraints = [], + /** @var array */ + public array $consumes = [], + /** @var array */ + public array $produces = [], + /** @var array */ + public array $tags = [], + public string $summary = '', + public string $description = '', + public bool $isDeprecated = false, + public int $priority = 0, ) { } } diff --git a/src/Dictionary/ErrorMessage.php b/src/Dictionary/ErrorMessage.php index 0312b502..c07ed662 100644 --- a/src/Dictionary/ErrorMessage.php +++ b/src/Dictionary/ErrorMessage.php @@ -18,7 +18,7 @@ */ final class ErrorMessage { - public const INVALID_URI = 'The request URI is invalid and cannot be accepted by the server.'; + public const MALFORMED_URI = 'The request URI is malformed and cannot be accepted by the server.'; public const RESOURCE_NOT_FOUND = 'The requested resource was not found for this URI.'; public const METHOD_NOT_ALLOWED = 'The requested method is not allowed for this resource; Check the Allow response header for allowed methods.'; public const MISSING_CONTENT_TYPE = 'The request header Content-Type must be provided and cannot be empty; Check the Accept response header for supported media types.'; diff --git a/src/Entity/MediaType/ClientMediaType.php b/src/Entity/MediaType/ClientMediaType.php index 57350951..c1062ea4 100644 --- a/src/Entity/MediaType/ClientMediaType.php +++ b/src/Entity/MediaType/ClientMediaType.php @@ -46,6 +46,6 @@ public function getParameters(): array public function __toString(): string { - return $this->type . '/' . $this->subtype; + return $this->type . $this::SEPARATOR . $this->subtype; } } diff --git a/src/Entity/MediaType/MediaTypeInterface.php b/src/Entity/MediaType/MediaTypeInterface.php index 3f1a2bc4..91bc5b94 100644 --- a/src/Entity/MediaType/MediaTypeInterface.php +++ b/src/Entity/MediaType/MediaTypeInterface.php @@ -20,6 +20,8 @@ */ interface MediaTypeInterface extends Stringable { + final public const SEPARATOR = '/'; + public function getType(): string; public function getSubtype(): string; diff --git a/src/Entity/MediaType/ServerMediaType.php b/src/Entity/MediaType/ServerMediaType.php index cbf08778..0e1f1b9e 100644 --- a/src/Entity/MediaType/ServerMediaType.php +++ b/src/Entity/MediaType/ServerMediaType.php @@ -36,6 +36,6 @@ public function getSubtype(): string public function __toString(): string { - return $this->type . '/' . $this->subtype; + return $this->type . $this::SEPARATOR . $this->subtype; } } diff --git a/src/Exception/HttpExceptionFactory.php b/src/Exception/HttpExceptionFactory.php index 88003b57..aef16ce7 100644 --- a/src/Exception/HttpExceptionFactory.php +++ b/src/Exception/HttpExceptionFactory.php @@ -22,13 +22,13 @@ */ final class HttpExceptionFactory { - public static function invalidUri( + public static function malformedUri( ?string $message = null, ?int $code = null, ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::INVALID_URI, + message: $message ?? ErrorMessage::MALFORMED_URI, code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, previous: $previous, ); diff --git a/src/Exception/RouteNotFoundException.php b/src/Exception/NoRouteFoundException.php similarity index 81% rename from src/Exception/RouteNotFoundException.php rename to src/Exception/NoRouteFoundException.php index 6b7209fb..61777baa 100644 --- a/src/Exception/RouteNotFoundException.php +++ b/src/Exception/NoRouteFoundException.php @@ -18,6 +18,6 @@ /** * @since 2.0.0 */ -final class RouteNotFoundException extends InvalidArgumentException implements ExceptionInterface +final class NoRouteFoundException extends InvalidArgumentException implements ExceptionInterface { } diff --git a/src/Exception/NoRoutesRegisteredException.php b/src/Exception/NoRoutesRegisteredException.php new file mode 100644 index 00000000..757bcbab --- /dev/null +++ b/src/Exception/NoRoutesRegisteredException.php @@ -0,0 +1,23 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Exception; + +use LogicException; + +/** + * @since 3.0.0 + */ +final class NoRoutesRegisteredException extends LogicException implements ExceptionInterface +{ +} diff --git a/src/Helper/ClassFinder.php b/src/Helper/ClassFinder.php index 23c6a858..ed81b967 100644 --- a/src/Helper/ClassFinder.php +++ b/src/Helper/ClassFinder.php @@ -44,12 +44,12 @@ public static function getDirClasses(string $dirname): Generator throw new InvalidArgumentException(sprintf('The directory %s does not exist.', $dirname)); } - /** @var iterable $directory */ - $directory = new RegexIterator(new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dirname)), '/\.php$/'); + /** @var iterable $files */ + $files = new RegexIterator(new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dirname)), '/\.php$/'); /** @var array $filenames */ $filenames = []; - foreach ($directory as $file) { + foreach ($files as $file) { $filenames[$file->getRealPath()] = true; (static function (string $filename): void { diff --git a/src/Helper/RouteMatcher.php b/src/Helper/RouteMatcher.php index 4ee64144..77b95228 100644 --- a/src/Helper/RouteMatcher.php +++ b/src/Helper/RouteMatcher.php @@ -72,9 +72,7 @@ public static function matchPattern(string $route, string $pattern, string $subj } throw new InvalidRouteMatchingPatternException(sprintf( - 'The route %s could not be matched due to: %s; ' . - 'most likely, this problem is related to one of the route patterns. ' . - 'Please refer to the official documentation: https://www.php.net/preg_last_error', + 'The route %s could not be matched due to: %s; most likely, this problem is related to one of the route patterns.', $route, preg_last_error_msg(), ), preg_last_error()); diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 7206cbde..ffd9536e 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -149,7 +149,9 @@ private function getResourceDescriptors(string $resource): Generator } if (class_exists($resource)) { - return yield from $this->getClassDescriptors(new ReflectionClass($resource)); + yield from $this->getClassDescriptors(new ReflectionClass($resource)); + + return; } throw new InvalidRouteLoadingResourceException(sprintf( diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index e69bf442..0ffb5cc2 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -94,7 +94,8 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } if (isset($this->validator)) { - if (($violations = $this->validator->startContext()->atPath($cookieName)->validate($argument, new ArgumentConstraint($parameter))->getViolations())->count() > 0) { + $violations = $this->validator->startContext()->atPath($cookieName)->validate($argument, new ArgumentConstraint($parameter))->getViolations(); + if ($violations->count() > 0) { throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode) ->addMessagePlaceholder(self::PLACEHOLDER_COOKIE_NAME, $cookieName) ->addConstraintViolation(...array_map(ValidatorConstraintViolationAdapter::create(...), [...$violations])); diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 0d37edc3..c6c37ac1 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -92,7 +92,8 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } if (isset($this->validator)) { - if (($violations = $this->validator->startContext()->atPath($headerName)->validate($argument, new ArgumentConstraint($parameter))->getViolations())->count() > 0) { + $violations = $this->validator->startContext()->atPath($headerName)->validate($argument, new ArgumentConstraint($parameter))->getViolations(); + if ($violations->count() > 0) { throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode) ->addMessagePlaceholder(self::PLACEHOLDER_HEADER_NAME, $headerName) ->addConstraintViolation(...array_map(ValidatorConstraintViolationAdapter::create(...), [...$violations])); diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index e7426f97..2a50f72e 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -108,7 +108,8 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } if (isset($this->validator)) { - if (($violations = $this->validator->startContext()->atPath($variableName)->validate($argument, new ArgumentConstraint($parameter))->getViolations())->count() > 0) { + $violations = $this->validator->startContext()->atPath($variableName)->validate($argument, new ArgumentConstraint($parameter))->getViolations(); + if ($violations->count() > 0) { throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode) ->addMessagePlaceholder(self::PLACEHOLDER_VARIABLE_NAME, $variableName) ->addMessagePlaceholder(self::PLACEHOLDER_ROUTE_URI, RouteSimplifier::simplifyRoute($route->getPath())) diff --git a/src/ParameterResolverChain.php b/src/ParameterResolverChain.php index f7853849..0263d2be 100644 --- a/src/ParameterResolverChain.php +++ b/src/ParameterResolverChain.php @@ -97,7 +97,7 @@ private function sortResolvers(): void $this->isSorted = usort($this->resolvers, static fn( ParameterResolverInterface $a, ParameterResolverInterface $b, - ) => $b->getWeight() <=> $a->getWeight()); + ): int => $b->getWeight() <=> $a->getWeight()); } public static function stringifyParameter(ReflectionParameter $parameter): string diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index 2847b5a5..5f6bf9b0 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -39,15 +39,10 @@ final class JsonResponseResolver implements ResponseResolverInterface public const DEFAULT_ENCODING_FLAGS = 0; public const DEFAULT_ENCODING_DEPTH = 512; - public const DEFAULT_STATUS_CODE = StatusCodeInterface::STATUS_OK; - public const DEFAULT_CONTENT_TYPE = 'application/json; charset=UTF-8'; - public function __construct( private readonly ResponseFactoryInterface $responseFactory, private readonly ?int $defaultEncodingFlags = null, private readonly ?int $defaultEncodingDepth = null, - private readonly ?int $defaultStatusCode = null, - private readonly ?string $defaultContentType = null, ) { } @@ -81,11 +76,8 @@ public function resolveResponse( ), previous: $e); } - $statusCode = $this->defaultStatusCode ?? self::DEFAULT_STATUS_CODE; - $contentType = $this->defaultContentType ?? self::DEFAULT_CONTENT_TYPE; - - $jsonResponse = $this->responseFactory->createResponse($statusCode) - ->withHeader('Content-Type', $contentType); + $jsonResponse = $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK) + ->withHeader('Content-Type', 'application/json; charset=UTF-8'); $jsonResponse->getBody()->write($payload); diff --git a/src/Router.php b/src/Router.php index 3bb48915..84c5d358 100644 --- a/src/Router.php +++ b/src/Router.php @@ -23,7 +23,8 @@ use Sunrise\Http\Router\Exception\InvalidRouteMatchingPatternException; use Sunrise\Http\Router\Exception\InvalidRouteMatchingSubjectException; use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; -use Sunrise\Http\Router\Exception\RouteNotFoundException; +use Sunrise\Http\Router\Exception\NoRouteFoundException; +use Sunrise\Http\Router\Exception\NoRoutesRegisteredException; use Sunrise\Http\Router\Helper\RouteBuilder; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Helper\RouteMatcher; @@ -38,45 +39,33 @@ class Router implements RequestHandlerInterface { + public const REQUEST_ATTRIBUTE_ROUTE = '@route'; + private readonly ReferenceResolverInterface $referenceResolver; - /** - * The router's middlewares - */ - private readonly array $middlewares; + private ?RequestHandlerInterface $requestHandler = null; - /** - * @var array - */ + private bool $isLoaded = false; + + /** @var array */ private array $routes = []; - /** - * @var array - */ + /** @var array */ private array $routePatterns = []; - /** - * @var array - */ + /** @var array */ private array $routeRequestHandlers = []; /** - * The router's request handler - */ - private ?RequestHandlerInterface $requestHandler = null; - - /** - * @param list $loaders - * * @since 3.0.0 */ public function __construct( - array $loaders = [], - array $middlewares = [], + /** @var array */ + private readonly array $loaders = [], + /** @var array */ + private readonly array $middlewares = [], ?ReferenceResolverInterface $referenceResolver = null, ) { - $this->load(...$loaders); - $this->middlewares = $middlewares; $this->referenceResolver = $referenceResolver ?? ReferenceResolver::build(); } @@ -85,24 +74,30 @@ public function __construct( */ public function getRoutes(): array { + $this->lazyLoad(); + return $this->routes; } /** - * @throws RouteNotFoundException + * @throws NoRouteFoundException */ public function getRoute(string $name): RouteInterface { - if (isset($this->routes[$name])) { - return $this->routes[$name]; + $routes = $this->getRoutes(); + + if (isset($routes[$name])) { + return $routes[$name]; } - throw new RouteNotFoundException(sprintf('The route %s does not exist.', $name)); + throw new NoRouteFoundException(sprintf('The route %s does not exist.', $name)); } public function hasRoute(string $name): bool { - return isset($this->routes[$name]); + $routes = $this->getRoutes(); + + return isset($routes[$name]); } public function addRoute(RouteInterface ...$routes): void @@ -123,25 +118,33 @@ public function load(LoaderInterface ...$loaders): void * @throws HttpExceptionInterface * @throws InvalidRouteMatchingPatternException * @throws InvalidRouteParsingSubjectException + * @throws NoRoutesRegisteredException */ public function match(ServerRequestInterface $request): RouteInterface { + $routes = $this->getRoutes(); + if ($routes === []) { + throw new NoRoutesRegisteredException('No routes are registered in the router.'); + } + $requestPath = rawurldecode($request->getUri()->getPath()); + $requestMethod = $request->getMethod(); $allowedMethods = []; - foreach ($this->routes as $route) { + + foreach ($routes as $route) { $routePattern = $this->compileRoute($route); try { $isRouteMatched = RouteMatcher::matchPattern($route->getPath(), $routePattern, $requestPath, $matches); } catch (InvalidRouteMatchingSubjectException $e) { - throw HttpExceptionFactory::invalidUri(previous: $e); + throw HttpExceptionFactory::malformedUri(previous: $e); } if (!$isRouteMatched) { continue; } - if (!$route->allowsMethod($request->getMethod())) { + if (!$route->allowsMethod($requestMethod)) { $allowedMethods += array_flip($route->getMethods()); continue; } @@ -151,7 +154,7 @@ public function match(ServerRequestInterface $request): RouteInterface if (!empty($allowedMethods)) { throw HttpExceptionFactory::methodNotAllowed() - ->addMessagePlaceholder('{{ request_method }}', $request->getMethod()) + ->addMessagePlaceholder('{{ request_method }}', $requestMethod) ->addHeaderField('Allow', ...array_keys($allowedMethods)); } @@ -166,6 +169,7 @@ public function match(ServerRequestInterface $request): RouteInterface * @throws InvalidReferenceException * @throws InvalidRouteMatchingPatternException * @throws InvalidRouteParsingSubjectException + * @throws NoRoutesRegisteredException */ public function handle(ServerRequestInterface $request): ResponseInterface { @@ -173,7 +177,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface } /** - * @throws RouteNotFoundException + * @throws NoRouteFoundException * @throws InvalidReferenceException * * @since 3.0.0 @@ -189,12 +193,12 @@ public function runRoute(RouteInterface|string $route, ServerRequestInterface $r } return $this->getRouteRequestHandler($route)->handle( - $request->withAttribute('@route', $route) + $request->withAttribute(self::REQUEST_ATTRIBUTE_ROUTE, $route) ); } /** - * @throws RouteNotFoundException + * @throws NoRouteFoundException * @throws InvalidRouteBuildingValueException * @throws InvalidRouteParsingSubjectException * @@ -210,7 +214,7 @@ public function buildRoute(RouteInterface|string $route, array $values = []): st } /** - * @throws RouteNotFoundException + * @throws NoRouteFoundException * @throws InvalidRouteBuildingValueException * @throws InvalidRouteParsingSubjectException * @@ -237,7 +241,7 @@ public function strictBuildRoute(RouteInterface|string $route, array $values = [ /** * @return non-empty-string * - * @throws RouteNotFoundException + * @throws NoRouteFoundException * @throws InvalidRouteParsingSubjectException * * @since 3.0.0 @@ -252,7 +256,7 @@ public function compileRoute(RouteInterface|string $route): string } /** - * @throws RouteNotFoundException + * @throws NoRouteFoundException * @throws InvalidReferenceException * * @since 3.0.0 @@ -283,6 +287,7 @@ public function getRouteRequestHandler(RouteInterface|string $route): RequestHan /** * @throws InvalidReferenceException + * @throws NoRoutesRegisteredException * * @since 3.0.0 */ @@ -307,4 +312,17 @@ public function getRequestHandler(): RequestHandlerInterface return $this->requestHandler; } + + private function lazyLoad(): void + { + if ($this->isLoaded) { + return; + } + + foreach ($this->loaders as $loader) { + $this->load($loader); + } + + $this->isLoaded = true; + } } diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 61e0692e..1792be59 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -86,7 +86,7 @@ public function withMediaTypeComparator(MediaTypeComparatorInterface $mediaTypeC */ public function getRoute(): RouteInterface { - $route = $this->request->getAttribute('@route'); + $route = $this->request->getAttribute(Router::REQUEST_ATTRIBUTE_ROUTE); if (! $route instanceof RouteInterface) { throw new LogicException('At this level of the application, the request does not contain information about the requested route.'); } From 509f010992a6655dde8fa0d4f10272d97cd1be05 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 31 Mar 2024 23:22:06 +0200 Subject: [PATCH 150/180] v3 --- resources/definitions/router.php | 15 ++++++++-- src/Event/RoutePostRunEvent.php | 51 ++++++++++++++++++++++++++++++++ src/Event/RoutePreRunEvent.php | 44 +++++++++++++++++++++++++++ src/Router.php | 24 +++++++++++++-- 4 files changed, 128 insertions(+), 6 deletions(-) create mode 100644 src/Event/RoutePostRunEvent.php create mode 100644 src/Event/RoutePreRunEvent.php diff --git a/resources/definitions/router.php b/resources/definitions/router.php index 797a22d9..3b7392eb 100644 --- a/resources/definitions/router.php +++ b/resources/definitions/router.php @@ -5,6 +5,10 @@ use Psr\Container\ContainerInterface; use Sunrise\Http\Router\ClassResolver; use Sunrise\Http\Router\ClassResolverInterface; +use Sunrise\Http\Router\Entity\Language\LanguageComparator; +use Sunrise\Http\Router\Entity\Language\LanguageComparatorInterface; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparatorInterface; use Sunrise\Http\Router\MiddlewareResolver; use Sunrise\Http\Router\MiddlewareResolverInterface; use Sunrise\Http\Router\ParameterResolverChain; @@ -25,6 +29,7 @@ 'router.middlewares' => [], 'router.parameter_resolvers' => [], 'router.response_resolvers' => [], + 'router.event_listener' => null, ParameterResolverChainInterface::class => create(ParameterResolverChain::class) ->constructor( @@ -64,8 +69,12 @@ Router::class => create() ->constructor( - get('router.loaders'), - get('router.middlewares'), - get(ReferenceResolverInterface::class), + loaders: get('router.loaders'), + middlewares: get('router.middlewares'), + referenceResolver: get(ReferenceResolverInterface::class), + eventDispatcher: get('router.event_listener'), ), + + MediaTypeComparatorInterface::class => create(MediaTypeComparator::class), + LanguageComparatorInterface::class => create(LanguageComparator::class), ]; diff --git a/src/Event/RoutePostRunEvent.php b/src/Event/RoutePostRunEvent.php new file mode 100644 index 00000000..53c1c356 --- /dev/null +++ b/src/Event/RoutePostRunEvent.php @@ -0,0 +1,51 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Event; + +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Sunrise\Http\Router\RouteInterface; + +/** + * @since 3.0.0 + */ +final class RoutePostRunEvent +{ + public function __construct( + private readonly RouteInterface $route, + private readonly ServerRequestInterface $request, + private ResponseInterface $response, + ) { + } + + public function getRoute(): RouteInterface + { + return $this->route; + } + + public function getRequest(): ServerRequestInterface + { + return $this->request; + } + + public function getResponse(): ResponseInterface + { + return $this->response; + } + + public function setResponse(ResponseInterface $response): void + { + $this->response = $response; + } +} diff --git a/src/Event/RoutePreRunEvent.php b/src/Event/RoutePreRunEvent.php new file mode 100644 index 00000000..2633e0d8 --- /dev/null +++ b/src/Event/RoutePreRunEvent.php @@ -0,0 +1,44 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Event; + +use Psr\Http\Message\ServerRequestInterface; +use Sunrise\Http\Router\RouteInterface; + +/** + * @since 3.0.0 + */ +final class RoutePreRunEvent +{ + public function __construct( + private readonly RouteInterface $route, + private ServerRequestInterface $request, + ) { + } + + public function getRoute(): RouteInterface + { + return $this->route; + } + + public function getRequest(): ServerRequestInterface + { + return $this->request; + } + + public function setRequest(ServerRequestInterface $request): void + { + $this->request = $request; + } +} diff --git a/src/Router.php b/src/Router.php index 84c5d358..6d260fda 100644 --- a/src/Router.php +++ b/src/Router.php @@ -13,9 +13,12 @@ namespace Sunrise\Http\Router; +use Psr\EventDispatcher\EventDispatcherInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\Event\RoutePostRunEvent; +use Sunrise\Http\Router\Event\RoutePreRunEvent; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\Exception\InvalidReferenceException; @@ -65,6 +68,7 @@ public function __construct( /** @var array */ private readonly array $middlewares = [], ?ReferenceResolverInterface $referenceResolver = null, + private readonly ?EventDispatcherInterface $eventDispatcher = null, ) { $this->referenceResolver = $referenceResolver ?? ReferenceResolver::build(); } @@ -192,9 +196,23 @@ public function runRoute(RouteInterface|string $route, ServerRequestInterface $r $request = $request->withAttribute($name, $value); } - return $this->getRouteRequestHandler($route)->handle( - $request->withAttribute(self::REQUEST_ATTRIBUTE_ROUTE, $route) - ); + $request = $request->withAttribute(self::REQUEST_ATTRIBUTE_ROUTE, $route); + + if (isset($this->eventDispatcher)) { + $event = new RoutePreRunEvent($route, $request); + $this->eventDispatcher->dispatch($event); + $request = $event->getRequest(); + } + + $response = $this->getRouteRequestHandler($route)->handle($request); + + if (isset($this->eventDispatcher)) { + $event = new RoutePostRunEvent($route, $request, $response); + $this->eventDispatcher->dispatch($event); + $response = $event->getResponse(); + } + + return $response; } /** From 482a8e299386ad479ebc486524722462f54fff05 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 31 Mar 2024 23:30:40 +0200 Subject: [PATCH 151/180] v3 --- resources/definitions/router.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/resources/definitions/router.php b/resources/definitions/router.php index 3b7392eb..2c03152f 100644 --- a/resources/definitions/router.php +++ b/resources/definitions/router.php @@ -29,7 +29,7 @@ 'router.middlewares' => [], 'router.parameter_resolvers' => [], 'router.response_resolvers' => [], - 'router.event_listener' => null, + 'router.event_dispatcher' => null, ParameterResolverChainInterface::class => create(ParameterResolverChain::class) ->constructor( @@ -72,7 +72,7 @@ loaders: get('router.loaders'), middlewares: get('router.middlewares'), referenceResolver: get(ReferenceResolverInterface::class), - eventDispatcher: get('router.event_listener'), + eventDispatcher: get('router.event_dispatcher'), ), MediaTypeComparatorInterface::class => create(MediaTypeComparator::class), From 89fc96168e2178645dc554b950a72e1b4be95c47 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Mon, 1 Apr 2024 00:40:58 +0200 Subject: [PATCH 152/180] v3 --- resources/definitions/router.php | 2 ++ src/Router.php | 4 +++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/resources/definitions/router.php b/resources/definitions/router.php index 2c03152f..3b697258 100644 --- a/resources/definitions/router.php +++ b/resources/definitions/router.php @@ -27,6 +27,7 @@ return [ 'router.loaders' => [], 'router.middlewares' => [], + 'router.route_middlewares' => [], 'router.parameter_resolvers' => [], 'router.response_resolvers' => [], 'router.event_dispatcher' => null, @@ -71,6 +72,7 @@ ->constructor( loaders: get('router.loaders'), middlewares: get('router.middlewares'), + routeMiddlewares: get('router.route_middlewares'), referenceResolver: get(ReferenceResolverInterface::class), eventDispatcher: get('router.event_dispatcher'), ), diff --git a/src/Router.php b/src/Router.php index 6d260fda..a279c833 100644 --- a/src/Router.php +++ b/src/Router.php @@ -37,6 +37,7 @@ use function array_flip; use function array_keys; +use function array_merge; use function rawurldecode; use function sprintf; @@ -67,6 +68,7 @@ public function __construct( private readonly array $loaders = [], /** @var array */ private readonly array $middlewares = [], + private readonly array $routeMiddlewares = [], ?ReferenceResolverInterface $referenceResolver = null, private readonly ?EventDispatcherInterface $eventDispatcher = null, ) { @@ -292,7 +294,7 @@ public function getRouteRequestHandler(RouteInterface|string $route): RequestHan $this->routeRequestHandlers[$name] = $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()); - $middlewares = $route->getMiddlewares(); + $middlewares = array_merge($this->routeMiddlewares, $route->getMiddlewares()); if (!empty($middlewares)) { $this->routeRequestHandlers[$name] = new QueueableRequestHandler($this->routeRequestHandlers[$name]); foreach ($middlewares as $middleware) { From 57186b1f8fe4bcc848e0eadf8b7bfe121b789059 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 14 Apr 2024 03:17:45 +0200 Subject: [PATCH 153/180] v3 --- composer.json | 5 ++- src/Annotation/Consumes.php | 2 +- src/Annotation/NamePrefix.php | 28 ++++++++++++++ .../{Prefix.php => PathPostfix.php} | 2 +- .../{Postfix.php => PathPrefix.php} | 2 +- src/Annotation/Produces.php | 2 +- src/Annotation/Route.php | 7 +++- src/Entity/MediaType/ServerMediaType.php | 12 ++++++ src/Helper/HeaderParser.php | 4 ++ src/Loader/DescriptorLoader.php | 37 ++++++++++++++----- 10 files changed, 84 insertions(+), 17 deletions(-) create mode 100644 src/Annotation/NamePrefix.php rename src/Annotation/{Prefix.php => PathPostfix.php} (95%) rename src/Annotation/{Postfix.php => PathPrefix.php} (96%) diff --git a/composer.json b/composer.json index d290a798..09333ab8 100644 --- a/composer.json +++ b/composer.json @@ -74,7 +74,7 @@ }, "scripts": { "test": [ - "phpcs", + "phpcs --colors", "psalm --no-cache", "phpstan analyse src --level=5 --memory-limit=-1", "XDEBUG_MODE=coverage phpunit --coverage-text --colors=always" @@ -83,5 +83,8 @@ "phpdoc -d src/ -t phpdoc/", "XDEBUG_MODE=coverage phpunit --coverage-html coverage/" ] + }, + "config": { + "sort-packages": true } } diff --git a/src/Annotation/Consumes.php b/src/Annotation/Consumes.php index 18f2fd8e..22f1bd52 100644 --- a/src/Annotation/Consumes.php +++ b/src/Annotation/Consumes.php @@ -23,7 +23,7 @@ final class Consumes { public function __construct( - public readonly MediaTypeInterface $value, + public readonly string|MediaTypeInterface $value, ) { } } diff --git a/src/Annotation/NamePrefix.php b/src/Annotation/NamePrefix.php new file mode 100644 index 00000000..1614babb --- /dev/null +++ b/src/Annotation/NamePrefix.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] +final class NamePrefix +{ + public function __construct( + public readonly string $value, + ) { + } +} diff --git a/src/Annotation/Prefix.php b/src/Annotation/PathPostfix.php similarity index 95% rename from src/Annotation/Prefix.php rename to src/Annotation/PathPostfix.php index c260e0d0..8b276933 100644 --- a/src/Annotation/Prefix.php +++ b/src/Annotation/PathPostfix.php @@ -19,7 +19,7 @@ * @since 2.11.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] -final class Prefix +final class PathPostfix { public function __construct( public readonly string $value, diff --git a/src/Annotation/Postfix.php b/src/Annotation/PathPrefix.php similarity index 96% rename from src/Annotation/Postfix.php rename to src/Annotation/PathPrefix.php index 94d84eda..abe65754 100644 --- a/src/Annotation/Postfix.php +++ b/src/Annotation/PathPrefix.php @@ -19,7 +19,7 @@ * @since 2.11.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] -final class Postfix +final class PathPrefix { public function __construct( public readonly string $value, diff --git a/src/Annotation/Produces.php b/src/Annotation/Produces.php index c7aff81c..4dced168 100644 --- a/src/Annotation/Produces.php +++ b/src/Annotation/Produces.php @@ -23,7 +23,7 @@ final class Produces { public function __construct( - public readonly MediaTypeInterface $value, + public readonly string|MediaTypeInterface $value, ) { } } diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index 1f5d3a27..36b14ac9 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -25,13 +25,16 @@ final class Route public mixed $holder = null; /** @var array */ - public array $prefixes = []; + public array $namePrefixes = []; + + /** @var array */ + public array $pathPrefixes = []; /** @var non-empty-string|null */ public ?string $pattern = null; public function __construct( - public readonly string $name, + public string $name, public string $path, /** @var array */ public array $patterns = [], diff --git a/src/Entity/MediaType/ServerMediaType.php b/src/Entity/MediaType/ServerMediaType.php index 0e1f1b9e..2021bc48 100644 --- a/src/Entity/MediaType/ServerMediaType.php +++ b/src/Entity/MediaType/ServerMediaType.php @@ -13,6 +13,8 @@ namespace Sunrise\Http\Router\Entity\MediaType; +use function explode; + /** * @since 3.0.0 */ @@ -24,6 +26,16 @@ public function __construct( ) { } + public static function fromString(string $string): self + { + $parts = explode(self::SEPARATOR, $string, 2); + + $type = isset($parts[0][0]) ? $parts[0] : '*'; + $subtype = isset($parts[1][0]) ? $parts[1] : '*'; + + return new self($type, $subtype); + } + public function getType(): string { return $this->type; diff --git a/src/Helper/HeaderParser.php b/src/Helper/HeaderParser.php index 2be2801d..70645203 100644 --- a/src/Helper/HeaderParser.php +++ b/src/Helper/HeaderParser.php @@ -33,6 +33,10 @@ final class HeaderParser */ public static function parseHeader(string $header): array { + if ($header === '') { + return []; + } + $cursor = self::IN_IDENTIFIER; $value = 0; $param = -1; diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index ffd9536e..9fd8e4f9 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -27,14 +27,16 @@ use Sunrise\Http\Router\Annotation\Description; use Sunrise\Http\Router\Annotation\Method; use Sunrise\Http\Router\Annotation\Middleware; +use Sunrise\Http\Router\Annotation\NamePrefix; +use Sunrise\Http\Router\Annotation\PathPostfix; +use Sunrise\Http\Router\Annotation\PathPrefix; use Sunrise\Http\Router\Annotation\Pattern; -use Sunrise\Http\Router\Annotation\Postfix; -use Sunrise\Http\Router\Annotation\Prefix; use Sunrise\Http\Router\Annotation\Priority; use Sunrise\Http\Router\Annotation\Produces; use Sunrise\Http\Router\Annotation\Route as Descriptor; use Sunrise\Http\Router\Annotation\Summary; use Sunrise\Http\Router\Annotation\Tag; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; use Sunrise\Http\Router\Exception\InvalidRouteLoadingResourceException; use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; use Sunrise\Http\Router\Helper\ClassFinder; @@ -44,6 +46,7 @@ use function class_exists; use function is_dir; use function is_file; +use function is_string; use function join; use function sprintf; use function usort; @@ -214,15 +217,22 @@ private function enrichDescriptorFromParentClasses(Descriptor $descriptor, Refle private function enrichDescriptorFromClassOrMethod(Descriptor $descriptor, ReflectionClass|ReflectionMethod $classOrMethod): void { - /** @var list> $annotations */ - $annotations = $classOrMethod->getAttributes(Prefix::class); + /** @var list> $annotations */ + $annotations = $classOrMethod->getAttributes(NamePrefix::class); if (isset($annotations[0])) { $annotation = $annotations[0]->newInstance(); - $descriptor->prefixes[] = $annotation->value; + $descriptor->namePrefixes[] = $annotation->value; } - /** @var list> $annotations */ - $annotations = $classOrMethod->getAttributes(Postfix::class); + /** @var list> $annotations */ + $annotations = $classOrMethod->getAttributes(PathPrefix::class); + if (isset($annotations[0])) { + $annotation = $annotations[0]->newInstance(); + $descriptor->pathPrefixes[] = $annotation->value; + } + + /** @var list> $annotations */ + $annotations = $classOrMethod->getAttributes(PathPostfix::class); if (isset($annotations[0])) { $annotation = $annotations[0]->newInstance(); $descriptor->path .= $annotation->value; @@ -267,14 +277,20 @@ private function enrichDescriptorFromClassOrMethod(Descriptor $descriptor, Refle $annotations = $classOrMethod->getAttributes(Consumes::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->consumes[] = $annotation->value; + + $descriptor->consumes[] = is_string($annotation->value) ? + ServerMediaType::fromString($annotation->value) : + $annotation->value; } /** @var list> $annotations */ $annotations = $classOrMethod->getAttributes(Produces::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->produces[] = $annotation->value; + + $descriptor->produces[] = is_string($annotation->value) ? + ServerMediaType::fromString($annotation->value) : + $annotation->value; } /** @var list> $annotations */ @@ -317,7 +333,8 @@ private function enrichDescriptorFromClassOrMethod(Descriptor $descriptor, Refle */ private function completeDescriptor(Descriptor $descriptor): void { - $descriptor->path = join($descriptor->prefixes) . $descriptor->path; + $descriptor->name = join($descriptor->namePrefixes) . $descriptor->name; + $descriptor->path = join($descriptor->pathPrefixes) . $descriptor->path; $descriptor->pattern = RouteCompiler::compileRoute($descriptor->path, $descriptor->patterns); } From c2f4c6ac06efef215bb367a126437a6c35bcc73f Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Mon, 15 Jul 2024 22:49:59 +0200 Subject: [PATCH 154/180] v3 --- src/RequestHandler/CallableRequestHandler.php | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index d80067f6..2022dc06 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -39,6 +39,16 @@ public function __construct(callable $callback) $this->callback = $callback; } + /** + * @return T + * + * @since 2.10.0 + */ + public function getCallback(): callable + { + return $this->callback; + } + /** * @inheritDoc */ From 73d17f90a0527427559501af72709e801241d910 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Tue, 20 Aug 2024 01:06:27 +0200 Subject: [PATCH 155/180] v3 --- resources/definitions/router.php | 3 +- src/ClassResolver.php | 4 + src/ClassResolverInterface.php | 4 + src/Command/RouteListCommand.php | 4 +- src/Entity/Language/ServerLanguage.php | 30 +++++ src/Helper/RouteBuilder.php | 2 +- src/Helper/RouteCompiler.php | 2 +- src/Helper/RouteMatcher.php | 2 +- src/Helper/RouteSimplifier.php | 2 +- src/Loader/LoaderInterface.php | 3 + src/MiddlewareResolver.php | 7 ++ src/MiddlewareResolverInterface.php | 4 + src/ParameterResolverChain.php | 5 +- src/ParameterResolverChainInterface.php | 5 + src/ParameterResolverInterface.php | 3 + src/ReferenceResolver.php | 6 + src/RequestHandlerResolver.php | 7 ++ src/RequestHandlerResolverInterface.php | 4 + .../EmptyResponseResolver.php | 3 + src/ResponseResolver/JsonResponseResolver.php | 2 + src/ResponseResolverChain.php | 4 +- src/ResponseResolverChainInterface.php | 6 + src/ResponseResolverInterface.php | 4 + src/Router.php | 92 +++++++-------- src/RouterInterface.php | 110 ++++++++++++++++++ src/ServerRequest.php | 5 +- .../Entity/Language/ClientLanguageTest.php | 20 ++++ .../Language/LanguageComparatorTest.php | 60 ++++++++++ .../Entity/Language/ServerLanguageTest.php | 18 +++ .../Entity/MediaType/ClientMediaTypeTest.php | 27 +++++ .../MediaType/MediaTypeComparatorTest.php | 78 +++++++++++++ .../Entity/MediaType/ServerMediaTypeTest.php | 70 +++++++++++ tests/Unit/Event/RoutePostRunEventTest.php | 40 +++++++ tests/Unit/Event/RoutePreRunEventTest.php | 36 ++++++ tests/{ => Unit}/Helper/RouteParserTest.php | 9 +- 35 files changed, 611 insertions(+), 70 deletions(-) create mode 100644 src/Entity/Language/ServerLanguage.php create mode 100644 src/RouterInterface.php create mode 100644 tests/Unit/Entity/Language/ClientLanguageTest.php create mode 100644 tests/Unit/Entity/Language/LanguageComparatorTest.php create mode 100644 tests/Unit/Entity/Language/ServerLanguageTest.php create mode 100644 tests/Unit/Entity/MediaType/ClientMediaTypeTest.php create mode 100644 tests/Unit/Entity/MediaType/MediaTypeComparatorTest.php create mode 100644 tests/Unit/Entity/MediaType/ServerMediaTypeTest.php create mode 100644 tests/Unit/Event/RoutePostRunEventTest.php create mode 100644 tests/Unit/Event/RoutePreRunEventTest.php rename tests/{ => Unit}/Helper/RouteParserTest.php (96%) diff --git a/resources/definitions/router.php b/resources/definitions/router.php index 3b697258..f0c964ad 100644 --- a/resources/definitions/router.php +++ b/resources/definitions/router.php @@ -20,6 +20,7 @@ use Sunrise\Http\Router\ResponseResolverChain; use Sunrise\Http\Router\ResponseResolverChainInterface; use Sunrise\Http\Router\Router; +use Sunrise\Http\Router\RouterInterface; use function DI\create; use function DI\get; @@ -68,7 +69,7 @@ get(RequestHandlerResolverInterface::class), ), - Router::class => create() + RouterInterface::class => create(Router::class) ->constructor( loaders: get('router.loaders'), middlewares: get('router.middlewares'), diff --git a/src/ClassResolver.php b/src/ClassResolver.php index c80f27ec..48f3049b 100644 --- a/src/ClassResolver.php +++ b/src/ClassResolver.php @@ -17,6 +17,8 @@ use Psr\Container\ContainerExceptionInterface; use Psr\Container\ContainerInterface; use ReflectionClass; +use Sunrise\Http\Router\Exception\InvalidParameterException; +use Sunrise\Http\Router\Exception\UnsupportedParameterException; use function class_exists; use function sprintf; @@ -48,6 +50,8 @@ public function __construct( * * @throws InvalidArgumentException If the named class cannot be resolved. * @throws ContainerExceptionInterface If something went wrong while working with the container. + * @throws InvalidParameterException {@see ParameterResolverChainInterface::resolveParameters()} + * @throws UnsupportedParameterException {@see ParameterResolverChainInterface::resolveParameters()} */ public function resolveClass(string $className): object { diff --git a/src/ClassResolverInterface.php b/src/ClassResolverInterface.php index 73410d6e..68a0ec5c 100644 --- a/src/ClassResolverInterface.php +++ b/src/ClassResolverInterface.php @@ -13,6 +13,8 @@ namespace Sunrise\Http\Router; +use InvalidArgumentException; + /** * @since 3.0.0 */ @@ -26,6 +28,8 @@ interface ClassResolverInterface * @return T * * @template T of object + * + * @throws InvalidArgumentException */ public function resolveClass(string $className): object; } diff --git a/src/Command/RouteListCommand.php b/src/Command/RouteListCommand.php index 285162c7..56213738 100644 --- a/src/Command/RouteListCommand.php +++ b/src/Command/RouteListCommand.php @@ -13,7 +13,7 @@ namespace Sunrise\Http\Router\Command; -use Sunrise\Http\Router\Router; +use Sunrise\Http\Router\RouterInterface; use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Helper\Table; @@ -28,7 +28,7 @@ #[AsCommand('router:route-list', 'Lists all routes.')] final class RouteListCommand extends Command { - public function __construct(private readonly Router $router) + public function __construct(private readonly RouterInterface $router) { parent::__construct(); } diff --git a/src/Entity/Language/ServerLanguage.php b/src/Entity/Language/ServerLanguage.php new file mode 100644 index 00000000..ef184b41 --- /dev/null +++ b/src/Entity/Language/ServerLanguage.php @@ -0,0 +1,30 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Entity\Language; + +/** + * @since 3.0.0 + */ +final class ServerLanguage implements LanguageInterface +{ + public function __construct( + private readonly string $code, + ) { + } + + public function getCode(): string + { + return $this->code; + } +} diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index e553a041..4c4aee97 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -33,7 +33,7 @@ final class RouteBuilder { /** * @throws InvalidRouteBuildingValueException - * @throws InvalidRouteParsingSubjectException + * @throws InvalidRouteParsingSubjectException {@see RouteParser::parseRoute()} */ public static function buildRoute(string $route, array $values = []): string { diff --git a/src/Helper/RouteCompiler.php b/src/Helper/RouteCompiler.php index 1e41ec3a..8f197f30 100644 --- a/src/Helper/RouteCompiler.php +++ b/src/Helper/RouteCompiler.php @@ -31,7 +31,7 @@ final class RouteCompiler * * @return non-empty-string * - * @throws InvalidRouteParsingSubjectException + * @throws InvalidRouteParsingSubjectException {@see RouteParser::parseRoute()} */ public static function compileRoute(string $route, array $patterns = []): string { diff --git a/src/Helper/RouteMatcher.php b/src/Helper/RouteMatcher.php index 77b95228..0c1d8f60 100644 --- a/src/Helper/RouteMatcher.php +++ b/src/Helper/RouteMatcher.php @@ -38,7 +38,7 @@ final class RouteMatcher * @param array $patterns * @param-out array $matches * - * @throws InvalidRouteParsingSubjectException + * @throws InvalidRouteParsingSubjectException {@see RouteCompiler::compileRoute()} * @throws InvalidRouteMatchingPatternException * @throws InvalidRouteMatchingSubjectException */ diff --git a/src/Helper/RouteSimplifier.php b/src/Helper/RouteSimplifier.php index 17318be9..dda17355 100644 --- a/src/Helper/RouteSimplifier.php +++ b/src/Helper/RouteSimplifier.php @@ -24,7 +24,7 @@ final class RouteSimplifier { /** - * @throws InvalidRouteParsingSubjectException + * @throws InvalidRouteParsingSubjectException {@see RouteParser::parseRoute()} */ public static function simplifyRoute(string $route): string { diff --git a/src/Loader/LoaderInterface.php b/src/Loader/LoaderInterface.php index fc2086d5..f4eb0394 100644 --- a/src/Loader/LoaderInterface.php +++ b/src/Loader/LoaderInterface.php @@ -13,6 +13,7 @@ namespace Sunrise\Http\Router\Loader; +use Sunrise\Http\Router\Exception\InvalidRouteLoadingResourceException; use Sunrise\Http\Router\RouteInterface; /** @@ -22,6 +23,8 @@ interface LoaderInterface { /** * @return iterable + * + * @throws InvalidRouteLoadingResourceException */ public function load(): iterable; } diff --git a/src/MiddlewareResolver.php b/src/MiddlewareResolver.php index 5b59b997..236691e2 100644 --- a/src/MiddlewareResolver.php +++ b/src/MiddlewareResolver.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router; use Closure; +use InvalidArgumentException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; @@ -43,6 +44,12 @@ public function __construct( ) { } + /** + * @inheritDoc + * + * @throws InvalidArgumentException {@see ClassResolverInterface::resolveClass()} + * @throws InvalidReferenceException + */ public function resolveMiddleware(mixed $reference): MiddlewareInterface { if ($reference instanceof MiddlewareInterface) { diff --git a/src/MiddlewareResolverInterface.php b/src/MiddlewareResolverInterface.php index c49e3cd1..3b87f1f0 100644 --- a/src/MiddlewareResolverInterface.php +++ b/src/MiddlewareResolverInterface.php @@ -14,11 +14,15 @@ namespace Sunrise\Http\Router; use Psr\Http\Server\MiddlewareInterface; +use Sunrise\Http\Router\Exception\InvalidReferenceException; /** * @since 3.0.0 */ interface MiddlewareResolverInterface { + /** + * @throws InvalidReferenceException + */ public function resolveMiddleware(mixed $reference): MiddlewareInterface; } diff --git a/src/ParameterResolverChain.php b/src/ParameterResolverChain.php index 0263d2be..669ad31b 100644 --- a/src/ParameterResolverChain.php +++ b/src/ParameterResolverChain.php @@ -58,9 +58,6 @@ public function withResolver(ParameterResolverInterface ...$resolvers): static /** * @inheritDoc - * - * @throws InvalidParameterException - * @throws UnsupportedParameterException */ public function resolveParameters(ReflectionParameter ...$parameters): Generator { @@ -74,7 +71,7 @@ public function resolveParameters(ReflectionParameter ...$parameters): Generator /** * @return Generator * - * @throws InvalidParameterException + * @throws InvalidParameterException {@see ParameterResolverInterface::resolveParameter()} * @throws UnsupportedParameterException */ private function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator diff --git a/src/ParameterResolverChainInterface.php b/src/ParameterResolverChainInterface.php index a1d0f8b2..4d904dcc 100644 --- a/src/ParameterResolverChainInterface.php +++ b/src/ParameterResolverChainInterface.php @@ -15,6 +15,8 @@ use Generator; use ReflectionParameter; +use Sunrise\Http\Router\Exception\InvalidParameterException; +use Sunrise\Http\Router\Exception\UnsupportedParameterException; /** * @since 3.0.0 @@ -27,6 +29,9 @@ public function withResolver(ParameterResolverInterface ...$resolvers): static; /** * @return Generator + * + * @throws InvalidParameterException {@see ParameterResolverInterface::resolveParameter()} + * @throws UnsupportedParameterException */ public function resolveParameters(ReflectionParameter ...$parameters): Generator; } diff --git a/src/ParameterResolverInterface.php b/src/ParameterResolverInterface.php index 25ec7f55..556176b5 100644 --- a/src/ParameterResolverInterface.php +++ b/src/ParameterResolverInterface.php @@ -15,6 +15,7 @@ use Generator; use ReflectionParameter; +use Sunrise\Http\Router\Exception\InvalidParameterException; /** * @since 3.0.0 @@ -23,6 +24,8 @@ interface ParameterResolverInterface { /** * @return Generator + * + * @throws InvalidParameterException */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator; diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index aa9e9395..9846c413 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -49,11 +49,17 @@ public static function build( return new self($middlewareResolver, $requestHandlerResolver); } + /** + * @inheritDoc + */ public function resolveMiddleware(mixed $reference): MiddlewareInterface { return $this->middlewareResolver->resolveMiddleware($reference); } + /** + * @inheritDoc + */ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface { return $this->requestHandlerResolver->resolveRequestHandler($reference); diff --git a/src/RequestHandlerResolver.php b/src/RequestHandlerResolver.php index 74217416..81cb4895 100644 --- a/src/RequestHandlerResolver.php +++ b/src/RequestHandlerResolver.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router; use Closure; +use InvalidArgumentException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; @@ -42,6 +43,12 @@ public function __construct( ) { } + /** + * @inheritDoc + * + * @throws InvalidArgumentException {@see ClassResolverInterface::resolveClass()} + * @throws InvalidReferenceException + */ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface { if ($reference instanceof RequestHandlerInterface) { diff --git a/src/RequestHandlerResolverInterface.php b/src/RequestHandlerResolverInterface.php index 8b1fde8b..2209ee85 100644 --- a/src/RequestHandlerResolverInterface.php +++ b/src/RequestHandlerResolverInterface.php @@ -14,11 +14,15 @@ namespace Sunrise\Http\Router; use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\Exception\InvalidReferenceException; /** * @since 3.0.0 */ interface RequestHandlerResolverInterface { + /** + * @throws InvalidReferenceException + */ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface; } diff --git a/src/ResponseResolver/EmptyResponseResolver.php b/src/ResponseResolver/EmptyResponseResolver.php index 29309b19..b9e90f02 100644 --- a/src/ResponseResolver/EmptyResponseResolver.php +++ b/src/ResponseResolver/EmptyResponseResolver.php @@ -35,6 +35,9 @@ public function __construct( ) { } + /** + * @inheritDoc + */ public function resolveResponse( mixed $response, ReflectionMethod|ReflectionFunction $responder, diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index 5f6bf9b0..10b63a3d 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -47,6 +47,8 @@ public function __construct( } /** + * @inheritDoc + * * @throws InvalidResponseException */ public function resolveResponse( diff --git a/src/ResponseResolverChain.php b/src/ResponseResolverChain.php index 18836c5c..ea7ae82a 100644 --- a/src/ResponseResolverChain.php +++ b/src/ResponseResolverChain.php @@ -20,7 +20,6 @@ use ReflectionMethod; use Sunrise\Http\Router\Annotation\ResponseHeader; use Sunrise\Http\Router\Annotation\ResponseStatus; -use Sunrise\Http\Router\Exception\InvalidResponseException; use Sunrise\Http\Router\Exception\UnsupportedResponseException; use function sprintf; @@ -40,8 +39,7 @@ public function __construct( } /** - * @throws InvalidResponseException - * @throws UnsupportedResponseException + * @inheritDoc */ public function resolveResponse( mixed $response, diff --git a/src/ResponseResolverChainInterface.php b/src/ResponseResolverChainInterface.php index e917d1b5..ffa80dfd 100644 --- a/src/ResponseResolverChainInterface.php +++ b/src/ResponseResolverChainInterface.php @@ -17,12 +17,18 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionFunction; use ReflectionMethod; +use Sunrise\Http\Router\Exception\InvalidResponseException; +use Sunrise\Http\Router\Exception\UnsupportedResponseException; /** * @since 3.0.0 */ interface ResponseResolverChainInterface { + /** + * @throws InvalidResponseException {@see ResponseResolverInterface::resolveResponse()} + * @throws UnsupportedResponseException + */ public function resolveResponse( mixed $response, ReflectionMethod|ReflectionFunction $responder, diff --git a/src/ResponseResolverInterface.php b/src/ResponseResolverInterface.php index 19883b53..3a8e3a47 100644 --- a/src/ResponseResolverInterface.php +++ b/src/ResponseResolverInterface.php @@ -17,12 +17,16 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionFunction; use ReflectionMethod; +use Sunrise\Http\Router\Exception\InvalidResponseException; /** * @since 3.0.0 */ interface ResponseResolverInterface { + /** + * @throws InvalidResponseException + */ public function resolveResponse( mixed $response, ReflectionMethod|ReflectionFunction $responder, diff --git a/src/Router.php b/src/Router.php index a279c833..032ad371 100644 --- a/src/Router.php +++ b/src/Router.php @@ -23,6 +23,7 @@ use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\Exception\InvalidReferenceException; use Sunrise\Http\Router\Exception\InvalidRouteBuildingValueException; +use Sunrise\Http\Router\Exception\InvalidRouteLoadingResourceException; use Sunrise\Http\Router\Exception\InvalidRouteMatchingPatternException; use Sunrise\Http\Router\Exception\InvalidRouteMatchingSubjectException; use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; @@ -41,16 +42,12 @@ use function rawurldecode; use function sprintf; -class Router implements RequestHandlerInterface +final class Router implements RouterInterface { - public const REQUEST_ATTRIBUTE_ROUTE = '@route'; - private readonly ReferenceResolverInterface $referenceResolver; private ?RequestHandlerInterface $requestHandler = null; - private bool $isLoaded = false; - /** @var array */ private array $routes = []; @@ -60,6 +57,8 @@ class Router implements RequestHandlerInterface /** @var array */ private array $routeRequestHandlers = []; + private bool $isLoaded = false; + /** * @since 3.0.0 */ @@ -68,6 +67,7 @@ public function __construct( private readonly array $loaders = [], /** @var array */ private readonly array $middlewares = [], + /** @var array */ private readonly array $routeMiddlewares = [], ?ReferenceResolverInterface $referenceResolver = null, private readonly ?EventDispatcherInterface $eventDispatcher = null, @@ -76,7 +76,7 @@ public function __construct( } /** - * @return array + * @inheritDoc */ public function getRoutes(): array { @@ -86,6 +86,8 @@ public function getRoutes(): array } /** + * @inheritDoc + * * @throws NoRouteFoundException */ public function getRoute(string $name): RouteInterface @@ -99,6 +101,9 @@ public function getRoute(string $name): RouteInterface throw new NoRouteFoundException(sprintf('The route %s does not exist.', $name)); } + /** + * @inheritDoc + */ public function hasRoute(string $name): bool { $routes = $this->getRoutes(); @@ -106,6 +111,9 @@ public function hasRoute(string $name): bool return isset($routes[$name]); } + /** + * @inheritDoc + */ public function addRoute(RouteInterface ...$routes): void { foreach ($routes as $route) { @@ -113,6 +121,11 @@ public function addRoute(RouteInterface ...$routes): void } } + /** + * @inheritDoc + * + * @throws InvalidRouteLoadingResourceException {@see LoaderInterface::load()} + */ public function load(LoaderInterface ...$loaders): void { foreach ($loaders as $loader) { @@ -121,6 +134,8 @@ public function load(LoaderInterface ...$loaders): void } /** + * @inheritDoc + * * @throws HttpExceptionInterface * @throws InvalidRouteMatchingPatternException * @throws InvalidRouteParsingSubjectException @@ -138,18 +153,14 @@ public function match(ServerRequestInterface $request): RouteInterface $allowedMethods = []; foreach ($routes as $route) { - $routePattern = $this->compileRoute($route); - try { - $isRouteMatched = RouteMatcher::matchPattern($route->getPath(), $routePattern, $requestPath, $matches); + if (!RouteMatcher::matchPattern($route->getPath(), $this->compileRoute($route), $requestPath, $matches)) { + continue; + } } catch (InvalidRouteMatchingSubjectException $e) { throw HttpExceptionFactory::malformedUri(previous: $e); } - if (!$isRouteMatched) { - continue; - } - if (!$route->allowsMethod($requestMethod)) { $allowedMethods += array_flip($route->getMethods()); continue; @@ -183,10 +194,10 @@ public function handle(ServerRequestInterface $request): ResponseInterface } /** - * @throws NoRouteFoundException - * @throws InvalidReferenceException + * @inheritDoc * - * @since 3.0.0 + * @throws InvalidReferenceException + * @throws NoRouteFoundException */ public function runRoute(RouteInterface|string $route, ServerRequestInterface $request): ResponseInterface { @@ -218,37 +229,21 @@ public function runRoute(RouteInterface|string $route, ServerRequestInterface $r } /** - * @throws NoRouteFoundException - * @throws InvalidRouteBuildingValueException - * @throws InvalidRouteParsingSubjectException + * @inheritDoc * - * @since 3.0.0 - */ - public function buildRoute(RouteInterface|string $route, array $values = []): string - { - if (! $route instanceof RouteInterface) { - $route = $this->getRoute($route); - } - - return RouteBuilder::buildRoute($route->getPath(), $values + $route->getAttributes()); - } - - /** - * @throws NoRouteFoundException * @throws InvalidRouteBuildingValueException * @throws InvalidRouteParsingSubjectException - * - * @since 3.0.0 + * @throws NoRouteFoundException */ - public function strictBuildRoute(RouteInterface|string $route, array $values = []): string + public function buildRoute(RouteInterface|string $route, array $values = [], bool $strictly = false): string { if (! $route instanceof RouteInterface) { $route = $this->getRoute($route); } - $result = $this->buildRoute($route, $values); + $result = RouteBuilder::buildRoute($route->getPath(), $values + $route->getAttributes()); - if (!RouteMatcher::matchPattern($route->getPath(), $this->compileRoute($route), $result)) { + if ($strictly && !RouteMatcher::matchPattern($route->getPath(), $this->compileRoute($route), $result)) { throw new InvalidRouteBuildingValueException(sprintf( 'The route %s could not be built because one of the values does not match its pattern.', $route->getName(), @@ -259,12 +254,10 @@ public function strictBuildRoute(RouteInterface|string $route, array $values = [ } /** - * @return non-empty-string + * @inheritDoc * - * @throws NoRouteFoundException * @throws InvalidRouteParsingSubjectException - * - * @since 3.0.0 + * @throws NoRouteFoundException */ public function compileRoute(RouteInterface|string $route): string { @@ -276,10 +269,10 @@ public function compileRoute(RouteInterface|string $route): string } /** - * @throws NoRouteFoundException - * @throws InvalidReferenceException + * @inheritDoc * - * @since 3.0.0 + * @throws InvalidReferenceException + * @throws NoRouteFoundException */ public function getRouteRequestHandler(RouteInterface|string $route): RequestHandlerInterface { @@ -298,7 +291,9 @@ public function getRouteRequestHandler(RouteInterface|string $route): RequestHan if (!empty($middlewares)) { $this->routeRequestHandlers[$name] = new QueueableRequestHandler($this->routeRequestHandlers[$name]); foreach ($middlewares as $middleware) { - $this->routeRequestHandlers[$name]->enqueue($this->referenceResolver->resolveMiddleware($middleware)); + $this->routeRequestHandlers[$name]->enqueue( + $this->referenceResolver->resolveMiddleware($middleware) + ); } } @@ -307,11 +302,10 @@ public function getRouteRequestHandler(RouteInterface|string $route): RequestHan /** * @throws InvalidReferenceException - * @throws NoRoutesRegisteredException * * @since 3.0.0 */ - public function getRequestHandler(): RequestHandlerInterface + private function getRequestHandler(): RequestHandlerInterface { if (isset($this->requestHandler)) { return $this->requestHandler; @@ -326,7 +320,9 @@ public function getRequestHandler(): RequestHandlerInterface if (!empty($this->middlewares)) { $this->requestHandler = new QueueableRequestHandler($this->requestHandler); foreach ($this->middlewares as $middleware) { - $this->requestHandler->enqueue($this->referenceResolver->resolveMiddleware($middleware)); + $this->requestHandler->enqueue( + $this->referenceResolver->resolveMiddleware($middleware) + ); } } diff --git a/src/RouterInterface.php b/src/RouterInterface.php new file mode 100644 index 00000000..e4056e33 --- /dev/null +++ b/src/RouterInterface.php @@ -0,0 +1,110 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router; + +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\Exception\HttpExceptionInterface; +use Sunrise\Http\Router\Exception\InvalidRouteLoadingResourceException; +use Sunrise\Http\Router\Exception\NoRouteFoundException; +use Sunrise\Http\Router\Exception\NoRoutesRegisteredException; +use Sunrise\Http\Router\Loader\LoaderInterface; + +/** + * @since 3.0.0 + */ +interface RouterInterface extends RequestHandlerInterface +{ + public const REQUEST_ATTRIBUTE_ROUTE = '@route'; + + /** + * @return array + * + * @since 1.0.0 + */ + public function getRoutes(): array; + + /** + * @throws NoRouteFoundException + * + * @since 2.0.0 + */ + public function getRoute(string $name): RouteInterface; + + /** + * @since 2.16.0 + */ + public function hasRoute(string $name): bool; + + /** + * @since 1.0.0 + */ + public function addRoute(RouteInterface ...$routes): void; + + /** + * @since 2.0.0 + * + * @throws InvalidRouteLoadingResourceException {@see LoaderInterface::load()} + */ + public function load(LoaderInterface ...$loaders): void; + + /** + * @throws HttpExceptionInterface + * @throws NoRoutesRegisteredException + * + * @since 1.0.0 + */ + public function match(ServerRequestInterface $request): RouteInterface; + + /** + * @inheritDoc + * + * @throws HttpExceptionInterface + * @throws NoRoutesRegisteredException + * + * @since 1.0.0 + */ + public function handle(ServerRequestInterface $request): ResponseInterface; + + /** + * @throws NoRouteFoundException + * + * @since 3.0.0 + */ + public function runRoute(RouteInterface|string $route, ServerRequestInterface $request): ResponseInterface; + + /** + * @throws NoRouteFoundException + * + * @since 3.0.0 + */ + public function buildRoute(RouteInterface|string $route, array $values = []): string; + + /** + * @return non-empty-string + * + * @throws NoRouteFoundException + * + * @since 3.0.0 + */ + public function compileRoute(RouteInterface|string $route): string; + + /** + * @throws NoRouteFoundException + * + * @since 3.0.0 + */ + public function getRouteRequestHandler(RouteInterface|string $route): RequestHandlerInterface; +} diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 1792be59..3570d782 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -38,7 +38,6 @@ final class ServerRequest implements ServerRequestInterface { private ?LanguageComparatorInterface $languageComparator = null; - private ?MediaTypeComparatorInterface $mediaTypeComparator = null; public function __construct(private ServerRequestInterface $request) @@ -52,7 +51,7 @@ public static function create(ServerRequestInterface $request): self public function getOriginalRequest(): ServerRequestInterface { - return $this->request; + return ($this->request instanceof self) ? $this->request->getOriginalRequest() : $this->request; } public function getLanguageComparator(): LanguageComparatorInterface @@ -86,7 +85,7 @@ public function withMediaTypeComparator(MediaTypeComparatorInterface $mediaTypeC */ public function getRoute(): RouteInterface { - $route = $this->request->getAttribute(Router::REQUEST_ATTRIBUTE_ROUTE); + $route = $this->request->getAttribute(RouterInterface::REQUEST_ATTRIBUTE_ROUTE); if (! $route instanceof RouteInterface) { throw new LogicException('At this level of the application, the request does not contain information about the requested route.'); } diff --git a/tests/Unit/Entity/Language/ClientLanguageTest.php b/tests/Unit/Entity/Language/ClientLanguageTest.php new file mode 100644 index 00000000..77c40ecd --- /dev/null +++ b/tests/Unit/Entity/Language/ClientLanguageTest.php @@ -0,0 +1,20 @@ + '1.0']); + + $this->assertSame('sr', $language->getCode()); + $this->assertSame('sr-RS', $language->getIdentifier()); + $this->assertSame(['q' => '1.0'], $language->getParameters()); + } +} diff --git a/tests/Unit/Entity/Language/LanguageComparatorTest.php b/tests/Unit/Entity/Language/LanguageComparatorTest.php new file mode 100644 index 00000000..acd6cce8 --- /dev/null +++ b/tests/Unit/Entity/Language/LanguageComparatorTest.php @@ -0,0 +1,60 @@ +assertSame($expected, (new LanguageComparator)->compare($a, $b)); + } + + private function compareDataProvider(): iterable + { + yield [ + new ServerLanguage('sr'), + new ServerLanguage('sr'), + 0, + ]; + + yield [ + new ServerLanguage('*'), + new ServerLanguage('*'), + 0, + ]; + + yield [ + new ServerLanguage('*'), + new ServerLanguage('sr'), + 0, + ]; + + yield [ + new ServerLanguage('sr'), + new ServerLanguage('*'), + 0, + ]; + + yield [ + new ServerLanguage('sr'), + new ServerLanguage('bs'), + 'sr' <=> 'bs', + ]; + + yield [ + new ServerLanguage('bs'), + new ServerLanguage('sr'), + 'bs' <=> 'sr', + ]; + } +} diff --git a/tests/Unit/Entity/Language/ServerLanguageTest.php b/tests/Unit/Entity/Language/ServerLanguageTest.php new file mode 100644 index 00000000..e8e7ff33 --- /dev/null +++ b/tests/Unit/Entity/Language/ServerLanguageTest.php @@ -0,0 +1,18 @@ +assertSame('sr', $language->getCode()); + } +} diff --git a/tests/Unit/Entity/MediaType/ClientMediaTypeTest.php b/tests/Unit/Entity/MediaType/ClientMediaTypeTest.php new file mode 100644 index 00000000..4ac388f2 --- /dev/null +++ b/tests/Unit/Entity/MediaType/ClientMediaTypeTest.php @@ -0,0 +1,27 @@ + '1.0']); + + $this->assertSame('application', $mediaType->getType()); + $this->assertSame('json', $mediaType->getSubtype()); + $this->assertSame(['q' => '1.0'], $mediaType->getParameters()); + } + + public function testToString(): void + { + $mediaType = new ClientMediaType('application', 'json', ['q' => '1.0']); + + $this->assertSame('application/json', (string) $mediaType); + } +} diff --git a/tests/Unit/Entity/MediaType/MediaTypeComparatorTest.php b/tests/Unit/Entity/MediaType/MediaTypeComparatorTest.php new file mode 100644 index 00000000..af26bb98 --- /dev/null +++ b/tests/Unit/Entity/MediaType/MediaTypeComparatorTest.php @@ -0,0 +1,78 @@ +assertSame($expected, (new MediaTypeComparator)->compare($a, $b)); + } + + private function compareDataProvider(): iterable + { + yield [ + new ServerMediaType('application', 'json'), + new ServerMediaType('application', 'json'), + 0, + ]; + + yield [ + new ServerMediaType('*', '*'), + new ServerMediaType('*', '*'), + 0, + ]; + + yield [ + new ServerMediaType('*', '*'), + new ServerMediaType('application', 'json'), + 0, + ]; + + yield [ + new ServerMediaType('application', 'json'), + new ServerMediaType('*', '*'), + 0, + ]; + + yield [ + new ServerMediaType('image', '*'), + new ServerMediaType('image', '*'), + 0, + ]; + + yield [ + new ServerMediaType('image', '*'), + new ServerMediaType('image', 'webp'), + 0, + ]; + + yield [ + new ServerMediaType('image', 'webp'), + new ServerMediaType('image', '*'), + 0, + ]; + + yield [ + new ServerMediaType('application', 'json'), + new ServerMediaType('application', 'xml'), + 'application/json' <=> 'application/xml', + ]; + + yield [ + new ServerMediaType('application', 'xml'), + new ServerMediaType('application', 'json'), + 'application/xml' <=> 'application/json', + ]; + } +} diff --git a/tests/Unit/Entity/MediaType/ServerMediaTypeTest.php b/tests/Unit/Entity/MediaType/ServerMediaTypeTest.php new file mode 100644 index 00000000..adab10d9 --- /dev/null +++ b/tests/Unit/Entity/MediaType/ServerMediaTypeTest.php @@ -0,0 +1,70 @@ +assertSame('application', $mediaType->getType()); + $this->assertSame('json', $mediaType->getSubtype()); + } + + /** + * @dataProvider fromStringProvider + */ + public function testFromString(string $string, string $expectedType, string $expectedSubtype): void + { + $mediaType = ServerMediaType::fromString($string); + + $this->assertSame($expectedType, $mediaType->getType()); + $this->assertSame($expectedSubtype, $mediaType->getSubtype()); + } + + public function testToString(): void + { + $mediaType = new ServerMediaType('application', 'json'); + + $this->assertSame('application/json', (string) $mediaType); + } + + private function fromStringProvider(): iterable + { + yield [ + '', + '*', + '*', + ]; + + yield [ + '*', + '*', + '*', + ]; + + yield [ + '*/*', + '*', + '*', + ]; + + yield [ + 'image', + 'image', + '*', + ]; + + yield [ + 'application/json', + 'application', + 'json', + ]; + } +} diff --git a/tests/Unit/Event/RoutePostRunEventTest.php b/tests/Unit/Event/RoutePostRunEventTest.php new file mode 100644 index 00000000..6952cb54 --- /dev/null +++ b/tests/Unit/Event/RoutePostRunEventTest.php @@ -0,0 +1,40 @@ +createMock(RouteInterface::class); + $request = $this->createMock(ServerRequestInterface::class); + $response = $this->createMock(ResponseInterface::class); + + $event = new RoutePostRunEvent($route, $request, $response); + + $this->assertSame($route, $event->getRoute()); + $this->assertSame($request, $event->getRequest()); + $this->assertSame($response, $event->getResponse()); + } + + public function testSetResponse(): void + { + $event = new RoutePostRunEvent( + $this->createMock(RouteInterface::class), + $this->createMock(ServerRequestInterface::class), + $this->createMock(ResponseInterface::class), + ); + + $response = $this->createMock(ResponseInterface::class); + $event->setResponse($response); + $this->assertSame($response, $event->getResponse()); + } +} diff --git a/tests/Unit/Event/RoutePreRunEventTest.php b/tests/Unit/Event/RoutePreRunEventTest.php new file mode 100644 index 00000000..83def914 --- /dev/null +++ b/tests/Unit/Event/RoutePreRunEventTest.php @@ -0,0 +1,36 @@ +createMock(RouteInterface::class); + $request = $this->createMock(ServerRequestInterface::class); + + $event = new RoutePreRunEvent($route, $request); + + $this->assertSame($route, $event->getRoute()); + $this->assertSame($request, $event->getRequest()); + } + + public function testSetRequest(): void + { + $event = new RoutePreRunEvent( + $this->createMock(RouteInterface::class), + $this->createMock(ServerRequestInterface::class), + ); + + $request = $this->createMock(ServerRequestInterface::class); + $event->setRequest($request); + $this->assertSame($request, $event->getRequest()); + } +} diff --git a/tests/Helper/RouteParserTest.php b/tests/Unit/Helper/RouteParserTest.php similarity index 96% rename from tests/Helper/RouteParserTest.php rename to tests/Unit/Helper/RouteParserTest.php index 4ca96c70..89e651d8 100644 --- a/tests/Helper/RouteParserTest.php +++ b/tests/Unit/Helper/RouteParserTest.php @@ -2,12 +2,11 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Tests\Helper; +namespace Sunrise\Http\Router\Tests\Unit\Helper; -use Generator; +use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; use Sunrise\Http\Router\Helper\RouteParser; -use PHPUnit\Framework\TestCase; final class RouteParserTest extends TestCase { @@ -32,7 +31,7 @@ public function testParseInvalidRoute(string $route, string $expectedMessageRege RouteParser::parseRoute($route); } - private function validRouteDataProvider(): Generator + private function validRouteDataProvider(): iterable { yield [ '', @@ -96,7 +95,7 @@ private function validRouteDataProvider(): Generator ]; } - private function invalidRouteDataProvider(): Generator + private function invalidRouteDataProvider(): iterable { yield [ '((', From 268138f0d9eca763331ae3021c977de19038808e Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Mon, 14 Oct 2024 00:42:51 +0200 Subject: [PATCH 156/180] v3 --- src/Command/RouteListCommand.php | 2 +- .../RouterClearDescriptorsCacheCommand.php | 45 +++++++++++++++++++ src/Loader/DescriptorLoader.php | 11 ++--- 3 files changed, 50 insertions(+), 8 deletions(-) create mode 100644 src/Command/RouterClearDescriptorsCacheCommand.php diff --git a/src/Command/RouteListCommand.php b/src/Command/RouteListCommand.php index 56213738..445e6922 100644 --- a/src/Command/RouteListCommand.php +++ b/src/Command/RouteListCommand.php @@ -25,7 +25,7 @@ /** * @since 2.9.0 */ -#[AsCommand('router:route-list', 'Lists all routes.')] +#[AsCommand('router:list-routes', 'Lists all routes.', ['router:route-list'])] final class RouteListCommand extends Command { public function __construct(private readonly RouterInterface $router) diff --git a/src/Command/RouterClearDescriptorsCacheCommand.php b/src/Command/RouterClearDescriptorsCacheCommand.php new file mode 100644 index 00000000..338ba4e2 --- /dev/null +++ b/src/Command/RouterClearDescriptorsCacheCommand.php @@ -0,0 +1,45 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Command; + +use Psr\SimpleCache\CacheInterface; +use Sunrise\Http\Router\Loader\DescriptorLoader; +use Symfony\Component\Console\Attribute\AsCommand; +use Symfony\Component\Console\Command\Command; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Output\OutputInterface; + +/** + * @since 3.0.0 + */ +#[AsCommand('router:clear-descriptors-cache', 'Clears the descriptors cache.')] +final class RouterClearDescriptorsCacheCommand extends Command +{ + public function __construct(private readonly ?CacheInterface $cache) + { + parent::__construct(); + } + + /** + * @inheritDoc + */ + protected function execute(InputInterface $input, OutputInterface $output): int + { + $this->cache?->delete(DescriptorLoader::CACHE_KEY); + + $output->writeln('Done'); + + return self::SUCCESS; + } +} diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 9fd8e4f9..cf6d9b21 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -56,13 +56,12 @@ */ final class DescriptorLoader implements LoaderInterface { - public const DEFAULT_CACHE_KEY = 'router_descriptors'; + public const CACHE_KEY = 'router_descriptors'; public function __construct( /** @var array */ private readonly array $resources, private readonly ?CacheInterface $cache = null, - private readonly ?string $cacheKey = null, ) { } @@ -105,11 +104,9 @@ public function load(): Generator */ private function getDescriptors(): array { - $cacheKey = $this->cacheKey ?? self::DEFAULT_CACHE_KEY; - /** @var list|null $descriptors */ - $descriptors = $this->cache?->get($cacheKey); - if (isset($descriptors)) { + $descriptors = $this->cache?->get(self::CACHE_KEY); + if ($descriptors !== null) { return $descriptors; } @@ -122,7 +119,7 @@ private function getDescriptors(): array usort($descriptors, static fn(Descriptor $a, Descriptor $b): int => $b->priority <=> $a->priority); - $this->cache?->set($cacheKey, $descriptors); + $this->cache?->set(self::CACHE_KEY, $descriptors); return $descriptors; } From 758f5346dc3975990d593439b5d3a8cba76c8afc Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 24 Oct 2024 15:37:58 +0200 Subject: [PATCH 157/180] v3 --- src/Annotation/Consumes.php | 2 +- src/Annotation/Consumes/Image.php | 28 ++++++++++++ src/Annotation/Consumes/Json.php | 28 ++++++++++++ src/Annotation/Consumes/Xml.php | 28 ++++++++++++ src/Annotation/Method.php | 2 +- src/Annotation/Method/Delete.php | 28 ++++++++++++ src/Annotation/Method/Get.php | 28 ++++++++++++ src/Annotation/Method/Head.php | 28 ++++++++++++ src/Annotation/Method/Options.php | 28 ++++++++++++ src/Annotation/Method/Patch.php | 28 ++++++++++++ src/Annotation/Method/Post.php | 28 ++++++++++++ src/Annotation/Method/Purge.php | 28 ++++++++++++ src/Annotation/Method/Put.php | 28 ++++++++++++ src/Annotation/Pattern.php | 2 +- src/Annotation/Pattern/Uuid.php | 28 ++++++++++++ src/Annotation/Produces.php | 2 +- src/Annotation/Produces/Html.php | 28 ++++++++++++ src/Annotation/Produces/Json.php | 28 ++++++++++++ src/Annotation/Produces/Text.php | 28 ++++++++++++ src/Annotation/Produces/Xml.php | 28 ++++++++++++ src/Annotation/RequestBody.php | 1 + src/Annotation/RequestCookie.php | 1 + src/Annotation/RequestHeader.php | 1 + src/Annotation/RequestQuery.php | 1 + src/Entity/MediaType/ServerMediaType.php | 25 +++++++++++ src/Loader/DescriptorLoader.php | 44 +++++++++---------- .../JsonPayloadDecodingMiddleware.php | 2 +- .../RequestBodyParameterResolver.php | 2 +- .../RequestCookieParameterResolver.php | 2 +- .../RequestHeaderParameterResolver.php | 2 +- .../RequestQueryParameterResolver.php | 2 +- src/ResponseResolverChain.php | 4 +- src/Router.php | 2 +- src/RouterInterface.php | 2 - src/ServerRequest.php | 3 +- .../ValidatorConstraintViolationAdapter.php | 4 +- 36 files changed, 515 insertions(+), 39 deletions(-) create mode 100644 src/Annotation/Consumes/Image.php create mode 100644 src/Annotation/Consumes/Json.php create mode 100644 src/Annotation/Consumes/Xml.php create mode 100644 src/Annotation/Method/Delete.php create mode 100644 src/Annotation/Method/Get.php create mode 100644 src/Annotation/Method/Head.php create mode 100644 src/Annotation/Method/Options.php create mode 100644 src/Annotation/Method/Patch.php create mode 100644 src/Annotation/Method/Post.php create mode 100644 src/Annotation/Method/Purge.php create mode 100644 src/Annotation/Method/Put.php create mode 100644 src/Annotation/Pattern/Uuid.php create mode 100644 src/Annotation/Produces/Html.php create mode 100644 src/Annotation/Produces/Json.php create mode 100644 src/Annotation/Produces/Text.php create mode 100644 src/Annotation/Produces/Xml.php diff --git a/src/Annotation/Consumes.php b/src/Annotation/Consumes.php index 22f1bd52..e14359c8 100644 --- a/src/Annotation/Consumes.php +++ b/src/Annotation/Consumes.php @@ -20,7 +20,7 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Consumes +class Consumes { public function __construct( public readonly string|MediaTypeInterface $value, diff --git a/src/Annotation/Consumes/Image.php b/src/Annotation/Consumes/Image.php new file mode 100644 index 00000000..dea1d648 --- /dev/null +++ b/src/Annotation/Consumes/Image.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Consumes; + +use Sunrise\Http\Router\Annotation\Consumes; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; + +/** + * @since 3.0.0 + */ +final class Image extends Consumes +{ + public function __construct() + { + parent::__construct(ServerMediaType::image()); + } +} diff --git a/src/Annotation/Consumes/Json.php b/src/Annotation/Consumes/Json.php new file mode 100644 index 00000000..7a98c482 --- /dev/null +++ b/src/Annotation/Consumes/Json.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Consumes; + +use Sunrise\Http\Router\Annotation\Consumes; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; + +/** + * @since 3.0.0 + */ +final class Json extends Consumes +{ + public function __construct() + { + parent::__construct(ServerMediaType::json()); + } +} diff --git a/src/Annotation/Consumes/Xml.php b/src/Annotation/Consumes/Xml.php new file mode 100644 index 00000000..a1eddcca --- /dev/null +++ b/src/Annotation/Consumes/Xml.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Consumes; + +use Sunrise\Http\Router\Annotation\Consumes; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; + +/** + * @since 3.0.0 + */ +final class Xml extends Consumes +{ + public function __construct() + { + parent::__construct(ServerMediaType::xml()); + } +} diff --git a/src/Annotation/Method.php b/src/Annotation/Method.php index 1ae7f34a..5238a7ea 100644 --- a/src/Annotation/Method.php +++ b/src/Annotation/Method.php @@ -19,7 +19,7 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Method +class Method { public function __construct( public readonly string $value, diff --git a/src/Annotation/Method/Delete.php b/src/Annotation/Method/Delete.php new file mode 100644 index 00000000..3cfc630a --- /dev/null +++ b/src/Annotation/Method/Delete.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Method; + +use Fig\Http\Message\RequestMethodInterface; +use Sunrise\Http\Router\Annotation\Method; + +/** + * @since 3.0.0 + */ +final class Delete extends Method +{ + public function __construct() + { + parent::__construct(RequestMethodInterface::METHOD_DELETE); + } +} diff --git a/src/Annotation/Method/Get.php b/src/Annotation/Method/Get.php new file mode 100644 index 00000000..e11dcf38 --- /dev/null +++ b/src/Annotation/Method/Get.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Method; + +use Fig\Http\Message\RequestMethodInterface; +use Sunrise\Http\Router\Annotation\Method; + +/** + * @since 3.0.0 + */ +final class Get extends Method +{ + public function __construct() + { + parent::__construct(RequestMethodInterface::METHOD_GET); + } +} diff --git a/src/Annotation/Method/Head.php b/src/Annotation/Method/Head.php new file mode 100644 index 00000000..bf2a900a --- /dev/null +++ b/src/Annotation/Method/Head.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Method; + +use Fig\Http\Message\RequestMethodInterface; +use Sunrise\Http\Router\Annotation\Method; + +/** + * @since 3.0.0 + */ +final class Head extends Method +{ + public function __construct() + { + parent::__construct(RequestMethodInterface::METHOD_HEAD); + } +} diff --git a/src/Annotation/Method/Options.php b/src/Annotation/Method/Options.php new file mode 100644 index 00000000..f4dda616 --- /dev/null +++ b/src/Annotation/Method/Options.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Method; + +use Fig\Http\Message\RequestMethodInterface; +use Sunrise\Http\Router\Annotation\Method; + +/** + * @since 3.0.0 + */ +final class Options extends Method +{ + public function __construct() + { + parent::__construct(RequestMethodInterface::METHOD_OPTIONS); + } +} diff --git a/src/Annotation/Method/Patch.php b/src/Annotation/Method/Patch.php new file mode 100644 index 00000000..79554d6e --- /dev/null +++ b/src/Annotation/Method/Patch.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Method; + +use Fig\Http\Message\RequestMethodInterface; +use Sunrise\Http\Router\Annotation\Method; + +/** + * @since 3.0.0 + */ +final class Patch extends Method +{ + public function __construct() + { + parent::__construct(RequestMethodInterface::METHOD_PATCH); + } +} diff --git a/src/Annotation/Method/Post.php b/src/Annotation/Method/Post.php new file mode 100644 index 00000000..a8714620 --- /dev/null +++ b/src/Annotation/Method/Post.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Method; + +use Fig\Http\Message\RequestMethodInterface; +use Sunrise\Http\Router\Annotation\Method; + +/** + * @since 3.0.0 + */ +final class Post extends Method +{ + public function __construct() + { + parent::__construct(RequestMethodInterface::METHOD_POST); + } +} diff --git a/src/Annotation/Method/Purge.php b/src/Annotation/Method/Purge.php new file mode 100644 index 00000000..d6c18777 --- /dev/null +++ b/src/Annotation/Method/Purge.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Method; + +use Fig\Http\Message\RequestMethodInterface; +use Sunrise\Http\Router\Annotation\Method; + +/** + * @since 3.0.0 + */ +final class Purge extends Method +{ + public function __construct() + { + parent::__construct(RequestMethodInterface::METHOD_PURGE); + } +} diff --git a/src/Annotation/Method/Put.php b/src/Annotation/Method/Put.php new file mode 100644 index 00000000..1e10b328 --- /dev/null +++ b/src/Annotation/Method/Put.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Method; + +use Fig\Http\Message\RequestMethodInterface; +use Sunrise\Http\Router\Annotation\Method; + +/** + * @since 3.0.0 + */ +final class Put extends Method +{ + public function __construct() + { + parent::__construct(RequestMethodInterface::METHOD_PUT); + } +} diff --git a/src/Annotation/Pattern.php b/src/Annotation/Pattern.php index 63b9c0d1..1f15f19d 100644 --- a/src/Annotation/Pattern.php +++ b/src/Annotation/Pattern.php @@ -22,7 +22,7 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Pattern +class Pattern { public function __construct( public readonly string $variableName, diff --git a/src/Annotation/Pattern/Uuid.php b/src/Annotation/Pattern/Uuid.php new file mode 100644 index 00000000..c58dfa57 --- /dev/null +++ b/src/Annotation/Pattern/Uuid.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Pattern; + +use Sunrise\Http\Router\Annotation\Pattern; +use Sunrise\Http\Router\Dictionary\VariablePattern; + +/** + * @since 3.0.0 + */ +final class Uuid extends Pattern +{ + public function __construct(string $variableName) + { + parent::__construct($variableName, VariablePattern::UUID); + } +} diff --git a/src/Annotation/Produces.php b/src/Annotation/Produces.php index 4dced168..5404a814 100644 --- a/src/Annotation/Produces.php +++ b/src/Annotation/Produces.php @@ -20,7 +20,7 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Produces +class Produces { public function __construct( public readonly string|MediaTypeInterface $value, diff --git a/src/Annotation/Produces/Html.php b/src/Annotation/Produces/Html.php new file mode 100644 index 00000000..c939421e --- /dev/null +++ b/src/Annotation/Produces/Html.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Produces; + +use Sunrise\Http\Router\Annotation\Produces; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; + +/** + * @since 3.0.0 + */ +final class Html extends Produces +{ + public function __construct() + { + parent::__construct(ServerMediaType::html()); + } +} diff --git a/src/Annotation/Produces/Json.php b/src/Annotation/Produces/Json.php new file mode 100644 index 00000000..5fd7e0fb --- /dev/null +++ b/src/Annotation/Produces/Json.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Produces; + +use Sunrise\Http\Router\Annotation\Produces; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; + +/** + * @since 3.0.0 + */ +final class Json extends Produces +{ + public function __construct() + { + parent::__construct(ServerMediaType::json()); + } +} diff --git a/src/Annotation/Produces/Text.php b/src/Annotation/Produces/Text.php new file mode 100644 index 00000000..1def0c6e --- /dev/null +++ b/src/Annotation/Produces/Text.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Produces; + +use Sunrise\Http\Router\Annotation\Produces; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; + +/** + * @since 3.0.0 + */ +final class Text extends Produces +{ + public function __construct() + { + parent::__construct(ServerMediaType::text()); + } +} diff --git a/src/Annotation/Produces/Xml.php b/src/Annotation/Produces/Xml.php new file mode 100644 index 00000000..11962c37 --- /dev/null +++ b/src/Annotation/Produces/Xml.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Produces; + +use Sunrise\Http\Router\Annotation\Produces; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; + +/** + * @since 3.0.0 + */ +final class Xml extends Produces +{ + public function __construct() + { + parent::__construct(ServerMediaType::xml()); + } +} diff --git a/src/Annotation/RequestBody.php b/src/Annotation/RequestBody.php index a29a3fb8..6e8fd13b 100644 --- a/src/Annotation/RequestBody.php +++ b/src/Annotation/RequestBody.php @@ -24,6 +24,7 @@ final class RequestBody public function __construct( public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, + public readonly bool $validation = true, ) { } } diff --git a/src/Annotation/RequestCookie.php b/src/Annotation/RequestCookie.php index aa73328c..ab708645 100644 --- a/src/Annotation/RequestCookie.php +++ b/src/Annotation/RequestCookie.php @@ -25,6 +25,7 @@ public function __construct( public readonly string $name, public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, + public readonly bool $validation = true, ) { } } diff --git a/src/Annotation/RequestHeader.php b/src/Annotation/RequestHeader.php index c088085a..b804aaa8 100644 --- a/src/Annotation/RequestHeader.php +++ b/src/Annotation/RequestHeader.php @@ -25,6 +25,7 @@ public function __construct( public readonly string $name, public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, + public readonly bool $validation = true, ) { } } diff --git a/src/Annotation/RequestQuery.php b/src/Annotation/RequestQuery.php index 0759e9c4..cbaf352d 100644 --- a/src/Annotation/RequestQuery.php +++ b/src/Annotation/RequestQuery.php @@ -24,6 +24,7 @@ final class RequestQuery public function __construct( public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, + public readonly bool $validation = true, ) { } } diff --git a/src/Entity/MediaType/ServerMediaType.php b/src/Entity/MediaType/ServerMediaType.php index 2021bc48..652c6426 100644 --- a/src/Entity/MediaType/ServerMediaType.php +++ b/src/Entity/MediaType/ServerMediaType.php @@ -26,6 +26,31 @@ public function __construct( ) { } + public static function json(): self + { + return new self('application', 'json'); + } + + public static function xml(): self + { + return new self('application', 'xml'); + } + + public static function html(): self + { + return new self('text', 'html'); + } + + public static function text(): self + { + return new self('text', 'plain'); + } + + public static function image(): self + { + return new self('image', '*'); + } + public static function fromString(string $string): self { $parts = explode(self::SEPARATOR, $string, 2); diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index cf6d9b21..0ebb0178 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -112,7 +112,7 @@ private function getDescriptors(): array $descriptors = []; foreach ($this->resources as $resource) { - foreach ($this->getResourceDescriptors($resource) as $descriptor) { + foreach (self::getResourceDescriptors($resource) as $descriptor) { $descriptors[] = $descriptor; } } @@ -130,11 +130,11 @@ private function getDescriptors(): array * @throws InvalidRouteLoadingResourceException * @throws InvalidRouteParsingSubjectException */ - private function getResourceDescriptors(string $resource): Generator + private static function getResourceDescriptors(string $resource): Generator { if (is_dir($resource)) { foreach (ClassFinder::getDirClasses($resource) as $class) { - yield from $this->getClassDescriptors($class); + yield from self::getClassDescriptors($class); } return; @@ -142,14 +142,14 @@ private function getResourceDescriptors(string $resource): Generator if (is_file($resource)) { foreach (ClassFinder::getFileClasses($resource) as $class) { - yield from $this->getClassDescriptors($class); + yield from self::getClassDescriptors($class); } return; } if (class_exists($resource)) { - yield from $this->getClassDescriptors(new ReflectionClass($resource)); + yield from self::getClassDescriptors(new ReflectionClass($resource)); return; } @@ -157,7 +157,7 @@ private function getResourceDescriptors(string $resource): Generator throw new InvalidRouteLoadingResourceException(sprintf( 'The loader %s only accepts directory, file or class names; ' . 'however, the resource %s is not one of them.', - $this::class, + self::class, $resource, )); } @@ -167,7 +167,7 @@ private function getResourceDescriptors(string $resource): Generator * * @throws InvalidRouteParsingSubjectException */ - private function getClassDescriptors(ReflectionClass $class): Generator + private static function getClassDescriptors(ReflectionClass $class): Generator { if (!$class->isInstantiable()) { return; @@ -179,9 +179,9 @@ private function getClassDescriptors(ReflectionClass $class): Generator if (isset($annotations[0])) { $descriptor = $annotations[0]->newInstance(); $descriptor->holder = $class->getName(); - $this->enrichDescriptorFromParentClasses($descriptor, $class); - $this->enrichDescriptorFromClassOrMethod($descriptor, $class); - $this->completeDescriptor($descriptor); + self::enrichDescriptorFromParentClasses($descriptor, $class); + self::enrichDescriptorFromClassOrMethod($descriptor, $class); + self::completeDescriptor($descriptor); yield $descriptor; } } @@ -196,23 +196,23 @@ private function getClassDescriptors(ReflectionClass $class): Generator if (isset($annotations[0])) { $descriptor = $annotations[0]->newInstance(); $descriptor->holder = [$class->getName(), $method->getName()]; - $this->enrichDescriptorFromParentClasses($descriptor, $class); - $this->enrichDescriptorFromClassOrMethod($descriptor, $class); - $this->enrichDescriptorFromClassOrMethod($descriptor, $method); - $this->completeDescriptor($descriptor); + self::enrichDescriptorFromParentClasses($descriptor, $class); + self::enrichDescriptorFromClassOrMethod($descriptor, $class); + self::enrichDescriptorFromClassOrMethod($descriptor, $method); + self::completeDescriptor($descriptor); yield $descriptor; } } } - private function enrichDescriptorFromParentClasses(Descriptor $descriptor, ReflectionClass $class): void + private static function enrichDescriptorFromParentClasses(Descriptor $descriptor, ReflectionClass $class): void { foreach (ClassFinder::getParentClasses($class) as $parent) { - $this->enrichDescriptorFromClassOrMethod($descriptor, $parent); + self::enrichDescriptorFromClassOrMethod($descriptor, $parent); } } - private function enrichDescriptorFromClassOrMethod(Descriptor $descriptor, ReflectionClass|ReflectionMethod $classOrMethod): void + private static function enrichDescriptorFromClassOrMethod(Descriptor $descriptor, ReflectionClass|ReflectionMethod $classOrMethod): void { /** @var list> $annotations */ $annotations = $classOrMethod->getAttributes(NamePrefix::class); @@ -236,14 +236,14 @@ private function enrichDescriptorFromClassOrMethod(Descriptor $descriptor, Refle } /** @var list> $annotations */ - $annotations = $classOrMethod->getAttributes(Pattern::class); + $annotations = $classOrMethod->getAttributes(Pattern::class, ReflectionAttribute::IS_INSTANCEOF); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); $descriptor->patterns[$annotation->variableName] = $annotation->value; } /** @var list> $annotations */ - $annotations = $classOrMethod->getAttributes(Method::class); + $annotations = $classOrMethod->getAttributes(Method::class, ReflectionAttribute::IS_INSTANCEOF); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); $descriptor->methods[] = $annotation->value; @@ -271,7 +271,7 @@ private function enrichDescriptorFromClassOrMethod(Descriptor $descriptor, Refle } /** @var list> $annotations */ - $annotations = $classOrMethod->getAttributes(Consumes::class); + $annotations = $classOrMethod->getAttributes(Consumes::class, ReflectionAttribute::IS_INSTANCEOF); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); @@ -281,7 +281,7 @@ private function enrichDescriptorFromClassOrMethod(Descriptor $descriptor, Refle } /** @var list> $annotations */ - $annotations = $classOrMethod->getAttributes(Produces::class); + $annotations = $classOrMethod->getAttributes(Produces::class, ReflectionAttribute::IS_INSTANCEOF); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); @@ -328,7 +328,7 @@ private function enrichDescriptorFromClassOrMethod(Descriptor $descriptor, Refle /** * @throws InvalidRouteParsingSubjectException */ - private function completeDescriptor(Descriptor $descriptor): void + private static function completeDescriptor(Descriptor $descriptor): void { $descriptor->name = join($descriptor->namePrefixes) . $descriptor->name; $descriptor->path = join($descriptor->pathPrefixes) . $descriptor->path; diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index a41a6753..e06fbaed 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -57,7 +57,7 @@ public function __construct( */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if (ServerRequest::create($request)->clientProducesMediaType(new ServerMediaType('application', 'json'))) { + if (ServerRequest::create($request)->clientProducesMediaType(ServerMediaType::json())) { $request = $request->withParsedBody($this->decodePayload($request->getBody()->__toString())); } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 12f7d668..ef9bd920 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -86,7 +86,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); } - if (isset($this->validator)) { + if ($processParams->validation && isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { throw HttpExceptionFactory::invalidBody($errorMessage, $errorStatusCode) ->addConstraintViolation(...array_map(ValidatorConstraintViolationAdapter::create(...), [...$violations])); diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index 0ffb5cc2..1a2985ad 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -93,7 +93,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); } - if (isset($this->validator)) { + if ($processParams->validation && isset($this->validator)) { $violations = $this->validator->startContext()->atPath($cookieName)->validate($argument, new ArgumentConstraint($parameter))->getViolations(); if ($violations->count() > 0) { throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode) diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index c6c37ac1..01a90b5c 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -91,7 +91,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); } - if (isset($this->validator)) { + if ($processParams->validation && isset($this->validator)) { $violations = $this->validator->startContext()->atPath($headerName)->validate($argument, new ArgumentConstraint($parameter))->getViolations(); if ($violations->count() > 0) { throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode) diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index b3262605..b22d3509 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -86,7 +86,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); } - if (isset($this->validator)) { + if ($processParams->validation && isset($this->validator)) { if (($violations = $this->validator->validate($argument))->count() > 0) { throw HttpExceptionFactory::invalidQuery($errorMessage, $errorStatusCode) ->addConstraintViolation(...array_map(ValidatorConstraintViolationAdapter::create(...), [...$violations])); diff --git a/src/ResponseResolverChain.php b/src/ResponseResolverChain.php index ea7ae82a..a118a104 100644 --- a/src/ResponseResolverChain.php +++ b/src/ResponseResolverChain.php @@ -55,7 +55,7 @@ public function resolveResponse( foreach ($this->resolvers as $resolver) { $result = $resolver->resolveResponse($response, $responder, $request); if ($result instanceof ResponseInterface) { - return $this->completeResponse($result, $responder); + return self::completeResponse($result, $responder); } } @@ -65,7 +65,7 @@ public function resolveResponse( )); } - private function completeResponse( + private static function completeResponse( ResponseInterface $response, ReflectionMethod|ReflectionFunction $responder, ): ResponseInterface { diff --git a/src/Router.php b/src/Router.php index 032ad371..f52592b2 100644 --- a/src/Router.php +++ b/src/Router.php @@ -209,7 +209,7 @@ public function runRoute(RouteInterface|string $route, ServerRequestInterface $r $request = $request->withAttribute($name, $value); } - $request = $request->withAttribute(self::REQUEST_ATTRIBUTE_ROUTE, $route); + $request = $request->withAttribute(RouteInterface::class, $route); if (isset($this->eventDispatcher)) { $event = new RoutePreRunEvent($route, $request); diff --git a/src/RouterInterface.php b/src/RouterInterface.php index e4056e33..62248b39 100644 --- a/src/RouterInterface.php +++ b/src/RouterInterface.php @@ -27,8 +27,6 @@ */ interface RouterInterface extends RequestHandlerInterface { - public const REQUEST_ATTRIBUTE_ROUTE = '@route'; - /** * @return array * diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 3570d782..d9cf8e03 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -85,7 +85,8 @@ public function withMediaTypeComparator(MediaTypeComparatorInterface $mediaTypeC */ public function getRoute(): RouteInterface { - $route = $this->request->getAttribute(RouterInterface::REQUEST_ATTRIBUTE_ROUTE); + $route = $this->request->getAttribute(RouteInterface::class); + if (! $route instanceof RouteInterface) { throw new LogicException('At this level of the application, the request does not contain information about the requested route.'); } diff --git a/src/Validation/ConstraintViolation/ValidatorConstraintViolationAdapter.php b/src/Validation/ConstraintViolation/ValidatorConstraintViolationAdapter.php index c6ae2739..fdeaee4f 100644 --- a/src/Validation/ConstraintViolation/ValidatorConstraintViolationAdapter.php +++ b/src/Validation/ConstraintViolation/ValidatorConstraintViolationAdapter.php @@ -50,7 +50,7 @@ public function getMessagePlaceholders(): array public function getPropertyPath(): string { - return $this->adaptPropertyPath($this->validatorConstraintViolation->getPropertyPath()); + return self::adaptPropertyPath($this->validatorConstraintViolation->getPropertyPath()); } public function getCode(): ?string @@ -58,7 +58,7 @@ public function getCode(): ?string return $this->validatorConstraintViolation->getCode(); } - private function adaptPropertyPath(string $propertyPath): string + private static function adaptPropertyPath(string $propertyPath): string { return preg_replace(['/\x5b([^\x5b\x5d]+)\x5d/', '/^\x2e/'], ['.$1'], $propertyPath); } From e146d46742cc5884275b3883f9fb32830f9f268b Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 24 Oct 2024 15:53:20 +0200 Subject: [PATCH 158/180] v3 --- src/Annotation/Consumes/Image.php | 2 ++ src/Annotation/Consumes/Json.php | 2 ++ src/Annotation/Consumes/Xml.php | 2 ++ src/Annotation/Method/Delete.php | 2 ++ src/Annotation/Method/Get.php | 2 ++ src/Annotation/Method/Head.php | 2 ++ src/Annotation/Method/Options.php | 2 ++ src/Annotation/Method/Patch.php | 2 ++ src/Annotation/Method/Post.php | 2 ++ src/Annotation/Method/Purge.php | 2 ++ src/Annotation/Method/Put.php | 2 ++ src/Annotation/Pattern/Uuid.php | 2 ++ src/Annotation/Produces/Html.php | 2 ++ src/Annotation/Produces/Json.php | 2 ++ src/Annotation/Produces/Text.php | 2 ++ src/Annotation/Produces/Xml.php | 2 ++ 16 files changed, 32 insertions(+) diff --git a/src/Annotation/Consumes/Image.php b/src/Annotation/Consumes/Image.php index dea1d648..63388005 100644 --- a/src/Annotation/Consumes/Image.php +++ b/src/Annotation/Consumes/Image.php @@ -13,12 +13,14 @@ namespace Sunrise\Http\Router\Annotation\Consumes; +use Attribute; use Sunrise\Http\Router\Annotation\Consumes; use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; /** * @since 3.0.0 */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Image extends Consumes { public function __construct() diff --git a/src/Annotation/Consumes/Json.php b/src/Annotation/Consumes/Json.php index 7a98c482..f8ae2d3b 100644 --- a/src/Annotation/Consumes/Json.php +++ b/src/Annotation/Consumes/Json.php @@ -13,12 +13,14 @@ namespace Sunrise\Http\Router\Annotation\Consumes; +use Attribute; use Sunrise\Http\Router\Annotation\Consumes; use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; /** * @since 3.0.0 */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Json extends Consumes { public function __construct() diff --git a/src/Annotation/Consumes/Xml.php b/src/Annotation/Consumes/Xml.php index a1eddcca..7b9617a7 100644 --- a/src/Annotation/Consumes/Xml.php +++ b/src/Annotation/Consumes/Xml.php @@ -13,12 +13,14 @@ namespace Sunrise\Http\Router\Annotation\Consumes; +use Attribute; use Sunrise\Http\Router\Annotation\Consumes; use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; /** * @since 3.0.0 */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Xml extends Consumes { public function __construct() diff --git a/src/Annotation/Method/Delete.php b/src/Annotation/Method/Delete.php index 3cfc630a..ad171d7d 100644 --- a/src/Annotation/Method/Delete.php +++ b/src/Annotation/Method/Delete.php @@ -13,12 +13,14 @@ namespace Sunrise\Http\Router\Annotation\Method; +use Attribute; use Fig\Http\Message\RequestMethodInterface; use Sunrise\Http\Router\Annotation\Method; /** * @since 3.0.0 */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Delete extends Method { public function __construct() diff --git a/src/Annotation/Method/Get.php b/src/Annotation/Method/Get.php index e11dcf38..d95d7aa7 100644 --- a/src/Annotation/Method/Get.php +++ b/src/Annotation/Method/Get.php @@ -13,12 +13,14 @@ namespace Sunrise\Http\Router\Annotation\Method; +use Attribute; use Fig\Http\Message\RequestMethodInterface; use Sunrise\Http\Router\Annotation\Method; /** * @since 3.0.0 */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Get extends Method { public function __construct() diff --git a/src/Annotation/Method/Head.php b/src/Annotation/Method/Head.php index bf2a900a..d7924d63 100644 --- a/src/Annotation/Method/Head.php +++ b/src/Annotation/Method/Head.php @@ -13,12 +13,14 @@ namespace Sunrise\Http\Router\Annotation\Method; +use Attribute; use Fig\Http\Message\RequestMethodInterface; use Sunrise\Http\Router\Annotation\Method; /** * @since 3.0.0 */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Head extends Method { public function __construct() diff --git a/src/Annotation/Method/Options.php b/src/Annotation/Method/Options.php index f4dda616..eaf7c577 100644 --- a/src/Annotation/Method/Options.php +++ b/src/Annotation/Method/Options.php @@ -13,12 +13,14 @@ namespace Sunrise\Http\Router\Annotation\Method; +use Attribute; use Fig\Http\Message\RequestMethodInterface; use Sunrise\Http\Router\Annotation\Method; /** * @since 3.0.0 */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Options extends Method { public function __construct() diff --git a/src/Annotation/Method/Patch.php b/src/Annotation/Method/Patch.php index 79554d6e..5348a673 100644 --- a/src/Annotation/Method/Patch.php +++ b/src/Annotation/Method/Patch.php @@ -13,12 +13,14 @@ namespace Sunrise\Http\Router\Annotation\Method; +use Attribute; use Fig\Http\Message\RequestMethodInterface; use Sunrise\Http\Router\Annotation\Method; /** * @since 3.0.0 */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Patch extends Method { public function __construct() diff --git a/src/Annotation/Method/Post.php b/src/Annotation/Method/Post.php index a8714620..1cf99363 100644 --- a/src/Annotation/Method/Post.php +++ b/src/Annotation/Method/Post.php @@ -13,12 +13,14 @@ namespace Sunrise\Http\Router\Annotation\Method; +use Attribute; use Fig\Http\Message\RequestMethodInterface; use Sunrise\Http\Router\Annotation\Method; /** * @since 3.0.0 */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Post extends Method { public function __construct() diff --git a/src/Annotation/Method/Purge.php b/src/Annotation/Method/Purge.php index d6c18777..303967be 100644 --- a/src/Annotation/Method/Purge.php +++ b/src/Annotation/Method/Purge.php @@ -13,12 +13,14 @@ namespace Sunrise\Http\Router\Annotation\Method; +use Attribute; use Fig\Http\Message\RequestMethodInterface; use Sunrise\Http\Router\Annotation\Method; /** * @since 3.0.0 */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Purge extends Method { public function __construct() diff --git a/src/Annotation/Method/Put.php b/src/Annotation/Method/Put.php index 1e10b328..c3572fb5 100644 --- a/src/Annotation/Method/Put.php +++ b/src/Annotation/Method/Put.php @@ -13,12 +13,14 @@ namespace Sunrise\Http\Router\Annotation\Method; +use Attribute; use Fig\Http\Message\RequestMethodInterface; use Sunrise\Http\Router\Annotation\Method; /** * @since 3.0.0 */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Put extends Method { public function __construct() diff --git a/src/Annotation/Pattern/Uuid.php b/src/Annotation/Pattern/Uuid.php index c58dfa57..a0e2b58e 100644 --- a/src/Annotation/Pattern/Uuid.php +++ b/src/Annotation/Pattern/Uuid.php @@ -13,12 +13,14 @@ namespace Sunrise\Http\Router\Annotation\Pattern; +use Attribute; use Sunrise\Http\Router\Annotation\Pattern; use Sunrise\Http\Router\Dictionary\VariablePattern; /** * @since 3.0.0 */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Uuid extends Pattern { public function __construct(string $variableName) diff --git a/src/Annotation/Produces/Html.php b/src/Annotation/Produces/Html.php index c939421e..dd50d12a 100644 --- a/src/Annotation/Produces/Html.php +++ b/src/Annotation/Produces/Html.php @@ -13,12 +13,14 @@ namespace Sunrise\Http\Router\Annotation\Produces; +use Attribute; use Sunrise\Http\Router\Annotation\Produces; use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; /** * @since 3.0.0 */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Html extends Produces { public function __construct() diff --git a/src/Annotation/Produces/Json.php b/src/Annotation/Produces/Json.php index 5fd7e0fb..c142c4a3 100644 --- a/src/Annotation/Produces/Json.php +++ b/src/Annotation/Produces/Json.php @@ -13,12 +13,14 @@ namespace Sunrise\Http\Router\Annotation\Produces; +use Attribute; use Sunrise\Http\Router\Annotation\Produces; use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; /** * @since 3.0.0 */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Json extends Produces { public function __construct() diff --git a/src/Annotation/Produces/Text.php b/src/Annotation/Produces/Text.php index 1def0c6e..b095fab6 100644 --- a/src/Annotation/Produces/Text.php +++ b/src/Annotation/Produces/Text.php @@ -13,12 +13,14 @@ namespace Sunrise\Http\Router\Annotation\Produces; +use Attribute; use Sunrise\Http\Router\Annotation\Produces; use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; /** * @since 3.0.0 */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Text extends Produces { public function __construct() diff --git a/src/Annotation/Produces/Xml.php b/src/Annotation/Produces/Xml.php index 11962c37..9e24403a 100644 --- a/src/Annotation/Produces/Xml.php +++ b/src/Annotation/Produces/Xml.php @@ -13,12 +13,14 @@ namespace Sunrise\Http\Router\Annotation\Produces; +use Attribute; use Sunrise\Http\Router\Annotation\Produces; use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; /** * @since 3.0.0 */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Xml extends Produces { public function __construct() From 7c896fcf42dba7089365abe81012ae7d35fcade6 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 25 Oct 2024 01:24:48 +0200 Subject: [PATCH 159/180] v3 --- src/Annotation/Consumes/Image.php | 30 ----- src/Annotation/Consumes/Json.php | 30 ----- src/Annotation/Consumes/Xml.php | 30 ----- src/Annotation/ConsumesImage.php | 29 +++++ src/Annotation/ConsumesJson.php | 29 +++++ src/Annotation/ConsumesXml.php | 29 +++++ .../{Method/Delete.php => MethodDelete.php} | 5 +- .../{Method/Get.php => MethodGet.php} | 5 +- .../{Method/Head.php => MethodHead.php} | 5 +- .../{Method/Options.php => MethodOptions.php} | 5 +- .../{Method/Patch.php => MethodPatch.php} | 5 +- .../{Method/Post.php => MethodPost.php} | 5 +- .../{Method/Purge.php => MethodPurge.php} | 5 +- .../{Method/Put.php => MethodPut.php} | 5 +- .../{Pattern/Uuid.php => PatternUuid.php} | 5 +- src/Annotation/Produces/Html.php | 30 ----- src/Annotation/Produces/Json.php | 30 ----- src/Annotation/Produces/Text.php | 30 ----- src/Annotation/Produces/Xml.php | 30 ----- src/Annotation/ProducesHtml.php | 29 +++++ src/Annotation/ProducesJson.php | 29 +++++ src/Annotation/ProducesText.php | 29 +++++ src/Annotation/ProducesXml.php | 29 +++++ src/Annotation/Route.php | 2 +- src/ClassResolver.php | 10 +- ...ommand.php => RouterClearCacheCommand.php} | 8 +- ...ommand.php => RouterListRoutesCommand.php} | 4 +- .../CacheKey.php} | 7 +- src/Entity/MediaType/MediaTypeFactory.php | 57 +++++++++ src/Entity/MediaType/ServerMediaType.php | 37 ------ src/Exception/InvalidParameterException.php | 23 ---- src/Exception/InvalidReferenceException.php | 23 ---- src/Exception/InvalidResponseException.php | 23 ---- .../InvalidRouteBuildingValueException.php | 23 ---- .../InvalidRouteLoadingResourceException.php | 23 ---- .../InvalidRouteMatchingPatternException.php | 23 ---- .../InvalidRouteMatchingSubjectException.php | 23 ---- .../InvalidRouteParsingSubjectException.php | 23 ---- src/Exception/NoRouteFoundException.php | 23 ---- .../UnsupportedParameterException.php | 23 ---- .../UnsupportedResponseException.php | 23 ---- src/Helper/ClassFinder.php | 7 +- src/Helper/RouteBuilder.php | 15 +-- src/Helper/RouteCompiler.php | 4 +- src/Helper/RouteMatcher.php | 23 ++-- src/Helper/RouteParser.php | 58 +++++----- src/Helper/RouteSimplifier.php | 4 +- src/Loader/DescriptorLoader.php | 35 +++--- src/Loader/LoaderInterface.php | 3 - .../JsonPayloadDecodingMiddleware.php | 12 +- .../PayloadMediaTypeNegotiationMiddleware.php | 4 +- src/MiddlewareResolver.php | 19 +-- src/MiddlewareResolverInterface.php | 4 +- ...ainerObjectInjectionParameterResolver.php} | 2 +- ...irectObjectInjectionParameterResolver.php} | 2 +- .../RequestBodyParameterResolver.php | 12 +- .../RequestCookieParameterResolver.php | 8 +- .../RequestHeaderParameterResolver.php | 8 +- .../RequestQueryParameterResolver.php | 12 +- .../RequestVariableParameterResolver.php | 18 +-- src/ParameterResolverChain.php | 13 ++- src/ParameterResolverChainInterface.php | 8 +- src/ParameterResolverInterface.php | 4 +- src/RequestHandlerResolver.php | 12 +- src/RequestHandlerResolverInterface.php | 4 +- src/ResponseResolver/JsonResponseResolver.php | 6 +- src/ResponseResolverChain.php | 8 +- src/ResponseResolverChainInterface.php | 8 +- src/ResponseResolverInterface.php | 4 +- src/Router.php | 108 ++++++++---------- src/RouterInterface.php | 26 ++--- src/ServerRequest.php | 16 +-- .../Entity/MediaType/ServerMediaTypeTest.php | 44 ------- tests/Unit/Helper/RouteParserTest.php | 4 +- 74 files changed, 518 insertions(+), 833 deletions(-) delete mode 100644 src/Annotation/Consumes/Image.php delete mode 100644 src/Annotation/Consumes/Json.php delete mode 100644 src/Annotation/Consumes/Xml.php create mode 100644 src/Annotation/ConsumesImage.php create mode 100644 src/Annotation/ConsumesJson.php create mode 100644 src/Annotation/ConsumesXml.php rename src/Annotation/{Method/Delete.php => MethodDelete.php} (83%) rename src/Annotation/{Method/Get.php => MethodGet.php} (83%) rename src/Annotation/{Method/Head.php => MethodHead.php} (83%) rename src/Annotation/{Method/Options.php => MethodOptions.php} (83%) rename src/Annotation/{Method/Patch.php => MethodPatch.php} (83%) rename src/Annotation/{Method/Post.php => MethodPost.php} (83%) rename src/Annotation/{Method/Purge.php => MethodPurge.php} (83%) rename src/Annotation/{Method/Put.php => MethodPut.php} (83%) rename src/Annotation/{Pattern/Uuid.php => PatternUuid.php} (83%) delete mode 100644 src/Annotation/Produces/Html.php delete mode 100644 src/Annotation/Produces/Json.php delete mode 100644 src/Annotation/Produces/Text.php delete mode 100644 src/Annotation/Produces/Xml.php create mode 100644 src/Annotation/ProducesHtml.php create mode 100644 src/Annotation/ProducesJson.php create mode 100644 src/Annotation/ProducesText.php create mode 100644 src/Annotation/ProducesXml.php rename src/Command/{RouterClearDescriptorsCacheCommand.php => RouterClearCacheCommand.php} (79%) rename src/Command/{RouteListCommand.php => RouterListRoutesCommand.php} (92%) rename src/{Exception/NoRoutesRegisteredException.php => Dictionary/CacheKey.php} (70%) create mode 100644 src/Entity/MediaType/MediaTypeFactory.php delete mode 100644 src/Exception/InvalidParameterException.php delete mode 100644 src/Exception/InvalidReferenceException.php delete mode 100644 src/Exception/InvalidResponseException.php delete mode 100644 src/Exception/InvalidRouteBuildingValueException.php delete mode 100644 src/Exception/InvalidRouteLoadingResourceException.php delete mode 100644 src/Exception/InvalidRouteMatchingPatternException.php delete mode 100644 src/Exception/InvalidRouteMatchingSubjectException.php delete mode 100644 src/Exception/InvalidRouteParsingSubjectException.php delete mode 100644 src/Exception/NoRouteFoundException.php delete mode 100644 src/Exception/UnsupportedParameterException.php delete mode 100644 src/Exception/UnsupportedResponseException.php rename src/ParameterResolver/{DependencyInjectionParameterResolver.php => ContainerObjectInjectionParameterResolver.php} (93%) rename src/ParameterResolver/{ObjectInjectionParameterResolver.php => DirectObjectInjectionParameterResolver.php} (92%) diff --git a/src/Annotation/Consumes/Image.php b/src/Annotation/Consumes/Image.php deleted file mode 100644 index 63388005..00000000 --- a/src/Annotation/Consumes/Image.php +++ /dev/null @@ -1,30 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation\Consumes; - -use Attribute; -use Sunrise\Http\Router\Annotation\Consumes; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Image extends Consumes -{ - public function __construct() - { - parent::__construct(ServerMediaType::image()); - } -} diff --git a/src/Annotation/Consumes/Json.php b/src/Annotation/Consumes/Json.php deleted file mode 100644 index f8ae2d3b..00000000 --- a/src/Annotation/Consumes/Json.php +++ /dev/null @@ -1,30 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation\Consumes; - -use Attribute; -use Sunrise\Http\Router\Annotation\Consumes; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Json extends Consumes -{ - public function __construct() - { - parent::__construct(ServerMediaType::json()); - } -} diff --git a/src/Annotation/Consumes/Xml.php b/src/Annotation/Consumes/Xml.php deleted file mode 100644 index 7b9617a7..00000000 --- a/src/Annotation/Consumes/Xml.php +++ /dev/null @@ -1,30 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation\Consumes; - -use Attribute; -use Sunrise\Http\Router\Annotation\Consumes; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Xml extends Consumes -{ - public function __construct() - { - parent::__construct(ServerMediaType::xml()); - } -} diff --git a/src/Annotation/ConsumesImage.php b/src/Annotation/ConsumesImage.php new file mode 100644 index 00000000..5b421104 --- /dev/null +++ b/src/Annotation/ConsumesImage.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class ConsumesImage extends Consumes +{ + public function __construct() + { + parent::__construct(MediaTypeFactory::image()); + } +} diff --git a/src/Annotation/ConsumesJson.php b/src/Annotation/ConsumesJson.php new file mode 100644 index 00000000..3524279d --- /dev/null +++ b/src/Annotation/ConsumesJson.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class ConsumesJson extends Consumes +{ + public function __construct() + { + parent::__construct(MediaTypeFactory::json()); + } +} diff --git a/src/Annotation/ConsumesXml.php b/src/Annotation/ConsumesXml.php new file mode 100644 index 00000000..c810ee07 --- /dev/null +++ b/src/Annotation/ConsumesXml.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class ConsumesXml extends Consumes +{ + public function __construct() + { + parent::__construct(MediaTypeFactory::xml()); + } +} diff --git a/src/Annotation/Method/Delete.php b/src/Annotation/MethodDelete.php similarity index 83% rename from src/Annotation/Method/Delete.php rename to src/Annotation/MethodDelete.php index ad171d7d..89bdd16a 100644 --- a/src/Annotation/Method/Delete.php +++ b/src/Annotation/MethodDelete.php @@ -11,17 +11,16 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Method; +namespace Sunrise\Http\Router\Annotation; use Attribute; use Fig\Http\Message\RequestMethodInterface; -use Sunrise\Http\Router\Annotation\Method; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Delete extends Method +final class MethodDelete extends Method { public function __construct() { diff --git a/src/Annotation/Method/Get.php b/src/Annotation/MethodGet.php similarity index 83% rename from src/Annotation/Method/Get.php rename to src/Annotation/MethodGet.php index d95d7aa7..8fc5afdb 100644 --- a/src/Annotation/Method/Get.php +++ b/src/Annotation/MethodGet.php @@ -11,17 +11,16 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Method; +namespace Sunrise\Http\Router\Annotation; use Attribute; use Fig\Http\Message\RequestMethodInterface; -use Sunrise\Http\Router\Annotation\Method; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Get extends Method +final class MethodGet extends Method { public function __construct() { diff --git a/src/Annotation/Method/Head.php b/src/Annotation/MethodHead.php similarity index 83% rename from src/Annotation/Method/Head.php rename to src/Annotation/MethodHead.php index d7924d63..f29157ad 100644 --- a/src/Annotation/Method/Head.php +++ b/src/Annotation/MethodHead.php @@ -11,17 +11,16 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Method; +namespace Sunrise\Http\Router\Annotation; use Attribute; use Fig\Http\Message\RequestMethodInterface; -use Sunrise\Http\Router\Annotation\Method; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Head extends Method +final class MethodHead extends Method { public function __construct() { diff --git a/src/Annotation/Method/Options.php b/src/Annotation/MethodOptions.php similarity index 83% rename from src/Annotation/Method/Options.php rename to src/Annotation/MethodOptions.php index eaf7c577..b5a8cd49 100644 --- a/src/Annotation/Method/Options.php +++ b/src/Annotation/MethodOptions.php @@ -11,17 +11,16 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Method; +namespace Sunrise\Http\Router\Annotation; use Attribute; use Fig\Http\Message\RequestMethodInterface; -use Sunrise\Http\Router\Annotation\Method; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Options extends Method +final class MethodOptions extends Method { public function __construct() { diff --git a/src/Annotation/Method/Patch.php b/src/Annotation/MethodPatch.php similarity index 83% rename from src/Annotation/Method/Patch.php rename to src/Annotation/MethodPatch.php index 5348a673..0ac67db3 100644 --- a/src/Annotation/Method/Patch.php +++ b/src/Annotation/MethodPatch.php @@ -11,17 +11,16 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Method; +namespace Sunrise\Http\Router\Annotation; use Attribute; use Fig\Http\Message\RequestMethodInterface; -use Sunrise\Http\Router\Annotation\Method; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Patch extends Method +final class MethodPatch extends Method { public function __construct() { diff --git a/src/Annotation/Method/Post.php b/src/Annotation/MethodPost.php similarity index 83% rename from src/Annotation/Method/Post.php rename to src/Annotation/MethodPost.php index 1cf99363..17004ba5 100644 --- a/src/Annotation/Method/Post.php +++ b/src/Annotation/MethodPost.php @@ -11,17 +11,16 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Method; +namespace Sunrise\Http\Router\Annotation; use Attribute; use Fig\Http\Message\RequestMethodInterface; -use Sunrise\Http\Router\Annotation\Method; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Post extends Method +final class MethodPost extends Method { public function __construct() { diff --git a/src/Annotation/Method/Purge.php b/src/Annotation/MethodPurge.php similarity index 83% rename from src/Annotation/Method/Purge.php rename to src/Annotation/MethodPurge.php index 303967be..50a781d5 100644 --- a/src/Annotation/Method/Purge.php +++ b/src/Annotation/MethodPurge.php @@ -11,17 +11,16 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Method; +namespace Sunrise\Http\Router\Annotation; use Attribute; use Fig\Http\Message\RequestMethodInterface; -use Sunrise\Http\Router\Annotation\Method; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Purge extends Method +final class MethodPurge extends Method { public function __construct() { diff --git a/src/Annotation/Method/Put.php b/src/Annotation/MethodPut.php similarity index 83% rename from src/Annotation/Method/Put.php rename to src/Annotation/MethodPut.php index c3572fb5..7be2b0fa 100644 --- a/src/Annotation/Method/Put.php +++ b/src/Annotation/MethodPut.php @@ -11,17 +11,16 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Method; +namespace Sunrise\Http\Router\Annotation; use Attribute; use Fig\Http\Message\RequestMethodInterface; -use Sunrise\Http\Router\Annotation\Method; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Put extends Method +final class MethodPut extends Method { public function __construct() { diff --git a/src/Annotation/Pattern/Uuid.php b/src/Annotation/PatternUuid.php similarity index 83% rename from src/Annotation/Pattern/Uuid.php rename to src/Annotation/PatternUuid.php index a0e2b58e..264c5184 100644 --- a/src/Annotation/Pattern/Uuid.php +++ b/src/Annotation/PatternUuid.php @@ -11,17 +11,16 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Pattern; +namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Annotation\Pattern; use Sunrise\Http\Router\Dictionary\VariablePattern; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Uuid extends Pattern +final class PatternUuid extends Pattern { public function __construct(string $variableName) { diff --git a/src/Annotation/Produces/Html.php b/src/Annotation/Produces/Html.php deleted file mode 100644 index dd50d12a..00000000 --- a/src/Annotation/Produces/Html.php +++ /dev/null @@ -1,30 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation\Produces; - -use Attribute; -use Sunrise\Http\Router\Annotation\Produces; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Html extends Produces -{ - public function __construct() - { - parent::__construct(ServerMediaType::html()); - } -} diff --git a/src/Annotation/Produces/Json.php b/src/Annotation/Produces/Json.php deleted file mode 100644 index c142c4a3..00000000 --- a/src/Annotation/Produces/Json.php +++ /dev/null @@ -1,30 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation\Produces; - -use Attribute; -use Sunrise\Http\Router\Annotation\Produces; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Json extends Produces -{ - public function __construct() - { - parent::__construct(ServerMediaType::json()); - } -} diff --git a/src/Annotation/Produces/Text.php b/src/Annotation/Produces/Text.php deleted file mode 100644 index b095fab6..00000000 --- a/src/Annotation/Produces/Text.php +++ /dev/null @@ -1,30 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation\Produces; - -use Attribute; -use Sunrise\Http\Router\Annotation\Produces; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Text extends Produces -{ - public function __construct() - { - parent::__construct(ServerMediaType::text()); - } -} diff --git a/src/Annotation/Produces/Xml.php b/src/Annotation/Produces/Xml.php deleted file mode 100644 index 9e24403a..00000000 --- a/src/Annotation/Produces/Xml.php +++ /dev/null @@ -1,30 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation\Produces; - -use Attribute; -use Sunrise\Http\Router\Annotation\Produces; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class Xml extends Produces -{ - public function __construct() - { - parent::__construct(ServerMediaType::xml()); - } -} diff --git a/src/Annotation/ProducesHtml.php b/src/Annotation/ProducesHtml.php new file mode 100644 index 00000000..ce98ca05 --- /dev/null +++ b/src/Annotation/ProducesHtml.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class ProducesHtml extends Produces +{ + public function __construct() + { + parent::__construct(MediaTypeFactory::html()); + } +} diff --git a/src/Annotation/ProducesJson.php b/src/Annotation/ProducesJson.php new file mode 100644 index 00000000..356ac287 --- /dev/null +++ b/src/Annotation/ProducesJson.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class ProducesJson extends Produces +{ + public function __construct() + { + parent::__construct(MediaTypeFactory::json()); + } +} diff --git a/src/Annotation/ProducesText.php b/src/Annotation/ProducesText.php new file mode 100644 index 00000000..4c3048f2 --- /dev/null +++ b/src/Annotation/ProducesText.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class ProducesText extends Produces +{ + public function __construct() + { + parent::__construct(MediaTypeFactory::text()); + } +} diff --git a/src/Annotation/ProducesXml.php b/src/Annotation/ProducesXml.php new file mode 100644 index 00000000..5b4c9dd5 --- /dev/null +++ b/src/Annotation/ProducesXml.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class ProducesXml extends Produces +{ + public function __construct() + { + parent::__construct(MediaTypeFactory::xml()); + } +} diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index 36b14ac9..c4b0b886 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -35,7 +35,7 @@ final class Route public function __construct( public string $name, - public string $path, + public string $path = '', /** @var array */ public array $patterns = [], /** @var array */ diff --git a/src/ClassResolver.php b/src/ClassResolver.php index 48f3049b..fbebdc6d 100644 --- a/src/ClassResolver.php +++ b/src/ClassResolver.php @@ -17,8 +17,7 @@ use Psr\Container\ContainerExceptionInterface; use Psr\Container\ContainerInterface; use ReflectionClass; -use Sunrise\Http\Router\Exception\InvalidParameterException; -use Sunrise\Http\Router\Exception\UnsupportedParameterException; +use ReflectionException; use function class_exists; use function sprintf; @@ -48,10 +47,9 @@ public function __construct( * * @template T of object * - * @throws InvalidArgumentException If the named class cannot be resolved. - * @throws ContainerExceptionInterface If something went wrong while working with the container. - * @throws InvalidParameterException {@see ParameterResolverChainInterface::resolveParameters()} - * @throws UnsupportedParameterException {@see ParameterResolverChainInterface::resolveParameters()} + * @throws ContainerExceptionInterface + * @throws InvalidArgumentException + * @throws ReflectionException */ public function resolveClass(string $className): object { diff --git a/src/Command/RouterClearDescriptorsCacheCommand.php b/src/Command/RouterClearCacheCommand.php similarity index 79% rename from src/Command/RouterClearDescriptorsCacheCommand.php rename to src/Command/RouterClearCacheCommand.php index 338ba4e2..d3a0c0d1 100644 --- a/src/Command/RouterClearDescriptorsCacheCommand.php +++ b/src/Command/RouterClearCacheCommand.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Command; use Psr\SimpleCache\CacheInterface; -use Sunrise\Http\Router\Loader\DescriptorLoader; +use Sunrise\Http\Router\Dictionary\CacheKey; use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputInterface; @@ -23,8 +23,8 @@ /** * @since 3.0.0 */ -#[AsCommand('router:clear-descriptors-cache', 'Clears the descriptors cache.')] -final class RouterClearDescriptorsCacheCommand extends Command +#[AsCommand('router:clear-cache', 'Clears the cache.')] +final class RouterClearCacheCommand extends Command { public function __construct(private readonly ?CacheInterface $cache) { @@ -36,7 +36,7 @@ public function __construct(private readonly ?CacheInterface $cache) */ protected function execute(InputInterface $input, OutputInterface $output): int { - $this->cache?->delete(DescriptorLoader::CACHE_KEY); + $this->cache?->delete(CacheKey::DESCRIPTORS); $output->writeln('Done'); diff --git a/src/Command/RouteListCommand.php b/src/Command/RouterListRoutesCommand.php similarity index 92% rename from src/Command/RouteListCommand.php rename to src/Command/RouterListRoutesCommand.php index 445e6922..d34683d6 100644 --- a/src/Command/RouteListCommand.php +++ b/src/Command/RouterListRoutesCommand.php @@ -25,8 +25,8 @@ /** * @since 2.9.0 */ -#[AsCommand('router:list-routes', 'Lists all routes.', ['router:route-list'])] -final class RouteListCommand extends Command +#[AsCommand('router:list-routes', 'Lists all routes.')] +final class RouterListRoutesCommand extends Command { public function __construct(private readonly RouterInterface $router) { diff --git a/src/Exception/NoRoutesRegisteredException.php b/src/Dictionary/CacheKey.php similarity index 70% rename from src/Exception/NoRoutesRegisteredException.php rename to src/Dictionary/CacheKey.php index 757bcbab..ffd4ca4e 100644 --- a/src/Exception/NoRoutesRegisteredException.php +++ b/src/Dictionary/CacheKey.php @@ -11,13 +11,12 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Exception; - -use LogicException; +namespace Sunrise\Http\Router\Dictionary; /** * @since 3.0.0 */ -final class NoRoutesRegisteredException extends LogicException implements ExceptionInterface +final class CacheKey { + public const DESCRIPTORS = 'router_descriptors'; } diff --git a/src/Entity/MediaType/MediaTypeFactory.php b/src/Entity/MediaType/MediaTypeFactory.php new file mode 100644 index 00000000..92b9ddfc --- /dev/null +++ b/src/Entity/MediaType/MediaTypeFactory.php @@ -0,0 +1,57 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Entity\MediaType; + +use function explode; + +/** + * @since 3.0.0 + */ +final class MediaTypeFactory +{ + public static function json(): MediaTypeInterface + { + return new ServerMediaType('application', 'json'); + } + + public static function xml(): MediaTypeInterface + { + return new ServerMediaType('application', 'xml'); + } + + public static function html(): MediaTypeInterface + { + return new ServerMediaType('text', 'html'); + } + + public static function text(): MediaTypeInterface + { + return new ServerMediaType('text', 'plain'); + } + + public static function image(): MediaTypeInterface + { + return new ServerMediaType('image', '*'); + } + + public static function fromString(string $string): MediaTypeInterface + { + $parts = explode(MediaTypeInterface::SEPARATOR, $string, 2); + + return new ServerMediaType( + type: isset($parts[0][0]) ? $parts[0] : '*', + subtype: isset($parts[1][0]) ? $parts[1] : '*', + ); + } +} diff --git a/src/Entity/MediaType/ServerMediaType.php b/src/Entity/MediaType/ServerMediaType.php index 652c6426..0e1f1b9e 100644 --- a/src/Entity/MediaType/ServerMediaType.php +++ b/src/Entity/MediaType/ServerMediaType.php @@ -13,8 +13,6 @@ namespace Sunrise\Http\Router\Entity\MediaType; -use function explode; - /** * @since 3.0.0 */ @@ -26,41 +24,6 @@ public function __construct( ) { } - public static function json(): self - { - return new self('application', 'json'); - } - - public static function xml(): self - { - return new self('application', 'xml'); - } - - public static function html(): self - { - return new self('text', 'html'); - } - - public static function text(): self - { - return new self('text', 'plain'); - } - - public static function image(): self - { - return new self('image', '*'); - } - - public static function fromString(string $string): self - { - $parts = explode(self::SEPARATOR, $string, 2); - - $type = isset($parts[0][0]) ? $parts[0] : '*'; - $subtype = isset($parts[1][0]) ? $parts[1] : '*'; - - return new self($type, $subtype); - } - public function getType(): string { return $this->type; diff --git a/src/Exception/InvalidParameterException.php b/src/Exception/InvalidParameterException.php deleted file mode 100644 index 1ae574dd..00000000 --- a/src/Exception/InvalidParameterException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use InvalidArgumentException; - -/** - * @since 3.0.0 - */ -final class InvalidParameterException extends InvalidArgumentException implements ExceptionInterface -{ -} diff --git a/src/Exception/InvalidReferenceException.php b/src/Exception/InvalidReferenceException.php deleted file mode 100644 index e1e4c873..00000000 --- a/src/Exception/InvalidReferenceException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use InvalidArgumentException; - -/** - * @since 3.0.0 - */ -final class InvalidReferenceException extends InvalidArgumentException implements ExceptionInterface -{ -} diff --git a/src/Exception/InvalidResponseException.php b/src/Exception/InvalidResponseException.php deleted file mode 100644 index 97863c59..00000000 --- a/src/Exception/InvalidResponseException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use InvalidArgumentException; - -/** - * @since 3.0.0 - */ -final class InvalidResponseException extends InvalidArgumentException implements ExceptionInterface -{ -} diff --git a/src/Exception/InvalidRouteBuildingValueException.php b/src/Exception/InvalidRouteBuildingValueException.php deleted file mode 100644 index e3c95641..00000000 --- a/src/Exception/InvalidRouteBuildingValueException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use InvalidArgumentException; - -/** - * @since 3.0.0 - */ -final class InvalidRouteBuildingValueException extends InvalidArgumentException implements ExceptionInterface -{ -} diff --git a/src/Exception/InvalidRouteLoadingResourceException.php b/src/Exception/InvalidRouteLoadingResourceException.php deleted file mode 100644 index 86f699be..00000000 --- a/src/Exception/InvalidRouteLoadingResourceException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use InvalidArgumentException; - -/** - * @since 3.0.0 - */ -final class InvalidRouteLoadingResourceException extends InvalidArgumentException implements ExceptionInterface -{ -} diff --git a/src/Exception/InvalidRouteMatchingPatternException.php b/src/Exception/InvalidRouteMatchingPatternException.php deleted file mode 100644 index ac6e280f..00000000 --- a/src/Exception/InvalidRouteMatchingPatternException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use InvalidArgumentException; - -/** - * @since 3.0.0 - */ -final class InvalidRouteMatchingPatternException extends InvalidArgumentException implements ExceptionInterface -{ -} diff --git a/src/Exception/InvalidRouteMatchingSubjectException.php b/src/Exception/InvalidRouteMatchingSubjectException.php deleted file mode 100644 index 4fa08962..00000000 --- a/src/Exception/InvalidRouteMatchingSubjectException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use InvalidArgumentException; - -/** - * @since 3.0.0 - */ -final class InvalidRouteMatchingSubjectException extends InvalidArgumentException implements ExceptionInterface -{ -} diff --git a/src/Exception/InvalidRouteParsingSubjectException.php b/src/Exception/InvalidRouteParsingSubjectException.php deleted file mode 100644 index 1e6b72cb..00000000 --- a/src/Exception/InvalidRouteParsingSubjectException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use InvalidArgumentException; - -/** - * @since 3.0.0 - */ -final class InvalidRouteParsingSubjectException extends InvalidArgumentException implements ExceptionInterface -{ -} diff --git a/src/Exception/NoRouteFoundException.php b/src/Exception/NoRouteFoundException.php deleted file mode 100644 index 61777baa..00000000 --- a/src/Exception/NoRouteFoundException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use InvalidArgumentException; - -/** - * @since 2.0.0 - */ -final class NoRouteFoundException extends InvalidArgumentException implements ExceptionInterface -{ -} diff --git a/src/Exception/UnsupportedParameterException.php b/src/Exception/UnsupportedParameterException.php deleted file mode 100644 index ffa457f2..00000000 --- a/src/Exception/UnsupportedParameterException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use LogicException; - -/** - * @since 3.0.0 - */ -final class UnsupportedParameterException extends LogicException implements ExceptionInterface -{ -} diff --git a/src/Exception/UnsupportedResponseException.php b/src/Exception/UnsupportedResponseException.php deleted file mode 100644 index c4a1978f..00000000 --- a/src/Exception/UnsupportedResponseException.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use LogicException; - -/** - * @since 3.0.0 - */ -final class UnsupportedResponseException extends LogicException implements ExceptionInterface -{ -} diff --git a/src/Helper/ClassFinder.php b/src/Helper/ClassFinder.php index ed81b967..f79b2f6e 100644 --- a/src/Helper/ClassFinder.php +++ b/src/Helper/ClassFinder.php @@ -18,6 +18,7 @@ use RecursiveDirectoryIterator; use RecursiveIteratorIterator; use ReflectionClass; +use ReflectionException; use RegexIterator; use SplFileInfo; use SplStack; @@ -36,7 +37,8 @@ final class ClassFinder /** * @return Generator * - * @throws InvalidArgumentException If the directory doesn't exist. + * @throws InvalidArgumentException + * @throws ReflectionException */ public static function getDirClasses(string $dirname): Generator { @@ -68,7 +70,8 @@ public static function getDirClasses(string $dirname): Generator /** * @return Generator * - * @throws InvalidArgumentException If the file doesn't exist. + * @throws InvalidArgumentException + * @throws ReflectionException */ public static function getFileClasses(string $filename): Generator { diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index 4c4aee97..a6d7b406 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -16,8 +16,6 @@ use BackedEnum; use InvalidArgumentException; use Stringable; -use Sunrise\Http\Router\Exception\InvalidRouteBuildingValueException; -use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; use function get_debug_type; use function is_int; @@ -32,8 +30,7 @@ final class RouteBuilder { /** - * @throws InvalidRouteBuildingValueException - * @throws InvalidRouteParsingSubjectException {@see RouteParser::parseRoute()} + * @throws InvalidArgumentException */ public static function buildRoute(string $route, array $values = []): string { @@ -50,8 +47,8 @@ public static function buildRoute(string $route, array $values = []): string try { $value = self::stringifyValue($value); } catch (InvalidArgumentException $e) { - throw new InvalidRouteBuildingValueException(sprintf( - 'The route %s could not be built with an invalid value for the variable {%s} due to: %s', + throw new InvalidArgumentException(sprintf( + 'The route %s could not be built due to an invalid value for the variable {%s}: %s.', $route, $variable['name'], $e->getMessage(), @@ -69,8 +66,8 @@ public static function buildRoute(string $route, array $values = []): string continue; } - throw new InvalidRouteBuildingValueException(sprintf( - 'The route %s could not be built without a required value for the variable {%s}.', + throw new InvalidArgumentException(sprintf( + 'The route %s could not be built because the required value for the variable {%s} is missing.', $route, $variable['name'], )); @@ -106,7 +103,7 @@ public static function stringifyValue(mixed $value): string throw new InvalidArgumentException(sprintf( 'The %s value could not be converted to a string; ' . - 'supported types: string, integer, backed enum and stringable object.', + 'supported types are: string, integer, backed enum and stringable object.', get_debug_type($value), )); } diff --git a/src/Helper/RouteCompiler.php b/src/Helper/RouteCompiler.php index 8f197f30..8136c517 100644 --- a/src/Helper/RouteCompiler.php +++ b/src/Helper/RouteCompiler.php @@ -13,7 +13,7 @@ namespace Sunrise\Http\Router\Helper; -use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; +use InvalidArgumentException; use function addcslashes; use function str_replace; @@ -31,7 +31,7 @@ final class RouteCompiler * * @return non-empty-string * - * @throws InvalidRouteParsingSubjectException {@see RouteParser::parseRoute()} + * @throws InvalidArgumentException */ public static function compileRoute(string $route, array $patterns = []): string { diff --git a/src/Helper/RouteMatcher.php b/src/Helper/RouteMatcher.php index 0c1d8f60..5c2c384c 100644 --- a/src/Helper/RouteMatcher.php +++ b/src/Helper/RouteMatcher.php @@ -14,10 +14,9 @@ namespace Sunrise\Http\Router\Helper; use ErrorException; -use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; -use Sunrise\Http\Router\Exception\InvalidRouteMatchingPatternException; -use Sunrise\Http\Router\Exception\InvalidRouteMatchingSubjectException; +use InvalidArgumentException; use Throwable; +use UnexpectedValueException; use function is_int; use function preg_last_error; @@ -38,9 +37,8 @@ final class RouteMatcher * @param array $patterns * @param-out array $matches * - * @throws InvalidRouteParsingSubjectException {@see RouteCompiler::compileRoute()} - * @throws InvalidRouteMatchingPatternException - * @throws InvalidRouteMatchingSubjectException + * @throws InvalidArgumentException + * @throws UnexpectedValueException */ public static function matchRoute(string $route, array $patterns, string $subject, ?array &$matches = null): bool { @@ -53,8 +51,8 @@ public static function matchRoute(string $route, array $patterns, string $subjec * @param non-empty-string $pattern * @param-out array $matches * - * @throws InvalidRouteMatchingPatternException - * @throws InvalidRouteMatchingSubjectException + * @throws InvalidArgumentException + * @throws UnexpectedValueException */ public static function matchPattern(string $route, string $pattern, string $subject, ?array &$matches = null): bool { @@ -64,15 +62,16 @@ public static function matchPattern(string $route, string $pattern, string $subj } } catch (Throwable) { if (preg_last_error() === PREG_BAD_UTF8_ERROR) { - throw new InvalidRouteMatchingSubjectException(sprintf( - 'The route %s could not be matched with an invalid subject due to: %s.', + throw new UnexpectedValueException(sprintf( + 'The route %s could not be matched due to an invalid subject: %s.', $route, preg_last_error_msg(), )); } - throw new InvalidRouteMatchingPatternException(sprintf( - 'The route %s could not be matched due to: %s; most likely, this problem is related to one of the route patterns.', + throw new InvalidArgumentException(sprintf( + 'The route %s could not be matched due to: %s. ' . + 'This problem is most likely related to one of the route patterns', $route, preg_last_error_msg(), ), preg_last_error()); diff --git a/src/Helper/RouteParser.php b/src/Helper/RouteParser.php index 57fc2fb5..87701e08 100644 --- a/src/Helper/RouteParser.php +++ b/src/Helper/RouteParser.php @@ -13,8 +13,8 @@ namespace Sunrise\Http\Router\Helper; +use InvalidArgumentException; use Sunrise\Http\Router\Dictionary\Charset; -use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; use function sprintf; @@ -34,7 +34,7 @@ final class RouteParser * * @return list * - * @throws InvalidRouteParsingSubjectException + * @throws InvalidArgumentException */ public static function parseRoute(string $route): array { @@ -47,9 +47,9 @@ public static function parseRoute(string $route): array for ($offset = 0; isset($route[$offset]); $offset++) { if ($route[$offset] === '(' && !($cursor & self::IN_VARIABLE)) { if (($cursor & self::IN_OPTIONAL_PART)) { - throw new InvalidRouteParsingSubjectException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to open an optional part at position %d has failed ' . + 'The attempt to open an optional part at position %d failed ' . 'because nested optional parts are not supported.', $route, $offset, @@ -61,9 +61,9 @@ public static function parseRoute(string $route): array } if ($route[$offset] === ')' && !($cursor & self::IN_VARIABLE)) { if (!($cursor & self::IN_OPTIONAL_PART)) { - throw new InvalidRouteParsingSubjectException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to close an optional part at position %d has failed ' . + 'The attempt to close an optional part at position %d failed ' . 'because an open optional part was not found.', $route, $offset, @@ -83,18 +83,18 @@ public static function parseRoute(string $route): array if ($route[$offset] === '{' && !($cursor & self::IN_VARIABLE_PATTERN)) { if (($cursor & self::IN_VARIABLE)) { - throw new InvalidRouteParsingSubjectException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to open a variable at position %d has failed ' . + 'The attempt to open a variable at position %d failed ' . 'because nested variables are not supported.', $route, $offset, )); } if (($cursor & self::IN_OCCUPIED_PART)) { - throw new InvalidRouteParsingSubjectException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to open a variable at position %d has failed ' . + 'The attempt to open a variable at position %d failed ' . 'because more than one variable inside an optional part is not supported.', $route, $offset, @@ -113,18 +113,18 @@ public static function parseRoute(string $route): array } if ($route[$offset] === '}' && !($cursor & self::IN_VARIABLE_PATTERN)) { if (!($cursor & self::IN_VARIABLE)) { - throw new InvalidRouteParsingSubjectException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to close a variable at position %d has failed ' . + 'The attempt to close a variable at position %d failed ' . 'because an open variable was not found.', $route, $offset, )); } if (!isset($variables[$variable]['name'])) { - throw new InvalidRouteParsingSubjectException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to close a variable at position %d has failed ' . + 'The attempt to close a variable at position %d failed ' . 'because its name is required for its declaration.', $route, $offset, @@ -139,18 +139,18 @@ public static function parseRoute(string $route): array if ($route[$offset] === '<' && ($cursor & self::IN_VARIABLE)) { if (($cursor & self::IN_VARIABLE_PATTERN)) { - throw new InvalidRouteParsingSubjectException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to open a variable pattern at position %d has failed ' . + 'The attempt to open a variable pattern at position %d failed ' . 'because nested patterns are not supported.', $route, $offset, )); } if (!($cursor & self::IN_VARIABLE_NAME)) { - throw new InvalidRouteParsingSubjectException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to open a variable pattern at position %d has failed ' . + 'The attempt to open a variable pattern at position %d failed ' . 'because the pattern must be preceded by the variable name.', $route, $offset, @@ -162,18 +162,18 @@ public static function parseRoute(string $route): array } if ($route[$offset] === '>' && ($cursor & self::IN_VARIABLE)) { if (!($cursor & self::IN_VARIABLE_PATTERN)) { - throw new InvalidRouteParsingSubjectException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to close a variable pattern at position %d has failed ' . + 'The attempt to close a variable pattern at position %d failed ' . 'because an open pattern was not found.', $route, $offset, )); } if (!isset($variables[$variable]['pattern'])) { - throw new InvalidRouteParsingSubjectException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to close a variable pattern at position %d has failed ' . + 'The attempt to close a variable pattern at position %d failed ' . 'because its content is required for its declaration.', $route, $offset, @@ -199,7 +199,7 @@ public static function parseRoute(string $route): array // https://www.pcre.org/original/doc/html/pcrepattern.html#SEC16 if (($cursor & self::IN_VARIABLE_NAME)) { if (!isset($variables[$variable]['name']) && $route[$offset] >= '0' && $route[$offset] <= '9') { - throw new InvalidRouteParsingSubjectException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An invalid character was found at position %d. ' . 'Please note that variable names cannot start with digits.', @@ -208,7 +208,7 @@ public static function parseRoute(string $route): array )); } if (!isset(Charset::PCRE_SUBPATTERN_NAME[$route[$offset]])) { - throw new InvalidRouteParsingSubjectException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An invalid character was found at position %d. ' . 'Please note that variable names must consist only of digits, letters and underscores.', @@ -217,7 +217,7 @@ public static function parseRoute(string $route): array )); } if (isset($variables[$variable]['name'][31])) { - throw new InvalidRouteParsingSubjectException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An extra character was found at position %d. ' . 'Please note that variable names must not exceed 32 characters.', @@ -233,7 +233,7 @@ public static function parseRoute(string $route): array if (($cursor & self::IN_VARIABLE_PATTERN)) { if ($route[$offset] === RouteCompiler::PATTERN_DELIMITER) { - throw new InvalidRouteParsingSubjectException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An invalid character was found at position %d. ' . 'Please note that variable patterns cannot contain the character %s; ' . @@ -252,7 +252,7 @@ public static function parseRoute(string $route): array // {foo<\w+>xxx} // ~~~~~~~~~^^^~ if (($cursor & self::IN_VARIABLE)) { - throw new InvalidRouteParsingSubjectException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An unexpected character was found at position %d; a variable at this position must be closed.', $route, @@ -262,9 +262,9 @@ public static function parseRoute(string $route): array } if (($cursor & self::IN_VARIABLE) || ($cursor & self::IN_OPTIONAL_PART)) { - throw new InvalidRouteParsingSubjectException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . - 'An attempt to parse the route has failed because it contains an unclosed optional part or variable.', + 'The attempt to parse the route failed because it contains an unclosed optional part or variable.', $route, )); } diff --git a/src/Helper/RouteSimplifier.php b/src/Helper/RouteSimplifier.php index dda17355..c2852ad8 100644 --- a/src/Helper/RouteSimplifier.php +++ b/src/Helper/RouteSimplifier.php @@ -13,7 +13,7 @@ namespace Sunrise\Http\Router\Helper; -use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; +use InvalidArgumentException; use function str_replace; use function substr; @@ -24,7 +24,7 @@ final class RouteSimplifier { /** - * @throws InvalidRouteParsingSubjectException {@see RouteParser::parseRoute()} + * @throws InvalidArgumentException */ public static function simplifyRoute(string $route): string { diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 0ebb0178..d9423b03 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -14,11 +14,13 @@ namespace Sunrise\Http\Router\Loader; use Generator; +use InvalidArgumentException; use Psr\Http\Server\RequestHandlerInterface; use Psr\SimpleCache\CacheException; use Psr\SimpleCache\CacheInterface; use ReflectionAttribute; use ReflectionClass; +use ReflectionException; use ReflectionMethod; use Sunrise\Http\Router\Annotation\Attribute; use Sunrise\Http\Router\Annotation\Constraint; @@ -36,9 +38,8 @@ use Sunrise\Http\Router\Annotation\Route as Descriptor; use Sunrise\Http\Router\Annotation\Summary; use Sunrise\Http\Router\Annotation\Tag; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; -use Sunrise\Http\Router\Exception\InvalidRouteLoadingResourceException; -use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; +use Sunrise\Http\Router\Dictionary\CacheKey; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; use Sunrise\Http\Router\Helper\ClassFinder; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Route; @@ -56,8 +57,6 @@ */ final class DescriptorLoader implements LoaderInterface { - public const CACHE_KEY = 'router_descriptors'; - public function __construct( /** @var array */ private readonly array $resources, @@ -69,8 +68,8 @@ public function __construct( * @inheritDoc * * @throws CacheException - * @throws InvalidRouteLoadingResourceException - * @throws InvalidRouteParsingSubjectException + * @throws InvalidArgumentException + * @throws ReflectionException */ public function load(): Generator { @@ -99,13 +98,13 @@ public function load(): Generator * @return list * * @throws CacheException - * @throws InvalidRouteLoadingResourceException - * @throws InvalidRouteParsingSubjectException + * @throws InvalidArgumentException + * @throws ReflectionException */ private function getDescriptors(): array { /** @var list|null $descriptors */ - $descriptors = $this->cache?->get(self::CACHE_KEY); + $descriptors = $this->cache?->get(CacheKey::DESCRIPTORS); if ($descriptors !== null) { return $descriptors; } @@ -119,7 +118,7 @@ private function getDescriptors(): array usort($descriptors, static fn(Descriptor $a, Descriptor $b): int => $b->priority <=> $a->priority); - $this->cache?->set(self::CACHE_KEY, $descriptors); + $this->cache?->set(CacheKey::DESCRIPTORS, $descriptors); return $descriptors; } @@ -127,8 +126,8 @@ private function getDescriptors(): array /** * @return Generator * - * @throws InvalidRouteLoadingResourceException - * @throws InvalidRouteParsingSubjectException + * @throws InvalidArgumentException + * @throws ReflectionException */ private static function getResourceDescriptors(string $resource): Generator { @@ -154,7 +153,7 @@ private static function getResourceDescriptors(string $resource): Generator return; } - throw new InvalidRouteLoadingResourceException(sprintf( + throw new InvalidArgumentException(sprintf( 'The loader %s only accepts directory, file or class names; ' . 'however, the resource %s is not one of them.', self::class, @@ -165,7 +164,7 @@ private static function getResourceDescriptors(string $resource): Generator /** * @return Generator * - * @throws InvalidRouteParsingSubjectException + * @throws InvalidArgumentException */ private static function getClassDescriptors(ReflectionClass $class): Generator { @@ -276,7 +275,7 @@ private static function enrichDescriptorFromClassOrMethod(Descriptor $descriptor $annotation = $annotation->newInstance(); $descriptor->consumes[] = is_string($annotation->value) ? - ServerMediaType::fromString($annotation->value) : + MediaTypeFactory::fromString($annotation->value) : $annotation->value; } @@ -286,7 +285,7 @@ private static function enrichDescriptorFromClassOrMethod(Descriptor $descriptor $annotation = $annotation->newInstance(); $descriptor->produces[] = is_string($annotation->value) ? - ServerMediaType::fromString($annotation->value) : + MediaTypeFactory::fromString($annotation->value) : $annotation->value; } @@ -326,7 +325,7 @@ private static function enrichDescriptorFromClassOrMethod(Descriptor $descriptor } /** - * @throws InvalidRouteParsingSubjectException + * @throws InvalidArgumentException */ private static function completeDescriptor(Descriptor $descriptor): void { diff --git a/src/Loader/LoaderInterface.php b/src/Loader/LoaderInterface.php index f4eb0394..fc2086d5 100644 --- a/src/Loader/LoaderInterface.php +++ b/src/Loader/LoaderInterface.php @@ -13,7 +13,6 @@ namespace Sunrise\Http\Router\Loader; -use Sunrise\Http\Router\Exception\InvalidRouteLoadingResourceException; use Sunrise\Http\Router\RouteInterface; /** @@ -23,8 +22,6 @@ interface LoaderInterface { /** * @return iterable - * - * @throws InvalidRouteLoadingResourceException */ public function load(): iterable; } diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index e06fbaed..1af66e79 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -18,9 +18,9 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; -use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; use Sunrise\Http\Router\Exception\HttpExceptionFactory; +use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ServerRequest; use function is_array; @@ -53,12 +53,12 @@ public function __construct( /** * @inheritDoc * - * @throws HttpException If the request's payload couldn't be decoded. + * @throws HttpExceptionInterface If the request's payload couldn't be decoded. */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if (ServerRequest::create($request)->clientProducesMediaType(ServerMediaType::json())) { - $request = $request->withParsedBody($this->decodePayload($request->getBody()->__toString())); + if (ServerRequest::create($request)->clientProducesMediaType(MediaTypeFactory::json())) { + $request = $request->withParsedBody($this->decodePayload((string) $request->getBody())); } return $handler->handle($request); @@ -67,7 +67,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface /** * @return array * - * @throws HttpException If the payload couldn't be decoded. + * @throws HttpExceptionInterface If the payload couldn't be decoded. */ private function decodePayload(string $payload): array { diff --git a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php index 8aa9c75e..5ec28339 100644 --- a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php +++ b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php @@ -17,8 +17,8 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; +use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ServerRequest; use function array_values; @@ -37,7 +37,7 @@ public function __construct( /** * @inheritDoc * - * @throws HttpException If the request's payload media type isn't supported by the server. + * @throws HttpExceptionInterface If the request payload's media type isn't supported by the server. */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { diff --git a/src/MiddlewareResolver.php b/src/MiddlewareResolver.php index 236691e2..b3caf333 100644 --- a/src/MiddlewareResolver.php +++ b/src/MiddlewareResolver.php @@ -19,11 +19,11 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; +use ReflectionException; use ReflectionFunction; use ReflectionMethod; -use Sunrise\Http\Router\Exception\InvalidReferenceException; use Sunrise\Http\Router\Middleware\CallableMiddleware; -use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; +use Sunrise\Http\Router\ParameterResolver\DirectObjectInjectionParameterResolver; use function class_exists; use function is_array; @@ -47,8 +47,8 @@ public function __construct( /** * @inheritDoc * - * @throws InvalidArgumentException {@see ClassResolverInterface::resolveClass()} - * @throws InvalidReferenceException + * @throws InvalidArgumentException + * @throws ReflectionException */ public function resolveMiddleware(mixed $reference): MiddlewareInterface { @@ -79,7 +79,7 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface } } - throw new InvalidReferenceException(sprintf( + throw new InvalidArgumentException(sprintf( 'The middleware reference %s could not be resolved.', ReferenceResolver::stringifyReference($reference), )); @@ -88,14 +88,17 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface private function createCallbackMiddleware(callable $callback, ReflectionMethod|ReflectionFunction $reflection): MiddlewareInterface { return new CallableMiddleware( - fn(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface => ( + fn( + ServerRequestInterface $request, + RequestHandlerInterface $handler, + ): ResponseInterface => ( $this->responseResolverChain->resolveResponse( $callback( ...$this->parameterResolverChain ->withContext($request) ->withResolver( - new ObjectInjectionParameterResolver($request), - new ObjectInjectionParameterResolver($handler), + new DirectObjectInjectionParameterResolver($request), + new DirectObjectInjectionParameterResolver($handler), ) ->resolveParameters(...$reflection->getParameters()) ), diff --git a/src/MiddlewareResolverInterface.php b/src/MiddlewareResolverInterface.php index 3b87f1f0..52fe9408 100644 --- a/src/MiddlewareResolverInterface.php +++ b/src/MiddlewareResolverInterface.php @@ -13,8 +13,8 @@ namespace Sunrise\Http\Router; +use InvalidArgumentException; use Psr\Http\Server\MiddlewareInterface; -use Sunrise\Http\Router\Exception\InvalidReferenceException; /** * @since 3.0.0 @@ -22,7 +22,7 @@ interface MiddlewareResolverInterface { /** - * @throws InvalidReferenceException + * @throws InvalidArgumentException */ public function resolveMiddleware(mixed $reference): MiddlewareInterface; } diff --git a/src/ParameterResolver/DependencyInjectionParameterResolver.php b/src/ParameterResolver/ContainerObjectInjectionParameterResolver.php similarity index 93% rename from src/ParameterResolver/DependencyInjectionParameterResolver.php rename to src/ParameterResolver/ContainerObjectInjectionParameterResolver.php index 887ef4c6..ff505811 100644 --- a/src/ParameterResolver/DependencyInjectionParameterResolver.php +++ b/src/ParameterResolver/ContainerObjectInjectionParameterResolver.php @@ -23,7 +23,7 @@ /** * @since 3.0.0 */ -final class DependencyInjectionParameterResolver implements ParameterResolverInterface +final class ContainerObjectInjectionParameterResolver implements ParameterResolverInterface { public function __construct( private readonly ContainerInterface $container, diff --git a/src/ParameterResolver/ObjectInjectionParameterResolver.php b/src/ParameterResolver/DirectObjectInjectionParameterResolver.php similarity index 92% rename from src/ParameterResolver/ObjectInjectionParameterResolver.php rename to src/ParameterResolver/DirectObjectInjectionParameterResolver.php index bc9b741b..28e308eb 100644 --- a/src/ParameterResolver/ObjectInjectionParameterResolver.php +++ b/src/ParameterResolver/DirectObjectInjectionParameterResolver.php @@ -23,7 +23,7 @@ /** * @since 3.0.0 */ -final class ObjectInjectionParameterResolver implements ParameterResolverInterface +final class DirectObjectInjectionParameterResolver implements ParameterResolverInterface { public function __construct( private readonly object $object, diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index ef9bd920..d1ced8c4 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -14,14 +14,14 @@ namespace Sunrise\Http\Router\ParameterResolver; use Generator; +use InvalidArgumentException; use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionNamedType; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestBody; -use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Exception\InvalidParameterException; +use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ParameterResolverChain; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; @@ -50,9 +50,9 @@ public function __construct( /** * @inheritDoc * - * @throws HttpException + * @throws HttpExceptionInterface + * @throws InvalidArgumentException * @throws InvalidObjectException - * @throws InvalidParameterException */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -68,7 +68,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { - throw new InvalidParameterException(sprintf( + throw new InvalidArgumentException(sprintf( 'To use the #[RequestBody] annotation, the parameter %s must be typed with an object.', ParameterResolverChain::stringifyParameter($parameter), )); @@ -86,7 +86,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); } - if ($processParams->validation && isset($this->validator)) { + if ($processParams->validation && $this->validator !== null) { if (($violations = $this->validator->validate($argument))->count() > 0) { throw HttpExceptionFactory::invalidBody($errorMessage, $errorStatusCode) ->addConstraintViolation(...array_map(ValidatorConstraintViolationAdapter::create(...), [...$violations])); diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index 1a2985ad..70fac92b 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -18,14 +18,15 @@ use ReflectionAttribute; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestCookie; -use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; +use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ServerRequest; use Sunrise\Http\Router\Validation\Constraint\ArgumentConstraint; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; +use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; use Sunrise\Hydrator\Type; @@ -51,7 +52,8 @@ public function __construct( /** * @inheritDoc * - * @throws HttpException + * @throws HttpExceptionInterface + * @throws InvalidObjectException */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -93,7 +95,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); } - if ($processParams->validation && isset($this->validator)) { + if ($processParams->validation && $this->validator !== null) { $violations = $this->validator->startContext()->atPath($cookieName)->validate($argument, new ArgumentConstraint($parameter))->getViolations(); if ($violations->count() > 0) { throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode) diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 01a90b5c..4dba5394 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -18,13 +18,14 @@ use ReflectionAttribute; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestHeader; -use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; +use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\Validation\Constraint\ArgumentConstraint; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; +use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; use Sunrise\Hydrator\Type; @@ -50,7 +51,8 @@ public function __construct( /** * @inheritDoc * - * @throws HttpException + * @throws HttpExceptionInterface + * @throws InvalidObjectException */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -91,7 +93,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); } - if ($processParams->validation && isset($this->validator)) { + if ($processParams->validation && $this->validator !== null) { $violations = $this->validator->startContext()->atPath($headerName)->validate($argument, new ArgumentConstraint($parameter))->getViolations(); if ($violations->count() > 0) { throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode) diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index b22d3509..913b5a92 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -14,14 +14,14 @@ namespace Sunrise\Http\Router\ParameterResolver; use Generator; +use InvalidArgumentException; use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionNamedType; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestQuery; -use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Exception\InvalidParameterException; +use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ParameterResolverChain; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; @@ -50,9 +50,9 @@ public function __construct( /** * @inheritDoc * - * @throws HttpException + * @throws HttpExceptionInterface + * @throws InvalidArgumentException * @throws InvalidObjectException - * @throws InvalidParameterException */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -68,7 +68,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $type = $parameter->getType(); if (! $type instanceof ReflectionNamedType || $type->isBuiltin()) { - throw new InvalidParameterException(sprintf( + throw new InvalidArgumentException(sprintf( 'To use the #[RequestQuery] annotation, the parameter %s must be typed with an object.', ParameterResolverChain::stringifyParameter($parameter), )); @@ -86,7 +86,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); } - if ($processParams->validation && isset($this->validator)) { + if ($processParams->validation && $this->validator !== null) { if (($violations = $this->validator->validate($argument))->count() > 0) { throw HttpExceptionFactory::invalidQuery($errorMessage, $errorStatusCode) ->addConstraintViolation(...array_map(ValidatorConstraintViolationAdapter::create(...), [...$violations])); diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index 2a50f72e..ed789810 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -14,13 +14,13 @@ namespace Sunrise\Http\Router\ParameterResolver; use Generator; +use InvalidArgumentException; use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestVariable; -use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Exception\InvalidParameterException; +use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\Helper\RouteSimplifier; use Sunrise\Http\Router\ParameterResolverChain; use Sunrise\Http\Router\ParameterResolverInterface; @@ -29,6 +29,7 @@ use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; +use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\Exception\InvalidValueException; use Sunrise\Hydrator\HydratorInterface; use Sunrise\Hydrator\Type; @@ -56,8 +57,9 @@ public function __construct( /** * @inheritDoc * - * @throws HttpException - * @throws InvalidParameterException + * @throws HttpExceptionInterface + * @throws InvalidArgumentException + * @throws InvalidObjectException */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -83,9 +85,9 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) return yield $parameter->getDefaultValue(); } - throw new InvalidParameterException(sprintf( - 'The parameter %s expects a value of the variable {%s} from the route %s ' . - 'which is not present in the request, most likely, because the variable is optional. ' . + throw new InvalidArgumentException(sprintf( + 'The parameter %s expects a value of the variable {%s} from the route %s, ' . + 'which is not present in the request, likely because the variable is optional. ' . 'To resolve this issue, assign the default value to the parameter.', ParameterResolverChain::stringifyParameter($parameter), $variableName, @@ -107,7 +109,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); } - if (isset($this->validator)) { + if ($this->validator !== null) { $violations = $this->validator->startContext()->atPath($variableName)->validate($argument, new ArgumentConstraint($parameter))->getViolations(); if ($violations->count() > 0) { throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode) diff --git a/src/ParameterResolverChain.php b/src/ParameterResolverChain.php index 669ad31b..7ad9490e 100644 --- a/src/ParameterResolverChain.php +++ b/src/ParameterResolverChain.php @@ -14,10 +14,10 @@ namespace Sunrise\Http\Router; use Generator; +use InvalidArgumentException; +use LogicException; use ReflectionMethod; use ReflectionParameter; -use Sunrise\Http\Router\Exception\InvalidParameterException; -use Sunrise\Http\Router\Exception\UnsupportedParameterException; use function sprintf; use function usort; @@ -58,6 +58,9 @@ public function withResolver(ParameterResolverInterface ...$resolvers): static /** * @inheritDoc + * + * @throws InvalidArgumentException + * @throws LogicException */ public function resolveParameters(ReflectionParameter ...$parameters): Generator { @@ -71,8 +74,8 @@ public function resolveParameters(ReflectionParameter ...$parameters): Generator /** * @return Generator * - * @throws InvalidParameterException {@see ParameterResolverInterface::resolveParameter()} - * @throws UnsupportedParameterException + * @throws InvalidArgumentException + * @throws LogicException */ private function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator { @@ -83,7 +86,7 @@ private function resolveParameter(ReflectionParameter $parameter, mixed $context } } - throw new UnsupportedParameterException(sprintf( + throw new LogicException(sprintf( 'The parameter %s is not supported and cannot be resolved.', self::stringifyParameter($parameter), )); diff --git a/src/ParameterResolverChainInterface.php b/src/ParameterResolverChainInterface.php index 4d904dcc..13737c7d 100644 --- a/src/ParameterResolverChainInterface.php +++ b/src/ParameterResolverChainInterface.php @@ -14,9 +14,9 @@ namespace Sunrise\Http\Router; use Generator; +use InvalidArgumentException; +use LogicException; use ReflectionParameter; -use Sunrise\Http\Router\Exception\InvalidParameterException; -use Sunrise\Http\Router\Exception\UnsupportedParameterException; /** * @since 3.0.0 @@ -30,8 +30,8 @@ public function withResolver(ParameterResolverInterface ...$resolvers): static; /** * @return Generator * - * @throws InvalidParameterException {@see ParameterResolverInterface::resolveParameter()} - * @throws UnsupportedParameterException + * @throws InvalidArgumentException + * @throws LogicException */ public function resolveParameters(ReflectionParameter ...$parameters): Generator; } diff --git a/src/ParameterResolverInterface.php b/src/ParameterResolverInterface.php index 556176b5..90fd400b 100644 --- a/src/ParameterResolverInterface.php +++ b/src/ParameterResolverInterface.php @@ -14,8 +14,8 @@ namespace Sunrise\Http\Router; use Generator; +use InvalidArgumentException; use ReflectionParameter; -use Sunrise\Http\Router\Exception\InvalidParameterException; /** * @since 3.0.0 @@ -25,7 +25,7 @@ interface ParameterResolverInterface /** * @return Generator * - * @throws InvalidParameterException + * @throws InvalidArgumentException */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator; diff --git a/src/RequestHandlerResolver.php b/src/RequestHandlerResolver.php index 81cb4895..30b3a016 100644 --- a/src/RequestHandlerResolver.php +++ b/src/RequestHandlerResolver.php @@ -18,10 +18,10 @@ use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; +use ReflectionException; use ReflectionFunction; use ReflectionMethod; -use Sunrise\Http\Router\Exception\InvalidReferenceException; -use Sunrise\Http\Router\ParameterResolver\ObjectInjectionParameterResolver; +use Sunrise\Http\Router\ParameterResolver\DirectObjectInjectionParameterResolver; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use function class_exists; @@ -46,8 +46,8 @@ public function __construct( /** * @inheritDoc * - * @throws InvalidArgumentException {@see ClassResolverInterface::resolveClass()} - * @throws InvalidReferenceException + * @throws InvalidArgumentException + * @throws ReflectionException */ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface { @@ -78,7 +78,7 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface return $this->classResolver->resolveClass($reference); } - throw new InvalidReferenceException(sprintf( + throw new InvalidArgumentException(sprintf( 'The request handler reference %s could not be resolved.', ReferenceResolver::stringifyReference($reference), )); @@ -93,7 +93,7 @@ private function createRequestHandlerCallback(callable $callback, ReflectionMeth ...$this->parameterResolverChain ->withContext($request) ->withResolver( - new ObjectInjectionParameterResolver($request), + new DirectObjectInjectionParameterResolver($request), ) ->resolveParameters(...$reflection->getParameters()) ), diff --git a/src/RequestHandlerResolverInterface.php b/src/RequestHandlerResolverInterface.php index 2209ee85..a2b254d1 100644 --- a/src/RequestHandlerResolverInterface.php +++ b/src/RequestHandlerResolverInterface.php @@ -13,8 +13,8 @@ namespace Sunrise\Http\Router; +use InvalidArgumentException; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\InvalidReferenceException; /** * @since 3.0.0 @@ -22,7 +22,7 @@ interface RequestHandlerResolverInterface { /** - * @throws InvalidReferenceException + * @throws InvalidArgumentException */ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface; } diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index 10b63a3d..171dcdac 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -21,8 +21,8 @@ use ReflectionAttribute; use ReflectionFunction; use ReflectionMethod; +use RuntimeException; use Sunrise\Http\Router\Annotation\JsonResponse; -use Sunrise\Http\Router\Exception\InvalidResponseException; use Sunrise\Http\Router\ResponseResolverChain; use Sunrise\Http\Router\ResponseResolverInterface; @@ -49,7 +49,7 @@ public function __construct( /** * @inheritDoc * - * @throws InvalidResponseException + * @throws RuntimeException */ public function resolveResponse( mixed $response, @@ -71,7 +71,7 @@ public function resolveResponse( /** @psalm-suppress ArgumentTypeCoercion */ $payload = json_encode($response, $encodingFlags | JSON_THROW_ON_ERROR, $encodingDepth); } catch (JsonException $e) { - throw new InvalidResponseException(sprintf( + throw new RuntimeException(sprintf( 'The responder %s returned a response that could not be encoded to JSON due to: %s', ResponseResolverChain::stringifyResponder($responder), $e->getMessage(), diff --git a/src/ResponseResolverChain.php b/src/ResponseResolverChain.php index a118a104..1eedc250 100644 --- a/src/ResponseResolverChain.php +++ b/src/ResponseResolverChain.php @@ -13,6 +13,8 @@ namespace Sunrise\Http\Router; +use InvalidArgumentException; +use LogicException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use ReflectionAttribute; @@ -20,7 +22,6 @@ use ReflectionMethod; use Sunrise\Http\Router\Annotation\ResponseHeader; use Sunrise\Http\Router\Annotation\ResponseStatus; -use Sunrise\Http\Router\Exception\UnsupportedResponseException; use function sprintf; use function usort; @@ -40,6 +41,9 @@ public function __construct( /** * @inheritDoc + * + * @throws InvalidArgumentException + * @throws LogicException */ public function resolveResponse( mixed $response, @@ -59,7 +63,7 @@ public function resolveResponse( } } - throw new UnsupportedResponseException(sprintf( + throw new LogicException(sprintf( 'The responder %s returned an unsupported response that cannot be resolved.', self::stringifyResponder($responder), )); diff --git a/src/ResponseResolverChainInterface.php b/src/ResponseResolverChainInterface.php index ffa80dfd..e7b2b44a 100644 --- a/src/ResponseResolverChainInterface.php +++ b/src/ResponseResolverChainInterface.php @@ -13,12 +13,12 @@ namespace Sunrise\Http\Router; +use InvalidArgumentException; +use LogicException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use ReflectionFunction; use ReflectionMethod; -use Sunrise\Http\Router\Exception\InvalidResponseException; -use Sunrise\Http\Router\Exception\UnsupportedResponseException; /** * @since 3.0.0 @@ -26,8 +26,8 @@ interface ResponseResolverChainInterface { /** - * @throws InvalidResponseException {@see ResponseResolverInterface::resolveResponse()} - * @throws UnsupportedResponseException + * @throws InvalidArgumentException + * @throws LogicException */ public function resolveResponse( mixed $response, diff --git a/src/ResponseResolverInterface.php b/src/ResponseResolverInterface.php index 3a8e3a47..25c2a858 100644 --- a/src/ResponseResolverInterface.php +++ b/src/ResponseResolverInterface.php @@ -13,11 +13,11 @@ namespace Sunrise\Http\Router; +use InvalidArgumentException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use ReflectionFunction; use ReflectionMethod; -use Sunrise\Http\Router\Exception\InvalidResponseException; /** * @since 3.0.0 @@ -25,7 +25,7 @@ interface ResponseResolverInterface { /** - * @throws InvalidResponseException + * @throws InvalidArgumentException */ public function resolveResponse( mixed $response, diff --git a/src/Router.php b/src/Router.php index f52592b2..c0681911 100644 --- a/src/Router.php +++ b/src/Router.php @@ -13,6 +13,8 @@ namespace Sunrise\Http\Router; +use InvalidArgumentException; +use LogicException; use Psr\EventDispatcher\EventDispatcherInterface; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; @@ -21,20 +23,13 @@ use Sunrise\Http\Router\Event\RoutePreRunEvent; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\HttpExceptionInterface; -use Sunrise\Http\Router\Exception\InvalidReferenceException; -use Sunrise\Http\Router\Exception\InvalidRouteBuildingValueException; -use Sunrise\Http\Router\Exception\InvalidRouteLoadingResourceException; -use Sunrise\Http\Router\Exception\InvalidRouteMatchingPatternException; -use Sunrise\Http\Router\Exception\InvalidRouteMatchingSubjectException; -use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; -use Sunrise\Http\Router\Exception\NoRouteFoundException; -use Sunrise\Http\Router\Exception\NoRoutesRegisteredException; use Sunrise\Http\Router\Helper\RouteBuilder; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Helper\RouteMatcher; use Sunrise\Http\Router\Loader\LoaderInterface; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; use Sunrise\Http\Router\RequestHandler\QueueableRequestHandler; +use UnexpectedValueException; use function array_flip; use function array_keys; @@ -77,10 +72,12 @@ public function __construct( /** * @inheritDoc + * + * @throws InvalidArgumentException */ public function getRoutes(): array { - $this->lazyLoad(); + $this->isLoaded or $this->load(); return $this->routes; } @@ -88,21 +85,23 @@ public function getRoutes(): array /** * @inheritDoc * - * @throws NoRouteFoundException + * @throws InvalidArgumentException */ public function getRoute(string $name): RouteInterface { $routes = $this->getRoutes(); - if (isset($routes[$name])) { - return $routes[$name]; + if (!isset($routes[$name])) { + throw new InvalidArgumentException(sprintf('The route %s does not exist.', $name)); } - throw new NoRouteFoundException(sprintf('The route %s does not exist.', $name)); + return $routes[$name]; } /** * @inheritDoc + * + * @throws InvalidArgumentException */ public function hasRoute(string $name): bool { @@ -113,23 +112,19 @@ public function hasRoute(string $name): bool /** * @inheritDoc + * + * @throws InvalidArgumentException */ public function addRoute(RouteInterface ...$routes): void { foreach ($routes as $route) { - $this->routes[$route->getName()] = $route; - } - } + $name = $route->getName(); - /** - * @inheritDoc - * - * @throws InvalidRouteLoadingResourceException {@see LoaderInterface::load()} - */ - public function load(LoaderInterface ...$loaders): void - { - foreach ($loaders as $loader) { - $this->addRoute(...$loader->load()); + if (isset($this->routes[$name])) { + throw new InvalidArgumentException(sprintf('The route %s already exists.', $name)); + } + + $this->routes[$name] = $route; } } @@ -137,15 +132,15 @@ public function load(LoaderInterface ...$loaders): void * @inheritDoc * * @throws HttpExceptionInterface - * @throws InvalidRouteMatchingPatternException - * @throws InvalidRouteParsingSubjectException - * @throws NoRoutesRegisteredException + * @throws InvalidArgumentException + * @throws LogicException */ public function match(ServerRequestInterface $request): RouteInterface { $routes = $this->getRoutes(); + if ($routes === []) { - throw new NoRoutesRegisteredException('No routes are registered in the router.'); + throw new LogicException('No routes are registered in the router.'); } $requestPath = rawurldecode($request->getUri()->getPath()); @@ -157,7 +152,7 @@ public function match(ServerRequestInterface $request): RouteInterface if (!RouteMatcher::matchPattern($route->getPath(), $this->compileRoute($route), $requestPath, $matches)) { continue; } - } catch (InvalidRouteMatchingSubjectException $e) { + } catch (UnexpectedValueException $e) { throw HttpExceptionFactory::malformedUri(previous: $e); } @@ -169,7 +164,7 @@ public function match(ServerRequestInterface $request): RouteInterface return $route->withAddedAttributes($matches); } - if (!empty($allowedMethods)) { + if ($allowedMethods !== []) { throw HttpExceptionFactory::methodNotAllowed() ->addMessagePlaceholder('{{ request_method }}', $requestMethod) ->addHeaderField('Allow', ...array_keys($allowedMethods)); @@ -183,10 +178,8 @@ public function match(ServerRequestInterface $request): RouteInterface * @inheritDoc * * @throws HttpExceptionInterface - * @throws InvalidReferenceException - * @throws InvalidRouteMatchingPatternException - * @throws InvalidRouteParsingSubjectException - * @throws NoRoutesRegisteredException + * @throws InvalidArgumentException + * @throws LogicException */ public function handle(ServerRequestInterface $request): ResponseInterface { @@ -196,8 +189,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface /** * @inheritDoc * - * @throws InvalidReferenceException - * @throws NoRouteFoundException + * @throws InvalidArgumentException */ public function runRoute(RouteInterface|string $route, ServerRequestInterface $request): ResponseInterface { @@ -211,7 +203,7 @@ public function runRoute(RouteInterface|string $route, ServerRequestInterface $r $request = $request->withAttribute(RouteInterface::class, $route); - if (isset($this->eventDispatcher)) { + if ($this->eventDispatcher !== null) { $event = new RoutePreRunEvent($route, $request); $this->eventDispatcher->dispatch($event); $request = $event->getRequest(); @@ -219,7 +211,7 @@ public function runRoute(RouteInterface|string $route, ServerRequestInterface $r $response = $this->getRouteRequestHandler($route)->handle($request); - if (isset($this->eventDispatcher)) { + if ($this->eventDispatcher !== null) { $event = new RoutePostRunEvent($route, $request, $response); $this->eventDispatcher->dispatch($event); $response = $event->getResponse(); @@ -231,9 +223,7 @@ public function runRoute(RouteInterface|string $route, ServerRequestInterface $r /** * @inheritDoc * - * @throws InvalidRouteBuildingValueException - * @throws InvalidRouteParsingSubjectException - * @throws NoRouteFoundException + * @throws InvalidArgumentException */ public function buildRoute(RouteInterface|string $route, array $values = [], bool $strictly = false): string { @@ -244,7 +234,7 @@ public function buildRoute(RouteInterface|string $route, array $values = [], boo $result = RouteBuilder::buildRoute($route->getPath(), $values + $route->getAttributes()); if ($strictly && !RouteMatcher::matchPattern($route->getPath(), $this->compileRoute($route), $result)) { - throw new InvalidRouteBuildingValueException(sprintf( + throw new InvalidArgumentException(sprintf( 'The route %s could not be built because one of the values does not match its pattern.', $route->getName(), )); @@ -256,8 +246,7 @@ public function buildRoute(RouteInterface|string $route, array $values = [], boo /** * @inheritDoc * - * @throws InvalidRouteParsingSubjectException - * @throws NoRouteFoundException + * @throws InvalidArgumentException */ public function compileRoute(RouteInterface|string $route): string { @@ -271,8 +260,7 @@ public function compileRoute(RouteInterface|string $route): string /** * @inheritDoc * - * @throws InvalidReferenceException - * @throws NoRouteFoundException + * @throws InvalidArgumentException */ public function getRouteRequestHandler(RouteInterface|string $route): RequestHandlerInterface { @@ -288,7 +276,7 @@ public function getRouteRequestHandler(RouteInterface|string $route): RequestHan $this->routeRequestHandlers[$name] = $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()); $middlewares = array_merge($this->routeMiddlewares, $route->getMiddlewares()); - if (!empty($middlewares)) { + if ($middlewares !== []) { $this->routeRequestHandlers[$name] = new QueueableRequestHandler($this->routeRequestHandlers[$name]); foreach ($middlewares as $middleware) { $this->routeRequestHandlers[$name]->enqueue( @@ -301,23 +289,22 @@ public function getRouteRequestHandler(RouteInterface|string $route): RequestHan } /** - * @throws InvalidReferenceException + * @throws InvalidArgumentException * * @since 3.0.0 */ private function getRequestHandler(): RequestHandlerInterface { - if (isset($this->requestHandler)) { + if ($this->requestHandler !== null) { return $this->requestHandler; } $this->requestHandler = new CallableRequestHandler( - fn(ServerRequestInterface $request): ResponseInterface => ( - $this->runRoute($this->match($request), $request) - ) + fn(ServerRequestInterface $request): ResponseInterface + => $this->runRoute($this->match($request), $request) ); - if (!empty($this->middlewares)) { + if ($this->middlewares !== []) { $this->requestHandler = new QueueableRequestHandler($this->requestHandler); foreach ($this->middlewares as $middleware) { $this->requestHandler->enqueue( @@ -329,14 +316,15 @@ private function getRequestHandler(): RequestHandlerInterface return $this->requestHandler; } - private function lazyLoad(): void + /** + * @throws InvalidArgumentException + * + * @since 3.0.0 The method was removed from the contract. + */ + private function load(): void { - if ($this->isLoaded) { - return; - } - foreach ($this->loaders as $loader) { - $this->load($loader); + $this->addRoute(...$loader->load()); } $this->isLoaded = true; diff --git a/src/RouterInterface.php b/src/RouterInterface.php index 62248b39..3318bb34 100644 --- a/src/RouterInterface.php +++ b/src/RouterInterface.php @@ -13,14 +13,11 @@ namespace Sunrise\Http\Router; +use InvalidArgumentException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; use Sunrise\Http\Router\Exception\HttpExceptionInterface; -use Sunrise\Http\Router\Exception\InvalidRouteLoadingResourceException; -use Sunrise\Http\Router\Exception\NoRouteFoundException; -use Sunrise\Http\Router\Exception\NoRoutesRegisteredException; -use Sunrise\Http\Router\Loader\LoaderInterface; /** * @since 3.0.0 @@ -35,7 +32,7 @@ interface RouterInterface extends RequestHandlerInterface public function getRoutes(): array; /** - * @throws NoRouteFoundException + * @throws InvalidArgumentException * * @since 2.0.0 */ @@ -48,19 +45,13 @@ public function hasRoute(string $name): bool; /** * @since 1.0.0 - */ - public function addRoute(RouteInterface ...$routes): void; - - /** - * @since 2.0.0 * - * @throws InvalidRouteLoadingResourceException {@see LoaderInterface::load()} + * @throws InvalidArgumentException */ - public function load(LoaderInterface ...$loaders): void; + public function addRoute(RouteInterface ...$routes): void; /** * @throws HttpExceptionInterface - * @throws NoRoutesRegisteredException * * @since 1.0.0 */ @@ -70,21 +61,20 @@ public function match(ServerRequestInterface $request): RouteInterface; * @inheritDoc * * @throws HttpExceptionInterface - * @throws NoRoutesRegisteredException * * @since 1.0.0 */ public function handle(ServerRequestInterface $request): ResponseInterface; /** - * @throws NoRouteFoundException + * @throws InvalidArgumentException * * @since 3.0.0 */ public function runRoute(RouteInterface|string $route, ServerRequestInterface $request): ResponseInterface; /** - * @throws NoRouteFoundException + * @throws InvalidArgumentException * * @since 3.0.0 */ @@ -93,14 +83,14 @@ public function buildRoute(RouteInterface|string $route, array $values = []): st /** * @return non-empty-string * - * @throws NoRouteFoundException + * @throws InvalidArgumentException * * @since 3.0.0 */ public function compileRoute(RouteInterface|string $route): string; /** - * @throws NoRouteFoundException + * @throws InvalidArgumentException * * @since 3.0.0 */ diff --git a/src/ServerRequest.php b/src/ServerRequest.php index d9cf8e03..81a6c76c 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -390,16 +390,12 @@ public function getQueryParams(): array public function hasQueryParam(string $name): bool { - $params = $this->request->getQueryParams(); - - return isset($params[$name]); + return isset($this->request->getQueryParams()[$name]); } public function getQueryParam(string $name, mixed $default = null): mixed { - $params = $this->request->getQueryParams(); - - return $params[$name] ?? $default; + return $this->request->getQueryParams()[$name] ?? $default; } /** @@ -423,16 +419,12 @@ public function getCookieParams(): array public function hasCookieParam(string $name): bool { - $params = $this->request->getCookieParams(); - - return isset($params[$name]); + return isset($this->request->getCookieParams()[$name]); } public function getCookieParam(string $name, mixed $default = null): mixed { - $params = $this->request->getCookieParams(); - - return $params[$name] ?? $default; + return $this->request->getCookieParams()[$name] ?? $default; } /** diff --git a/tests/Unit/Entity/MediaType/ServerMediaTypeTest.php b/tests/Unit/Entity/MediaType/ServerMediaTypeTest.php index adab10d9..5e95ce1c 100644 --- a/tests/Unit/Entity/MediaType/ServerMediaTypeTest.php +++ b/tests/Unit/Entity/MediaType/ServerMediaTypeTest.php @@ -17,54 +17,10 @@ public function testConstructor(): void $this->assertSame('json', $mediaType->getSubtype()); } - /** - * @dataProvider fromStringProvider - */ - public function testFromString(string $string, string $expectedType, string $expectedSubtype): void - { - $mediaType = ServerMediaType::fromString($string); - - $this->assertSame($expectedType, $mediaType->getType()); - $this->assertSame($expectedSubtype, $mediaType->getSubtype()); - } - public function testToString(): void { $mediaType = new ServerMediaType('application', 'json'); $this->assertSame('application/json', (string) $mediaType); } - - private function fromStringProvider(): iterable - { - yield [ - '', - '*', - '*', - ]; - - yield [ - '*', - '*', - '*', - ]; - - yield [ - '*/*', - '*', - '*', - ]; - - yield [ - 'image', - 'image', - '*', - ]; - - yield [ - 'application/json', - 'application', - 'json', - ]; - } } diff --git a/tests/Unit/Helper/RouteParserTest.php b/tests/Unit/Helper/RouteParserTest.php index 89e651d8..8fabab36 100644 --- a/tests/Unit/Helper/RouteParserTest.php +++ b/tests/Unit/Helper/RouteParserTest.php @@ -4,8 +4,8 @@ namespace Sunrise\Http\Router\Tests\Unit\Helper; +use InvalidArgumentException; use PHPUnit\Framework\TestCase; -use Sunrise\Http\Router\Exception\InvalidRouteParsingSubjectException; use Sunrise\Http\Router\Helper\RouteParser; final class RouteParserTest extends TestCase @@ -25,7 +25,7 @@ public function testParseValidRoute(string $route, array $expectedVariables): vo */ public function testParseInvalidRoute(string $route, string $expectedMessageRegex): void { - $this->expectException(InvalidRouteParsingSubjectException::class); + $this->expectException(InvalidArgumentException::class); $this->expectExceptionMessageMatches($expectedMessageRegex); RouteParser::parseRoute($route); From 564e5b00fc16b787242c94669fb66190e62f5d2d Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 25 Oct 2024 23:44:01 +0200 Subject: [PATCH 160/180] v3 --- src/Annotation/PatternAsciiSlug.php | 29 +++++++++++++++++++++++++++ src/Annotation/PatternPositiveInt.php | 29 +++++++++++++++++++++++++++ src/Dictionary/VariablePattern.php | 2 ++ 3 files changed, 60 insertions(+) create mode 100644 src/Annotation/PatternAsciiSlug.php create mode 100644 src/Annotation/PatternPositiveInt.php diff --git a/src/Annotation/PatternAsciiSlug.php b/src/Annotation/PatternAsciiSlug.php new file mode 100644 index 00000000..07fd6334 --- /dev/null +++ b/src/Annotation/PatternAsciiSlug.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; +use Sunrise\Http\Router\Dictionary\VariablePattern; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class PatternAsciiSlug extends Pattern +{ + public function __construct(string $variableName) + { + parent::__construct($variableName, VariablePattern::ASCII_SLUG); + } +} diff --git a/src/Annotation/PatternPositiveInt.php b/src/Annotation/PatternPositiveInt.php new file mode 100644 index 00000000..1fbf4964 --- /dev/null +++ b/src/Annotation/PatternPositiveInt.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; +use Sunrise\Http\Router\Dictionary\VariablePattern; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class PatternPositiveInt extends Pattern +{ + public function __construct(string $variableName) + { + parent::__construct($variableName, VariablePattern::POSITIVE_INT); + } +} diff --git a/src/Dictionary/VariablePattern.php b/src/Dictionary/VariablePattern.php index 69532fff..1b499de5 100644 --- a/src/Dictionary/VariablePattern.php +++ b/src/Dictionary/VariablePattern.php @@ -18,5 +18,7 @@ */ final class VariablePattern { + public const POSITIVE_INT = '[0-9]+'; + public const ASCII_SLUG = '[0-9A-Za-z]+(?:-[0-9A-Za-z]+)*'; public const UUID = '[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}'; } From c3ecd037efa0bc6e77901be3d86bd06bbc88201c Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 26 Oct 2024 03:12:19 +0200 Subject: [PATCH 161/180] v3 --- src/Annotation/Path.php | 28 ++++++++ src/Annotation/PathHome.php | 28 ++++++++ src/Loader/DescriptorLoader.php | 8 +++ .../WhitespaceTrimmingMiddleware.php | 68 +++++++++++++++++++ 4 files changed, 132 insertions(+) create mode 100644 src/Annotation/Path.php create mode 100644 src/Annotation/PathHome.php create mode 100644 src/Middleware/WhitespaceTrimmingMiddleware.php diff --git a/src/Annotation/Path.php b/src/Annotation/Path.php new file mode 100644 index 00000000..bb827434 --- /dev/null +++ b/src/Annotation/Path.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] +class Path +{ + public function __construct( + public readonly string $value, + ) { + } +} diff --git a/src/Annotation/PathHome.php b/src/Annotation/PathHome.php new file mode 100644 index 00000000..958270fd --- /dev/null +++ b/src/Annotation/PathHome.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] +final class PathHome extends Path +{ + public function __construct() + { + parent::__construct('/'); + } +} diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index d9423b03..1971ac79 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -30,6 +30,7 @@ use Sunrise\Http\Router\Annotation\Method; use Sunrise\Http\Router\Annotation\Middleware; use Sunrise\Http\Router\Annotation\NamePrefix; +use Sunrise\Http\Router\Annotation\Path; use Sunrise\Http\Router\Annotation\PathPostfix; use Sunrise\Http\Router\Annotation\PathPrefix; use Sunrise\Http\Router\Annotation\Pattern; @@ -220,6 +221,13 @@ private static function enrichDescriptorFromClassOrMethod(Descriptor $descriptor $descriptor->namePrefixes[] = $annotation->value; } + /** @var list> $annotations */ + $annotations = $classOrMethod->getAttributes(Path::class, ReflectionAttribute::IS_INSTANCEOF); + if (isset($annotations[0])) { + $annotation = $annotations[0]->newInstance(); + $descriptor->path = $annotation->value; + } + /** @var list> $annotations */ $annotations = $classOrMethod->getAttributes(PathPrefix::class); if (isset($annotations[0])) { diff --git a/src/Middleware/WhitespaceTrimmingMiddleware.php b/src/Middleware/WhitespaceTrimmingMiddleware.php new file mode 100644 index 00000000..66a3d9ef --- /dev/null +++ b/src/Middleware/WhitespaceTrimmingMiddleware.php @@ -0,0 +1,68 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Middleware; + +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; +use Psr\Http\Server\MiddlewareInterface; +use Psr\Http\Server\RequestHandlerInterface; + +use function array_walk_recursive; +use function is_array; +use function is_string; +use function trim; + +/** + * @since 3.0.0 + */ +final class WhitespaceTrimmingMiddleware implements MiddlewareInterface +{ + /** + * @var callable + * + * @readonly + */ + private $walker; + + /** + * @param null|callable(string):string $trimmer + */ + public function __construct(?callable $trimmer) + { + $trimmer ??= trim(...); + + $this->walker = static function (mixed &$value) use ($trimmer): void { + if (is_string($value)) { + $value = $trimmer($value); + } + }; + } + + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + $parsedBody = $request->getParsedBody(); + if ($parsedBody !== [] && is_array($parsedBody)) { + array_walk_recursive($parsedBody, $this->walker); + $request = $request->withParsedBody($parsedBody); + } + + $queryParams = $request->getQueryParams(); + if ($queryParams !== []) { + array_walk_recursive($queryParams, $this->walker); + $request = $request->withQueryParams($queryParams); + } + + return $handler->handle($request); + } +} From 6f1d40b56dabf7b44ee804328f5007cfd6dd51da Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 26 Oct 2024 03:14:40 +0200 Subject: [PATCH 162/180] v3 --- src/Middleware/WhitespaceTrimmingMiddleware.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Middleware/WhitespaceTrimmingMiddleware.php b/src/Middleware/WhitespaceTrimmingMiddleware.php index 66a3d9ef..98740297 100644 --- a/src/Middleware/WhitespaceTrimmingMiddleware.php +++ b/src/Middleware/WhitespaceTrimmingMiddleware.php @@ -38,7 +38,7 @@ final class WhitespaceTrimmingMiddleware implements MiddlewareInterface /** * @param null|callable(string):string $trimmer */ - public function __construct(?callable $trimmer) + public function __construct(?callable $trimmer = null) { $trimmer ??= trim(...); From b6ad278b64399c0aadb69c7d3766294d16dc12e7 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 31 Oct 2024 22:14:35 +0100 Subject: [PATCH 163/180] v3 --- .scrutinizer.yml | 11 +-- composer.json | 33 +++----- psalm.xml.dist | 4 +- src/Annotation/Consumes.php | 2 +- src/Annotation/ConsumesImage.php | 4 +- src/Annotation/ConsumesJson.php | 4 +- src/Annotation/ConsumesXml.php | 4 +- src/Annotation/ProducesHtml.php | 4 +- src/Annotation/ProducesJson.php | 4 +- src/Annotation/ProducesText.php | 4 +- src/Annotation/ProducesXml.php | 4 +- .../Language/LanguageComparatorInterface.php | 3 + src/Entity/MediaType/MediaTypeComparator.php | 11 ++- .../MediaTypeComparatorInterface.php | 3 + ...Factory.php => ServerMediaTypeFactory.php} | 44 ++++++++--- src/Helper/ClassFinder.php | 13 +++- src/Helper/HeaderParser.php | 2 + src/Helper/RouteBuilder.php | 3 + src/Helper/RouteMatcher.php | 2 + src/Helper/RouteParser.php | 3 +- src/Loader/DescriptorLoader.php | 27 ++++--- src/Middleware/CallableMiddleware.php | 6 +- .../JsonPayloadDecodingMiddleware.php | 6 +- .../WhitespaceTrimmingMiddleware.php | 2 +- src/MiddlewareResolver.php | 49 ++++++------ .../RequestBodyParameterResolver.php | 4 +- .../RequestCookieParameterResolver.php | 1 + .../RequestHeaderParameterResolver.php | 1 + .../RequestQueryParameterResolver.php | 4 +- .../RequestVariableParameterResolver.php | 1 + src/RequestHandler/CallableRequestHandler.php | 8 +- src/RequestHandlerResolver.php | 44 ++++++----- src/ResponseResolver/JsonResponseResolver.php | 2 +- src/Route.php | 1 + src/Router.php | 22 +++--- src/RouterInterface.php | 2 + src/ServerRequest.php | 75 +++++++++++++++---- src/Validation/ConstraintViolation.php | 10 +++ .../HydratorConstraintViolationAdapter.php | 8 ++ .../ValidatorConstraintViolationAdapter.php | 10 ++- .../ConstraintViolationInterface.php | 5 ++ 41 files changed, 286 insertions(+), 164 deletions(-) rename src/Entity/MediaType/{MediaTypeFactory.php => ServerMediaTypeFactory.php} (52%) diff --git a/.scrutinizer.yml b/.scrutinizer.yml index a4b33801..6f32340f 100644 --- a/.scrutinizer.yml +++ b/.scrutinizer.yml @@ -3,26 +3,19 @@ build: nodes: analysis: environment: - php: 8.3 + php: 8.2 tests: override: - php-scrutinizer-run coverage: environment: - php: 8.3 + php: 8.2 tests: override: - command: XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-clover coverage.xml coverage: file: coverage.xml format: clover - php82: - environment: - php: 8.2 - tests: - override: - - command: php vendor/bin/phpunit - php81: environment: php: 8.1 diff --git a/composer.json b/composer.json index 09333ab8..40f7e585 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,7 @@ { "name": "sunrise/http-router", "homepage": "https://github.com/sunrise-php/http-router", - "description": "HTTP router for PHP 7.4+ based on PSR-7 and PSR-15 with support for annotations/attributes and OpenAPI (Swagger) Specification", + "description": "HTTP router for PHP 8.1+ based on PSR-7 and PSR-15 with support for attributes and Swagger", "license": "MIT", "keywords": [ "fenric", @@ -10,13 +10,11 @@ "router", "request-handler", "middlewares", - "annotations", "attributes", "openapi", "swagger", "psr-7", "psr-15", - "php7", "php8" ], "authors": [ @@ -31,33 +29,22 @@ "fig/http-message-util": "^1.1", "psr/container": "^1.0 || ^2.0", "psr/event-dispatcher": "^1.0", - "psr/http-message": "^1.0 || ^2.0", + "psr/http-factory": "^1.0", + "psr/http-message": "^1.0", "psr/http-server-handler": "^1.0", "psr/http-server-middleware": "^1.0", "psr/log": "^1.0 || ^2.0 || ^3.0", "psr/simple-cache": "^1.0 || ^2.0 || ^3.0" }, "require-dev": { + "php-di/php-di": "^7.0", + "phpstan/phpstan": "^1.12", "phpunit/phpunit": "^9.6", - "vimeo/psalm": "^5.15", "sunrise/coding-standard": "^1.0", - "sunrise/http-message": "^3.0", - "sunrise/hydrator": "^3.7", - "symfony/console": "^6.0", - "symfony/validator": "^6.0", - "monolog/monolog": "^2.9", - "doctrine/persistence": "^3.2", - "filp/whoops": "^2.15", - "symfony/event-dispatcher": "^6.0", - "symfony/serializer": "^6.0", - "twig/twig": "^3.7", - "symfony/property-access": "^6.0", - "doctrine/dbal": "^3.7", - "doctrine/orm": "^2.16", - "symfony/uid": "^6.0", - "ramsey/uuid": "^4.7", - "neomerx/cors-psr7": "^3.0", - "php-di/php-di": "^7.0" + "sunrise/hydrator": "^3.13", + "symfony/console": "^6.4", + "symfony/validator": "^6.4", + "vimeo/psalm": "^5.26" }, "autoload": { "files": [ @@ -76,7 +63,7 @@ "test": [ "phpcs --colors", "psalm --no-cache", - "phpstan analyse src --level=5 --memory-limit=-1", + "phpstan analyse src --level=9 --memory-limit=-1", "XDEBUG_MODE=coverage phpunit --coverage-text --colors=always" ], "build": [ diff --git a/psalm.xml.dist b/psalm.xml.dist index dfaf4f2f..3fe0c565 100644 --- a/psalm.xml.dist +++ b/psalm.xml.dist @@ -4,7 +4,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://getpsalm.org/schema/config" xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd" - phpVersion="8.2" + phpVersion="8.1" > @@ -14,8 +14,6 @@ - - diff --git a/src/Annotation/Consumes.php b/src/Annotation/Consumes.php index e14359c8..91554e45 100644 --- a/src/Annotation/Consumes.php +++ b/src/Annotation/Consumes.php @@ -23,7 +23,7 @@ class Consumes { public function __construct( - public readonly string|MediaTypeInterface $value, + public readonly MediaTypeInterface $value, ) { } } diff --git a/src/Annotation/ConsumesImage.php b/src/Annotation/ConsumesImage.php index 5b421104..7de292e2 100644 --- a/src/Annotation/ConsumesImage.php +++ b/src/Annotation/ConsumesImage.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ConsumesImage extends Consumes { public function __construct() { - parent::__construct(MediaTypeFactory::image()); + parent::__construct(ServerMediaTypeFactory::image()); } } diff --git a/src/Annotation/ConsumesJson.php b/src/Annotation/ConsumesJson.php index 3524279d..3d95c027 100644 --- a/src/Annotation/ConsumesJson.php +++ b/src/Annotation/ConsumesJson.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ConsumesJson extends Consumes { public function __construct() { - parent::__construct(MediaTypeFactory::json()); + parent::__construct(ServerMediaTypeFactory::json()); } } diff --git a/src/Annotation/ConsumesXml.php b/src/Annotation/ConsumesXml.php index c810ee07..645f5c23 100644 --- a/src/Annotation/ConsumesXml.php +++ b/src/Annotation/ConsumesXml.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ConsumesXml extends Consumes { public function __construct() { - parent::__construct(MediaTypeFactory::xml()); + parent::__construct(ServerMediaTypeFactory::xml()); } } diff --git a/src/Annotation/ProducesHtml.php b/src/Annotation/ProducesHtml.php index ce98ca05..76900667 100644 --- a/src/Annotation/ProducesHtml.php +++ b/src/Annotation/ProducesHtml.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ProducesHtml extends Produces { public function __construct() { - parent::__construct(MediaTypeFactory::html()); + parent::__construct(ServerMediaTypeFactory::html()); } } diff --git a/src/Annotation/ProducesJson.php b/src/Annotation/ProducesJson.php index 356ac287..324a59b2 100644 --- a/src/Annotation/ProducesJson.php +++ b/src/Annotation/ProducesJson.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ProducesJson extends Produces { public function __construct() { - parent::__construct(MediaTypeFactory::json()); + parent::__construct(ServerMediaTypeFactory::json()); } } diff --git a/src/Annotation/ProducesText.php b/src/Annotation/ProducesText.php index 4c3048f2..a40ab739 100644 --- a/src/Annotation/ProducesText.php +++ b/src/Annotation/ProducesText.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ProducesText extends Produces { public function __construct() { - parent::__construct(MediaTypeFactory::text()); + parent::__construct(ServerMediaTypeFactory::text()); } } diff --git a/src/Annotation/ProducesXml.php b/src/Annotation/ProducesXml.php index 5b4c9dd5..622410cd 100644 --- a/src/Annotation/ProducesXml.php +++ b/src/Annotation/ProducesXml.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ProducesXml extends Produces { public function __construct() { - parent::__construct(MediaTypeFactory::xml()); + parent::__construct(ServerMediaTypeFactory::xml()); } } diff --git a/src/Entity/Language/LanguageComparatorInterface.php b/src/Entity/Language/LanguageComparatorInterface.php index 293a5f27..0a269412 100644 --- a/src/Entity/Language/LanguageComparatorInterface.php +++ b/src/Entity/Language/LanguageComparatorInterface.php @@ -18,5 +18,8 @@ */ interface LanguageComparatorInterface { + /** + * @return int<-1, 1> + */ public function compare(LanguageInterface $a, LanguageInterface $b): int; } diff --git a/src/Entity/MediaType/MediaTypeComparator.php b/src/Entity/MediaType/MediaTypeComparator.php index 25ec94e3..c84cb116 100644 --- a/src/Entity/MediaType/MediaTypeComparator.php +++ b/src/Entity/MediaType/MediaTypeComparator.php @@ -13,18 +13,23 @@ namespace Sunrise\Http\Router\Entity\MediaType; +use function strcasecmp; + /** * @since 3.0.0 */ final class MediaTypeComparator implements MediaTypeComparatorInterface { + /** + * @link https://datatracker.ietf.org/doc/html/rfc2045#section-5.1 + */ public function compare(MediaTypeInterface $a, MediaTypeInterface $b): int { - if (($a->getType() === $b->getType() || $a->getType() === '*' || $b->getType() === '*') && - ($a->getSubtype() === $b->getSubtype() || $a->getSubtype() === '*' || $b->getSubtype() === '*')) { + if (($a->getType() === '*' || $b->getType() === '*' || strcasecmp($a->getType(), $b->getType()) === 0) && + ($a->getSubtype() === '*' || $b->getSubtype() === '*' || strcasecmp($a->getSubtype(), $b->getSubtype()) === 0)) { return 0; } - return $a->__toString() <=> $b->__toString(); + return strcasecmp($a->__toString(), $b->__toString()) < 0 ? -1 : 1; } } diff --git a/src/Entity/MediaType/MediaTypeComparatorInterface.php b/src/Entity/MediaType/MediaTypeComparatorInterface.php index ff89facb..3380a7fe 100644 --- a/src/Entity/MediaType/MediaTypeComparatorInterface.php +++ b/src/Entity/MediaType/MediaTypeComparatorInterface.php @@ -18,5 +18,8 @@ */ interface MediaTypeComparatorInterface { + /** + * @return int<-1, 1> + */ public function compare(MediaTypeInterface $a, MediaTypeInterface $b): int; } diff --git a/src/Entity/MediaType/MediaTypeFactory.php b/src/Entity/MediaType/ServerMediaTypeFactory.php similarity index 52% rename from src/Entity/MediaType/MediaTypeFactory.php rename to src/Entity/MediaType/ServerMediaTypeFactory.php index 92b9ddfc..57eea54d 100644 --- a/src/Entity/MediaType/MediaTypeFactory.php +++ b/src/Entity/MediaType/ServerMediaTypeFactory.php @@ -13,13 +13,43 @@ namespace Sunrise\Http\Router\Entity\MediaType; -use function explode; +use InvalidArgumentException; + +use function preg_match; +use function sprintf; /** * @since 3.0.0 */ -final class MediaTypeFactory +final class ServerMediaTypeFactory { + /** + * @throws InvalidArgumentException See {@see fromString()}. + */ + public static function create(MediaTypeInterface|string $mediaType): MediaTypeInterface + { + if ($mediaType instanceof MediaTypeInterface) { + return $mediaType; + } + + return self::fromString($mediaType); + } + + /** + * @throws InvalidArgumentException If the given media type doesn't look like a media type. + */ + public static function fromString(string $mediaType): MediaTypeInterface + { + if (!preg_match('|^([^/;]+)/([^/;]+)$|', $mediaType, $matches)) { + throw new InvalidArgumentException(sprintf( + 'The string %s does not look like a media type.', + $mediaType, + )); + } + + return new ServerMediaType($matches[1], $matches[2]); + } + public static function json(): MediaTypeInterface { return new ServerMediaType('application', 'json'); @@ -44,14 +74,4 @@ public static function image(): MediaTypeInterface { return new ServerMediaType('image', '*'); } - - public static function fromString(string $string): MediaTypeInterface - { - $parts = explode(MediaTypeInterface::SEPARATOR, $string, 2); - - return new ServerMediaType( - type: isset($parts[0][0]) ? $parts[0] : '*', - subtype: isset($parts[1][0]) ? $parts[1] : '*', - ); - } } diff --git a/src/Helper/ClassFinder.php b/src/Helper/ClassFinder.php index f79b2f6e..468405ab 100644 --- a/src/Helper/ClassFinder.php +++ b/src/Helper/ClassFinder.php @@ -35,7 +35,7 @@ final class ClassFinder { /** - * @return Generator + * @return Generator> * * @throws InvalidArgumentException * @throws ReflectionException @@ -55,6 +55,7 @@ public static function getDirClasses(string $dirname): Generator $filenames[$file->getRealPath()] = true; (static function (string $filename): void { + /** @psalm-suppress UnresolvableInclude */ require_once $filename; })($file->getRealPath()); } @@ -68,7 +69,7 @@ public static function getDirClasses(string $dirname): Generator } /** - * @return Generator + * @return Generator> * * @throws InvalidArgumentException * @throws ReflectionException @@ -79,9 +80,11 @@ public static function getFileClasses(string $filename): Generator throw new InvalidArgumentException(sprintf('The file %s does not exist.', $filename)); } + /** @var string $filename */ $filename = realpath($filename); (static function (string $filename): void { + /** @psalm-suppress UnresolvableInclude */ require_once $filename; })($filename); @@ -94,11 +97,13 @@ public static function getFileClasses(string $filename): Generator } /** - * @return SplStack + * @param ReflectionClass $class + * + * @return SplStack> */ public static function getParentClasses(ReflectionClass $class): SplStack { - /** @var SplStack $parents */ + /** @var SplStack> $parents */ $parents = new SplStack(); while ($class = $class->getParentClass()) { $parents->push($class); diff --git a/src/Helper/HeaderParser.php b/src/Helper/HeaderParser.php index 70645203..0f2bd051 100644 --- a/src/Helper/HeaderParser.php +++ b/src/Helper/HeaderParser.php @@ -40,6 +40,8 @@ public static function parseHeader(string $header): array $cursor = self::IN_IDENTIFIER; $value = 0; $param = -1; + + /** @var array, array{0?: string, 1?: array, array{0?: string, 1?: string}>}> $values */ $values = []; for ($offset = 0; isset($header[$offset]) && $offset < 1024; $offset++) { diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index a6d7b406..97603e59 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -30,6 +30,8 @@ final class RouteBuilder { /** + * @param array $values + * * @throws InvalidArgumentException */ public static function buildRoute(string $route, array $values = []): string @@ -42,6 +44,7 @@ public static function buildRoute(string $route, array $values = []): string $statement = substr($route, $variable['offset'], $variable['length']); if (isset($values[$variable['name']])) { + /** @var mixed $value */ $value = $values[$variable['name']]; try { diff --git a/src/Helper/RouteMatcher.php b/src/Helper/RouteMatcher.php index 5c2c384c..dd22f850 100644 --- a/src/Helper/RouteMatcher.php +++ b/src/Helper/RouteMatcher.php @@ -35,6 +35,7 @@ final class RouteMatcher { /** * @param array $patterns + * @param ?array $matches * @param-out array $matches * * @throws InvalidArgumentException @@ -49,6 +50,7 @@ public static function matchRoute(string $route, array $patterns, string $subjec /** * @param non-empty-string $pattern + * @param ?array $matches * @param-out array $matches * * @throws InvalidArgumentException diff --git a/src/Helper/RouteParser.php b/src/Helper/RouteParser.php index 87701e08..d42e53fc 100644 --- a/src/Helper/RouteParser.php +++ b/src/Helper/RouteParser.php @@ -40,6 +40,8 @@ public static function parseRoute(string $route): array { $cursor = 0; $variable = -1; + + /** @var list $variables */ $variables = []; $left = $right = ''; @@ -132,7 +134,6 @@ public static function parseRoute(string $route): array } $cursor &= ~(self::IN_VARIABLE | self::IN_VARIABLE_NAME); - /** @psalm-suppress PossiblyUndefinedArrayOffset */ $variables[$variable]['length'] = $offset - $variables[$variable]['offset'] + 1; continue; } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 1971ac79..cfefef9f 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -40,17 +40,18 @@ use Sunrise\Http\Router\Annotation\Summary; use Sunrise\Http\Router\Annotation\Tag; use Sunrise\Http\Router\Dictionary\CacheKey; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; use Sunrise\Http\Router\Helper\ClassFinder; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Route; +use function array_map; use function class_exists; use function is_dir; use function is_file; -use function is_string; use function join; use function sprintf; +use function strtoupper; use function usort; /** @@ -163,6 +164,8 @@ private static function getResourceDescriptors(string $resource): Generator } /** + * @param ReflectionClass $class + * * @return Generator * * @throws InvalidArgumentException @@ -205,6 +208,9 @@ private static function getClassDescriptors(ReflectionClass $class): Generator } } + /** + * @param ReflectionClass $class + */ private static function enrichDescriptorFromParentClasses(Descriptor $descriptor, ReflectionClass $class): void { foreach (ClassFinder::getParentClasses($class) as $parent) { @@ -212,6 +218,11 @@ private static function enrichDescriptorFromParentClasses(Descriptor $descriptor } } + /** + * @param ReflectionClass|ReflectionMethod $classOrMethod + * + * @throws InvalidArgumentException + */ private static function enrichDescriptorFromClassOrMethod(Descriptor $descriptor, ReflectionClass|ReflectionMethod $classOrMethod): void { /** @var list> $annotations */ @@ -281,20 +292,14 @@ private static function enrichDescriptorFromClassOrMethod(Descriptor $descriptor $annotations = $classOrMethod->getAttributes(Consumes::class, ReflectionAttribute::IS_INSTANCEOF); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - - $descriptor->consumes[] = is_string($annotation->value) ? - MediaTypeFactory::fromString($annotation->value) : - $annotation->value; + $descriptor->consumes[] = ServerMediaTypeFactory::create($annotation->value); } /** @var list> $annotations */ $annotations = $classOrMethod->getAttributes(Produces::class, ReflectionAttribute::IS_INSTANCEOF); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - - $descriptor->produces[] = is_string($annotation->value) ? - MediaTypeFactory::fromString($annotation->value) : - $annotation->value; + $descriptor->produces[] = ServerMediaTypeFactory::create($annotation->value); } /** @var list> $annotations */ @@ -340,6 +345,8 @@ private static function completeDescriptor(Descriptor $descriptor): void $descriptor->name = join($descriptor->namePrefixes) . $descriptor->name; $descriptor->path = join($descriptor->pathPrefixes) . $descriptor->path; + $descriptor->methods = array_map(strtoupper(...), $descriptor->methods); + $descriptor->pattern = RouteCompiler::compileRoute($descriptor->path, $descriptor->patterns); } } diff --git a/src/Middleware/CallableMiddleware.php b/src/Middleware/CallableMiddleware.php index 1a68543b..e6c65b06 100644 --- a/src/Middleware/CallableMiddleware.php +++ b/src/Middleware/CallableMiddleware.php @@ -20,20 +20,18 @@ /** * @since 2.8.0 - * - * @template T as callable(ServerRequestInterface=, RequestHandlerInterface=): ResponseInterface */ final class CallableMiddleware implements MiddlewareInterface { /** - * @var T + * @var callable(ServerRequestInterface, RequestHandlerInterface): ResponseInterface * * @readonly */ private $callback; /** - * @param T $callback + * @param callable(ServerRequestInterface, RequestHandlerInterface): ResponseInterface $callback */ public function __construct(callable $callback) { diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 1af66e79..0ded8d43 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -18,7 +18,7 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ServerRequest; @@ -57,7 +57,7 @@ public function __construct( */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if (ServerRequest::create($request)->clientProducesMediaType(MediaTypeFactory::json())) { + if (ServerRequest::create($request)->clientProducesMediaType(ServerMediaTypeFactory::json())) { $request = $request->withParsedBody($this->decodePayload((string) $request->getBody())); } @@ -76,10 +76,10 @@ private function decodePayload(string $payload): array } $decodingFlags = $this->decodingFlags ?? self::DEFAULT_DECODING_FLAGS; + /** @psalm-var int<1, 2147483647> $decodingDepth */ $decodingDepth = $this->decodingDepth ?? self::DEFAULT_DECODING_DEPTH; try { - /** @psalm-suppress ArgumentTypeCoercion */ $data = json_decode($payload, true, $decodingDepth, $decodingFlags | JSON_THROW_ON_ERROR); } catch (JsonException $e) { throw HttpExceptionFactory::invalidJsonPayload($this->errorMessage, $this->errorStatusCode, previous: $e); diff --git a/src/Middleware/WhitespaceTrimmingMiddleware.php b/src/Middleware/WhitespaceTrimmingMiddleware.php index 98740297..13e41b60 100644 --- a/src/Middleware/WhitespaceTrimmingMiddleware.php +++ b/src/Middleware/WhitespaceTrimmingMiddleware.php @@ -36,7 +36,7 @@ final class WhitespaceTrimmingMiddleware implements MiddlewareInterface private $walker; /** - * @param null|callable(string):string $trimmer + * @param ?callable(string):string $trimmer */ public function __construct(?callable $trimmer = null) { diff --git a/src/MiddlewareResolver.php b/src/MiddlewareResolver.php index b3caf333..88e86a66 100644 --- a/src/MiddlewareResolver.php +++ b/src/MiddlewareResolver.php @@ -15,6 +15,7 @@ use Closure; use InvalidArgumentException; +use LogicException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; @@ -48,6 +49,7 @@ public function __construct( * @inheritDoc * * @throws InvalidArgumentException + * @throws LogicException * @throws ReflectionException */ public function resolveMiddleware(mixed $reference): MiddlewareInterface @@ -57,7 +59,7 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface } if ($reference instanceof Closure) { - return $this->createCallbackMiddleware($reference, new ReflectionFunction($reference)); + return new CallableMiddleware($this->createCallback($reference, new ReflectionFunction($reference))); } if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { @@ -67,15 +69,17 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 if (is_array($reference) && is_callable($reference, true)) { /** @var array{0: string|object, 1: string} $reference */ - if (is_string($reference[0]) && class_exists($reference[0])) { $reference[0] = $this->classResolver->resolveClass($reference[0]); } if (is_callable($reference)) { /** @var array{0: class-string|object, 1: non-empty-string} $reference */ + $reflection = new ReflectionMethod($reference[0], $reference[1]); + + /** @var callable $reference */ - return $this->createCallbackMiddleware($reference, new ReflectionMethod($reference[0], $reference[1])); + return new CallableMiddleware($this->createCallback($reference, $reflection)); } } @@ -85,26 +89,27 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface )); } - private function createCallbackMiddleware(callable $callback, ReflectionMethod|ReflectionFunction $reflection): MiddlewareInterface + /** + * @return callable(ServerRequestInterface, RequestHandlerInterface): ResponseInterface + * + * @throws InvalidArgumentException + * @throws LogicException + */ + private function createCallback(callable $callback, ReflectionMethod|ReflectionFunction $reflection): callable { - return new CallableMiddleware( - fn( - ServerRequestInterface $request, - RequestHandlerInterface $handler, - ): ResponseInterface => ( - $this->responseResolverChain->resolveResponse( - $callback( - ...$this->parameterResolverChain - ->withContext($request) - ->withResolver( - new DirectObjectInjectionParameterResolver($request), - new DirectObjectInjectionParameterResolver($handler), - ) - ->resolveParameters(...$reflection->getParameters()) - ), - $reflection, - $request, - ) + return fn(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface => ( + $this->responseResolverChain->resolveResponse( + $callback( + ...$this->parameterResolverChain + ->withContext($request) + ->withResolver( + new DirectObjectInjectionParameterResolver($request), + new DirectObjectInjectionParameterResolver($handler), + ) + ->resolveParameters(...$reflection->getParameters()) + ), + $reflection, + $request, ) ); } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index d1ced8c4..ee488d50 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -74,13 +74,15 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) )); } + /** @var class-string $className */ + $className = $type->getName(); $processParams = $annotations[0]->newInstance(); $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; $errorMessage = $processParams->errorMessage ?? $this->defaultErrorMessage; try { - $argument = $this->hydrator->hydrate($type->getName(), (array) $context->getParsedBody()); + $argument = $this->hydrator->hydrate($className, (array) $context->getParsedBody()); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidBody($errorMessage, $errorStatusCode, previous: $e) ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index 70fac92b..b9431ce7 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -84,6 +84,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } try { + /** @var mixed $argument */ $argument = $this->hydrator->castValue($request->getCookieParam($cookieName), Type::fromParameter($parameter), path: [$cookieName]); } catch (InvalidValueException $e) { throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode, previous: $e) diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 4dba5394..29108a8b 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -82,6 +82,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } try { + /** @var mixed $argument */ $argument = $this->hydrator->castValue($context->getHeaderLine($headerName), Type::fromParameter($parameter), path: [$headerName]); } catch (InvalidValueException $e) { throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode, previous: $e) diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 913b5a92..df9bf6a2 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -74,13 +74,15 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) )); } + /** @var class-string $className */ + $className = $type->getName(); $processParams = $annotations[0]->newInstance(); $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; $errorMessage = $processParams->errorMessage ?? $this->defaultErrorMessage; try { - $argument = $this->hydrator->hydrate($type->getName(), $context->getQueryParams()); + $argument = $this->hydrator->hydrate($className, $context->getQueryParams()); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidQuery($errorMessage, $errorStatusCode, previous: $e) ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index ed789810..cc9f74e0 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -96,6 +96,7 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } try { + /** @var mixed $argument */ $argument = $this->hydrator->castValue($route->getAttribute($variableName), Type::fromParameter($parameter), path: [$variableName]); } catch (InvalidValueException $e) { throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode, previous: $e) diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index 2022dc06..e2bb91b0 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -19,20 +19,18 @@ /** * @since 2.0.0 - * - * @template T as callable(ServerRequestInterface=): ResponseInterface */ final class CallableRequestHandler implements RequestHandlerInterface { /** - * @var T + * @var callable(ServerRequestInterface): ResponseInterface * * @readonly */ private $callback; /** - * @param T $callback + * @param callable(ServerRequestInterface): ResponseInterface $callback */ public function __construct(callable $callback) { @@ -40,8 +38,6 @@ public function __construct(callable $callback) } /** - * @return T - * * @since 2.10.0 */ public function getCallback(): callable diff --git a/src/RequestHandlerResolver.php b/src/RequestHandlerResolver.php index 30b3a016..afac8697 100644 --- a/src/RequestHandlerResolver.php +++ b/src/RequestHandlerResolver.php @@ -15,6 +15,7 @@ use Closure; use InvalidArgumentException; +use LogicException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; @@ -47,6 +48,7 @@ public function __construct( * @inheritDoc * * @throws InvalidArgumentException + * @throws LogicException * @throws ReflectionException */ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface @@ -56,21 +58,23 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface } if ($reference instanceof Closure) { - return $this->createRequestHandlerCallback($reference, new ReflectionFunction($reference)); + return new CallableRequestHandler($this->createCallback($reference, new ReflectionFunction($reference))); } // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 if (is_array($reference) && is_callable($reference, true)) { /** @var array{0: string|object, 1: string} $reference */ - if (is_string($reference[0]) && class_exists($reference[0])) { $reference[0] = $this->classResolver->resolveClass($reference[0]); } if (is_callable($reference)) { /** @var array{0: class-string|object, 1: non-empty-string} $reference */ + $reflection = new ReflectionMethod($reference[0], $reference[1]); + + /** @var callable $reference */ - return $this->createRequestHandlerCallback($reference, new ReflectionMethod($reference[0], $reference[1])); + return new CallableRequestHandler($this->createCallback($reference, $reflection)); } } @@ -84,22 +88,26 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface )); } - private function createRequestHandlerCallback(callable $callback, ReflectionMethod|ReflectionFunction $reflection): RequestHandlerInterface + /** + * @return callable(ServerRequestInterface): ResponseInterface + * + * @throws InvalidArgumentException + * @throws LogicException + */ + private function createCallback(callable $callback, ReflectionMethod|ReflectionFunction $reflection): callable { - return new CallableRequestHandler( - fn(ServerRequestInterface $request): ResponseInterface => ( - $this->responseResolverChain->resolveResponse( - $callback( - ...$this->parameterResolverChain - ->withContext($request) - ->withResolver( - new DirectObjectInjectionParameterResolver($request), - ) - ->resolveParameters(...$reflection->getParameters()) - ), - $reflection, - $request, - ) + return fn(ServerRequestInterface $request): ResponseInterface => ( + $this->responseResolverChain->resolveResponse( + $callback( + ...$this->parameterResolverChain + ->withContext($request) + ->withResolver( + new DirectObjectInjectionParameterResolver($request), + ) + ->resolveParameters(...$reflection->getParameters()) + ), + $reflection, + $request, ) ); } diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/JsonResponseResolver.php index 171dcdac..16b45164 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -65,10 +65,10 @@ public function resolveResponse( $processParams = $annotations[0]->newInstance(); $encodingFlags = $processParams->encodingFlags ?? $this->defaultEncodingFlags ?? self::DEFAULT_ENCODING_FLAGS; + /** @psalm-var int<1, 2147483647> $encodingDepth */ $encodingDepth = $processParams->encodingDepth ?? $this->defaultEncodingDepth ?? self::DEFAULT_ENCODING_DEPTH; try { - /** @psalm-suppress ArgumentTypeCoercion */ $payload = json_encode($response, $encodingFlags | JSON_THROW_ON_ERROR, $encodingDepth); } catch (JsonException $e) { throw new RuntimeException(sprintf( diff --git a/src/Route.php b/src/Route.php index 963cd9f0..9dc0e2d9 100644 --- a/src/Route.php +++ b/src/Route.php @@ -115,6 +115,7 @@ public function hasAttribute(string $name): bool public function withAddedAttributes(array $attributes): static { $clone = clone $this; + /** @var mixed $value */ foreach ($attributes as $name => $value) { $clone->attributes[$name] = $value; } diff --git a/src/Router.php b/src/Router.php index c0681911..f5efa8ae 100644 --- a/src/Router.php +++ b/src/Router.php @@ -140,7 +140,7 @@ public function match(ServerRequestInterface $request): RouteInterface $routes = $this->getRoutes(); if ($routes === []) { - throw new LogicException('No routes are registered in the router.'); + throw new LogicException('The router does not contain any routes.'); } $requestPath = rawurldecode($request->getUri()->getPath()); @@ -148,8 +148,10 @@ public function match(ServerRequestInterface $request): RouteInterface $allowedMethods = []; foreach ($routes as $route) { + $routeRegex = $this->compileRoute($route); + try { - if (!RouteMatcher::matchPattern($route->getPath(), $this->compileRoute($route), $requestPath, $matches)) { + if (!RouteMatcher::matchPattern($route->getPath(), $routeRegex, $requestPath, $matches)) { continue; } } catch (UnexpectedValueException $e) { @@ -197,6 +199,7 @@ public function runRoute(RouteInterface|string $route, ServerRequestInterface $r $route = $this->getRoute($route); } + /** @var mixed $value */ foreach ($route->getAttributes() as $name => $value) { $request = $request->withAttribute($name, $value); } @@ -254,7 +257,8 @@ public function compileRoute(RouteInterface|string $route): string $route = $this->getRoute($route); } - return $this->routePatterns[$route->getName()] ??= $route->getPattern() ?? RouteCompiler::compileRoute($route->getPath(), $route->getPatterns()); + return $this->routePatterns[$route->getName()] ??= $route->getPattern() + ?? RouteCompiler::compileRoute($route->getPath(), $route->getPatterns()); } /** @@ -278,10 +282,9 @@ public function getRouteRequestHandler(RouteInterface|string $route): RequestHan $middlewares = array_merge($this->routeMiddlewares, $route->getMiddlewares()); if ($middlewares !== []) { $this->routeRequestHandlers[$name] = new QueueableRequestHandler($this->routeRequestHandlers[$name]); + /** @var mixed $middleware */ foreach ($middlewares as $middleware) { - $this->routeRequestHandlers[$name]->enqueue( - $this->referenceResolver->resolveMiddleware($middleware) - ); + $this->routeRequestHandlers[$name]->enqueue($this->referenceResolver->resolveMiddleware($middleware)); } } @@ -301,15 +304,14 @@ private function getRequestHandler(): RequestHandlerInterface $this->requestHandler = new CallableRequestHandler( fn(ServerRequestInterface $request): ResponseInterface - => $this->runRoute($this->match($request), $request) + => $this->runRoute($this->match($request), $request), ); if ($this->middlewares !== []) { $this->requestHandler = new QueueableRequestHandler($this->requestHandler); + /** @var mixed $middleware */ foreach ($this->middlewares as $middleware) { - $this->requestHandler->enqueue( - $this->referenceResolver->resolveMiddleware($middleware) - ); + $this->requestHandler->enqueue($this->referenceResolver->resolveMiddleware($middleware)); } } diff --git a/src/RouterInterface.php b/src/RouterInterface.php index 3318bb34..9dc85db3 100644 --- a/src/RouterInterface.php +++ b/src/RouterInterface.php @@ -74,6 +74,8 @@ public function handle(ServerRequestInterface $request): ResponseInterface; public function runRoute(RouteInterface|string $route, ServerRequestInterface $request): ResponseInterface; /** + * @param array $values + * * @throws InvalidArgumentException * * @since 3.0.0 diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 81a6c76c..c9a481ff 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -28,8 +28,8 @@ use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; use Sunrise\Http\Router\Helper\HeaderParser; -use function current; use function preg_match; +use function reset; use function usort; /** @@ -101,8 +101,7 @@ public function getClientProducedMediaType(): ?ClientMediaType return null; } - [$identifier, $parameters] = current($values); - + [$identifier, $parameters] = reset($values); if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier, $matches) === 1) { return new ClientMediaType($matches[1], $matches[2], $parameters); } @@ -125,6 +124,7 @@ public function getClientConsumedMediaTypes(): Generator (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') )); + /** @phpstan-var int<0, max> $index */ foreach ($values as $index => [$identifier, $parameters]) { if (preg_match('|^([^/]+)/([^/]+)$|', $identifier, $matches) === 1) { yield $index => new ClientMediaType($matches[1], $matches[2], $parameters); @@ -147,6 +147,7 @@ public function getClientConsumedLanguages(): Generator (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') )); + /** @phpstan-var int<0, max> $index */ foreach ($values as $index => [$identifier, $parameters]) { if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches) === 1) { yield $index => new ClientLanguage($matches[1], $identifier, $parameters); @@ -373,7 +374,9 @@ public function withRequestTarget($requestTarget): self } /** - * @inheritDoc + * {@inheritDoc} + * + * @return array */ public function getServerParams(): array { @@ -381,7 +384,9 @@ public function getServerParams(): array } /** - * @inheritDoc + * {@inheritDoc} + * + * @return array */ public function getQueryParams(): array { @@ -399,7 +404,11 @@ public function getQueryParam(string $name, mixed $default = null): mixed } /** - * @inheritDoc + * {@inheritDoc} + * + * @param array $query + * + * @return static */ public function withQueryParams(array $query): self { @@ -410,7 +419,9 @@ public function withQueryParams(array $query): self } /** - * @inheritDoc + * {@inheritDoc} + * + * @return array */ public function getCookieParams(): array { @@ -428,7 +439,11 @@ public function getCookieParam(string $name, mixed $default = null): mixed } /** - * @inheritDoc + * {@inheritDoc} + * + * @param array $cookies + * + * @return static */ public function withCookieParams(array $cookies): self { @@ -439,7 +454,9 @@ public function withCookieParams(array $cookies): self } /** - * @inheritDoc + * {@inheritDoc} + * + * @return array */ public function getUploadedFiles(): array { @@ -447,7 +464,11 @@ public function getUploadedFiles(): array } /** - * @inheritDoc + * {@inheritDoc} + * + * @param array $uploadedFiles + * + * @return static */ public function withUploadedFiles(array $uploadedFiles): self { @@ -458,7 +479,9 @@ public function withUploadedFiles(array $uploadedFiles): self } /** - * @inheritDoc + * {@inheritDoc} + * + * @return array|object|null */ public function getParsedBody(): mixed { @@ -466,7 +489,11 @@ public function getParsedBody(): mixed } /** - * @inheritDoc + * {@inheritDoc} + * + * @param array|object|null $data + * + * @return static */ public function withParsedBody($data): self { @@ -477,7 +504,9 @@ public function withParsedBody($data): self } /** - * @inheritDoc + * {@inheritDoc} + * + * @return array */ public function getAttributes(): array { @@ -485,7 +514,12 @@ public function getAttributes(): array } /** - * @inheritDoc + * {@inheritDoc} + * + * @param string $name + * @param mixed $default + * + * @return mixed */ public function getAttribute($name, $default = null): mixed { @@ -493,7 +527,12 @@ public function getAttribute($name, $default = null): mixed } /** - * @inheritDoc + * {@inheritDoc} + * + * @param string $name + * @param mixed $value + * + * @return static */ public function withAttribute($name, $value): self { @@ -504,7 +543,11 @@ public function withAttribute($name, $value): self } /** - * @inheritDoc + * {@inheritDoc} + * + * @param string $name + * + * @return static */ public function withoutAttribute($name): self { diff --git a/src/Validation/ConstraintViolation.php b/src/Validation/ConstraintViolation.php index ed31f16e..ec10cece 100644 --- a/src/Validation/ConstraintViolation.php +++ b/src/Validation/ConstraintViolation.php @@ -21,9 +21,11 @@ final class ConstraintViolation implements ConstraintViolationInterface public function __construct( private readonly string $message, private readonly string $messageTemplate, + /** @var array */ private readonly array $messagePlaceholders, private readonly string $propertyPath, private readonly ?string $code, + private readonly mixed $invalidValue, ) { } @@ -37,6 +39,9 @@ public function getMessageTemplate(): string return $this->messageTemplate; } + /** + * @inheritDoc + */ public function getMessagePlaceholders(): array { return $this->messagePlaceholders; @@ -51,4 +56,9 @@ public function getCode(): ?string { return $this->code; } + + public function getInvalidValue(): mixed + { + return $this->invalidValue; + } } diff --git a/src/Validation/ConstraintViolation/HydratorConstraintViolationAdapter.php b/src/Validation/ConstraintViolation/HydratorConstraintViolationAdapter.php index 86bad0b0..e28521eb 100644 --- a/src/Validation/ConstraintViolation/HydratorConstraintViolationAdapter.php +++ b/src/Validation/ConstraintViolation/HydratorConstraintViolationAdapter.php @@ -41,6 +41,9 @@ public function getMessageTemplate(): string return $this->hydratorConstraintViolation->getMessageTemplate(); } + /** + * @inheritDoc + */ public function getMessagePlaceholders(): array { return $this->hydratorConstraintViolation->getMessagePlaceholders(); @@ -55,4 +58,9 @@ public function getCode(): ?string { return $this->hydratorConstraintViolation->getErrorCode(); } + + public function getInvalidValue(): mixed + { + return $this->hydratorConstraintViolation->getInvalidValue(); + } } diff --git a/src/Validation/ConstraintViolation/ValidatorConstraintViolationAdapter.php b/src/Validation/ConstraintViolation/ValidatorConstraintViolationAdapter.php index fdeaee4f..c3636ca4 100644 --- a/src/Validation/ConstraintViolation/ValidatorConstraintViolationAdapter.php +++ b/src/Validation/ConstraintViolation/ValidatorConstraintViolationAdapter.php @@ -43,6 +43,9 @@ public function getMessageTemplate(): string return $this->validatorConstraintViolation->getMessageTemplate(); } + /** + * @inheritDoc + */ public function getMessagePlaceholders(): array { return $this->validatorConstraintViolation->getParameters(); @@ -58,8 +61,13 @@ public function getCode(): ?string return $this->validatorConstraintViolation->getCode(); } + public function getInvalidValue(): mixed + { + return $this->validatorConstraintViolation->getInvalidValue(); + } + private static function adaptPropertyPath(string $propertyPath): string { - return preg_replace(['/\x5b([^\x5b\x5d]+)\x5d/', '/^\x2e/'], ['.$1'], $propertyPath); + return (string) preg_replace(['/\x5b([^\x5b\x5d]+)\x5d/', '/^\x2e/'], ['.$1'], $propertyPath); } } diff --git a/src/Validation/ConstraintViolationInterface.php b/src/Validation/ConstraintViolationInterface.php index c17ef729..4c840523 100644 --- a/src/Validation/ConstraintViolationInterface.php +++ b/src/Validation/ConstraintViolationInterface.php @@ -22,9 +22,14 @@ public function getMessage(): string; public function getMessageTemplate(): string; + /** + * @return array + */ public function getMessagePlaceholders(): array; public function getPropertyPath(): string; public function getCode(): ?string; + + public function getInvalidValue(): mixed; } From 5b947172d412ff23cf5640a104475a17522936b1 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 31 Oct 2024 22:42:34 +0100 Subject: [PATCH 164/180] v3 --- tests/{Unit => }/Entity/Language/ClientLanguageTest.php | 2 +- tests/{Unit => }/Entity/Language/LanguageComparatorTest.php | 2 +- tests/{Unit => }/Entity/Language/ServerLanguageTest.php | 2 +- tests/{Unit => }/Entity/MediaType/ClientMediaTypeTest.php | 2 +- tests/{Unit => }/Entity/MediaType/MediaTypeComparatorTest.php | 4 ++-- tests/{Unit => }/Entity/MediaType/ServerMediaTypeTest.php | 2 +- tests/{Unit => }/Event/RoutePostRunEventTest.php | 2 +- tests/{Unit => }/Event/RoutePreRunEventTest.php | 4 ++-- tests/{Unit => }/Helper/RouteParserTest.php | 2 +- 9 files changed, 11 insertions(+), 11 deletions(-) rename tests/{Unit => }/Entity/Language/ClientLanguageTest.php (89%) rename tests/{Unit => }/Entity/Language/LanguageComparatorTest.php (95%) rename tests/{Unit => }/Entity/Language/ServerLanguageTest.php (85%) rename tests/{Unit => }/Entity/MediaType/ClientMediaTypeTest.php (92%) rename tests/{Unit => }/Entity/MediaType/MediaTypeComparatorTest.php (97%) rename tests/{Unit => }/Entity/MediaType/ServerMediaTypeTest.php (91%) rename tests/{Unit => }/Event/RoutePostRunEventTest.php (96%) rename tests/{Unit => }/Event/RoutePreRunEventTest.php (95%) rename tests/{Unit => }/Helper/RouteParserTest.php (98%) diff --git a/tests/Unit/Entity/Language/ClientLanguageTest.php b/tests/Entity/Language/ClientLanguageTest.php similarity index 89% rename from tests/Unit/Entity/Language/ClientLanguageTest.php rename to tests/Entity/Language/ClientLanguageTest.php index 77c40ecd..068901b0 100644 --- a/tests/Unit/Entity/Language/ClientLanguageTest.php +++ b/tests/Entity/Language/ClientLanguageTest.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Tests\Unit\Entity\Language; +namespace Sunrise\Http\Router\Tests\Entity\Language; use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Entity\Language\ClientLanguage; diff --git a/tests/Unit/Entity/Language/LanguageComparatorTest.php b/tests/Entity/Language/LanguageComparatorTest.php similarity index 95% rename from tests/Unit/Entity/Language/LanguageComparatorTest.php rename to tests/Entity/Language/LanguageComparatorTest.php index acd6cce8..270cd726 100644 --- a/tests/Unit/Entity/Language/LanguageComparatorTest.php +++ b/tests/Entity/Language/LanguageComparatorTest.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Tests\Unit\Entity\Language; +namespace Sunrise\Http\Router\Tests\Entity\Language; use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Entity\Language\LanguageComparator; diff --git a/tests/Unit/Entity/Language/ServerLanguageTest.php b/tests/Entity/Language/ServerLanguageTest.php similarity index 85% rename from tests/Unit/Entity/Language/ServerLanguageTest.php rename to tests/Entity/Language/ServerLanguageTest.php index e8e7ff33..bd6cbcab 100644 --- a/tests/Unit/Entity/Language/ServerLanguageTest.php +++ b/tests/Entity/Language/ServerLanguageTest.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Tests\Unit\Entity\Language; +namespace Sunrise\Http\Router\Tests\Entity\Language; use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Entity\Language\ServerLanguage; diff --git a/tests/Unit/Entity/MediaType/ClientMediaTypeTest.php b/tests/Entity/MediaType/ClientMediaTypeTest.php similarity index 92% rename from tests/Unit/Entity/MediaType/ClientMediaTypeTest.php rename to tests/Entity/MediaType/ClientMediaTypeTest.php index 4ac388f2..fe214210 100644 --- a/tests/Unit/Entity/MediaType/ClientMediaTypeTest.php +++ b/tests/Entity/MediaType/ClientMediaTypeTest.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Tests\Unit\Entity\MediaType; +namespace Sunrise\Http\Router\Tests\Entity\MediaType; use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Entity\MediaType\ClientMediaType; diff --git a/tests/Unit/Entity/MediaType/MediaTypeComparatorTest.php b/tests/Entity/MediaType/MediaTypeComparatorTest.php similarity index 97% rename from tests/Unit/Entity/MediaType/MediaTypeComparatorTest.php rename to tests/Entity/MediaType/MediaTypeComparatorTest.php index af26bb98..ea2adbfa 100644 --- a/tests/Unit/Entity/MediaType/MediaTypeComparatorTest.php +++ b/tests/Entity/MediaType/MediaTypeComparatorTest.php @@ -2,10 +2,10 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Tests\Unit\Entity\MediaType; +namespace Sunrise\Http\Router\Tests\Entity\MediaType; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; use PHPUnit\Framework\TestCase; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; diff --git a/tests/Unit/Entity/MediaType/ServerMediaTypeTest.php b/tests/Entity/MediaType/ServerMediaTypeTest.php similarity index 91% rename from tests/Unit/Entity/MediaType/ServerMediaTypeTest.php rename to tests/Entity/MediaType/ServerMediaTypeTest.php index 5e95ce1c..bc9949f0 100644 --- a/tests/Unit/Entity/MediaType/ServerMediaTypeTest.php +++ b/tests/Entity/MediaType/ServerMediaTypeTest.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Tests\Unit\Entity\MediaType; +namespace Sunrise\Http\Router\Tests\Entity\MediaType; use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; diff --git a/tests/Unit/Event/RoutePostRunEventTest.php b/tests/Event/RoutePostRunEventTest.php similarity index 96% rename from tests/Unit/Event/RoutePostRunEventTest.php rename to tests/Event/RoutePostRunEventTest.php index 6952cb54..60c77b37 100644 --- a/tests/Unit/Event/RoutePostRunEventTest.php +++ b/tests/Event/RoutePostRunEventTest.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Tests\Unit\Event; +namespace Sunrise\Http\Router\Tests\Event; use PHPUnit\Framework\TestCase; use Psr\Http\Message\ResponseInterface; diff --git a/tests/Unit/Event/RoutePreRunEventTest.php b/tests/Event/RoutePreRunEventTest.php similarity index 95% rename from tests/Unit/Event/RoutePreRunEventTest.php rename to tests/Event/RoutePreRunEventTest.php index 83def914..07c4f436 100644 --- a/tests/Unit/Event/RoutePreRunEventTest.php +++ b/tests/Event/RoutePreRunEventTest.php @@ -2,11 +2,11 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Tests\Unit\Event; +namespace Sunrise\Http\Router\Tests\Event; +use PHPUnit\Framework\TestCase; use Psr\Http\Message\ServerRequestInterface; use Sunrise\Http\Router\Event\RoutePreRunEvent; -use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\RouteInterface; final class RoutePreRunEventTest extends TestCase diff --git a/tests/Unit/Helper/RouteParserTest.php b/tests/Helper/RouteParserTest.php similarity index 98% rename from tests/Unit/Helper/RouteParserTest.php rename to tests/Helper/RouteParserTest.php index 8fabab36..fcaa615f 100644 --- a/tests/Unit/Helper/RouteParserTest.php +++ b/tests/Helper/RouteParserTest.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Tests\Unit\Helper; +namespace Sunrise\Http\Router\Tests\Helper; use InvalidArgumentException; use PHPUnit\Framework\TestCase; From fec640f9105e771d6aad322684f36d7d04317fca Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 1 Nov 2024 03:51:24 +0100 Subject: [PATCH 165/180] v3 --- composer.json | 12 ++++-- phpcs.xml.dist | 13 +++---- src/Annotation/Constraint.php | 1 + src/Dictionary/ErrorMessage.php | 2 + src/Entity/Language/LanguageComparator.php | 7 +++- src/Entity/MediaType/MediaTypeComparator.php | 14 +++++-- src/Exception/HttpException.php | 21 ++++++++++ src/Helper/RouteBuilder.php | 2 +- src/Helper/RouteParser.php | 11 +++++- src/Loader/DescriptorLoader.php | 6 ++- .../RequestBodyParameterResolver.php | 7 +--- .../RequestCookieParameterResolver.php | 21 +++++----- .../RequestHeaderParameterResolver.php | 21 +++++----- .../RequestQueryParameterResolver.php | 7 +--- .../RequestVariableParameterResolver.php | 25 +++++++----- src/ParameterResolverChain.php | 8 +++- src/ReferenceResolver.php | 15 +++++++- .../QueueableRequestHandler.php | 4 +- src/Router.php | 3 +- src/ServerRequest.php | 4 +- .../Constraint/ArgumentConstraint.php | 2 +- tests/Command/RouterClearCacheCommandTest.php | 38 +++++++++++++++++++ tests/Command/RouterListRoutesCommandTest.php | 30 +++++++++++++++ .../Language/LanguageComparatorTest.php | 2 +- .../MediaType/MediaTypeComparatorTest.php | 2 +- tests/Helper/RouteParserTest.php | 2 +- 26 files changed, 213 insertions(+), 67 deletions(-) create mode 100644 tests/Command/RouterClearCacheCommandTest.php create mode 100644 tests/Command/RouterListRoutesCommandTest.php diff --git a/composer.json b/composer.json index 40f7e585..cacaf3dd 100644 --- a/composer.json +++ b/composer.json @@ -60,11 +60,15 @@ } }, "scripts": { + "phpcs": "phpcs --colors", + "psalm": "psalm --no-cache", + "phpstan": "phpstan analyse src --level=9 --memory-limit=-1", + "phpunit": "XDEBUG_MODE=coverage phpunit --coverage-text --colors=always", "test": [ - "phpcs --colors", - "psalm --no-cache", - "phpstan analyse src --level=9 --memory-limit=-1", - "XDEBUG_MODE=coverage phpunit --coverage-text --colors=always" + "@phpcs", + "@psalm", + "@phpstan", + "@phpunit" ], "build": [ "phpdoc -d src/ -t phpdoc/", diff --git a/phpcs.xml.dist b/phpcs.xml.dist index 1f6e6c02..724b8a1c 100644 --- a/phpcs.xml.dist +++ b/phpcs.xml.dist @@ -1,14 +1,13 @@ - + + + + + tests/* + benchmarks src tests - - - - - - diff --git a/src/Annotation/Constraint.php b/src/Annotation/Constraint.php index 85f744c4..7c725390 100644 --- a/src/Annotation/Constraint.php +++ b/src/Annotation/Constraint.php @@ -18,6 +18,7 @@ /** * @since 3.0.0 */ +// phpcs:ignore Generic.Files.LineLength.TooLong #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::TARGET_PARAMETER | Attribute::IS_REPEATABLE)] final class Constraint { diff --git a/src/Dictionary/ErrorMessage.php b/src/Dictionary/ErrorMessage.php index c07ed662..d0409bdc 100644 --- a/src/Dictionary/ErrorMessage.php +++ b/src/Dictionary/ErrorMessage.php @@ -18,6 +18,7 @@ */ final class ErrorMessage { + // phpcs:disable Generic.Files.LineLength.TooLong public const MALFORMED_URI = 'The request URI is malformed and cannot be accepted by the server.'; public const RESOURCE_NOT_FOUND = 'The requested resource was not found for this URI.'; public const METHOD_NOT_ALLOWED = 'The requested method is not allowed for this resource; Check the Allow response header for allowed methods.'; @@ -33,4 +34,5 @@ final class ErrorMessage public const EMPTY_JSON_PAYLOAD = 'The JSON payload cannot be empty.'; public const INVALID_JSON_PAYLOAD = 'The JSON payload is invalid.'; public const INVALID_JSON_PAYLOAD_FORMAT = 'The JSON payload must be in the format of an array or an object.'; + // phpcs:enable Generic.Files.LineLength.TooLong } diff --git a/src/Entity/Language/LanguageComparator.php b/src/Entity/Language/LanguageComparator.php index fd5ce6bf..2ee53654 100644 --- a/src/Entity/Language/LanguageComparator.php +++ b/src/Entity/Language/LanguageComparator.php @@ -20,10 +20,13 @@ final class LanguageComparator implements LanguageComparatorInterface { public function compare(LanguageInterface $a, LanguageInterface $b): int { - if ($a->getCode() === $b->getCode() || $a->getCode() === '*' || $b->getCode() === '*') { + $aCode = $a->getCode(); + $bCode = $b->getCode(); + + if ($aCode === $bCode || $aCode === '*' || $bCode === '*') { return 0; } - return $a->getCode() <=> $b->getCode(); + return $aCode <=> $bCode; } } diff --git a/src/Entity/MediaType/MediaTypeComparator.php b/src/Entity/MediaType/MediaTypeComparator.php index c84cb116..e6c71c8e 100644 --- a/src/Entity/MediaType/MediaTypeComparator.php +++ b/src/Entity/MediaType/MediaTypeComparator.php @@ -25,11 +25,19 @@ final class MediaTypeComparator implements MediaTypeComparatorInterface */ public function compare(MediaTypeInterface $a, MediaTypeInterface $b): int { - if (($a->getType() === '*' || $b->getType() === '*' || strcasecmp($a->getType(), $b->getType()) === 0) && - ($a->getSubtype() === '*' || $b->getSubtype() === '*' || strcasecmp($a->getSubtype(), $b->getSubtype()) === 0)) { + $aType = $a->getType(); + $aSubtype = $a->getSubtype(); + + $bType = $b->getType(); + $bSubtype = $b->getSubtype(); + + if ( + ($aType === '*' || $bType === '*' || strcasecmp($aType, $bType) === 0) && + ($aSubtype === '*' || $bSubtype === '*' || strcasecmp($aSubtype, $bSubtype) === 0) + ) { return 0; } - return strcasecmp($a->__toString(), $b->__toString()) < 0 ? -1 : 1; + return strcasecmp((string) $a, (string) $b) < 0 ? -1 : 1; } } diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index e78d0d0e..b05913cb 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -15,9 +15,12 @@ use RuntimeException; use Stringable; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Http\Router\Validation\ConstraintViolationInterface; use Throwable; +use function array_map; use function join; use function strtr; @@ -112,4 +115,22 @@ final public function addConstraintViolation(ConstraintViolationInterface ...$co return $this; } + + final public function addHydratorConstraintViolations( + \Sunrise\Hydrator\Exception\InvalidValueException ...$constraintViolations + ): static { + return $this->addConstraintViolation(...array_map( + HydratorConstraintViolationAdapter::create(...), + $constraintViolations, + )); + } + + final public function addValidatorConstraintViolations( + \Symfony\Component\Validator\ConstraintViolationInterface ...$constraintViolations + ): static { + return $this->addConstraintViolation(...array_map( + ValidatorConstraintViolationAdapter::create(...), + $constraintViolations, + )); + } } diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index 97603e59..f868e9bb 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -101,7 +101,7 @@ public static function stringifyValue(mixed $value): string return (string) $value->value; } if ($value instanceof Stringable) { - return $value->__toString(); + return (string) $value; } throw new InvalidArgumentException(sprintf( diff --git a/src/Helper/RouteParser.php b/src/Helper/RouteParser.php index d42e53fc..2d6db1ed 100644 --- a/src/Helper/RouteParser.php +++ b/src/Helper/RouteParser.php @@ -32,7 +32,16 @@ final class RouteParser /** * Parses the given route and returns its variables * - * @return list + * @return list * * @throws InvalidArgumentException */ diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index cfefef9f..675e4278 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -223,8 +223,10 @@ private static function enrichDescriptorFromParentClasses(Descriptor $descriptor * * @throws InvalidArgumentException */ - private static function enrichDescriptorFromClassOrMethod(Descriptor $descriptor, ReflectionClass|ReflectionMethod $classOrMethod): void - { + private static function enrichDescriptorFromClassOrMethod( + Descriptor $descriptor, + ReflectionClass|ReflectionMethod $classOrMethod, + ): void { /** @var list> $annotations */ $annotations = $classOrMethod->getAttributes(NamePrefix::class); if (isset($annotations[0])) { diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index ee488d50..6d9a1647 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -24,14 +24,11 @@ use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ParameterResolverChain; use Sunrise\Http\Router\ParameterResolverInterface; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; -use function array_map; use function sprintf; /** @@ -85,13 +82,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->hydrate($className, (array) $context->getParsedBody()); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidBody($errorMessage, $errorStatusCode, previous: $e) - ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); + ->addHydratorConstraintViolations(...$e->getExceptions()); } if ($processParams->validation && $this->validator !== null) { if (($violations = $this->validator->validate($argument))->count() > 0) { throw HttpExceptionFactory::invalidBody($errorMessage, $errorStatusCode) - ->addConstraintViolation(...array_map(ValidatorConstraintViolationAdapter::create(...), [...$violations])); + ->addValidatorConstraintViolations(...$violations); } } diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index b9431ce7..7e9cccbe 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -23,8 +23,6 @@ use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ServerRequest; use Sunrise\Http\Router\Validation\Constraint\ArgumentConstraint; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\Exception\InvalidValueException; @@ -32,8 +30,6 @@ use Sunrise\Hydrator\Type; use Symfony\Component\Validator\Validator\ValidatorInterface; -use function array_map; - /** * @since 3.0.0 */ @@ -85,23 +81,30 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) try { /** @var mixed $argument */ - $argument = $this->hydrator->castValue($request->getCookieParam($cookieName), Type::fromParameter($parameter), path: [$cookieName]); + $argument = $this->hydrator->castValue( + $request->getCookieParam($cookieName), + Type::fromParameter($parameter), + path: [$cookieName], + ); } catch (InvalidValueException $e) { throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder(self::PLACEHOLDER_COOKIE_NAME, $cookieName) - ->addConstraintViolation(HydratorConstraintViolationAdapter::create($e)); + ->addHydratorConstraintViolations($e); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder(self::PLACEHOLDER_COOKIE_NAME, $cookieName) - ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); + ->addHydratorConstraintViolations(...$e->getExceptions()); } if ($processParams->validation && $this->validator !== null) { - $violations = $this->validator->startContext()->atPath($cookieName)->validate($argument, new ArgumentConstraint($parameter))->getViolations(); + $violations = $this->validator->startContext() + ->atPath($cookieName) + ->validate($argument, new ArgumentConstraint($parameter)) + ->getViolations(); if ($violations->count() > 0) { throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode) ->addMessagePlaceholder(self::PLACEHOLDER_COOKIE_NAME, $cookieName) - ->addConstraintViolation(...array_map(ValidatorConstraintViolationAdapter::create(...), [...$violations])); + ->addValidatorConstraintViolations(...$violations); } } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 29108a8b..39440a2f 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -22,8 +22,6 @@ use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\Validation\Constraint\ArgumentConstraint; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\Exception\InvalidValueException; @@ -31,8 +29,6 @@ use Sunrise\Hydrator\Type; use Symfony\Component\Validator\Validator\ValidatorInterface; -use function array_map; - /** * @since 3.0.0 */ @@ -83,23 +79,30 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) try { /** @var mixed $argument */ - $argument = $this->hydrator->castValue($context->getHeaderLine($headerName), Type::fromParameter($parameter), path: [$headerName]); + $argument = $this->hydrator->castValue( + $context->getHeaderLine($headerName), + Type::fromParameter($parameter), + path: [$headerName], + ); } catch (InvalidValueException $e) { throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder(self::PLACEHOLDER_HEADER_NAME, $headerName) - ->addConstraintViolation(HydratorConstraintViolationAdapter::create($e)); + ->addHydratorConstraintViolations($e); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder(self::PLACEHOLDER_HEADER_NAME, $headerName) - ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); + ->addHydratorConstraintViolations(...$e->getExceptions()); } if ($processParams->validation && $this->validator !== null) { - $violations = $this->validator->startContext()->atPath($headerName)->validate($argument, new ArgumentConstraint($parameter))->getViolations(); + $violations = $this->validator->startContext() + ->atPath($headerName) + ->validate($argument, new ArgumentConstraint($parameter)) + ->getViolations(); if ($violations->count() > 0) { throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode) ->addMessagePlaceholder(self::PLACEHOLDER_HEADER_NAME, $headerName) - ->addConstraintViolation(...array_map(ValidatorConstraintViolationAdapter::create(...), [...$violations])); + ->addValidatorConstraintViolations(...$violations); } } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index df9bf6a2..97a33905 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -24,14 +24,11 @@ use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ParameterResolverChain; use Sunrise\Http\Router\ParameterResolverInterface; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; -use function array_map; use function sprintf; /** @@ -85,13 +82,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->hydrate($className, $context->getQueryParams()); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidQuery($errorMessage, $errorStatusCode, previous: $e) - ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); + ->addHydratorConstraintViolations(...$e->getExceptions()); } if ($processParams->validation && $this->validator !== null) { if (($violations = $this->validator->validate($argument))->count() > 0) { throw HttpExceptionFactory::invalidQuery($errorMessage, $errorStatusCode) - ->addConstraintViolation(...array_map(ValidatorConstraintViolationAdapter::create(...), [...$violations])); + ->addValidatorConstraintViolations(...$violations); } } diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index cc9f74e0..77310389 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -26,8 +26,6 @@ use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ServerRequest; use Sunrise\Http\Router\Validation\Constraint\ArgumentConstraint; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\Exception\InvalidValueException; @@ -35,7 +33,6 @@ use Sunrise\Hydrator\Type; use Symfony\Component\Validator\Validator\ValidatorInterface; -use function array_map; use function sprintf; /** @@ -97,26 +94,36 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) try { /** @var mixed $argument */ - $argument = $this->hydrator->castValue($route->getAttribute($variableName), Type::fromParameter($parameter), path: [$variableName]); + $argument = $this->hydrator->castValue( + $route->getAttribute($variableName), + Type::fromParameter($parameter), + path: [$variableName], + ); } catch (InvalidValueException $e) { throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder(self::PLACEHOLDER_VARIABLE_NAME, $variableName) ->addMessagePlaceholder(self::PLACEHOLDER_ROUTE_URI, RouteSimplifier::simplifyRoute($route->getPath())) - ->addConstraintViolation(HydratorConstraintViolationAdapter::create($e)); + ->addHydratorConstraintViolations($e); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder(self::PLACEHOLDER_VARIABLE_NAME, $variableName) ->addMessagePlaceholder(self::PLACEHOLDER_ROUTE_URI, RouteSimplifier::simplifyRoute($route->getPath())) - ->addConstraintViolation(...array_map(HydratorConstraintViolationAdapter::create(...), $e->getExceptions())); + ->addHydratorConstraintViolations(...$e->getExceptions()); } if ($this->validator !== null) { - $violations = $this->validator->startContext()->atPath($variableName)->validate($argument, new ArgumentConstraint($parameter))->getViolations(); + $violations = $this->validator->startContext() + ->atPath($variableName) + ->validate($argument, new ArgumentConstraint($parameter)) + ->getViolations(); if ($violations->count() > 0) { throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode) ->addMessagePlaceholder(self::PLACEHOLDER_VARIABLE_NAME, $variableName) - ->addMessagePlaceholder(self::PLACEHOLDER_ROUTE_URI, RouteSimplifier::simplifyRoute($route->getPath())) - ->addConstraintViolation(...array_map(ValidatorConstraintViolationAdapter::create(...), [...$violations])); + ->addMessagePlaceholder( + self::PLACEHOLDER_ROUTE_URI, + RouteSimplifier::simplifyRoute($route->getPath()), + ) + ->addValidatorConstraintViolations(...$violations); } } diff --git a/src/ParameterResolverChain.php b/src/ParameterResolverChain.php index 7ad9490e..e137f6dc 100644 --- a/src/ParameterResolverChain.php +++ b/src/ParameterResolverChain.php @@ -105,7 +105,13 @@ public static function stringifyParameter(ReflectionParameter $parameter): strin $function = $parameter->getDeclaringFunction(); if ($function instanceof ReflectionMethod) { - return sprintf('%s::%s($%s[%d])', $function->getDeclaringClass()->getName(), $function->getName(), $parameter->getName(), $parameter->getPosition()); + return sprintf( + '%s::%s($%s[%d])', + $function->getDeclaringClass()->getName(), + $function->getName(), + $parameter->getName(), + $parameter->getPosition(), + ); } return sprintf('%s($%s[%d])', $function->getName(), $parameter->getName(), $parameter->getPosition()); diff --git a/src/ReferenceResolver.php b/src/ReferenceResolver.php index 9846c413..cdc529fe 100644 --- a/src/ReferenceResolver.php +++ b/src/ReferenceResolver.php @@ -42,9 +42,20 @@ public static function build( ): ReferenceResolverInterface { $parameterResolverChain = new ParameterResolverChain($parameterResolvers); $responseResolverChain = new ResponseResolverChain($responseResolvers); + $classResolver = new ClassResolver($parameterResolverChain, $container); - $middlewareResolver = new MiddlewareResolver($classResolver, $parameterResolverChain, $responseResolverChain); - $requestHandlerResolver = new RequestHandlerResolver($classResolver, $parameterResolverChain, $responseResolverChain); + + $middlewareResolver = new MiddlewareResolver( + $classResolver, + $parameterResolverChain, + $responseResolverChain, + ); + + $requestHandlerResolver = new RequestHandlerResolver( + $classResolver, + $parameterResolverChain, + $responseResolverChain, + ); return new self($middlewareResolver, $requestHandlerResolver); } diff --git a/src/RequestHandler/QueueableRequestHandler.php b/src/RequestHandler/QueueableRequestHandler.php index 0360df14..9e09c280 100644 --- a/src/RequestHandler/QueueableRequestHandler.php +++ b/src/RequestHandler/QueueableRequestHandler.php @@ -36,6 +36,8 @@ public function __construct( */ public function handle(ServerRequestInterface $request): ResponseInterface { - return ! $this->isEmpty() ? ($clone = clone $this)->dequeue()->process($request, $clone) : $this->endpoint->handle($request); + return $this->isEmpty() + ? $this->endpoint->handle($request) + : ($clone = clone $this)->dequeue()->process($request, $clone); } } diff --git a/src/Router.php b/src/Router.php index f5efa8ae..16d6d027 100644 --- a/src/Router.php +++ b/src/Router.php @@ -277,7 +277,8 @@ public function getRouteRequestHandler(RouteInterface|string $route): RequestHan return $this->routeRequestHandlers[$name]; } - $this->routeRequestHandlers[$name] = $this->referenceResolver->resolveRequestHandler($route->getRequestHandler()); + $this->routeRequestHandlers[$name] = $this->referenceResolver + ->resolveRequestHandler($route->getRequestHandler()); $middlewares = array_merge($this->routeMiddlewares, $route->getMiddlewares()); if ($middlewares !== []) { diff --git a/src/ServerRequest.php b/src/ServerRequest.php index c9a481ff..5b92eda5 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -88,7 +88,9 @@ public function getRoute(): RouteInterface $route = $this->request->getAttribute(RouteInterface::class); if (! $route instanceof RouteInterface) { - throw new LogicException('At this level of the application, the request does not contain information about the requested route.'); + throw new LogicException( + 'At this level of the application, the request does not contain information about the requested route.' + ); } return $route; diff --git a/src/Validation/Constraint/ArgumentConstraint.php b/src/Validation/Constraint/ArgumentConstraint.php index 8684917f..ec2639fc 100644 --- a/src/Validation/Constraint/ArgumentConstraint.php +++ b/src/Validation/Constraint/ArgumentConstraint.php @@ -19,7 +19,7 @@ /** * @since 3.0.0 * - * @psalm-suppress PropertyNotSetInConstructor https://github.com/symfony/validator/blob/33e1f3bb76ef70e3170e12f878aefb9c69b0fc4c/Constraint.php#L71 + * @psalm-suppress PropertyNotSetInConstructor See {@see parent::$groups}. */ final class ArgumentConstraint extends Constraint { diff --git a/tests/Command/RouterClearCacheCommandTest.php b/tests/Command/RouterClearCacheCommandTest.php new file mode 100644 index 00000000..dfd4f964 --- /dev/null +++ b/tests/Command/RouterClearCacheCommandTest.php @@ -0,0 +1,38 @@ +cacheMock = $this->createMock(CacheInterface::class); + } + + public function testExecuteWithoutCache(): void + { + $command = new RouterClearCacheCommand(null); + $commandTester = new CommandTester($command); + $this->assertSame(0, $commandTester->execute([])); + } + + public function testExecuteWithCache(): void + { + $this->cacheMock->expects($this->once())->method('delete')->with(CacheKey::DESCRIPTORS); + + $command = new RouterClearCacheCommand($this->cacheMock); + $commandTester = new CommandTester($command); + $this->assertSame(0, $commandTester->execute([])); + } +} diff --git a/tests/Command/RouterListRoutesCommandTest.php b/tests/Command/RouterListRoutesCommandTest.php new file mode 100644 index 00000000..d6b7aaea --- /dev/null +++ b/tests/Command/RouterListRoutesCommandTest.php @@ -0,0 +1,30 @@ +routerMock = $this->createMock(RouterInterface::class); + } + + public function testExecute(): void + { + $this->routerMock->expects($this->once())->method('getRoutes')->willReturn([]); + + $command = new RouterListRoutesCommand($this->routerMock); + $commandTester = new CommandTester($command); + $this->assertSame(0, $commandTester->execute([])); + } +} diff --git a/tests/Entity/Language/LanguageComparatorTest.php b/tests/Entity/Language/LanguageComparatorTest.php index 270cd726..c809295b 100644 --- a/tests/Entity/Language/LanguageComparatorTest.php +++ b/tests/Entity/Language/LanguageComparatorTest.php @@ -16,7 +16,7 @@ final class LanguageComparatorTest extends TestCase */ public function testCompare(LanguageInterface $a, LanguageInterface $b, int $expected): void { - $this->assertSame($expected, (new LanguageComparator)->compare($a, $b)); + $this->assertSame($expected, (new LanguageComparator())->compare($a, $b)); } private function compareDataProvider(): iterable diff --git a/tests/Entity/MediaType/MediaTypeComparatorTest.php b/tests/Entity/MediaType/MediaTypeComparatorTest.php index ea2adbfa..c14cfd65 100644 --- a/tests/Entity/MediaType/MediaTypeComparatorTest.php +++ b/tests/Entity/MediaType/MediaTypeComparatorTest.php @@ -16,7 +16,7 @@ final class MediaTypeComparatorTest extends TestCase */ public function testCompare(MediaTypeInterface $a, MediaTypeInterface $b, int $expected): void { - $this->assertSame($expected, (new MediaTypeComparator)->compare($a, $b)); + $this->assertSame($expected, (new MediaTypeComparator())->compare($a, $b)); } private function compareDataProvider(): iterable diff --git a/tests/Helper/RouteParserTest.php b/tests/Helper/RouteParserTest.php index fcaa615f..d10d47a3 100644 --- a/tests/Helper/RouteParserTest.php +++ b/tests/Helper/RouteParserTest.php @@ -158,7 +158,7 @@ private function invalidRouteDataProvider(): iterable ]; yield [ - '{aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', + '{xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', '/variable names must not exceed 32 characters/' ]; From d9a10f0e37f5ecb6b243d5d51fec44a2cfa11e92 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 1 Nov 2024 04:23:26 +0100 Subject: [PATCH 166/180] v3 --- tests/Command/RouterClearCacheCommandTest.php | 14 +++--- tests/Command/RouterListRoutesCommandTest.php | 2 +- .../Language/LanguageComparatorTest.php | 34 ++++++++----- .../MediaType/MediaTypeComparatorTest.php | 48 +++++++++++-------- tests/Event/RoutePostRunEventTest.php | 40 +++++++++------- tests/Event/RoutePreRunEventTest.php | 34 +++++++------ 6 files changed, 101 insertions(+), 71 deletions(-) diff --git a/tests/Command/RouterClearCacheCommandTest.php b/tests/Command/RouterClearCacheCommandTest.php index dfd4f964..c29d3433 100644 --- a/tests/Command/RouterClearCacheCommandTest.php +++ b/tests/Command/RouterClearCacheCommandTest.php @@ -5,9 +5,9 @@ namespace Sunrise\Http\Router\Tests\Command; use PHPUnit\Framework\MockObject\MockObject; +use PHPUnit\Framework\TestCase; use Psr\SimpleCache\CacheInterface; use Sunrise\Http\Router\Command\RouterClearCacheCommand; -use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Dictionary\CacheKey; use Symfony\Component\Console\Tester\CommandTester; @@ -20,18 +20,18 @@ protected function setUp(): void $this->cacheMock = $this->createMock(CacheInterface::class); } - public function testExecuteWithoutCache(): void + public function testExecute(): void { - $command = new RouterClearCacheCommand(null); + $this->cacheMock->expects($this->once())->method('delete')->with(CacheKey::DESCRIPTORS); + + $command = new RouterClearCacheCommand($this->cacheMock); $commandTester = new CommandTester($command); $this->assertSame(0, $commandTester->execute([])); } - public function testExecuteWithCache(): void + public function testExecuteWithoutCache(): void { - $this->cacheMock->expects($this->once())->method('delete')->with(CacheKey::DESCRIPTORS); - - $command = new RouterClearCacheCommand($this->cacheMock); + $command = new RouterClearCacheCommand(null); $commandTester = new CommandTester($command); $this->assertSame(0, $commandTester->execute([])); } diff --git a/tests/Command/RouterListRoutesCommandTest.php b/tests/Command/RouterListRoutesCommandTest.php index d6b7aaea..0dc8c83e 100644 --- a/tests/Command/RouterListRoutesCommandTest.php +++ b/tests/Command/RouterListRoutesCommandTest.php @@ -5,8 +5,8 @@ namespace Sunrise\Http\Router\Tests\Command; use PHPUnit\Framework\MockObject\MockObject; -use Sunrise\Http\Router\Command\RouterListRoutesCommand; use PHPUnit\Framework\TestCase; +use Sunrise\Http\Router\Command\RouterListRoutesCommand; use Sunrise\Http\Router\RouterInterface; use Symfony\Component\Console\Tester\CommandTester; diff --git a/tests/Entity/Language/LanguageComparatorTest.php b/tests/Entity/Language/LanguageComparatorTest.php index c809295b..deac4301 100644 --- a/tests/Entity/Language/LanguageComparatorTest.php +++ b/tests/Entity/Language/LanguageComparatorTest.php @@ -4,10 +4,10 @@ namespace Sunrise\Http\Router\Tests\Entity\Language; +use PHPUnit\Framework\MockObject\MockObject; use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Entity\Language\LanguageComparator; use Sunrise\Http\Router\Entity\Language\LanguageInterface; -use Sunrise\Http\Router\Entity\Language\ServerLanguage; final class LanguageComparatorTest extends TestCase { @@ -22,39 +22,47 @@ public function testCompare(LanguageInterface $a, LanguageInterface $b, int $exp private function compareDataProvider(): iterable { yield [ - new ServerLanguage('sr'), - new ServerLanguage('sr'), + $this->mockLanguage('sr'), + $this->mockLanguage('sr'), 0, ]; yield [ - new ServerLanguage('*'), - new ServerLanguage('*'), + $this->mockLanguage('*'), + $this->mockLanguage('*'), 0, ]; yield [ - new ServerLanguage('*'), - new ServerLanguage('sr'), + $this->mockLanguage('*'), + $this->mockLanguage('sr'), 0, ]; yield [ - new ServerLanguage('sr'), - new ServerLanguage('*'), + $this->mockLanguage('sr'), + $this->mockLanguage('*'), 0, ]; yield [ - new ServerLanguage('sr'), - new ServerLanguage('bs'), + $this->mockLanguage('sr'), + $this->mockLanguage('bs'), 'sr' <=> 'bs', ]; yield [ - new ServerLanguage('bs'), - new ServerLanguage('sr'), + $this->mockLanguage('bs'), + $this->mockLanguage('sr'), 'bs' <=> 'sr', ]; } + + private function mockLanguage(string $code): LanguageInterface&MockObject + { + $languageMock = $this->createMock(LanguageInterface::class); + $languageMock->method('getCode')->willReturn($code); + + return $languageMock; + } } diff --git a/tests/Entity/MediaType/MediaTypeComparatorTest.php b/tests/Entity/MediaType/MediaTypeComparatorTest.php index c14cfd65..778c4662 100644 --- a/tests/Entity/MediaType/MediaTypeComparatorTest.php +++ b/tests/Entity/MediaType/MediaTypeComparatorTest.php @@ -4,10 +4,10 @@ namespace Sunrise\Http\Router\Tests\Entity\MediaType; +use PHPUnit\Framework\MockObject\MockObject; use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaType; final class MediaTypeComparatorTest extends TestCase { @@ -22,57 +22,67 @@ public function testCompare(MediaTypeInterface $a, MediaTypeInterface $b, int $e private function compareDataProvider(): iterable { yield [ - new ServerMediaType('application', 'json'), - new ServerMediaType('application', 'json'), + $this->mockMediaType('application', 'json'), + $this->mockMediaType('application', 'json'), 0, ]; yield [ - new ServerMediaType('*', '*'), - new ServerMediaType('*', '*'), + $this->mockMediaType('*', '*'), + $this->mockMediaType('*', '*'), 0, ]; yield [ - new ServerMediaType('*', '*'), - new ServerMediaType('application', 'json'), + $this->mockMediaType('*', '*'), + $this->mockMediaType('application', 'json'), 0, ]; yield [ - new ServerMediaType('application', 'json'), - new ServerMediaType('*', '*'), + $this->mockMediaType('application', 'json'), + $this->mockMediaType('*', '*'), 0, ]; yield [ - new ServerMediaType('image', '*'), - new ServerMediaType('image', '*'), + $this->mockMediaType('image', '*'), + $this->mockMediaType('image', '*'), 0, ]; yield [ - new ServerMediaType('image', '*'), - new ServerMediaType('image', 'webp'), + $this->mockMediaType('image', '*'), + $this->mockMediaType('image', 'webp'), 0, ]; yield [ - new ServerMediaType('image', 'webp'), - new ServerMediaType('image', '*'), + $this->mockMediaType('image', 'webp'), + $this->mockMediaType('image', '*'), 0, ]; yield [ - new ServerMediaType('application', 'json'), - new ServerMediaType('application', 'xml'), + $this->mockMediaType('application', 'json'), + $this->mockMediaType('application', 'xml'), 'application/json' <=> 'application/xml', ]; yield [ - new ServerMediaType('application', 'xml'), - new ServerMediaType('application', 'json'), + $this->mockMediaType('application', 'xml'), + $this->mockMediaType('application', 'json'), 'application/xml' <=> 'application/json', ]; } + + private function mockMediaType(string $type, string $subtype): MediaTypeInterface&MockObject + { + $mediaTypeMock = $this->createMock(MediaTypeInterface::class); + $mediaTypeMock->method('getType')->willReturn($type); + $mediaTypeMock->method('getSubtype')->willReturn($subtype); + $mediaTypeMock->method('__toString')->willReturn($type . '/' . $subtype); + + return $mediaTypeMock; + } } diff --git a/tests/Event/RoutePostRunEventTest.php b/tests/Event/RoutePostRunEventTest.php index 60c77b37..c9478736 100644 --- a/tests/Event/RoutePostRunEventTest.php +++ b/tests/Event/RoutePostRunEventTest.php @@ -4,6 +4,7 @@ namespace Sunrise\Http\Router\Tests\Event; +use PHPUnit\Framework\MockObject\MockObject; use PHPUnit\Framework\TestCase; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; @@ -12,29 +13,34 @@ final class RoutePostRunEventTest extends TestCase { - public function testConstructor(): void + private RouteInterface&MockObject $routeMock; + private ServerRequestInterface&MockObject $serverRequestMock; + private ResponseInterface&MockObject $responseMock; + + protected function setUp(): void { - $route = $this->createMock(RouteInterface::class); - $request = $this->createMock(ServerRequestInterface::class); - $response = $this->createMock(ResponseInterface::class); + $this->routeMock = $this->createMock(RouteInterface::class); + $this->serverRequestMock = $this->createMock(ServerRequestInterface::class); + $this->responseMock = $this->createMock(ResponseInterface::class); + } - $event = new RoutePostRunEvent($route, $request, $response); + public function testConstructor(): void + { + $event = new RoutePostRunEvent($this->routeMock, $this->serverRequestMock, $this->responseMock); - $this->assertSame($route, $event->getRoute()); - $this->assertSame($request, $event->getRequest()); - $this->assertSame($response, $event->getResponse()); + $this->assertSame($this->routeMock, $event->getRoute()); + $this->assertSame($this->serverRequestMock, $event->getRequest()); + $this->assertSame($this->responseMock, $event->getResponse()); } public function testSetResponse(): void { - $event = new RoutePostRunEvent( - $this->createMock(RouteInterface::class), - $this->createMock(ServerRequestInterface::class), - $this->createMock(ResponseInterface::class), - ); - - $response = $this->createMock(ResponseInterface::class); - $event->setResponse($response); - $this->assertSame($response, $event->getResponse()); + $event = new RoutePostRunEvent($this->routeMock, $this->serverRequestMock, $this->responseMock); + + $newResponse = clone $this->responseMock; + $this->assertNotSame($this->responseMock, $newResponse); + + $event->setResponse($newResponse); + $this->assertSame($newResponse, $event->getResponse()); } } diff --git a/tests/Event/RoutePreRunEventTest.php b/tests/Event/RoutePreRunEventTest.php index 07c4f436..4696b5a9 100644 --- a/tests/Event/RoutePreRunEventTest.php +++ b/tests/Event/RoutePreRunEventTest.php @@ -4,6 +4,7 @@ namespace Sunrise\Http\Router\Tests\Event; +use PHPUnit\Framework\MockObject\MockObject; use PHPUnit\Framework\TestCase; use Psr\Http\Message\ServerRequestInterface; use Sunrise\Http\Router\Event\RoutePreRunEvent; @@ -11,26 +12,31 @@ final class RoutePreRunEventTest extends TestCase { - public function testConstructor(): void + private RouteInterface&MockObject $routeMock; + private ServerRequestInterface&MockObject $serverRequestMock; + + protected function setUp(): void { - $route = $this->createMock(RouteInterface::class); - $request = $this->createMock(ServerRequestInterface::class); + $this->routeMock = $this->createMock(RouteInterface::class); + $this->serverRequestMock = $this->createMock(ServerRequestInterface::class); + } - $event = new RoutePreRunEvent($route, $request); + public function testConstructor(): void + { + $event = new RoutePreRunEvent($this->routeMock, $this->serverRequestMock); - $this->assertSame($route, $event->getRoute()); - $this->assertSame($request, $event->getRequest()); + $this->assertSame($this->routeMock, $event->getRoute()); + $this->assertSame($this->serverRequestMock, $event->getRequest()); } public function testSetRequest(): void { - $event = new RoutePreRunEvent( - $this->createMock(RouteInterface::class), - $this->createMock(ServerRequestInterface::class), - ); - - $request = $this->createMock(ServerRequestInterface::class); - $event->setRequest($request); - $this->assertSame($request, $event->getRequest()); + $event = new RoutePreRunEvent($this->routeMock, $this->serverRequestMock); + + $newServerRequest = clone $this->serverRequestMock; + $this->assertNotSame($this->serverRequestMock, $newServerRequest); + + $event->setRequest($newServerRequest); + $this->assertSame($newServerRequest, $event->getRequest()); } } From 7bf685fa90f24198e226c12376cd22537850fb70 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 1 Nov 2024 06:00:56 +0100 Subject: [PATCH 167/180] v3 --- src/Helper/ClassFinder.php | 8 +- tests/Entity/Language/ClientLanguageTest.php | 9 +- tests/Entity/Language/ServerLanguageTest.php | 5 +- .../Entity/MediaType/ClientMediaTypeTest.php | 14 +- .../Entity/MediaType/ServerMediaTypeTest.php | 12 +- tests/Event/RoutePostRunEventTest.php | 7 +- tests/Event/RoutePreRunEventTest.php | 7 +- tests/Exception/HttpExceptionTest.php | 258 ++++++++++++++++++ tests/Helper/RouteParserTest.php | 2 - 9 files changed, 281 insertions(+), 41 deletions(-) create mode 100644 tests/Exception/HttpExceptionTest.php diff --git a/src/Helper/ClassFinder.php b/src/Helper/ClassFinder.php index 468405ab..aa35ca84 100644 --- a/src/Helper/ClassFinder.php +++ b/src/Helper/ClassFinder.php @@ -35,7 +35,7 @@ final class ClassFinder { /** - * @return Generator> + * @return Generator> * * @throws InvalidArgumentException * @throws ReflectionException @@ -63,13 +63,13 @@ public static function getDirClasses(string $dirname): Generator foreach (get_declared_classes() as $className) { $classReflection = new ReflectionClass($className); if (isset($filenames[$classReflection->getFileName()])) { - yield $classReflection; + yield $className => $classReflection; } } } /** - * @return Generator> + * @return Generator> * * @throws InvalidArgumentException * @throws ReflectionException @@ -91,7 +91,7 @@ public static function getFileClasses(string $filename): Generator foreach (get_declared_classes() as $className) { $classReflection = new ReflectionClass($className); if ($classReflection->getFileName() === $filename) { - yield $classReflection; + yield $className => $classReflection; } } } diff --git a/tests/Entity/Language/ClientLanguageTest.php b/tests/Entity/Language/ClientLanguageTest.php index 068901b0..70fc3062 100644 --- a/tests/Entity/Language/ClientLanguageTest.php +++ b/tests/Entity/Language/ClientLanguageTest.php @@ -11,10 +11,9 @@ final class ClientLanguageTest extends TestCase { public function testConstructor(): void { - $language = new ClientLanguage('sr', 'sr-RS', ['q' => '1.0']); - - $this->assertSame('sr', $language->getCode()); - $this->assertSame('sr-RS', $language->getIdentifier()); - $this->assertSame(['q' => '1.0'], $language->getParameters()); + $clientLanguage = new ClientLanguage('sr', 'sr-RS', ['q' => '1.0']); + $this->assertSame('sr', $clientLanguage->getCode()); + $this->assertSame('sr-RS', $clientLanguage->getIdentifier()); + $this->assertSame(['q' => '1.0'], $clientLanguage->getParameters()); } } diff --git a/tests/Entity/Language/ServerLanguageTest.php b/tests/Entity/Language/ServerLanguageTest.php index bd6cbcab..d7d582c7 100644 --- a/tests/Entity/Language/ServerLanguageTest.php +++ b/tests/Entity/Language/ServerLanguageTest.php @@ -11,8 +11,7 @@ final class ServerLanguageTest extends TestCase { public function testConstructor(): void { - $language = new ServerLanguage('sr'); - - $this->assertSame('sr', $language->getCode()); + $serverLanguage = new ServerLanguage('sr'); + $this->assertSame('sr', $serverLanguage->getCode()); } } diff --git a/tests/Entity/MediaType/ClientMediaTypeTest.php b/tests/Entity/MediaType/ClientMediaTypeTest.php index fe214210..bbeee308 100644 --- a/tests/Entity/MediaType/ClientMediaTypeTest.php +++ b/tests/Entity/MediaType/ClientMediaTypeTest.php @@ -11,17 +11,15 @@ final class ClientMediaTypeTest extends TestCase { public function testConstructor(): void { - $mediaType = new ClientMediaType('application', 'json', ['q' => '1.0']); - - $this->assertSame('application', $mediaType->getType()); - $this->assertSame('json', $mediaType->getSubtype()); - $this->assertSame(['q' => '1.0'], $mediaType->getParameters()); + $clientMediaType = new ClientMediaType('application', 'json', ['q' => '1.0']); + $this->assertSame('application', $clientMediaType->getType()); + $this->assertSame('json', $clientMediaType->getSubtype()); + $this->assertSame(['q' => '1.0'], $clientMediaType->getParameters()); } public function testToString(): void { - $mediaType = new ClientMediaType('application', 'json', ['q' => '1.0']); - - $this->assertSame('application/json', (string) $mediaType); + $clientMediaType = new ClientMediaType('application', 'json', ['q' => '1.0']); + $this->assertSame('application/json', (string) $clientMediaType); } } diff --git a/tests/Entity/MediaType/ServerMediaTypeTest.php b/tests/Entity/MediaType/ServerMediaTypeTest.php index bc9949f0..acd51493 100644 --- a/tests/Entity/MediaType/ServerMediaTypeTest.php +++ b/tests/Entity/MediaType/ServerMediaTypeTest.php @@ -11,16 +11,14 @@ final class ServerMediaTypeTest extends TestCase { public function testConstructor(): void { - $mediaType = new ServerMediaType('application', 'json'); - - $this->assertSame('application', $mediaType->getType()); - $this->assertSame('json', $mediaType->getSubtype()); + $serverMediaType = new ServerMediaType('application', 'json'); + $this->assertSame('application', $serverMediaType->getType()); + $this->assertSame('json', $serverMediaType->getSubtype()); } public function testToString(): void { - $mediaType = new ServerMediaType('application', 'json'); - - $this->assertSame('application/json', (string) $mediaType); + $serverMediaType = new ServerMediaType('application', 'json'); + $this->assertSame('application/json', (string) $serverMediaType); } } diff --git a/tests/Event/RoutePostRunEventTest.php b/tests/Event/RoutePostRunEventTest.php index c9478736..e05b0e1f 100644 --- a/tests/Event/RoutePostRunEventTest.php +++ b/tests/Event/RoutePostRunEventTest.php @@ -27,7 +27,6 @@ protected function setUp(): void public function testConstructor(): void { $event = new RoutePostRunEvent($this->routeMock, $this->serverRequestMock, $this->responseMock); - $this->assertSame($this->routeMock, $event->getRoute()); $this->assertSame($this->serverRequestMock, $event->getRequest()); $this->assertSame($this->responseMock, $event->getResponse()); @@ -36,11 +35,7 @@ public function testConstructor(): void public function testSetResponse(): void { $event = new RoutePostRunEvent($this->routeMock, $this->serverRequestMock, $this->responseMock); - - $newResponse = clone $this->responseMock; - $this->assertNotSame($this->responseMock, $newResponse); - - $event->setResponse($newResponse); + $event->setResponse($newResponse = clone $this->responseMock); $this->assertSame($newResponse, $event->getResponse()); } } diff --git a/tests/Event/RoutePreRunEventTest.php b/tests/Event/RoutePreRunEventTest.php index 4696b5a9..f3d1c02c 100644 --- a/tests/Event/RoutePreRunEventTest.php +++ b/tests/Event/RoutePreRunEventTest.php @@ -24,7 +24,6 @@ protected function setUp(): void public function testConstructor(): void { $event = new RoutePreRunEvent($this->routeMock, $this->serverRequestMock); - $this->assertSame($this->routeMock, $event->getRoute()); $this->assertSame($this->serverRequestMock, $event->getRequest()); } @@ -32,11 +31,7 @@ public function testConstructor(): void public function testSetRequest(): void { $event = new RoutePreRunEvent($this->routeMock, $this->serverRequestMock); - - $newServerRequest = clone $this->serverRequestMock; - $this->assertNotSame($this->serverRequestMock, $newServerRequest); - - $event->setRequest($newServerRequest); + $event->setRequest($newServerRequest = clone $this->serverRequestMock); $this->assertSame($newServerRequest, $event->getRequest()); } } diff --git a/tests/Exception/HttpExceptionTest.php b/tests/Exception/HttpExceptionTest.php new file mode 100644 index 00000000..74d2b45b --- /dev/null +++ b/tests/Exception/HttpExceptionTest.php @@ -0,0 +1,258 @@ +createMock(Throwable::class); + $httpException = new HttpException('foo', 400, $previous); + $this->assertSame('foo', $httpException->getMessage()); + $this->assertSame(400, $httpException->getCode()); + $this->assertSame($previous, $httpException->getPrevious()); + $this->assertSame('foo', $httpException->getMessageTemplate()); + $this->assertSame([], $httpException->getMessagePlaceholders()); + $this->assertSame([], $httpException->getHeaderFields()); + $this->assertSame([], $httpException->getConstraintViolations()); + } + + public function testConstructorWithoutOptionalParameters(): void + { + $httpException = new HttpException('foo', 400); + $this->assertSame('foo', $httpException->getMessage()); + $this->assertSame(400, $httpException->getCode()); + $this->assertNull($httpException->getPrevious()); + $this->assertSame('foo', $httpException->getMessageTemplate()); + $this->assertSame([], $httpException->getMessagePlaceholders()); + $this->assertSame([], $httpException->getHeaderFields()); + $this->assertSame([], $httpException->getConstraintViolations()); + } + + public function testAddMessagePlaceholder(): void + { + } + + public function testAddHeaderFieldWithString(): void + { + $httpException = new HttpException('foo', 400); + + $httpException->addHeaderField('x-foo', 'bar', 'baz'); + $httpException->addHeaderField('x-foo', 'qux'); + $httpException->addHeaderField('x-foo'); + + $this->assertSame([ + ['x-foo', 'bar, baz'], + ['x-foo', 'qux'], + ['x-foo', ''], + ], $httpException->getHeaderFields()); + } + + public function testAddHeaderFieldWithStringableObject(): void + { + $httpException = new HttpException('foo', 400); + $httpException->addHeaderField('x-foo', $this->mockStringableObject('bar')); + $this->assertSame([['x-foo', 'bar']], $httpException->getHeaderFields()); + } + + public function testAddConstraintViolation(): void + { + $httpException = new HttpException('foo', 400); + $constraintViolations = []; + $constraintViolations[] = $this->createMock(ConstraintViolationInterface::class); + $constraintViolations[] = $this->createMock(ConstraintViolationInterface::class); + $httpException->addConstraintViolation(...$constraintViolations); + $additionalConstraintViolation = $this->createMock(ConstraintViolationInterface::class); + $httpException->addConstraintViolation($additionalConstraintViolation); + $expectedConstraintViolations = [...$constraintViolations, $additionalConstraintViolation]; + $this->assertSame($expectedConstraintViolations, $httpException->getConstraintViolations()); + } + + public function testAddHydratorConstraintViolations(): void + { + /** + * @var array{ + * 0: \Sunrise\Hydrator\Exception\InvalidValueException, + * 1: \Sunrise\Hydrator\Exception\InvalidValueException + * } $hydratorConstraintViolations + */ + $hydratorConstraintViolations = [ + $this->createHydratorConstraintViolation( + message: 'foo {bar}', + messageTemplate: 'foo {bar}', + messagePlaceholders: ['{bar}' => 'bar'], + propertyPath: ['foo', 'bar'], + errorCode: '00000000-0000-0000-0000-000000000000', + invalidValue: ['bar' => null], + ), + $this->createHydratorConstraintViolation( + message: 'bar {baz}', + messageTemplate: 'bar {baz}', + messagePlaceholders: ['{baz}' => 'baz'], + propertyPath: ['bar', 'baz'], + errorCode: '00000000-0000-0000-0000-000000000001', + invalidValue: ['baz' => null], + ), + ]; + + $additionalHydratorConstraintViolation = $this->createHydratorConstraintViolation( + message: 'baz {qux}', + messageTemplate: 'baz {qux}', + messagePlaceholders: ['{qux}' => 'qux'], + propertyPath: ['baz', 'qux'], + errorCode: '00000000-0000-0000-0000-000000000002', + invalidValue: ['qux' => null], + ); + + $httpException = new HttpException('foo', 400); + $httpException->addHydratorConstraintViolations(...$hydratorConstraintViolations); + $httpException->addHydratorConstraintViolations($additionalHydratorConstraintViolation); + $constraintViolations = $httpException->getConstraintViolations(); + $this->assertCount(3, $constraintViolations); + + $this->assertArrayHasKey(0, $constraintViolations); + $this->assertSame($hydratorConstraintViolations[0]->getMessage(), $constraintViolations[0]->getMessage()); + $this->assertSame($hydratorConstraintViolations[0]->getMessageTemplate(), $constraintViolations[0]->getMessageTemplate()); + $this->assertSame($hydratorConstraintViolations[0]->getMessagePlaceholders(), $constraintViolations[0]->getMessagePlaceholders()); + $this->assertSame($hydratorConstraintViolations[0]->getPropertyPath(), $constraintViolations[0]->getPropertyPath()); + $this->assertSame($hydratorConstraintViolations[0]->getErrorCode(), $constraintViolations[0]->getCode()); + $this->assertSame($hydratorConstraintViolations[0]->getInvalidValue(), $constraintViolations[0]->getInvalidValue()); + + $this->assertArrayHasKey(1, $constraintViolations); + $this->assertSame($hydratorConstraintViolations[1]->getMessage(), $constraintViolations[1]->getMessage()); + $this->assertSame($hydratorConstraintViolations[1]->getMessageTemplate(), $constraintViolations[1]->getMessageTemplate()); + $this->assertSame($hydratorConstraintViolations[1]->getMessagePlaceholders(), $constraintViolations[1]->getMessagePlaceholders()); + $this->assertSame($hydratorConstraintViolations[1]->getPropertyPath(), $constraintViolations[1]->getPropertyPath()); + $this->assertSame($hydratorConstraintViolations[1]->getErrorCode(), $constraintViolations[1]->getCode()); + $this->assertSame($hydratorConstraintViolations[1]->getInvalidValue(), $constraintViolations[1]->getInvalidValue()); + + $this->assertArrayHasKey(2, $constraintViolations); + $this->assertSame($additionalHydratorConstraintViolation->getMessage(), $constraintViolations[2]->getMessage()); + $this->assertSame($additionalHydratorConstraintViolation->getMessageTemplate(), $constraintViolations[2]->getMessageTemplate()); + $this->assertSame($additionalHydratorConstraintViolation->getMessagePlaceholders(), $constraintViolations[2]->getMessagePlaceholders()); + $this->assertSame($additionalHydratorConstraintViolation->getPropertyPath(), $constraintViolations[2]->getPropertyPath()); + $this->assertSame($additionalHydratorConstraintViolation->getErrorCode(), $constraintViolations[2]->getCode()); + $this->assertSame($additionalHydratorConstraintViolation->getInvalidValue(), $constraintViolations[2]->getInvalidValue()); + } + + public function testAddValidatorConstraintViolations(): void + { + /** + * @var array{ + * 0: \Symfony\Component\Validator\ConstraintViolationInterface&MockObject, + * 1: \Symfony\Component\Validator\ConstraintViolationInterface&MockObject + * } $validatorConstraintViolations + */ + $validatorConstraintViolations = [ + $this->mockValidatorConstraintViolation( + message: 'foo {bar}', + messageTemplate: 'foo {bar}', + messagePlaceholders: ['{bar}' => 'bar'], + propertyPath: 'foo.bar', + errorCode: '00000000-0000-0000-0000-000000000000', + invalidValue: ['bar' => null], + ), + $this->mockValidatorConstraintViolation( + message: 'bar {baz}', + messageTemplate: 'bar {baz}', + messagePlaceholders: ['{baz}' => 'baz'], + propertyPath: 'bar.baz', + errorCode: '00000000-0000-0000-0000-000000000001', + invalidValue: ['baz' => null], + ), + ]; + + $additionalValidatorConstraintViolation = $this->mockValidatorConstraintViolation( + message: 'baz {qux}', + messageTemplate: 'baz {qux}', + messagePlaceholders: ['{qux}' => 'qux'], + propertyPath: 'baz.qux', + errorCode: '00000000-0000-0000-0000-000000000002', + invalidValue: ['qux' => null], + ); + + $httpException = new HttpException('foo', 400); + $httpException->addValidatorConstraintViolations(...$validatorConstraintViolations); + $httpException->addValidatorConstraintViolations($additionalValidatorConstraintViolation); + $constraintViolations = $httpException->getConstraintViolations(); + $this->assertCount(3, $constraintViolations); + + $this->assertArrayHasKey(0, $constraintViolations); + $this->assertSame($validatorConstraintViolations[0]->getMessage(), $constraintViolations[0]->getMessage()); + $this->assertSame($validatorConstraintViolations[0]->getMessageTemplate(), $constraintViolations[0]->getMessageTemplate()); + $this->assertSame($validatorConstraintViolations[0]->getParameters(), $constraintViolations[0]->getMessagePlaceholders()); + $this->assertSame($validatorConstraintViolations[0]->getPropertyPath(), $constraintViolations[0]->getPropertyPath()); + $this->assertSame($validatorConstraintViolations[0]->getCode(), $constraintViolations[0]->getCode()); + $this->assertSame($validatorConstraintViolations[0]->getInvalidValue(), $constraintViolations[0]->getInvalidValue()); + + $this->assertArrayHasKey(1, $constraintViolations); + $this->assertSame($validatorConstraintViolations[1]->getMessage(), $constraintViolations[1]->getMessage()); + $this->assertSame($validatorConstraintViolations[1]->getMessageTemplate(), $constraintViolations[1]->getMessageTemplate()); + $this->assertSame($validatorConstraintViolations[1]->getParameters(), $constraintViolations[1]->getMessagePlaceholders()); + $this->assertSame($validatorConstraintViolations[1]->getPropertyPath(), $constraintViolations[1]->getPropertyPath()); + $this->assertSame($validatorConstraintViolations[1]->getCode(), $constraintViolations[1]->getCode()); + $this->assertSame($validatorConstraintViolations[1]->getInvalidValue(), $constraintViolations[1]->getInvalidValue()); + + $this->assertArrayHasKey(2, $constraintViolations); + $this->assertSame($additionalValidatorConstraintViolation->getMessage(), $constraintViolations[2]->getMessage()); + $this->assertSame($additionalValidatorConstraintViolation->getMessageTemplate(), $constraintViolations[2]->getMessageTemplate()); + $this->assertSame($additionalValidatorConstraintViolation->getParameters(), $constraintViolations[2]->getMessagePlaceholders()); + $this->assertSame($additionalValidatorConstraintViolation->getPropertyPath(), $constraintViolations[2]->getPropertyPath()); + $this->assertSame($additionalValidatorConstraintViolation->getCode(), $constraintViolations[2]->getCode()); + $this->assertSame($additionalValidatorConstraintViolation->getInvalidValue(), $constraintViolations[2]->getInvalidValue()); + } + + private function mockStringableObject(string $string): Stringable&MockObject + { + $stringableObjectMock = $this->createMock(Stringable::class); + $stringableObjectMock->method('__toString')->willReturn($string); + + return $stringableObjectMock; + } + + private function createHydratorConstraintViolation( + string $message, + string $messageTemplate, + array $messagePlaceholders, + array $propertyPath, + string $errorCode, + mixed $invalidValue = null, + ): \Sunrise\Hydrator\Exception\InvalidValueException { + return new \Sunrise\Hydrator\Exception\InvalidValueException( + message: $message, + errorCode: $errorCode, + propertyPath: $propertyPath, + messageTemplate: $messageTemplate, + messagePlaceholders: $messagePlaceholders, + invalidValue: $invalidValue, + ); + } + + private function mockValidatorConstraintViolation( + string $message, + string $messageTemplate, + array $messagePlaceholders, + string $propertyPath, + string $errorCode, + mixed $invalidValue = null, + ): \Symfony\Component\Validator\ConstraintViolationInterface&MockObject { + $constraintViolationMock = $this->createMock(\Symfony\Component\Validator\ConstraintViolationInterface::class); + $constraintViolationMock->method('getMessage')->willReturn($message); + $constraintViolationMock->method('getMessageTemplate')->willReturn($messageTemplate); + $constraintViolationMock->method('getParameters')->willReturn($messagePlaceholders); + $constraintViolationMock->method('getPropertyPath')->willReturn($propertyPath); + $constraintViolationMock->method('getCode')->willReturn($errorCode); + $constraintViolationMock->method('getInvalidValue')->willReturn($invalidValue); + + return $constraintViolationMock; + } +} diff --git a/tests/Helper/RouteParserTest.php b/tests/Helper/RouteParserTest.php index d10d47a3..704806a2 100644 --- a/tests/Helper/RouteParserTest.php +++ b/tests/Helper/RouteParserTest.php @@ -16,7 +16,6 @@ final class RouteParserTest extends TestCase public function testParseValidRoute(string $route, array $expectedVariables): void { $actualVariables = RouteParser::parseRoute($route); - $this->assertEquals($expectedVariables, $actualVariables); } @@ -27,7 +26,6 @@ public function testParseInvalidRoute(string $route, string $expectedMessageRege { $this->expectException(InvalidArgumentException::class); $this->expectExceptionMessageMatches($expectedMessageRegex); - RouteParser::parseRoute($route); } From e0f4e9838ca8dbd3417bca0452b8b7e9f6ac6fe7 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 1 Nov 2024 06:14:34 +0100 Subject: [PATCH 168/180] v3 --- composer.json | 1 + 1 file changed, 1 insertion(+) diff --git a/composer.json b/composer.json index cacaf3dd..f701053c 100644 --- a/composer.json +++ b/composer.json @@ -40,6 +40,7 @@ "php-di/php-di": "^7.0", "phpstan/phpstan": "^1.12", "phpunit/phpunit": "^9.6", + "squizlabs/php_codesniffer": "^3.10", "sunrise/coding-standard": "^1.0", "sunrise/hydrator": "^3.13", "symfony/console": "^6.4", From 2f9c06304237f45c94fc3ba0fe7e46022fffa37d Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 1 Nov 2024 06:21:29 +0100 Subject: [PATCH 169/180] v3 --- composer.json | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/composer.json b/composer.json index f701053c..e6674a8f 100644 --- a/composer.json +++ b/composer.json @@ -30,7 +30,7 @@ "psr/container": "^1.0 || ^2.0", "psr/event-dispatcher": "^1.0", "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", "psr/log": "^1.0 || ^2.0 || ^3.0", @@ -39,9 +39,8 @@ "require-dev": { "php-di/php-di": "^7.0", "phpstan/phpstan": "^1.12", - "phpunit/phpunit": "^9.6", + "phpunit/phpunit": "^10.5", "squizlabs/php_codesniffer": "^3.10", - "sunrise/coding-standard": "^1.0", "sunrise/hydrator": "^3.13", "symfony/console": "^6.4", "symfony/validator": "^6.4", From 0b6d58b491ec9f59e8db9d6d9398c4c56b89a326 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 1 Nov 2024 18:25:39 +0100 Subject: [PATCH 170/180] v3 --- src/Annotation/Consumes.php | 2 +- src/Annotation/ConsumesImage.php | 4 +- src/Annotation/ConsumesJson.php | 4 +- src/Annotation/ConsumesXml.php | 4 +- .../{Attribute.php => DefaultAttribute.php} | 6 +- src/Annotation/Produces.php | 2 +- src/Annotation/ProducesHtml.php | 4 +- src/Annotation/ProducesJson.php | 4 +- src/Annotation/ProducesText.php | 4 +- src/Annotation/ProducesXml.php | 4 +- .../{EmptyResponse.php => ResponseEmpty.php} | 2 +- .../{JsonResponse.php => ResponseJson.php} | 2 +- .../{ClientLanguage.php => Language.php} | 10 +-- src/Entity/Language/LanguageComparator.php | 6 +- src/Entity/Language/ServerLanguage.php | 30 -------- .../{ClientMediaType.php => MediaType.php} | 11 ++- src/Entity/MediaType/MediaTypeComparator.php | 1 - ...iaTypeFactory.php => MediaTypeFactory.php} | 45 ++++++----- src/Entity/MediaType/ServerMediaType.php | 41 ---------- src/Loader/DescriptorLoader.php | 12 +-- .../JsonPayloadDecodingMiddleware.php | 4 +- ...Resolver.php => ResponseEmptyResolver.php} | 6 +- ...eResolver.php => ResponseJsonResolver.php} | 8 +- src/ServerRequest.php | 20 ++--- tests/Command/RouterClearCacheCommandTest.php | 2 +- tests/Command/RouterListRoutesCommandTest.php | 24 +++++- tests/Entity/Language/ClientLanguageTest.php | 19 ----- .../Language/LanguageComparatorTest.php | 57 ++++---------- tests/Entity/Language/LanguageTest.php | 27 +++++++ tests/Entity/Language/ServerLanguageTest.php | 17 ----- .../Entity/MediaType/ClientMediaTypeTest.php | 25 ------- .../MediaType/MediaTypeComparatorTest.php | 64 ++++++++++------ .../Entity/MediaType/MediaTypeFactoryTest.php | 74 +++++++++++++++++++ tests/Entity/MediaType/MediaTypeTest.php | 35 +++++++++ .../Entity/MediaType/ServerMediaTypeTest.php | 24 ------ 35 files changed, 303 insertions(+), 301 deletions(-) rename src/Annotation/{Attribute.php => DefaultAttribute.php} (79%) rename src/Annotation/{EmptyResponse.php => ResponseEmpty.php} (94%) rename src/Annotation/{JsonResponse.php => ResponseJson.php} (96%) rename src/Entity/Language/{ClientLanguage.php => Language.php} (73%) delete mode 100644 src/Entity/Language/ServerLanguage.php rename src/Entity/MediaType/{ClientMediaType.php => MediaType.php} (83%) rename src/Entity/MediaType/{ServerMediaTypeFactory.php => MediaTypeFactory.php} (70%) delete mode 100644 src/Entity/MediaType/ServerMediaType.php rename src/ResponseResolver/{EmptyResponseResolver.php => ResponseEmptyResolver.php} (88%) rename src/ResponseResolver/{JsonResponseResolver.php => ResponseJsonResolver.php} (91%) delete mode 100644 tests/Entity/Language/ClientLanguageTest.php create mode 100644 tests/Entity/Language/LanguageTest.php delete mode 100644 tests/Entity/Language/ServerLanguageTest.php delete mode 100644 tests/Entity/MediaType/ClientMediaTypeTest.php create mode 100644 tests/Entity/MediaType/MediaTypeFactoryTest.php create mode 100644 tests/Entity/MediaType/MediaTypeTest.php delete mode 100644 tests/Entity/MediaType/ServerMediaTypeTest.php diff --git a/src/Annotation/Consumes.php b/src/Annotation/Consumes.php index 91554e45..235c35eb 100644 --- a/src/Annotation/Consumes.php +++ b/src/Annotation/Consumes.php @@ -23,7 +23,7 @@ class Consumes { public function __construct( - public readonly MediaTypeInterface $value, + public readonly MediaTypeInterface|string $value, ) { } } diff --git a/src/Annotation/ConsumesImage.php b/src/Annotation/ConsumesImage.php index 7de292e2..5b421104 100644 --- a/src/Annotation/ConsumesImage.php +++ b/src/Annotation/ConsumesImage.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ConsumesImage extends Consumes { public function __construct() { - parent::__construct(ServerMediaTypeFactory::image()); + parent::__construct(MediaTypeFactory::image()); } } diff --git a/src/Annotation/ConsumesJson.php b/src/Annotation/ConsumesJson.php index 3d95c027..3524279d 100644 --- a/src/Annotation/ConsumesJson.php +++ b/src/Annotation/ConsumesJson.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ConsumesJson extends Consumes { public function __construct() { - parent::__construct(ServerMediaTypeFactory::json()); + parent::__construct(MediaTypeFactory::json()); } } diff --git a/src/Annotation/ConsumesXml.php b/src/Annotation/ConsumesXml.php index 645f5c23..c810ee07 100644 --- a/src/Annotation/ConsumesXml.php +++ b/src/Annotation/ConsumesXml.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ConsumesXml extends Consumes { public function __construct() { - parent::__construct(ServerMediaTypeFactory::xml()); + parent::__construct(MediaTypeFactory::xml()); } } diff --git a/src/Annotation/Attribute.php b/src/Annotation/DefaultAttribute.php similarity index 79% rename from src/Annotation/Attribute.php rename to src/Annotation/DefaultAttribute.php index 15ac98a4..b55c0fe1 100644 --- a/src/Annotation/Attribute.php +++ b/src/Annotation/DefaultAttribute.php @@ -13,11 +13,13 @@ namespace Sunrise\Http\Router\Annotation; +use Attribute; + /** * @since 3.0.0 */ -#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)] -final class Attribute +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class DefaultAttribute { public function __construct( public readonly string $name, diff --git a/src/Annotation/Produces.php b/src/Annotation/Produces.php index 5404a814..7bba6461 100644 --- a/src/Annotation/Produces.php +++ b/src/Annotation/Produces.php @@ -23,7 +23,7 @@ class Produces { public function __construct( - public readonly string|MediaTypeInterface $value, + public readonly MediaTypeInterface|string $value, ) { } } diff --git a/src/Annotation/ProducesHtml.php b/src/Annotation/ProducesHtml.php index 76900667..ce98ca05 100644 --- a/src/Annotation/ProducesHtml.php +++ b/src/Annotation/ProducesHtml.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ProducesHtml extends Produces { public function __construct() { - parent::__construct(ServerMediaTypeFactory::html()); + parent::__construct(MediaTypeFactory::html()); } } diff --git a/src/Annotation/ProducesJson.php b/src/Annotation/ProducesJson.php index 324a59b2..356ac287 100644 --- a/src/Annotation/ProducesJson.php +++ b/src/Annotation/ProducesJson.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ProducesJson extends Produces { public function __construct() { - parent::__construct(ServerMediaTypeFactory::json()); + parent::__construct(MediaTypeFactory::json()); } } diff --git a/src/Annotation/ProducesText.php b/src/Annotation/ProducesText.php index a40ab739..4c3048f2 100644 --- a/src/Annotation/ProducesText.php +++ b/src/Annotation/ProducesText.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ProducesText extends Produces { public function __construct() { - parent::__construct(ServerMediaTypeFactory::text()); + parent::__construct(MediaTypeFactory::text()); } } diff --git a/src/Annotation/ProducesXml.php b/src/Annotation/ProducesXml.php index 622410cd..5b4c9dd5 100644 --- a/src/Annotation/ProducesXml.php +++ b/src/Annotation/ProducesXml.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ProducesXml extends Produces { public function __construct() { - parent::__construct(ServerMediaTypeFactory::xml()); + parent::__construct(MediaTypeFactory::xml()); } } diff --git a/src/Annotation/EmptyResponse.php b/src/Annotation/ResponseEmpty.php similarity index 94% rename from src/Annotation/EmptyResponse.php rename to src/Annotation/ResponseEmpty.php index 20fed114..17d11a73 100644 --- a/src/Annotation/EmptyResponse.php +++ b/src/Annotation/ResponseEmpty.php @@ -19,6 +19,6 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] -final class EmptyResponse +final class ResponseEmpty { } diff --git a/src/Annotation/JsonResponse.php b/src/Annotation/ResponseJson.php similarity index 96% rename from src/Annotation/JsonResponse.php rename to src/Annotation/ResponseJson.php index 9910aac6..5b27044b 100644 --- a/src/Annotation/JsonResponse.php +++ b/src/Annotation/ResponseJson.php @@ -19,7 +19,7 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] -final class JsonResponse +final class ResponseJson { public function __construct( public readonly ?int $encodingFlags = null, diff --git a/src/Entity/Language/ClientLanguage.php b/src/Entity/Language/Language.php similarity index 73% rename from src/Entity/Language/ClientLanguage.php rename to src/Entity/Language/Language.php index 92632eee..e9bba53f 100644 --- a/src/Entity/Language/ClientLanguage.php +++ b/src/Entity/Language/Language.php @@ -16,14 +16,14 @@ /** * @since 3.0.0 */ -final class ClientLanguage implements LanguageInterface +final class Language implements LanguageInterface { public function __construct( private readonly string $code, - // One of the Accept-Language header's identifier. - private readonly string $identifier, + // As an example, this could be one of the identifiers in the Accept-Language header. + private readonly ?string $identifier = null, /** @var array */ - private readonly array $parameters, + private readonly array $parameters = [], ) { } @@ -34,7 +34,7 @@ public function getCode(): string public function getIdentifier(): string { - return $this->identifier; + return $this->identifier ?? $this->code; } /** diff --git a/src/Entity/Language/LanguageComparator.php b/src/Entity/Language/LanguageComparator.php index 2ee53654..df250fbc 100644 --- a/src/Entity/Language/LanguageComparator.php +++ b/src/Entity/Language/LanguageComparator.php @@ -23,10 +23,6 @@ public function compare(LanguageInterface $a, LanguageInterface $b): int $aCode = $a->getCode(); $bCode = $b->getCode(); - if ($aCode === $bCode || $aCode === '*' || $bCode === '*') { - return 0; - } - - return $aCode <=> $bCode; + return ($aCode === '*' || $bCode === '*') ? 0 : $aCode <=> $bCode; } } diff --git a/src/Entity/Language/ServerLanguage.php b/src/Entity/Language/ServerLanguage.php deleted file mode 100644 index ef184b41..00000000 --- a/src/Entity/Language/ServerLanguage.php +++ /dev/null @@ -1,30 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Entity\Language; - -/** - * @since 3.0.0 - */ -final class ServerLanguage implements LanguageInterface -{ - public function __construct( - private readonly string $code, - ) { - } - - public function getCode(): string - { - return $this->code; - } -} diff --git a/src/Entity/MediaType/ClientMediaType.php b/src/Entity/MediaType/MediaType.php similarity index 83% rename from src/Entity/MediaType/ClientMediaType.php rename to src/Entity/MediaType/MediaType.php index c1062ea4..6589ce46 100644 --- a/src/Entity/MediaType/ClientMediaType.php +++ b/src/Entity/MediaType/MediaType.php @@ -16,13 +16,13 @@ /** * @since 3.0.0 */ -final class ClientMediaType implements MediaTypeInterface +final class MediaType implements MediaTypeInterface { public function __construct( private readonly string $type, private readonly string $subtype, /** @var array */ - private readonly array $parameters, + private readonly array $parameters = [], ) { } @@ -36,6 +36,11 @@ public function getSubtype(): string return $this->subtype; } + public function getIdentifier(): string + { + return $this->type . $this::SEPARATOR . $this->subtype; + } + /** * @return array */ @@ -46,6 +51,6 @@ public function getParameters(): array public function __toString(): string { - return $this->type . $this::SEPARATOR . $this->subtype; + return $this->getIdentifier(); } } diff --git a/src/Entity/MediaType/MediaTypeComparator.php b/src/Entity/MediaType/MediaTypeComparator.php index e6c71c8e..d74d1278 100644 --- a/src/Entity/MediaType/MediaTypeComparator.php +++ b/src/Entity/MediaType/MediaTypeComparator.php @@ -27,7 +27,6 @@ public function compare(MediaTypeInterface $a, MediaTypeInterface $b): int { $aType = $a->getType(); $aSubtype = $a->getSubtype(); - $bType = $b->getType(); $bSubtype = $b->getSubtype(); diff --git a/src/Entity/MediaType/ServerMediaTypeFactory.php b/src/Entity/MediaType/MediaTypeFactory.php similarity index 70% rename from src/Entity/MediaType/ServerMediaTypeFactory.php rename to src/Entity/MediaType/MediaTypeFactory.php index 57eea54d..708488c6 100644 --- a/src/Entity/MediaType/ServerMediaTypeFactory.php +++ b/src/Entity/MediaType/MediaTypeFactory.php @@ -21,7 +21,7 @@ /** * @since 3.0.0 */ -final class ServerMediaTypeFactory +final class MediaTypeFactory { /** * @throws InvalidArgumentException See {@see fromString()}. @@ -35,43 +35,52 @@ public static function create(MediaTypeInterface|string $mediaType): MediaTypeIn return self::fromString($mediaType); } - /** - * @throws InvalidArgumentException If the given media type doesn't look like a media type. - */ - public static function fromString(string $mediaType): MediaTypeInterface + public static function any(): MediaTypeInterface { - if (!preg_match('|^([^/;]+)/([^/;]+)$|', $mediaType, $matches)) { - throw new InvalidArgumentException(sprintf( - 'The string %s does not look like a media type.', - $mediaType, - )); - } - - return new ServerMediaType($matches[1], $matches[2]); + return new MediaType('*', '*'); } public static function json(): MediaTypeInterface { - return new ServerMediaType('application', 'json'); + return new MediaType('application', 'json'); } public static function xml(): MediaTypeInterface { - return new ServerMediaType('application', 'xml'); + return new MediaType('application', 'xml'); } public static function html(): MediaTypeInterface { - return new ServerMediaType('text', 'html'); + return new MediaType('text', 'html'); } public static function text(): MediaTypeInterface { - return new ServerMediaType('text', 'plain'); + return new MediaType('text', 'plain'); } public static function image(): MediaTypeInterface { - return new ServerMediaType('image', '*'); + return new MediaType('image', '*'); + } + + /** + * @throws InvalidArgumentException If the given media type doesn't look like a media type. + */ + public static function fromString(string $mediaType): MediaTypeInterface + { + if ($mediaType === '') { + throw new InvalidArgumentException('The media type cannot be an empty string.'); + } + + if (!preg_match('|^([^/;]+)/([^/;]+)$|', $mediaType, $matches)) { + throw new InvalidArgumentException(sprintf( + 'The string %s does not look like a media type (type/subtype).', + $mediaType, + )); + } + + return new MediaType($matches[1], $matches[2]); } } diff --git a/src/Entity/MediaType/ServerMediaType.php b/src/Entity/MediaType/ServerMediaType.php deleted file mode 100644 index 0e1f1b9e..00000000 --- a/src/Entity/MediaType/ServerMediaType.php +++ /dev/null @@ -1,41 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Entity\MediaType; - -/** - * @since 3.0.0 - */ -final class ServerMediaType implements MediaTypeInterface -{ - public function __construct( - private readonly string $type, - private readonly string $subtype, - ) { - } - - public function getType(): string - { - return $this->type; - } - - public function getSubtype(): string - { - return $this->subtype; - } - - public function __toString(): string - { - return $this->type . $this::SEPARATOR . $this->subtype; - } -} diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 675e4278..aee8e594 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -22,9 +22,9 @@ use ReflectionClass; use ReflectionException; use ReflectionMethod; -use Sunrise\Http\Router\Annotation\Attribute; use Sunrise\Http\Router\Annotation\Constraint; use Sunrise\Http\Router\Annotation\Consumes; +use Sunrise\Http\Router\Annotation\DefaultAttribute; use Sunrise\Http\Router\Annotation\Deprecated; use Sunrise\Http\Router\Annotation\Description; use Sunrise\Http\Router\Annotation\Method; @@ -40,7 +40,7 @@ use Sunrise\Http\Router\Annotation\Summary; use Sunrise\Http\Router\Annotation\Tag; use Sunrise\Http\Router\Dictionary\CacheKey; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; use Sunrise\Http\Router\Helper\ClassFinder; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Route; @@ -269,8 +269,8 @@ private static function enrichDescriptorFromClassOrMethod( $descriptor->methods[] = $annotation->value; } - /** @var list> $annotations */ - $annotations = $classOrMethod->getAttributes(Attribute::class); + /** @var list> $annotations */ + $annotations = $classOrMethod->getAttributes(DefaultAttribute::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); $descriptor->attributes[$annotation->name] = $annotation->value; @@ -294,14 +294,14 @@ private static function enrichDescriptorFromClassOrMethod( $annotations = $classOrMethod->getAttributes(Consumes::class, ReflectionAttribute::IS_INSTANCEOF); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->consumes[] = ServerMediaTypeFactory::create($annotation->value); + $descriptor->consumes[] = MediaTypeFactory::create($annotation->value); } /** @var list> $annotations */ $annotations = $classOrMethod->getAttributes(Produces::class, ReflectionAttribute::IS_INSTANCEOF); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->produces[] = ServerMediaTypeFactory::create($annotation->value); + $descriptor->produces[] = MediaTypeFactory::create($annotation->value); } /** @var list> $annotations */ diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 0ded8d43..d0bbbc5b 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -18,7 +18,7 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Entity\MediaType\ServerMediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ServerRequest; @@ -57,7 +57,7 @@ public function __construct( */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if (ServerRequest::create($request)->clientProducesMediaType(ServerMediaTypeFactory::json())) { + if (ServerRequest::create($request)->clientProducesMediaType(MediaTypeFactory::json())) { $request = $request->withParsedBody($this->decodePayload((string) $request->getBody())); } diff --git a/src/ResponseResolver/EmptyResponseResolver.php b/src/ResponseResolver/ResponseEmptyResolver.php similarity index 88% rename from src/ResponseResolver/EmptyResponseResolver.php rename to src/ResponseResolver/ResponseEmptyResolver.php index b9e90f02..2306bc32 100644 --- a/src/ResponseResolver/EmptyResponseResolver.php +++ b/src/ResponseResolver/ResponseEmptyResolver.php @@ -19,13 +19,13 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionFunction; use ReflectionMethod; -use Sunrise\Http\Router\Annotation\EmptyResponse; +use Sunrise\Http\Router\Annotation\ResponseEmpty; use Sunrise\Http\Router\ResponseResolverInterface; /** * @since 3.0.0 */ -final class EmptyResponseResolver implements ResponseResolverInterface +final class ResponseEmptyResolver implements ResponseResolverInterface { public const DEFAULT_STATUS_CODE = StatusCodeInterface::STATUS_NO_CONTENT; @@ -43,7 +43,7 @@ public function resolveResponse( ReflectionMethod|ReflectionFunction $responder, ServerRequestInterface $request, ): ?ResponseInterface { - if ($responder->getAttributes(EmptyResponse::class) === []) { + if ($responder->getAttributes(ResponseEmpty::class) === []) { return null; } diff --git a/src/ResponseResolver/JsonResponseResolver.php b/src/ResponseResolver/ResponseJsonResolver.php similarity index 91% rename from src/ResponseResolver/JsonResponseResolver.php rename to src/ResponseResolver/ResponseJsonResolver.php index 16b45164..2a68a874 100644 --- a/src/ResponseResolver/JsonResponseResolver.php +++ b/src/ResponseResolver/ResponseJsonResolver.php @@ -22,7 +22,7 @@ use ReflectionFunction; use ReflectionMethod; use RuntimeException; -use Sunrise\Http\Router\Annotation\JsonResponse; +use Sunrise\Http\Router\Annotation\ResponseJson; use Sunrise\Http\Router\ResponseResolverChain; use Sunrise\Http\Router\ResponseResolverInterface; @@ -34,7 +34,7 @@ /** * @since 3.0.0 */ -final class JsonResponseResolver implements ResponseResolverInterface +final class ResponseJsonResolver implements ResponseResolverInterface { public const DEFAULT_ENCODING_FLAGS = 0; public const DEFAULT_ENCODING_DEPTH = 512; @@ -56,8 +56,8 @@ public function resolveResponse( ReflectionMethod|ReflectionFunction $responder, ServerRequestInterface $request, ): ?ResponseInterface { - /** @var list> $annotations */ - $annotations = $responder->getAttributes(JsonResponse::class); + /** @var list> $annotations */ + $annotations = $responder->getAttributes(ResponseJson::class); if ($annotations === []) { return null; } diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 5b92eda5..2cd98c4b 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -18,11 +18,11 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\StreamInterface; use Psr\Http\Message\UriInterface; -use Sunrise\Http\Router\Entity\Language\ClientLanguage; +use Sunrise\Http\Router\Entity\Language\Language; use Sunrise\Http\Router\Entity\Language\LanguageComparator; use Sunrise\Http\Router\Entity\Language\LanguageComparatorInterface; use Sunrise\Http\Router\Entity\Language\LanguageInterface; -use Sunrise\Http\Router\Entity\MediaType\ClientMediaType; +use Sunrise\Http\Router\Entity\MediaType\MediaType; use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparatorInterface; use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; @@ -96,7 +96,7 @@ public function getRoute(): RouteInterface return $route; } - public function getClientProducedMediaType(): ?ClientMediaType + public function getClientProducedMediaType(): ?MediaType { $values = HeaderParser::parseHeader($this->request->getHeaderLine('Content-Type')); if ($values === []) { @@ -105,14 +105,14 @@ public function getClientProducedMediaType(): ?ClientMediaType [$identifier, $parameters] = reset($values); if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier, $matches) === 1) { - return new ClientMediaType($matches[1], $matches[2], $parameters); + return new MediaType($matches[1], $matches[2], $parameters); } return null; } /** - * @return Generator, ClientMediaType> + * @return Generator, MediaType> */ public function getClientConsumedMediaTypes(): Generator { @@ -129,13 +129,13 @@ public function getClientConsumedMediaTypes(): Generator /** @phpstan-var int<0, max> $index */ foreach ($values as $index => [$identifier, $parameters]) { if (preg_match('|^([^/]+)/([^/]+)$|', $identifier, $matches) === 1) { - yield $index => new ClientMediaType($matches[1], $matches[2], $parameters); + yield $index => new MediaType($matches[1], $matches[2], $parameters); } } } /** - * @return Generator, ClientLanguage> + * @return Generator, Language> */ public function getClientConsumedLanguages(): Generator { @@ -152,12 +152,12 @@ public function getClientConsumedLanguages(): Generator /** @phpstan-var int<0, max> $index */ foreach ($values as $index => [$identifier, $parameters]) { if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches) === 1) { - yield $index => new ClientLanguage($matches[1], $identifier, $parameters); + yield $index => new Language($matches[1], $identifier, $parameters); } } } - public function getClientPreferredMediaType(MediaTypeInterface ...$serverProducedMediaTypes): ?ClientMediaType + public function getClientPreferredMediaType(MediaTypeInterface ...$serverProducedMediaTypes): ?MediaType { if ($serverProducedMediaTypes === []) { return null; @@ -175,7 +175,7 @@ public function getClientPreferredMediaType(MediaTypeInterface ...$serverProduce return null; } - public function getClientPreferredLanguage(LanguageInterface ...$serverProducedLanguages): ?ClientLanguage + public function getClientPreferredLanguage(LanguageInterface ...$serverProducedLanguages): ?Language { if ($serverProducedLanguages === []) { return null; diff --git a/tests/Command/RouterClearCacheCommandTest.php b/tests/Command/RouterClearCacheCommandTest.php index c29d3433..4400d6b2 100644 --- a/tests/Command/RouterClearCacheCommandTest.php +++ b/tests/Command/RouterClearCacheCommandTest.php @@ -20,7 +20,7 @@ protected function setUp(): void $this->cacheMock = $this->createMock(CacheInterface::class); } - public function testExecute(): void + public function testExecuteWithCache(): void { $this->cacheMock->expects($this->once())->method('delete')->with(CacheKey::DESCRIPTORS); diff --git a/tests/Command/RouterListRoutesCommandTest.php b/tests/Command/RouterListRoutesCommandTest.php index 0dc8c83e..dd936cb3 100644 --- a/tests/Command/RouterListRoutesCommandTest.php +++ b/tests/Command/RouterListRoutesCommandTest.php @@ -7,6 +7,7 @@ use PHPUnit\Framework\MockObject\MockObject; use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Command\RouterListRoutesCommand; +use Sunrise\Http\Router\RouteInterface; use Sunrise\Http\Router\RouterInterface; use Symfony\Component\Console\Tester\CommandTester; @@ -14,17 +15,36 @@ final class RouterListRoutesCommandTest extends TestCase { private RouterInterface&MockObject $routerMock; + /** @var array */ + private array $routeMocks = []; + protected function setUp(): void { $this->routerMock = $this->createMock(RouterInterface::class); + $this->routeMocks = []; } - public function testExecute(): void + public function testExecuteWithRoutes(): void { - $this->routerMock->expects($this->once())->method('getRoutes')->willReturn([]); + $this->mockRoute(); + $this->routerMock->expects($this->once())->method('getRoutes')->willReturn($this->routeMocks); $command = new RouterListRoutesCommand($this->routerMock); $commandTester = new CommandTester($command); $this->assertSame(0, $commandTester->execute([])); } + + public function testExecuteWithoutRoutes(): void + { + $this->routerMock->expects($this->once())->method('getRoutes')->willReturn($this->routeMocks); + + $command = new RouterListRoutesCommand($this->routerMock); + $commandTester = new CommandTester($command); + $this->assertSame(0, $commandTester->execute([])); + } + + private function mockRoute(): RouteInterface&MockObject + { + return $this->routeMocks[] = $this->createMock(RouteInterface::class); + } } diff --git a/tests/Entity/Language/ClientLanguageTest.php b/tests/Entity/Language/ClientLanguageTest.php deleted file mode 100644 index 70fc3062..00000000 --- a/tests/Entity/Language/ClientLanguageTest.php +++ /dev/null @@ -1,19 +0,0 @@ - '1.0']); - $this->assertSame('sr', $clientLanguage->getCode()); - $this->assertSame('sr-RS', $clientLanguage->getIdentifier()); - $this->assertSame(['q' => '1.0'], $clientLanguage->getParameters()); - } -} diff --git a/tests/Entity/Language/LanguageComparatorTest.php b/tests/Entity/Language/LanguageComparatorTest.php index deac4301..8f4092af 100644 --- a/tests/Entity/Language/LanguageComparatorTest.php +++ b/tests/Entity/Language/LanguageComparatorTest.php @@ -4,6 +4,7 @@ namespace Sunrise\Http\Router\Tests\Entity\Language; +use PHPUnit\Framework\Attributes\DataProvider; use PHPUnit\Framework\MockObject\MockObject; use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Entity\Language\LanguageComparator; @@ -11,51 +12,25 @@ final class LanguageComparatorTest extends TestCase { - /** - * @dataProvider compareDataProvider - */ - public function testCompare(LanguageInterface $a, LanguageInterface $b, int $expected): void + #[DataProvider('compareDataProvider')] + public function testCompare(string $aCode, string $bCode, int $expectedResult): void { - $this->assertSame($expected, (new LanguageComparator())->compare($a, $b)); - } - - private function compareDataProvider(): iterable - { - yield [ - $this->mockLanguage('sr'), - $this->mockLanguage('sr'), - 0, - ]; - - yield [ - $this->mockLanguage('*'), - $this->mockLanguage('*'), - 0, - ]; + $comparator = new LanguageComparator(); - yield [ - $this->mockLanguage('*'), - $this->mockLanguage('sr'), - 0, - ]; + $a = $this->mockLanguage($aCode); + $b = $this->mockLanguage($bCode); - yield [ - $this->mockLanguage('sr'), - $this->mockLanguage('*'), - 0, - ]; - - yield [ - $this->mockLanguage('sr'), - $this->mockLanguage('bs'), - 'sr' <=> 'bs', - ]; + $this->assertSame($expectedResult, $comparator->compare($a, $b)); + } - yield [ - $this->mockLanguage('bs'), - $this->mockLanguage('sr'), - 'bs' <=> 'sr', - ]; + public static function compareDataProvider(): iterable + { + yield ['sr', 'sr', 0]; + yield ['*', '*', 0]; + yield ['*', 'sr', 0]; + yield ['sr', '*', 0]; + yield ['sr', 'bs', 'sr' <=> 'bs']; + yield ['bs', 'sr', 'bs' <=> 'sr']; } private function mockLanguage(string $code): LanguageInterface&MockObject diff --git a/tests/Entity/Language/LanguageTest.php b/tests/Entity/Language/LanguageTest.php new file mode 100644 index 00000000..b606d6a0 --- /dev/null +++ b/tests/Entity/Language/LanguageTest.php @@ -0,0 +1,27 @@ + '1.0']); + $this->assertSame('sr', $language->getCode()); + $this->assertSame('sr-RS', $language->getIdentifier()); + $this->assertSame(['q' => '1.0'], $language->getParameters()); + } + + public function testConstructorWithoutOptionalParameters(): void + { + $language = new Language('sr'); + $this->assertSame('sr', $language->getCode()); + $this->assertSame('sr', $language->getIdentifier()); + $this->assertSame([], $language->getParameters()); + } +} diff --git a/tests/Entity/Language/ServerLanguageTest.php b/tests/Entity/Language/ServerLanguageTest.php deleted file mode 100644 index d7d582c7..00000000 --- a/tests/Entity/Language/ServerLanguageTest.php +++ /dev/null @@ -1,17 +0,0 @@ -assertSame('sr', $serverLanguage->getCode()); - } -} diff --git a/tests/Entity/MediaType/ClientMediaTypeTest.php b/tests/Entity/MediaType/ClientMediaTypeTest.php deleted file mode 100644 index bbeee308..00000000 --- a/tests/Entity/MediaType/ClientMediaTypeTest.php +++ /dev/null @@ -1,25 +0,0 @@ - '1.0']); - $this->assertSame('application', $clientMediaType->getType()); - $this->assertSame('json', $clientMediaType->getSubtype()); - $this->assertSame(['q' => '1.0'], $clientMediaType->getParameters()); - } - - public function testToString(): void - { - $clientMediaType = new ClientMediaType('application', 'json', ['q' => '1.0']); - $this->assertSame('application/json', (string) $clientMediaType); - } -} diff --git a/tests/Entity/MediaType/MediaTypeComparatorTest.php b/tests/Entity/MediaType/MediaTypeComparatorTest.php index 778c4662..9b9ee083 100644 --- a/tests/Entity/MediaType/MediaTypeComparatorTest.php +++ b/tests/Entity/MediaType/MediaTypeComparatorTest.php @@ -4,6 +4,7 @@ namespace Sunrise\Http\Router\Tests\Entity\MediaType; +use PHPUnit\Framework\Attributes\DataProvider; use PHPUnit\Framework\MockObject\MockObject; use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; @@ -11,67 +12,82 @@ final class MediaTypeComparatorTest extends TestCase { - /** - * @dataProvider compareDataProvider - */ - public function testCompare(MediaTypeInterface $a, MediaTypeInterface $b, int $expected): void + #[DataProvider('compareDataProvider')] + public function testCompare(string $aType, string $aSubtype, string $bType, string $bSubtype, int $expectedResult): void { - $this->assertSame($expected, (new MediaTypeComparator())->compare($a, $b)); + $comparator = new MediaTypeComparator(); + + $a = $this->mockMediaType($aType, $aSubtype); + $b = $this->mockMediaType($bType, $bSubtype); + + $this->assertSame($expectedResult, $comparator->compare($a, $b)); } - private function compareDataProvider(): iterable + public static function compareDataProvider(): iterable { yield [ - $this->mockMediaType('application', 'json'), - $this->mockMediaType('application', 'json'), + 'application', 'json', + 'application', 'json', + 0, + ]; + + yield [ + 'APPLICATION', 'JSON', + 'application', 'json', + 0, + ]; + + yield [ + 'application', 'json', + 'APPLICATION', 'JSON', 0, ]; yield [ - $this->mockMediaType('*', '*'), - $this->mockMediaType('*', '*'), + '*', '*', + '*', '*', 0, ]; yield [ - $this->mockMediaType('*', '*'), - $this->mockMediaType('application', 'json'), + '*', '*', + 'application', 'json', 0, ]; yield [ - $this->mockMediaType('application', 'json'), - $this->mockMediaType('*', '*'), + 'application', 'json', + '*', '*', 0, ]; yield [ - $this->mockMediaType('image', '*'), - $this->mockMediaType('image', '*'), + 'image', '*', + 'image', '*', 0, ]; yield [ - $this->mockMediaType('image', '*'), - $this->mockMediaType('image', 'webp'), + 'image', '*', + 'image', 'webp', 0, ]; yield [ - $this->mockMediaType('image', 'webp'), - $this->mockMediaType('image', '*'), + 'image', 'webp', + 'image', '*', 0, ]; yield [ - $this->mockMediaType('application', 'json'), - $this->mockMediaType('application', 'xml'), + 'application', 'json', + 'application', 'xml', 'application/json' <=> 'application/xml', ]; yield [ - $this->mockMediaType('application', 'xml'), - $this->mockMediaType('application', 'json'), + 'application', 'xml', + 'application', 'json', 'application/xml' <=> 'application/json', ]; } diff --git a/tests/Entity/MediaType/MediaTypeFactoryTest.php b/tests/Entity/MediaType/MediaTypeFactoryTest.php new file mode 100644 index 00000000..8d0d7d7b --- /dev/null +++ b/tests/Entity/MediaType/MediaTypeFactoryTest.php @@ -0,0 +1,74 @@ +createMock(MediaTypeInterface::class); + $this->assertSame($mediaTypeMock, MediaTypeFactory::create($mediaTypeMock)); + } + + public function testCreateWithValidString(): void + { + $mediaType = MediaTypeFactory::create('application/json'); + $this->assertSame('application', $mediaType->getType()); + $this->assertSame('json', $mediaType->getSubtype()); + } + + public function testFromValidString(): void + { + $mediaType = MediaTypeFactory::fromString('application/json'); + $this->assertSame('application', $mediaType->getType()); + $this->assertSame('json', $mediaType->getSubtype()); + } + + public function testAny(): void + { + $mediaType = MediaTypeFactory::any(); + $this->assertSame('*', $mediaType->getType()); + $this->assertSame('*', $mediaType->getSubtype()); + } + + public function testJson(): void + { + $mediaType = MediaTypeFactory::json(); + $this->assertSame('application', $mediaType->getType()); + $this->assertSame('json', $mediaType->getSubtype()); + } + + public function testXml(): void + { + $mediaType = MediaTypeFactory::xml(); + $this->assertSame('application', $mediaType->getType()); + $this->assertSame('xml', $mediaType->getSubtype()); + } + + public function testHtml(): void + { + $mediaType = MediaTypeFactory::html(); + $this->assertSame('text', $mediaType->getType()); + $this->assertSame('html', $mediaType->getSubtype()); + } + + public function testText(): void + { + $mediaType = MediaTypeFactory::text(); + $this->assertSame('text', $mediaType->getType()); + $this->assertSame('plain', $mediaType->getSubtype()); + } + + public function testImage(): void + { + $mediaType = MediaTypeFactory::image(); + $this->assertSame('image', $mediaType->getType()); + $this->assertSame('*', $mediaType->getSubtype()); + } +} diff --git a/tests/Entity/MediaType/MediaTypeTest.php b/tests/Entity/MediaType/MediaTypeTest.php new file mode 100644 index 00000000..a1d01a19 --- /dev/null +++ b/tests/Entity/MediaType/MediaTypeTest.php @@ -0,0 +1,35 @@ + '1.0']); + $this->assertSame('application', $mediaType->getType()); + $this->assertSame('json', $mediaType->getSubtype()); + $this->assertSame('application/json', $mediaType->getIdentifier()); + $this->assertSame(['q' => '1.0'], $mediaType->getParameters()); + } + + public function testConstructorWithoutOptionalParameters(): void + { + $mediaType = new MediaType('application', 'json'); + $this->assertSame('application', $mediaType->getType()); + $this->assertSame('json', $mediaType->getSubtype()); + $this->assertSame('application/json', $mediaType->getIdentifier()); + $this->assertSame([], $mediaType->getParameters()); + } + + public function testToString(): void + { + $mediaType = new MediaType('application', 'json', ['q' => '1.0']); + $this->assertSame('application/json', (string) $mediaType); + } +} diff --git a/tests/Entity/MediaType/ServerMediaTypeTest.php b/tests/Entity/MediaType/ServerMediaTypeTest.php deleted file mode 100644 index acd51493..00000000 --- a/tests/Entity/MediaType/ServerMediaTypeTest.php +++ /dev/null @@ -1,24 +0,0 @@ -assertSame('application', $serverMediaType->getType()); - $this->assertSame('json', $serverMediaType->getSubtype()); - } - - public function testToString(): void - { - $serverMediaType = new ServerMediaType('application', 'json'); - $this->assertSame('application/json', (string) $serverMediaType); - } -} From fe84e3b4bdf0f3f34d0876b5ac1060e76ebc57f3 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sat, 2 Nov 2024 07:53:31 +0100 Subject: [PATCH 171/180] v3 --- src/Annotation/Constraint.php | 11 ++- src/Annotation/Consumes.php | 11 ++- src/Annotation/ConsumesJson.php | 4 +- src/Annotation/ConsumesXml.php | 4 +- src/Annotation/Method.php | 11 ++- src/Annotation/Method/DeleteMethod.php | 30 ++++++ .../GetMethod.php} | 9 +- .../{MethodGet.php => Method/HeadMethod.php} | 9 +- src/Annotation/Method/OptionsMethod.php | 30 ++++++ src/Annotation/Method/PatchMethod.php | 30 ++++++ .../{MethodHead.php => Method/PostMethod.php} | 9 +- src/Annotation/Method/PurgeMethod.php | 30 ++++++ .../PutMethod.php} | 9 +- src/Annotation/MethodOptions.php | 29 ------ src/Annotation/MethodPatch.php | 29 ------ src/Annotation/MethodPost.php | 29 ------ src/Annotation/MethodPurge.php | 29 ------ src/Annotation/MethodPut.php | 29 ------ src/Annotation/Middleware.php | 11 ++- src/Annotation/Path.php | 2 +- .../AsciiSlugPattern.php} | 5 +- .../UnsignedIntegerPattern.php} | 7 +- .../UuidPattern.php} | 5 +- src/Annotation/Produces.php | 11 ++- src/Annotation/ProducesHtml.php | 29 ------ src/Annotation/ProducesJson.php | 4 +- src/Annotation/ProducesText.php | 29 ------ src/Annotation/ProducesXml.php | 4 +- .../EmptyResponse.php} | 4 +- .../JsonResponse.php} | 4 +- src/Annotation/Tag.php | 11 ++- src/Command/RouterListRoutesCommand.php | 2 +- src/Dictionary/MediaType.php | 23 +++++ src/Dictionary/RequestMethod.php | 29 ++++++ src/Dictionary/VariablePattern.php | 2 +- .../{Language.php => ClientLanguage.php} | 11 +-- src/Entity/Language/LanguageComparator.php | 8 +- src/Entity/Language/StringableLanguage.php | 41 ++++++++ .../{MediaType.php => ClientMediaType.php} | 24 +---- src/Entity/MediaType/JsonMediaType.php | 27 +++++ src/Entity/MediaType/MediaTypeComparator.php | 30 +++--- src/Entity/MediaType/MediaTypeFactory.php | 86 ---------------- src/Entity/MediaType/MediaTypeInterface.php | 10 +- src/Entity/MediaType/StringableMediaType.php | 41 ++++++++ .../MediaType/XmlMediaType.php} | 11 +-- src/Helper/RouteMatcher.php | 2 +- src/Loader/DescriptorLoader.php | 27 +++-- .../JsonPayloadDecodingMiddleware.php | 4 +- .../PayloadMediaTypeNegotiationMiddleware.php | 6 +- .../ResponseEmptyResolver.php | 4 +- src/ResponseResolver/ResponseJsonResolver.php | 6 +- src/ServerRequest.php | 58 +++++------ .../ArgumentConstraintValidator.php | 18 ++-- tests/Command/RouterClearCacheCommandTest.php | 4 +- tests/Command/RouterListRoutesCommandTest.php | 7 +- tests/Entity/Language/ClientLanguageTest.php | 19 ++++ .../Language/LanguageComparatorTest.php | 87 +++++++++++++--- tests/Entity/Language/LanguageTest.php | 27 ----- .../Entity/MediaType/ClientMediaTypeTest.php | 18 ++++ .../MediaType/MediaTypeComparatorTest.php | 98 ++++++++++++------- .../Entity/MediaType/MediaTypeFactoryTest.php | 74 -------------- tests/Entity/MediaType/MediaTypeTest.php | 35 ------- tests/Event/RoutePostRunEventTest.php | 3 +- tests/Event/RoutePreRunEventTest.php | 3 +- 64 files changed, 663 insertions(+), 650 deletions(-) create mode 100644 src/Annotation/Method/DeleteMethod.php rename src/Annotation/{ConsumesImage.php => Method/GetMethod.php} (69%) rename src/Annotation/{MethodGet.php => Method/HeadMethod.php} (69%) create mode 100644 src/Annotation/Method/OptionsMethod.php create mode 100644 src/Annotation/Method/PatchMethod.php rename src/Annotation/{MethodHead.php => Method/PostMethod.php} (69%) create mode 100644 src/Annotation/Method/PurgeMethod.php rename src/Annotation/{MethodDelete.php => Method/PutMethod.php} (69%) delete mode 100644 src/Annotation/MethodOptions.php delete mode 100644 src/Annotation/MethodPatch.php delete mode 100644 src/Annotation/MethodPost.php delete mode 100644 src/Annotation/MethodPurge.php delete mode 100644 src/Annotation/MethodPut.php rename src/Annotation/{PatternAsciiSlug.php => Pattern/AsciiSlugPattern.php} (82%) rename src/Annotation/{PatternPositiveInt.php => Pattern/UnsignedIntegerPattern.php} (72%) rename src/Annotation/{PatternUuid.php => Pattern/UuidPattern.php} (83%) delete mode 100644 src/Annotation/ProducesHtml.php delete mode 100644 src/Annotation/ProducesText.php rename src/Annotation/{ResponseEmpty.php => Response/EmptyResponse.php} (85%) rename src/Annotation/{ResponseJson.php => Response/JsonResponse.php} (88%) create mode 100644 src/Dictionary/MediaType.php create mode 100644 src/Dictionary/RequestMethod.php rename src/Entity/Language/{Language.php => ClientLanguage.php} (69%) create mode 100644 src/Entity/Language/StringableLanguage.php rename src/Entity/MediaType/{MediaType.php => ClientMediaType.php} (58%) create mode 100644 src/Entity/MediaType/JsonMediaType.php delete mode 100644 src/Entity/MediaType/MediaTypeFactory.php create mode 100644 src/Entity/MediaType/StringableMediaType.php rename src/{Annotation/PathHome.php => Entity/MediaType/XmlMediaType.php} (62%) create mode 100644 tests/Entity/Language/ClientLanguageTest.php delete mode 100644 tests/Entity/Language/LanguageTest.php create mode 100644 tests/Entity/MediaType/ClientMediaTypeTest.php delete mode 100644 tests/Entity/MediaType/MediaTypeFactoryTest.php delete mode 100644 tests/Entity/MediaType/MediaTypeTest.php diff --git a/src/Annotation/Constraint.php b/src/Annotation/Constraint.php index 7c725390..2b17777c 100644 --- a/src/Annotation/Constraint.php +++ b/src/Annotation/Constraint.php @@ -22,8 +22,13 @@ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::TARGET_PARAMETER | Attribute::IS_REPEATABLE)] final class Constraint { - public function __construct( - public readonly mixed $value, - ) { + /** + * @var array + */ + public readonly array $values; + + public function __construct(mixed ...$values) + { + $this->values = $values; } } diff --git a/src/Annotation/Consumes.php b/src/Annotation/Consumes.php index 235c35eb..159088ef 100644 --- a/src/Annotation/Consumes.php +++ b/src/Annotation/Consumes.php @@ -22,8 +22,13 @@ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] class Consumes { - public function __construct( - public readonly MediaTypeInterface|string $value, - ) { + /** + * @var array + */ + public readonly array $values; + + public function __construct(MediaTypeInterface ...$values) + { + $this->values = $values; } } diff --git a/src/Annotation/ConsumesJson.php b/src/Annotation/ConsumesJson.php index 3524279d..a9a4344e 100644 --- a/src/Annotation/ConsumesJson.php +++ b/src/Annotation/ConsumesJson.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\JsonMediaType; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ConsumesJson extends Consumes { public function __construct() { - parent::__construct(MediaTypeFactory::json()); + parent::__construct(new JsonMediaType()); } } diff --git a/src/Annotation/ConsumesXml.php b/src/Annotation/ConsumesXml.php index c810ee07..a08c2a72 100644 --- a/src/Annotation/ConsumesXml.php +++ b/src/Annotation/ConsumesXml.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\XmlMediaType; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ConsumesXml extends Consumes { public function __construct() { - parent::__construct(MediaTypeFactory::xml()); + parent::__construct(new XmlMediaType()); } } diff --git a/src/Annotation/Method.php b/src/Annotation/Method.php index 5238a7ea..3049a344 100644 --- a/src/Annotation/Method.php +++ b/src/Annotation/Method.php @@ -21,8 +21,13 @@ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] class Method { - public function __construct( - public readonly string $value, - ) { + /** + * @var array + */ + public readonly array $values; + + public function __construct(string ...$values) + { + $this->values = $values; } } diff --git a/src/Annotation/Method/DeleteMethod.php b/src/Annotation/Method/DeleteMethod.php new file mode 100644 index 00000000..b91824e8 --- /dev/null +++ b/src/Annotation/Method/DeleteMethod.php @@ -0,0 +1,30 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Method; + +use Attribute; +use Sunrise\Http\Router\Annotation\Method; +use Sunrise\Http\Router\Dictionary\RequestMethod; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class DeleteMethod extends Method +{ + public function __construct() + { + parent::__construct(RequestMethod::DELETE); + } +} diff --git a/src/Annotation/ConsumesImage.php b/src/Annotation/Method/GetMethod.php similarity index 69% rename from src/Annotation/ConsumesImage.php rename to src/Annotation/Method/GetMethod.php index 5b421104..ca308bc8 100644 --- a/src/Annotation/ConsumesImage.php +++ b/src/Annotation/Method/GetMethod.php @@ -11,19 +11,20 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation; +namespace Sunrise\Http\Router\Annotation\Method; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Annotation\Method; +use Sunrise\Http\Router\Dictionary\RequestMethod; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class ConsumesImage extends Consumes +final class GetMethod extends Method { public function __construct() { - parent::__construct(MediaTypeFactory::image()); + parent::__construct(RequestMethod::GET); } } diff --git a/src/Annotation/MethodGet.php b/src/Annotation/Method/HeadMethod.php similarity index 69% rename from src/Annotation/MethodGet.php rename to src/Annotation/Method/HeadMethod.php index 8fc5afdb..ab907e3b 100644 --- a/src/Annotation/MethodGet.php +++ b/src/Annotation/Method/HeadMethod.php @@ -11,19 +11,20 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation; +namespace Sunrise\Http\Router\Annotation\Method; use Attribute; -use Fig\Http\Message\RequestMethodInterface; +use Sunrise\Http\Router\Annotation\Method; +use Sunrise\Http\Router\Dictionary\RequestMethod; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class MethodGet extends Method +final class HeadMethod extends Method { public function __construct() { - parent::__construct(RequestMethodInterface::METHOD_GET); + parent::__construct(RequestMethod::HEAD); } } diff --git a/src/Annotation/Method/OptionsMethod.php b/src/Annotation/Method/OptionsMethod.php new file mode 100644 index 00000000..26d1435a --- /dev/null +++ b/src/Annotation/Method/OptionsMethod.php @@ -0,0 +1,30 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Method; + +use Attribute; +use Sunrise\Http\Router\Annotation\Method; +use Sunrise\Http\Router\Dictionary\RequestMethod; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class OptionsMethod extends Method +{ + public function __construct() + { + parent::__construct(RequestMethod::OPTIONS); + } +} diff --git a/src/Annotation/Method/PatchMethod.php b/src/Annotation/Method/PatchMethod.php new file mode 100644 index 00000000..8e78c9c1 --- /dev/null +++ b/src/Annotation/Method/PatchMethod.php @@ -0,0 +1,30 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Method; + +use Attribute; +use Sunrise\Http\Router\Annotation\Method; +use Sunrise\Http\Router\Dictionary\RequestMethod; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class PatchMethod extends Method +{ + public function __construct() + { + parent::__construct(RequestMethod::PATCH); + } +} diff --git a/src/Annotation/MethodHead.php b/src/Annotation/Method/PostMethod.php similarity index 69% rename from src/Annotation/MethodHead.php rename to src/Annotation/Method/PostMethod.php index f29157ad..8a2d2efe 100644 --- a/src/Annotation/MethodHead.php +++ b/src/Annotation/Method/PostMethod.php @@ -11,19 +11,20 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation; +namespace Sunrise\Http\Router\Annotation\Method; use Attribute; -use Fig\Http\Message\RequestMethodInterface; +use Sunrise\Http\Router\Annotation\Method; +use Sunrise\Http\Router\Dictionary\RequestMethod; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class MethodHead extends Method +final class PostMethod extends Method { public function __construct() { - parent::__construct(RequestMethodInterface::METHOD_HEAD); + parent::__construct(RequestMethod::POST); } } diff --git a/src/Annotation/Method/PurgeMethod.php b/src/Annotation/Method/PurgeMethod.php new file mode 100644 index 00000000..9251f111 --- /dev/null +++ b/src/Annotation/Method/PurgeMethod.php @@ -0,0 +1,30 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation\Method; + +use Attribute; +use Sunrise\Http\Router\Annotation\Method; +use Sunrise\Http\Router\Dictionary\RequestMethod; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final class PurgeMethod extends Method +{ + public function __construct() + { + parent::__construct(RequestMethod::PURGE); + } +} diff --git a/src/Annotation/MethodDelete.php b/src/Annotation/Method/PutMethod.php similarity index 69% rename from src/Annotation/MethodDelete.php rename to src/Annotation/Method/PutMethod.php index 89bdd16a..f34c53f1 100644 --- a/src/Annotation/MethodDelete.php +++ b/src/Annotation/Method/PutMethod.php @@ -11,19 +11,20 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation; +namespace Sunrise\Http\Router\Annotation\Method; use Attribute; -use Fig\Http\Message\RequestMethodInterface; +use Sunrise\Http\Router\Annotation\Method; +use Sunrise\Http\Router\Dictionary\RequestMethod; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class MethodDelete extends Method +final class PutMethod extends Method { public function __construct() { - parent::__construct(RequestMethodInterface::METHOD_DELETE); + parent::__construct(RequestMethod::PUT); } } diff --git a/src/Annotation/MethodOptions.php b/src/Annotation/MethodOptions.php deleted file mode 100644 index b5a8cd49..00000000 --- a/src/Annotation/MethodOptions.php +++ /dev/null @@ -1,29 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation; - -use Attribute; -use Fig\Http\Message\RequestMethodInterface; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class MethodOptions extends Method -{ - public function __construct() - { - parent::__construct(RequestMethodInterface::METHOD_OPTIONS); - } -} diff --git a/src/Annotation/MethodPatch.php b/src/Annotation/MethodPatch.php deleted file mode 100644 index 0ac67db3..00000000 --- a/src/Annotation/MethodPatch.php +++ /dev/null @@ -1,29 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation; - -use Attribute; -use Fig\Http\Message\RequestMethodInterface; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class MethodPatch extends Method -{ - public function __construct() - { - parent::__construct(RequestMethodInterface::METHOD_PATCH); - } -} diff --git a/src/Annotation/MethodPost.php b/src/Annotation/MethodPost.php deleted file mode 100644 index 17004ba5..00000000 --- a/src/Annotation/MethodPost.php +++ /dev/null @@ -1,29 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation; - -use Attribute; -use Fig\Http\Message\RequestMethodInterface; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class MethodPost extends Method -{ - public function __construct() - { - parent::__construct(RequestMethodInterface::METHOD_POST); - } -} diff --git a/src/Annotation/MethodPurge.php b/src/Annotation/MethodPurge.php deleted file mode 100644 index 50a781d5..00000000 --- a/src/Annotation/MethodPurge.php +++ /dev/null @@ -1,29 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation; - -use Attribute; -use Fig\Http\Message\RequestMethodInterface; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class MethodPurge extends Method -{ - public function __construct() - { - parent::__construct(RequestMethodInterface::METHOD_PURGE); - } -} diff --git a/src/Annotation/MethodPut.php b/src/Annotation/MethodPut.php deleted file mode 100644 index 7be2b0fa..00000000 --- a/src/Annotation/MethodPut.php +++ /dev/null @@ -1,29 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation; - -use Attribute; -use Fig\Http\Message\RequestMethodInterface; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class MethodPut extends Method -{ - public function __construct() - { - parent::__construct(RequestMethodInterface::METHOD_PUT); - } -} diff --git a/src/Annotation/Middleware.php b/src/Annotation/Middleware.php index 879a7f8a..b63d2e6d 100644 --- a/src/Annotation/Middleware.php +++ b/src/Annotation/Middleware.php @@ -21,8 +21,13 @@ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Middleware { - public function __construct( - public readonly mixed $value, - ) { + /** + * @var array + */ + public readonly array $values; + + public function __construct(mixed ...$values) + { + $this->values = $values; } } diff --git a/src/Annotation/Path.php b/src/Annotation/Path.php index bb827434..a9e6f7bd 100644 --- a/src/Annotation/Path.php +++ b/src/Annotation/Path.php @@ -19,7 +19,7 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] -class Path +final class Path { public function __construct( public readonly string $value, diff --git a/src/Annotation/PatternAsciiSlug.php b/src/Annotation/Pattern/AsciiSlugPattern.php similarity index 82% rename from src/Annotation/PatternAsciiSlug.php rename to src/Annotation/Pattern/AsciiSlugPattern.php index 07fd6334..be4dcae3 100644 --- a/src/Annotation/PatternAsciiSlug.php +++ b/src/Annotation/Pattern/AsciiSlugPattern.php @@ -11,16 +11,17 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation; +namespace Sunrise\Http\Router\Annotation\Pattern; use Attribute; +use Sunrise\Http\Router\Annotation\Pattern; use Sunrise\Http\Router\Dictionary\VariablePattern; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class PatternAsciiSlug extends Pattern +final class AsciiSlugPattern extends Pattern { public function __construct(string $variableName) { diff --git a/src/Annotation/PatternPositiveInt.php b/src/Annotation/Pattern/UnsignedIntegerPattern.php similarity index 72% rename from src/Annotation/PatternPositiveInt.php rename to src/Annotation/Pattern/UnsignedIntegerPattern.php index 1fbf4964..6d3c7059 100644 --- a/src/Annotation/PatternPositiveInt.php +++ b/src/Annotation/Pattern/UnsignedIntegerPattern.php @@ -11,19 +11,20 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation; +namespace Sunrise\Http\Router\Annotation\Pattern; use Attribute; +use Sunrise\Http\Router\Annotation\Pattern; use Sunrise\Http\Router\Dictionary\VariablePattern; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class PatternPositiveInt extends Pattern +final class UnsignedIntegerPattern extends Pattern { public function __construct(string $variableName) { - parent::__construct($variableName, VariablePattern::POSITIVE_INT); + parent::__construct($variableName, VariablePattern::UNSIGNED_INTEGER); } } diff --git a/src/Annotation/PatternUuid.php b/src/Annotation/Pattern/UuidPattern.php similarity index 83% rename from src/Annotation/PatternUuid.php rename to src/Annotation/Pattern/UuidPattern.php index 264c5184..5b5cb53f 100644 --- a/src/Annotation/PatternUuid.php +++ b/src/Annotation/Pattern/UuidPattern.php @@ -11,16 +11,17 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation; +namespace Sunrise\Http\Router\Annotation\Pattern; use Attribute; +use Sunrise\Http\Router\Annotation\Pattern; use Sunrise\Http\Router\Dictionary\VariablePattern; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class PatternUuid extends Pattern +final class UuidPattern extends Pattern { public function __construct(string $variableName) { diff --git a/src/Annotation/Produces.php b/src/Annotation/Produces.php index 7bba6461..b911b801 100644 --- a/src/Annotation/Produces.php +++ b/src/Annotation/Produces.php @@ -22,8 +22,13 @@ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] class Produces { - public function __construct( - public readonly MediaTypeInterface|string $value, - ) { + /** + * @var array + */ + public readonly array $values; + + public function __construct(MediaTypeInterface ...$values) + { + $this->values = $values; } } diff --git a/src/Annotation/ProducesHtml.php b/src/Annotation/ProducesHtml.php deleted file mode 100644 index ce98ca05..00000000 --- a/src/Annotation/ProducesHtml.php +++ /dev/null @@ -1,29 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation; - -use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class ProducesHtml extends Produces -{ - public function __construct() - { - parent::__construct(MediaTypeFactory::html()); - } -} diff --git a/src/Annotation/ProducesJson.php b/src/Annotation/ProducesJson.php index 356ac287..018c7530 100644 --- a/src/Annotation/ProducesJson.php +++ b/src/Annotation/ProducesJson.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\JsonMediaType; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ProducesJson extends Produces { public function __construct() { - parent::__construct(MediaTypeFactory::json()); + parent::__construct(new JsonMediaType()); } } diff --git a/src/Annotation/ProducesText.php b/src/Annotation/ProducesText.php deleted file mode 100644 index 4c3048f2..00000000 --- a/src/Annotation/ProducesText.php +++ /dev/null @@ -1,29 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Annotation; - -use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; - -/** - * @since 3.0.0 - */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class ProducesText extends Produces -{ - public function __construct() - { - parent::__construct(MediaTypeFactory::text()); - } -} diff --git a/src/Annotation/ProducesXml.php b/src/Annotation/ProducesXml.php index 5b4c9dd5..703d206a 100644 --- a/src/Annotation/ProducesXml.php +++ b/src/Annotation/ProducesXml.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\XmlMediaType; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ProducesXml extends Produces { public function __construct() { - parent::__construct(MediaTypeFactory::xml()); + parent::__construct(new XmlMediaType()); } } diff --git a/src/Annotation/ResponseEmpty.php b/src/Annotation/Response/EmptyResponse.php similarity index 85% rename from src/Annotation/ResponseEmpty.php rename to src/Annotation/Response/EmptyResponse.php index 17d11a73..73ed8e39 100644 --- a/src/Annotation/ResponseEmpty.php +++ b/src/Annotation/Response/EmptyResponse.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation; +namespace Sunrise\Http\Router\Annotation\Response; use Attribute; @@ -19,6 +19,6 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] -final class ResponseEmpty +final class EmptyResponse { } diff --git a/src/Annotation/ResponseJson.php b/src/Annotation/Response/JsonResponse.php similarity index 88% rename from src/Annotation/ResponseJson.php rename to src/Annotation/Response/JsonResponse.php index 5b27044b..1acd3c9a 100644 --- a/src/Annotation/ResponseJson.php +++ b/src/Annotation/Response/JsonResponse.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation; +namespace Sunrise\Http\Router\Annotation\Response; use Attribute; @@ -19,7 +19,7 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] -final class ResponseJson +final class JsonResponse { public function __construct( public readonly ?int $encodingFlags = null, diff --git a/src/Annotation/Tag.php b/src/Annotation/Tag.php index f6c84879..55de6f94 100644 --- a/src/Annotation/Tag.php +++ b/src/Annotation/Tag.php @@ -21,8 +21,13 @@ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] final class Tag { - public function __construct( - public readonly string $value, - ) { + /** + * @var array + */ + public readonly array $values; + + public function __construct(string ...$values) + { + $this->values = $values; } } diff --git a/src/Command/RouterListRoutesCommand.php b/src/Command/RouterListRoutesCommand.php index d34683d6..376a89c1 100644 --- a/src/Command/RouterListRoutesCommand.php +++ b/src/Command/RouterListRoutesCommand.php @@ -25,7 +25,7 @@ /** * @since 2.9.0 */ -#[AsCommand('router:list-routes', 'Lists all routes.')] +#[AsCommand('router:list-routes', 'Lists routes.')] final class RouterListRoutesCommand extends Command { public function __construct(private readonly RouterInterface $router) diff --git a/src/Dictionary/MediaType.php b/src/Dictionary/MediaType.php new file mode 100644 index 00000000..6c96fd68 --- /dev/null +++ b/src/Dictionary/MediaType.php @@ -0,0 +1,23 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Dictionary; + +/** + * @since 3.0.0 + */ +final class MediaType +{ + public const JSON = 'application/json'; + public const XML = 'application/xml'; +} diff --git a/src/Dictionary/RequestMethod.php b/src/Dictionary/RequestMethod.php new file mode 100644 index 00000000..335af52d --- /dev/null +++ b/src/Dictionary/RequestMethod.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Dictionary; + +/** + * @since 3.0.0 + */ +final class RequestMethod +{ + public const OPTIONS = 'OPTIONS'; + public const HEAD = 'HEAD'; + public const GET = 'GET'; + public const POST = 'POST'; + public const PUT = 'PUT'; + public const PATCH = 'PATCH'; + public const DELETE = 'DELETE'; + public const PURGE = 'PURGE'; +} diff --git a/src/Dictionary/VariablePattern.php b/src/Dictionary/VariablePattern.php index 1b499de5..22b770b8 100644 --- a/src/Dictionary/VariablePattern.php +++ b/src/Dictionary/VariablePattern.php @@ -18,7 +18,7 @@ */ final class VariablePattern { - public const POSITIVE_INT = '[0-9]+'; + public const UNSIGNED_INTEGER = '[0-9]+'; public const ASCII_SLUG = '[0-9A-Za-z]+(?:-[0-9A-Za-z]+)*'; public const UUID = '[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}'; } diff --git a/src/Entity/Language/Language.php b/src/Entity/Language/ClientLanguage.php similarity index 69% rename from src/Entity/Language/Language.php rename to src/Entity/Language/ClientLanguage.php index e9bba53f..b1b22afd 100644 --- a/src/Entity/Language/Language.php +++ b/src/Entity/Language/ClientLanguage.php @@ -16,14 +16,13 @@ /** * @since 3.0.0 */ -final class Language implements LanguageInterface +final class ClientLanguage implements LanguageInterface { public function __construct( private readonly string $code, - // As an example, this could be one of the identifiers in the Accept-Language header. - private readonly ?string $identifier = null, + private readonly string $locale, /** @var array */ - private readonly array $parameters = [], + private readonly array $parameters, ) { } @@ -32,9 +31,9 @@ public function getCode(): string return $this->code; } - public function getIdentifier(): string + public function getLocale(): string { - return $this->identifier ?? $this->code; + return $this->locale; } /** diff --git a/src/Entity/Language/LanguageComparator.php b/src/Entity/Language/LanguageComparator.php index df250fbc..abc0620e 100644 --- a/src/Entity/Language/LanguageComparator.php +++ b/src/Entity/Language/LanguageComparator.php @@ -18,11 +18,11 @@ */ final class LanguageComparator implements LanguageComparatorInterface { + /** + * @inheritDoc + */ public function compare(LanguageInterface $a, LanguageInterface $b): int { - $aCode = $a->getCode(); - $bCode = $b->getCode(); - - return ($aCode === '*' || $bCode === '*') ? 0 : $aCode <=> $bCode; + return ($a->getCode() === '*' || $b->getCode() === '*') ? 0 : $a->getCode() <=> $b->getCode(); } } diff --git a/src/Entity/Language/StringableLanguage.php b/src/Entity/Language/StringableLanguage.php new file mode 100644 index 00000000..36532d7a --- /dev/null +++ b/src/Entity/Language/StringableLanguage.php @@ -0,0 +1,41 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Entity\Language; + +use Stringable; + +/** + * @since 3.0.0 + */ +final class StringableLanguage implements LanguageInterface, Stringable +{ + public function __construct(private readonly LanguageInterface $language) + { + } + + public static function create(LanguageInterface $language): self + { + return new self($language); + } + + public function getCode(): string + { + return $this->language->getCode(); + } + + public function __toString(): string + { + return $this->getCode(); + } +} diff --git a/src/Entity/MediaType/MediaType.php b/src/Entity/MediaType/ClientMediaType.php similarity index 58% rename from src/Entity/MediaType/MediaType.php rename to src/Entity/MediaType/ClientMediaType.php index 6589ce46..8718cd24 100644 --- a/src/Entity/MediaType/MediaType.php +++ b/src/Entity/MediaType/ClientMediaType.php @@ -16,29 +16,18 @@ /** * @since 3.0.0 */ -final class MediaType implements MediaTypeInterface +final class ClientMediaType implements MediaTypeInterface { public function __construct( - private readonly string $type, - private readonly string $subtype, + private readonly string $identifier, /** @var array */ - private readonly array $parameters = [], + private readonly array $parameters, ) { } - public function getType(): string - { - return $this->type; - } - - public function getSubtype(): string - { - return $this->subtype; - } - public function getIdentifier(): string { - return $this->type . $this::SEPARATOR . $this->subtype; + return $this->identifier; } /** @@ -48,9 +37,4 @@ public function getParameters(): array { return $this->parameters; } - - public function __toString(): string - { - return $this->getIdentifier(); - } } diff --git a/src/Entity/MediaType/JsonMediaType.php b/src/Entity/MediaType/JsonMediaType.php new file mode 100644 index 00000000..7585f2b0 --- /dev/null +++ b/src/Entity/MediaType/JsonMediaType.php @@ -0,0 +1,27 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Entity\MediaType; + +use Sunrise\Http\Router\Dictionary\MediaType; + +/** + * @since 3.0.0 + */ +final class JsonMediaType implements MediaTypeInterface +{ + public function getIdentifier(): string + { + return MediaType::JSON; + } +} diff --git a/src/Entity/MediaType/MediaTypeComparator.php b/src/Entity/MediaType/MediaTypeComparator.php index d74d1278..2e8ed001 100644 --- a/src/Entity/MediaType/MediaTypeComparator.php +++ b/src/Entity/MediaType/MediaTypeComparator.php @@ -13,7 +13,8 @@ namespace Sunrise\Http\Router\Entity\MediaType; -use function strcasecmp; +use function explode; +use function strtolower; /** * @since 3.0.0 @@ -21,22 +22,21 @@ final class MediaTypeComparator implements MediaTypeComparatorInterface { /** - * @link https://datatracker.ietf.org/doc/html/rfc2045#section-5.1 + * @inheritDoc */ public function compare(MediaTypeInterface $a, MediaTypeInterface $b): int { - $aType = $a->getType(); - $aSubtype = $a->getSubtype(); - $bType = $b->getType(); - $bSubtype = $b->getSubtype(); - - if ( - ($aType === '*' || $bType === '*' || strcasecmp($aType, $bType) === 0) && - ($aSubtype === '*' || $bSubtype === '*' || strcasecmp($aSubtype, $bSubtype) === 0) - ) { - return 0; - } - - return strcasecmp((string) $a, (string) $b) < 0 ? -1 : 1; + $aId = strtolower($a->getIdentifier()); + $aParts = explode('/', $aId, 2); + $aParts[1] ??= ''; + + $bId = strtolower($b->getIdentifier()); + $bParts = explode('/', $bId, 2); + $bParts[1] ??= ''; + + $sameTypes = $aParts[0] === '*' || $bParts[0] === '*' || $aParts[0] === $bParts[0]; + $sameSubtypes = $aParts[1] === '*' || $bParts[1] === '*' || $aParts[1] === $bParts[1]; + + return ($sameTypes && $sameSubtypes) ? 0 : $aId <=> $bId; } } diff --git a/src/Entity/MediaType/MediaTypeFactory.php b/src/Entity/MediaType/MediaTypeFactory.php deleted file mode 100644 index 708488c6..00000000 --- a/src/Entity/MediaType/MediaTypeFactory.php +++ /dev/null @@ -1,86 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Entity\MediaType; - -use InvalidArgumentException; - -use function preg_match; -use function sprintf; - -/** - * @since 3.0.0 - */ -final class MediaTypeFactory -{ - /** - * @throws InvalidArgumentException See {@see fromString()}. - */ - public static function create(MediaTypeInterface|string $mediaType): MediaTypeInterface - { - if ($mediaType instanceof MediaTypeInterface) { - return $mediaType; - } - - return self::fromString($mediaType); - } - - public static function any(): MediaTypeInterface - { - return new MediaType('*', '*'); - } - - public static function json(): MediaTypeInterface - { - return new MediaType('application', 'json'); - } - - public static function xml(): MediaTypeInterface - { - return new MediaType('application', 'xml'); - } - - public static function html(): MediaTypeInterface - { - return new MediaType('text', 'html'); - } - - public static function text(): MediaTypeInterface - { - return new MediaType('text', 'plain'); - } - - public static function image(): MediaTypeInterface - { - return new MediaType('image', '*'); - } - - /** - * @throws InvalidArgumentException If the given media type doesn't look like a media type. - */ - public static function fromString(string $mediaType): MediaTypeInterface - { - if ($mediaType === '') { - throw new InvalidArgumentException('The media type cannot be an empty string.'); - } - - if (!preg_match('|^([^/;]+)/([^/;]+)$|', $mediaType, $matches)) { - throw new InvalidArgumentException(sprintf( - 'The string %s does not look like a media type (type/subtype).', - $mediaType, - )); - } - - return new MediaType($matches[1], $matches[2]); - } -} diff --git a/src/Entity/MediaType/MediaTypeInterface.php b/src/Entity/MediaType/MediaTypeInterface.php index 91bc5b94..d2798ae1 100644 --- a/src/Entity/MediaType/MediaTypeInterface.php +++ b/src/Entity/MediaType/MediaTypeInterface.php @@ -13,16 +13,10 @@ namespace Sunrise\Http\Router\Entity\MediaType; -use Stringable; - /** * @since 3.0.0 */ -interface MediaTypeInterface extends Stringable +interface MediaTypeInterface { - final public const SEPARATOR = '/'; - - public function getType(): string; - - public function getSubtype(): string; + public function getIdentifier(): string; } diff --git a/src/Entity/MediaType/StringableMediaType.php b/src/Entity/MediaType/StringableMediaType.php new file mode 100644 index 00000000..5c4d5b30 --- /dev/null +++ b/src/Entity/MediaType/StringableMediaType.php @@ -0,0 +1,41 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Entity\MediaType; + +use Stringable; + +/** + * @since 3.0.0 + */ +final class StringableMediaType implements MediaTypeInterface, Stringable +{ + public function __construct(private readonly MediaTypeInterface $mediaType) + { + } + + public static function create(MediaTypeInterface $mediaType): self + { + return new self($mediaType); + } + + public function getIdentifier(): string + { + return $this->mediaType->getIdentifier(); + } + + public function __toString(): string + { + return $this->getIdentifier(); + } +} diff --git a/src/Annotation/PathHome.php b/src/Entity/MediaType/XmlMediaType.php similarity index 62% rename from src/Annotation/PathHome.php rename to src/Entity/MediaType/XmlMediaType.php index 958270fd..a18e278a 100644 --- a/src/Annotation/PathHome.php +++ b/src/Entity/MediaType/XmlMediaType.php @@ -11,18 +11,17 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation; +namespace Sunrise\Http\Router\Entity\MediaType; -use Attribute; +use Sunrise\Http\Router\Dictionary\MediaType; /** * @since 3.0.0 */ -#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] -final class PathHome extends Path +final class XmlMediaType implements MediaTypeInterface { - public function __construct() + public function getIdentifier(): string { - parent::__construct('/'); + return MediaType::XML; } } diff --git a/src/Helper/RouteMatcher.php b/src/Helper/RouteMatcher.php index dd22f850..f29c906b 100644 --- a/src/Helper/RouteMatcher.php +++ b/src/Helper/RouteMatcher.php @@ -73,7 +73,7 @@ public static function matchPattern(string $route, string $pattern, string $subj throw new InvalidArgumentException(sprintf( 'The route %s could not be matched due to: %s. ' . - 'This problem is most likely related to one of the route patterns', + 'This problem is most likely related to one of the route patterns.', $route, preg_last_error_msg(), ), preg_last_error()); diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index aee8e594..8dba8137 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -40,7 +40,6 @@ use Sunrise\Http\Router\Annotation\Summary; use Sunrise\Http\Router\Annotation\Tag; use Sunrise\Http\Router\Dictionary\CacheKey; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; use Sunrise\Http\Router\Helper\ClassFinder; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Route; @@ -266,7 +265,9 @@ private static function enrichDescriptorFromClassOrMethod( $annotations = $classOrMethod->getAttributes(Method::class, ReflectionAttribute::IS_INSTANCEOF); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->methods[] = $annotation->value; + foreach ($annotation->values as $value) { + $descriptor->methods[] = $value; + } } /** @var list> $annotations */ @@ -280,35 +281,47 @@ private static function enrichDescriptorFromClassOrMethod( $annotations = $classOrMethod->getAttributes(Middleware::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->middlewares[] = $annotation->value; + /** @var mixed $value */ + foreach ($annotation->values as $value) { + $descriptor->middlewares[] = $value; + } } /** @var list> $annotations */ $annotations = $classOrMethod->getAttributes(Constraint::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->constraints[] = $annotation->value; + /** @var mixed $value */ + foreach ($annotation->values as $value) { + $descriptor->constraints[] = $value; + } } /** @var list> $annotations */ $annotations = $classOrMethod->getAttributes(Consumes::class, ReflectionAttribute::IS_INSTANCEOF); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->consumes[] = MediaTypeFactory::create($annotation->value); + foreach ($annotation->values as $value) { + $descriptor->consumes[] = $value; + } } /** @var list> $annotations */ $annotations = $classOrMethod->getAttributes(Produces::class, ReflectionAttribute::IS_INSTANCEOF); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->produces[] = MediaTypeFactory::create($annotation->value); + foreach ($annotation->values as $value) { + $descriptor->produces[] = $value; + } } /** @var list> $annotations */ $annotations = $classOrMethod->getAttributes(Tag::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - $descriptor->tags[] = $annotation->value; + foreach ($annotation->values as $value) { + $descriptor->tags[] = $value; + } } /** @var list> $annotations */ diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index d0bbbc5b..e81f07c1 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -18,7 +18,7 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\JsonMediaType; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ServerRequest; @@ -57,7 +57,7 @@ public function __construct( */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if (ServerRequest::create($request)->clientProducesMediaType(MediaTypeFactory::json())) { + if (ServerRequest::create($request)->clientProducesMediaType(new JsonMediaType())) { $request = $request->withParsedBody($this->decodePayload((string) $request->getBody())); } diff --git a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php index 5ec28339..23276705 100644 --- a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php +++ b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php @@ -17,10 +17,12 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\Entity\MediaType\StringableMediaType; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ServerRequest; +use function array_map; use function array_values; /** @@ -50,13 +52,13 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface $clientProducedMediaType = $serverRequest->getClientProducedMediaType(); if ($clientProducedMediaType === null) { throw HttpExceptionFactory::missingContentType($this->errorMessage, $this->errorStatusCode) - ->addHeaderField('Accept', ...$serverConsumedMediaTypes); + ->addHeaderField('Accept', ...array_map(StringableMediaType::create(...), $serverConsumedMediaTypes)); } if (!$serverRequest->clientProducesMediaType(...$serverConsumedMediaTypes)) { throw HttpExceptionFactory::unsupportedMediaType($this->errorMessage, $this->errorStatusCode) ->addMessagePlaceholder('{{ media_type }}', $clientProducedMediaType) - ->addHeaderField('Accept', ...$serverConsumedMediaTypes); + ->addHeaderField('Accept', ...array_map(StringableMediaType::create(...), $serverConsumedMediaTypes)); } return $handler->handle($request); diff --git a/src/ResponseResolver/ResponseEmptyResolver.php b/src/ResponseResolver/ResponseEmptyResolver.php index 2306bc32..0ff09c6c 100644 --- a/src/ResponseResolver/ResponseEmptyResolver.php +++ b/src/ResponseResolver/ResponseEmptyResolver.php @@ -19,7 +19,7 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionFunction; use ReflectionMethod; -use Sunrise\Http\Router\Annotation\ResponseEmpty; +use Sunrise\Http\Router\Annotation\Response\EmptyResponse; use Sunrise\Http\Router\ResponseResolverInterface; /** @@ -43,7 +43,7 @@ public function resolveResponse( ReflectionMethod|ReflectionFunction $responder, ServerRequestInterface $request, ): ?ResponseInterface { - if ($responder->getAttributes(ResponseEmpty::class) === []) { + if ($responder->getAttributes(EmptyResponse::class) === []) { return null; } diff --git a/src/ResponseResolver/ResponseJsonResolver.php b/src/ResponseResolver/ResponseJsonResolver.php index 2a68a874..fb3dce4d 100644 --- a/src/ResponseResolver/ResponseJsonResolver.php +++ b/src/ResponseResolver/ResponseJsonResolver.php @@ -22,7 +22,7 @@ use ReflectionFunction; use ReflectionMethod; use RuntimeException; -use Sunrise\Http\Router\Annotation\ResponseJson; +use Sunrise\Http\Router\Annotation\Response\JsonResponse; use Sunrise\Http\Router\ResponseResolverChain; use Sunrise\Http\Router\ResponseResolverInterface; @@ -56,8 +56,8 @@ public function resolveResponse( ReflectionMethod|ReflectionFunction $responder, ServerRequestInterface $request, ): ?ResponseInterface { - /** @var list> $annotations */ - $annotations = $responder->getAttributes(ResponseJson::class); + /** @var list> $annotations */ + $annotations = $responder->getAttributes(JsonResponse::class); if ($annotations === []) { return null; } diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 2cd98c4b..0f659376 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -18,11 +18,11 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\StreamInterface; use Psr\Http\Message\UriInterface; -use Sunrise\Http\Router\Entity\Language\Language; +use Sunrise\Http\Router\Entity\Language\ClientLanguage; use Sunrise\Http\Router\Entity\Language\LanguageComparator; use Sunrise\Http\Router\Entity\Language\LanguageComparatorInterface; use Sunrise\Http\Router\Entity\Language\LanguageInterface; -use Sunrise\Http\Router\Entity\MediaType\MediaType; +use Sunrise\Http\Router\Entity\MediaType\ClientMediaType; use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparatorInterface; use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; @@ -96,7 +96,7 @@ public function getRoute(): RouteInterface return $route; } - public function getClientProducedMediaType(): ?MediaType + public function getClientProducedMediaType(): ?ClientMediaType { $values = HeaderParser::parseHeader($this->request->getHeaderLine('Content-Type')); if ($values === []) { @@ -104,19 +104,19 @@ public function getClientProducedMediaType(): ?MediaType } [$identifier, $parameters] = reset($values); - if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier, $matches) === 1) { - return new MediaType($matches[1], $matches[2], $parameters); + if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier) === 1) { + return new ClientMediaType($identifier, $parameters); } return null; } /** - * @return Generator, MediaType> + * @return Generator, ClientLanguage> */ - public function getClientConsumedMediaTypes(): Generator + public function getClientConsumedLanguages(): Generator { - $values = HeaderParser::parseHeader($this->request->getHeaderLine('Accept')); + $values = HeaderParser::parseHeader($this->request->getHeaderLine('Accept-Language')); if ($values === []) { return; } @@ -128,18 +128,18 @@ public function getClientConsumedMediaTypes(): Generator /** @phpstan-var int<0, max> $index */ foreach ($values as $index => [$identifier, $parameters]) { - if (preg_match('|^([^/]+)/([^/]+)$|', $identifier, $matches) === 1) { - yield $index => new MediaType($matches[1], $matches[2], $parameters); + if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches) === 1) { + yield $index => new ClientLanguage($matches[1], $identifier, $parameters); } } } /** - * @return Generator, Language> + * @return Generator, ClientMediaType> */ - public function getClientConsumedLanguages(): Generator + public function getClientConsumedMediaTypes(): Generator { - $values = HeaderParser::parseHeader($this->request->getHeaderLine('Accept-Language')); + $values = HeaderParser::parseHeader($this->request->getHeaderLine('Accept')); if ($values === []) { return; } @@ -151,23 +151,23 @@ public function getClientConsumedLanguages(): Generator /** @phpstan-var int<0, max> $index */ foreach ($values as $index => [$identifier, $parameters]) { - if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches) === 1) { - yield $index => new Language($matches[1], $identifier, $parameters); + if (preg_match('|^([^/]+)/([^/]+)$|', $identifier) === 1) { + yield $index => new ClientMediaType($identifier, $parameters); } } } - public function getClientPreferredMediaType(MediaTypeInterface ...$serverProducedMediaTypes): ?MediaType + public function getClientPreferredLanguage(LanguageInterface ...$serverProducedLanguages): ?ClientLanguage { - if ($serverProducedMediaTypes === []) { + if ($serverProducedLanguages === []) { return null; } - $mediaTypeComparator = $this->getMediaTypeComparator(); - foreach ($this->getClientConsumedMediaTypes() as $clientConsumedMediaType) { - foreach ($serverProducedMediaTypes as $serverProducedMediaType) { - if ($mediaTypeComparator->compare($clientConsumedMediaType, $serverProducedMediaType) === 0) { - return $clientConsumedMediaType; + $languageComparator = $this->getLanguageComparator(); + foreach ($this->getClientConsumedLanguages() as $clientConsumedLanguage) { + foreach ($serverProducedLanguages as $serverProducedLanguage) { + if ($languageComparator->compare($clientConsumedLanguage, $serverProducedLanguage) === 0) { + return $clientConsumedLanguage; } } } @@ -175,17 +175,17 @@ public function getClientPreferredMediaType(MediaTypeInterface ...$serverProduce return null; } - public function getClientPreferredLanguage(LanguageInterface ...$serverProducedLanguages): ?Language + public function getClientPreferredMediaType(MediaTypeInterface ...$serverProducedMediaTypes): ?ClientMediaType { - if ($serverProducedLanguages === []) { + if ($serverProducedMediaTypes === []) { return null; } - $languageComparator = $this->getLanguageComparator(); - foreach ($this->getClientConsumedLanguages() as $clientConsumedLanguage) { - foreach ($serverProducedLanguages as $serverProducedLanguage) { - if ($languageComparator->compare($clientConsumedLanguage, $serverProducedLanguage) === 0) { - return $clientConsumedLanguage; + $mediaTypeComparator = $this->getMediaTypeComparator(); + foreach ($this->getClientConsumedMediaTypes() as $clientConsumedMediaType) { + foreach ($serverProducedMediaTypes as $serverProducedMediaType) { + if ($mediaTypeComparator->compare($clientConsumedMediaType, $serverProducedMediaType) === 0) { + return $clientConsumedMediaType; } } } diff --git a/src/Validation/Constraint/ArgumentConstraintValidator.php b/src/Validation/Constraint/ArgumentConstraintValidator.php index bc3d9abe..fe3147ee 100644 --- a/src/Validation/Constraint/ArgumentConstraintValidator.php +++ b/src/Validation/Constraint/ArgumentConstraintValidator.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Validation\Constraint; use ReflectionAttribute; -use Sunrise\Http\Router\Annotation\Constraint as ParameterConstraint; +use Sunrise\Http\Router\Annotation\Constraint as ConstraintAnnotation; use Symfony\Component\Validator\Constraint; use Symfony\Component\Validator\ConstraintValidator; use Symfony\Component\Validator\Exception\UnexpectedTypeException; @@ -36,12 +36,16 @@ public function validate(mixed $value, Constraint $constraint): void } $constraints = []; - /** @var list> $parameterAnnotations */ - $parameterAnnotations = $constraint->getParameter()->getAttributes(ParameterConstraint::class); - foreach ($parameterAnnotations as $parameterAnnotation) { - $parameterConstraint = $parameterAnnotation->newInstance(); - if ($parameterConstraint->value instanceof Constraint) { - $constraints[] = $parameterConstraint->value; + + /** @var list> $constraintAnnotations */ + $constraintAnnotations = $constraint->getParameter()->getAttributes(ConstraintAnnotation::class); + foreach ($constraintAnnotations as $constraintAnnotation) { + $parameterConstraints = $constraintAnnotation->newInstance()->values; + /** @var mixed $parameterConstraint */ + foreach ($parameterConstraints as $parameterConstraint) { + if ($parameterConstraint instanceof Constraint) { + $constraints[] = $parameterConstraint; + } } } diff --git a/tests/Command/RouterClearCacheCommandTest.php b/tests/Command/RouterClearCacheCommandTest.php index 4400d6b2..ac7d8840 100644 --- a/tests/Command/RouterClearCacheCommandTest.php +++ b/tests/Command/RouterClearCacheCommandTest.php @@ -22,7 +22,9 @@ protected function setUp(): void public function testExecuteWithCache(): void { - $this->cacheMock->expects($this->once())->method('delete')->with(CacheKey::DESCRIPTORS); + $this->cacheMock->expects(self::once()) + ->method('delete') + ->with(CacheKey::DESCRIPTORS); $command = new RouterClearCacheCommand($this->cacheMock); $commandTester = new CommandTester($command); diff --git a/tests/Command/RouterListRoutesCommandTest.php b/tests/Command/RouterListRoutesCommandTest.php index dd936cb3..5386c4fc 100644 --- a/tests/Command/RouterListRoutesCommandTest.php +++ b/tests/Command/RouterListRoutesCommandTest.php @@ -27,7 +27,10 @@ protected function setUp(): void public function testExecuteWithRoutes(): void { $this->mockRoute(); - $this->routerMock->expects($this->once())->method('getRoutes')->willReturn($this->routeMocks); + + $this->routerMock->expects(self::once()) + ->method('getRoutes') + ->willReturn($this->routeMocks); $command = new RouterListRoutesCommand($this->routerMock); $commandTester = new CommandTester($command); @@ -36,8 +39,6 @@ public function testExecuteWithRoutes(): void public function testExecuteWithoutRoutes(): void { - $this->routerMock->expects($this->once())->method('getRoutes')->willReturn($this->routeMocks); - $command = new RouterListRoutesCommand($this->routerMock); $commandTester = new CommandTester($command); $this->assertSame(0, $commandTester->execute([])); diff --git a/tests/Entity/Language/ClientLanguageTest.php b/tests/Entity/Language/ClientLanguageTest.php new file mode 100644 index 00000000..94fb7411 --- /dev/null +++ b/tests/Entity/Language/ClientLanguageTest.php @@ -0,0 +1,19 @@ + '1.0']); + $this->assertSame('sr', $clientLanguage->getCode()); + $this->assertSame('sr-RS', $clientLanguage->getLocale()); + $this->assertSame(['q' => '1.0'], $clientLanguage->getParameters()); + } +} diff --git a/tests/Entity/Language/LanguageComparatorTest.php b/tests/Entity/Language/LanguageComparatorTest.php index 8f4092af..8adf4229 100644 --- a/tests/Entity/Language/LanguageComparatorTest.php +++ b/tests/Entity/Language/LanguageComparatorTest.php @@ -13,31 +13,88 @@ final class LanguageComparatorTest extends TestCase { #[DataProvider('compareDataProvider')] - public function testCompare(string $aCode, string $bCode, int $expectedResult): void + public function testCompare(string $aCode, string $bCode, int $expected): void { - $comparator = new LanguageComparator(); + $a = $this->mockLanguage(code: $aCode); + $b = $this->mockLanguage(code: $bCode); - $a = $this->mockLanguage($aCode); - $b = $this->mockLanguage($bCode); - - $this->assertSame($expectedResult, $comparator->compare($a, $b)); + $this->assertSame($expected, (new LanguageComparator())->compare($a, $b)); } public static function compareDataProvider(): iterable { - yield ['sr', 'sr', 0]; - yield ['*', '*', 0]; - yield ['*', 'sr', 0]; - yield ['sr', '*', 0]; - yield ['sr', 'bs', 'sr' <=> 'bs']; - yield ['bs', 'sr', 'bs' <=> 'sr']; + yield [ + 'sr', + 'sr', + 0, + ]; + + yield [ + '*', + '*', + 0, + ]; + + yield [ + '*', + 'sr', + 0, + ]; + + yield [ + 'sr', + '*', + 0, + ]; + + yield [ + 'sr', + 'bs', + 1, + ]; + + yield [ + 'bs', + 'sr', + -1, + ]; + + yield [ + 'it', + 'IT', + 1, + ]; + + yield [ + 'IT', + 'it', + -1, + ]; + + yield [ + '', + '', + 0, + ]; + + yield [ + 'sr', + '', + 1, + ]; + + yield [ + '', + 'sr', + -1, + ]; } private function mockLanguage(string $code): LanguageInterface&MockObject { - $languageMock = $this->createMock(LanguageInterface::class); - $languageMock->method('getCode')->willReturn($code); + $language = $this->createMock(LanguageInterface::class); + $language->method('getCode')->willReturn($code); - return $languageMock; + return $language; } } diff --git a/tests/Entity/Language/LanguageTest.php b/tests/Entity/Language/LanguageTest.php deleted file mode 100644 index b606d6a0..00000000 --- a/tests/Entity/Language/LanguageTest.php +++ /dev/null @@ -1,27 +0,0 @@ - '1.0']); - $this->assertSame('sr', $language->getCode()); - $this->assertSame('sr-RS', $language->getIdentifier()); - $this->assertSame(['q' => '1.0'], $language->getParameters()); - } - - public function testConstructorWithoutOptionalParameters(): void - { - $language = new Language('sr'); - $this->assertSame('sr', $language->getCode()); - $this->assertSame('sr', $language->getIdentifier()); - $this->assertSame([], $language->getParameters()); - } -} diff --git a/tests/Entity/MediaType/ClientMediaTypeTest.php b/tests/Entity/MediaType/ClientMediaTypeTest.php new file mode 100644 index 00000000..08085256 --- /dev/null +++ b/tests/Entity/MediaType/ClientMediaTypeTest.php @@ -0,0 +1,18 @@ + '1.0']); + $this->assertSame('application/json', $clientMediaType->getIdentifier()); + $this->assertSame(['q' => '1.0'], $clientMediaType->getParameters()); + } +} diff --git a/tests/Entity/MediaType/MediaTypeComparatorTest.php b/tests/Entity/MediaType/MediaTypeComparatorTest.php index 9b9ee083..2b758b52 100644 --- a/tests/Entity/MediaType/MediaTypeComparatorTest.php +++ b/tests/Entity/MediaType/MediaTypeComparatorTest.php @@ -13,92 +13,118 @@ final class MediaTypeComparatorTest extends TestCase { #[DataProvider('compareDataProvider')] - public function testCompare(string $aType, string $aSubtype, string $bType, string $bSubtype, int $expectedResult): void + public function testCompare(string $aId, string $bId, int $expected): void { - $comparator = new MediaTypeComparator(); + $a = $this->mockMediaType(identifier: $aId); + $b = $this->mockMediaType(identifier: $bId); - $a = $this->mockMediaType($aType, $aSubtype); - $b = $this->mockMediaType($bType, $bSubtype); - - $this->assertSame($expectedResult, $comparator->compare($a, $b)); + $this->assertSame($expected, (new MediaTypeComparator())->compare($a, $b)); } public static function compareDataProvider(): iterable { yield [ - 'application', 'json', - 'application', 'json', + 'application/json', + 'application/json', + 0, + ]; + + yield [ + 'application/json', + 'APPLICATION/JSON', 0, ]; yield [ - 'APPLICATION', 'JSON', - 'application', 'json', + 'APPLICATION/JSON', + 'application/json', 0, ]; yield [ - 'application', 'json', - 'APPLICATION', 'JSON', + '*/*', + '*/*', 0, ]; yield [ - '*', '*', - '*', '*', + 'application/json', + '*/*', 0, ]; yield [ - '*', '*', - 'application', 'json', + '*/*', + 'application/json', 0, ]; yield [ - 'application', 'json', - '*', '*', + '*/json', + 'application/*', 0, ]; yield [ - 'image', '*', - 'image', '*', + 'application/*', + '*/json', 0, ]; yield [ - 'image', '*', - 'image', 'webp', + 'image/*', + 'image/*', 0, ]; yield [ - 'image', 'webp', - 'image', '*', + '*/webp', + '*/webp', 0, ]; yield [ - 'application', 'json', - 'application', 'xml', - 'application/json' <=> 'application/xml', + 'image/*', + 'image/webp', + 0, + ]; + + yield [ + 'image/webp', + 'image/*', + 0, + ]; + + yield [ + 'image/*', + 'video/*', + -1, + ]; + + yield [ + '*/jpeg', + '*/png', + -1, + ]; + + yield [ + 'application/json', + 'application/xml', + -1, ]; yield [ - 'application', 'xml', - 'application', 'json', - 'application/xml' <=> 'application/json', + 'application/xml', + 'application/json', + 1, ]; } - private function mockMediaType(string $type, string $subtype): MediaTypeInterface&MockObject + private function mockMediaType(string $identifier): MediaTypeInterface&MockObject { - $mediaTypeMock = $this->createMock(MediaTypeInterface::class); - $mediaTypeMock->method('getType')->willReturn($type); - $mediaTypeMock->method('getSubtype')->willReturn($subtype); - $mediaTypeMock->method('__toString')->willReturn($type . '/' . $subtype); + $mediaType = $this->createMock(MediaTypeInterface::class); + $mediaType->method('getIdentifier')->willReturn($identifier); - return $mediaTypeMock; + return $mediaType; } } diff --git a/tests/Entity/MediaType/MediaTypeFactoryTest.php b/tests/Entity/MediaType/MediaTypeFactoryTest.php deleted file mode 100644 index 8d0d7d7b..00000000 --- a/tests/Entity/MediaType/MediaTypeFactoryTest.php +++ /dev/null @@ -1,74 +0,0 @@ -createMock(MediaTypeInterface::class); - $this->assertSame($mediaTypeMock, MediaTypeFactory::create($mediaTypeMock)); - } - - public function testCreateWithValidString(): void - { - $mediaType = MediaTypeFactory::create('application/json'); - $this->assertSame('application', $mediaType->getType()); - $this->assertSame('json', $mediaType->getSubtype()); - } - - public function testFromValidString(): void - { - $mediaType = MediaTypeFactory::fromString('application/json'); - $this->assertSame('application', $mediaType->getType()); - $this->assertSame('json', $mediaType->getSubtype()); - } - - public function testAny(): void - { - $mediaType = MediaTypeFactory::any(); - $this->assertSame('*', $mediaType->getType()); - $this->assertSame('*', $mediaType->getSubtype()); - } - - public function testJson(): void - { - $mediaType = MediaTypeFactory::json(); - $this->assertSame('application', $mediaType->getType()); - $this->assertSame('json', $mediaType->getSubtype()); - } - - public function testXml(): void - { - $mediaType = MediaTypeFactory::xml(); - $this->assertSame('application', $mediaType->getType()); - $this->assertSame('xml', $mediaType->getSubtype()); - } - - public function testHtml(): void - { - $mediaType = MediaTypeFactory::html(); - $this->assertSame('text', $mediaType->getType()); - $this->assertSame('html', $mediaType->getSubtype()); - } - - public function testText(): void - { - $mediaType = MediaTypeFactory::text(); - $this->assertSame('text', $mediaType->getType()); - $this->assertSame('plain', $mediaType->getSubtype()); - } - - public function testImage(): void - { - $mediaType = MediaTypeFactory::image(); - $this->assertSame('image', $mediaType->getType()); - $this->assertSame('*', $mediaType->getSubtype()); - } -} diff --git a/tests/Entity/MediaType/MediaTypeTest.php b/tests/Entity/MediaType/MediaTypeTest.php deleted file mode 100644 index a1d01a19..00000000 --- a/tests/Entity/MediaType/MediaTypeTest.php +++ /dev/null @@ -1,35 +0,0 @@ - '1.0']); - $this->assertSame('application', $mediaType->getType()); - $this->assertSame('json', $mediaType->getSubtype()); - $this->assertSame('application/json', $mediaType->getIdentifier()); - $this->assertSame(['q' => '1.0'], $mediaType->getParameters()); - } - - public function testConstructorWithoutOptionalParameters(): void - { - $mediaType = new MediaType('application', 'json'); - $this->assertSame('application', $mediaType->getType()); - $this->assertSame('json', $mediaType->getSubtype()); - $this->assertSame('application/json', $mediaType->getIdentifier()); - $this->assertSame([], $mediaType->getParameters()); - } - - public function testToString(): void - { - $mediaType = new MediaType('application', 'json', ['q' => '1.0']); - $this->assertSame('application/json', (string) $mediaType); - } -} diff --git a/tests/Event/RoutePostRunEventTest.php b/tests/Event/RoutePostRunEventTest.php index e05b0e1f..f9748169 100644 --- a/tests/Event/RoutePostRunEventTest.php +++ b/tests/Event/RoutePostRunEventTest.php @@ -35,7 +35,8 @@ public function testConstructor(): void public function testSetResponse(): void { $event = new RoutePostRunEvent($this->routeMock, $this->serverRequestMock, $this->responseMock); - $event->setResponse($newResponse = clone $this->responseMock); + $newResponse = $this->createMock(ResponseInterface::class); + $event->setResponse($newResponse); $this->assertSame($newResponse, $event->getResponse()); } } diff --git a/tests/Event/RoutePreRunEventTest.php b/tests/Event/RoutePreRunEventTest.php index f3d1c02c..d439b6ef 100644 --- a/tests/Event/RoutePreRunEventTest.php +++ b/tests/Event/RoutePreRunEventTest.php @@ -31,7 +31,8 @@ public function testConstructor(): void public function testSetRequest(): void { $event = new RoutePreRunEvent($this->routeMock, $this->serverRequestMock); - $event->setRequest($newServerRequest = clone $this->serverRequestMock); + $newServerRequest = $this->createMock(ServerRequestInterface::class); + $event->setRequest($newServerRequest); $this->assertSame($newServerRequest, $event->getRequest()); } } From bdff25ded76c18e02be68d27a10f1625c1c983bd Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Sun, 3 Nov 2024 11:33:59 +0100 Subject: [PATCH 172/180] v3 --- composer.json | 2 +- src/Annotation/ConsumesJson.php | 4 +- src/Annotation/ConsumesXml.php | 4 +- src/Annotation/Method.php | 5 +- src/Annotation/Method/DeleteMethod.php | 3 +- src/Annotation/Method/GetMethod.php | 3 +- src/Annotation/Method/HeadMethod.php | 3 +- src/Annotation/Method/OptionsMethod.php | 3 +- src/Annotation/Method/PatchMethod.php | 3 +- src/Annotation/Method/PostMethod.php | 3 +- src/Annotation/Method/PurgeMethod.php | 3 +- src/Annotation/Method/PutMethod.php | 3 +- src/Annotation/ProducesJson.php | 4 +- src/Annotation/ProducesXml.php | 4 +- src/Annotation/RequestVariable.php | 1 + src/Annotation/ResponseStatus.php | 5 +- ...=> RouterClearDescriptorsCacheCommand.php} | 16 ++-- src/Command/RouterListRoutesCommand.php | 5 +- src/Dictionary/CacheKey.php | 22 ----- src/Dictionary/Charset.php | 91 ------------------- src/Dictionary/MediaType.php | 23 ----- src/Dictionary/RequestMethod.php | 29 ------ src/Dictionary/VariablePattern.php | 2 +- src/Entity/Language/Language.php | 35 +++++++ src/Entity/Language/StringableLanguage.php | 7 +- .../{JsonMediaType.php => MediaType.php} | 16 +++- ...{XmlMediaType.php => MediaTypeFactory.php} | 18 +++- src/Entity/MediaType/StringableMediaType.php | 7 +- src/Exception/HttpException.php | 4 +- src/Exception/HttpExceptionInterface.php | 3 +- src/Helper/ClassFinder.php | 13 +-- src/Helper/HeaderParser.php | 38 +++++++- src/Helper/RouteBuilder.php | 4 +- src/Helper/RouteCompiler.php | 2 - src/Helper/RouteMatcher.php | 17 +--- src/Helper/RouteParser.php | 23 ++++- src/Loader/DescriptorLoader.php | 20 +++- .../JsonPayloadDecodingMiddleware.php | 9 +- .../PayloadMediaTypeNegotiationMiddleware.php | 2 +- .../WhitespaceTrimmingMiddleware.php | 31 ++----- .../RequestBodyParameterResolver.php | 4 +- .../RequestCookieParameterResolver.php | 10 +- .../RequestHeaderParameterResolver.php | 10 +- .../RequestQueryParameterResolver.php | 4 +- .../RequestVariableParameterResolver.php | 18 ++-- src/ResponseResolver/ResponseJsonResolver.php | 3 +- src/Router.php | 6 +- src/RouterInterface.php | 2 +- src/ServerRequest.php | 11 +++ src/Validation/ConstraintViolation.php | 2 +- .../ValidatorConstraintViolationAdapter.php | 1 + .../ConstraintViolationInterface.php | 2 +- src/{functions.php => functions/emit.php} | 0 tests/Command/RouterClearCacheCommandTest.php | 12 ++- tests/Exception/HttpExceptionTest.php | 8 +- 55 files changed, 264 insertions(+), 319 deletions(-) rename src/Command/{RouterClearCacheCommand.php => RouterClearDescriptorsCacheCommand.php} (68%) delete mode 100644 src/Dictionary/CacheKey.php delete mode 100644 src/Dictionary/Charset.php delete mode 100644 src/Dictionary/MediaType.php delete mode 100644 src/Dictionary/RequestMethod.php create mode 100644 src/Entity/Language/Language.php rename src/Entity/MediaType/{JsonMediaType.php => MediaType.php} (60%) rename src/Entity/MediaType/{XmlMediaType.php => MediaTypeFactory.php} (51%) rename src/{functions.php => functions/emit.php} (100%) diff --git a/composer.json b/composer.json index e6674a8f..ff297364 100644 --- a/composer.json +++ b/composer.json @@ -48,7 +48,7 @@ }, "autoload": { "files": [ - "src/functions.php" + "src/functions/emit.php" ], "psr-4": { "Sunrise\\Http\\Router\\": "src/" diff --git a/src/Annotation/ConsumesJson.php b/src/Annotation/ConsumesJson.php index a9a4344e..3524279d 100644 --- a/src/Annotation/ConsumesJson.php +++ b/src/Annotation/ConsumesJson.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\JsonMediaType; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ConsumesJson extends Consumes { public function __construct() { - parent::__construct(new JsonMediaType()); + parent::__construct(MediaTypeFactory::json()); } } diff --git a/src/Annotation/ConsumesXml.php b/src/Annotation/ConsumesXml.php index a08c2a72..c810ee07 100644 --- a/src/Annotation/ConsumesXml.php +++ b/src/Annotation/ConsumesXml.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\XmlMediaType; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ConsumesXml extends Consumes { public function __construct() { - parent::__construct(new XmlMediaType()); + parent::__construct(MediaTypeFactory::xml()); } } diff --git a/src/Annotation/Method.php b/src/Annotation/Method.php index 3049a344..e328197b 100644 --- a/src/Annotation/Method.php +++ b/src/Annotation/Method.php @@ -14,12 +14,15 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; +use Fig\Http\Message\RequestMethodInterface; /** + * Pay attention to the {@see RequestMethodInterface} dictionary. + * * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -class Method +class Method implements RequestMethodInterface { /** * @var array diff --git a/src/Annotation/Method/DeleteMethod.php b/src/Annotation/Method/DeleteMethod.php index b91824e8..ea98d321 100644 --- a/src/Annotation/Method/DeleteMethod.php +++ b/src/Annotation/Method/DeleteMethod.php @@ -15,7 +15,6 @@ use Attribute; use Sunrise\Http\Router\Annotation\Method; -use Sunrise\Http\Router\Dictionary\RequestMethod; /** * @since 3.0.0 @@ -25,6 +24,6 @@ final class DeleteMethod extends Method { public function __construct() { - parent::__construct(RequestMethod::DELETE); + parent::__construct(self::METHOD_DELETE); } } diff --git a/src/Annotation/Method/GetMethod.php b/src/Annotation/Method/GetMethod.php index ca308bc8..e2c4408e 100644 --- a/src/Annotation/Method/GetMethod.php +++ b/src/Annotation/Method/GetMethod.php @@ -15,7 +15,6 @@ use Attribute; use Sunrise\Http\Router\Annotation\Method; -use Sunrise\Http\Router\Dictionary\RequestMethod; /** * @since 3.0.0 @@ -25,6 +24,6 @@ final class GetMethod extends Method { public function __construct() { - parent::__construct(RequestMethod::GET); + parent::__construct(self::METHOD_GET); } } diff --git a/src/Annotation/Method/HeadMethod.php b/src/Annotation/Method/HeadMethod.php index ab907e3b..3de0e88b 100644 --- a/src/Annotation/Method/HeadMethod.php +++ b/src/Annotation/Method/HeadMethod.php @@ -15,7 +15,6 @@ use Attribute; use Sunrise\Http\Router\Annotation\Method; -use Sunrise\Http\Router\Dictionary\RequestMethod; /** * @since 3.0.0 @@ -25,6 +24,6 @@ final class HeadMethod extends Method { public function __construct() { - parent::__construct(RequestMethod::HEAD); + parent::__construct(self::METHOD_HEAD); } } diff --git a/src/Annotation/Method/OptionsMethod.php b/src/Annotation/Method/OptionsMethod.php index 26d1435a..22442b97 100644 --- a/src/Annotation/Method/OptionsMethod.php +++ b/src/Annotation/Method/OptionsMethod.php @@ -15,7 +15,6 @@ use Attribute; use Sunrise\Http\Router\Annotation\Method; -use Sunrise\Http\Router\Dictionary\RequestMethod; /** * @since 3.0.0 @@ -25,6 +24,6 @@ final class OptionsMethod extends Method { public function __construct() { - parent::__construct(RequestMethod::OPTIONS); + parent::__construct(self::METHOD_OPTIONS); } } diff --git a/src/Annotation/Method/PatchMethod.php b/src/Annotation/Method/PatchMethod.php index 8e78c9c1..77106487 100644 --- a/src/Annotation/Method/PatchMethod.php +++ b/src/Annotation/Method/PatchMethod.php @@ -15,7 +15,6 @@ use Attribute; use Sunrise\Http\Router\Annotation\Method; -use Sunrise\Http\Router\Dictionary\RequestMethod; /** * @since 3.0.0 @@ -25,6 +24,6 @@ final class PatchMethod extends Method { public function __construct() { - parent::__construct(RequestMethod::PATCH); + parent::__construct(self::METHOD_PATCH); } } diff --git a/src/Annotation/Method/PostMethod.php b/src/Annotation/Method/PostMethod.php index 8a2d2efe..4775b357 100644 --- a/src/Annotation/Method/PostMethod.php +++ b/src/Annotation/Method/PostMethod.php @@ -15,7 +15,6 @@ use Attribute; use Sunrise\Http\Router\Annotation\Method; -use Sunrise\Http\Router\Dictionary\RequestMethod; /** * @since 3.0.0 @@ -25,6 +24,6 @@ final class PostMethod extends Method { public function __construct() { - parent::__construct(RequestMethod::POST); + parent::__construct(self::METHOD_POST); } } diff --git a/src/Annotation/Method/PurgeMethod.php b/src/Annotation/Method/PurgeMethod.php index 9251f111..835c4372 100644 --- a/src/Annotation/Method/PurgeMethod.php +++ b/src/Annotation/Method/PurgeMethod.php @@ -15,7 +15,6 @@ use Attribute; use Sunrise\Http\Router\Annotation\Method; -use Sunrise\Http\Router\Dictionary\RequestMethod; /** * @since 3.0.0 @@ -25,6 +24,6 @@ final class PurgeMethod extends Method { public function __construct() { - parent::__construct(RequestMethod::PURGE); + parent::__construct(self::METHOD_PURGE); } } diff --git a/src/Annotation/Method/PutMethod.php b/src/Annotation/Method/PutMethod.php index f34c53f1..35c6b530 100644 --- a/src/Annotation/Method/PutMethod.php +++ b/src/Annotation/Method/PutMethod.php @@ -15,7 +15,6 @@ use Attribute; use Sunrise\Http\Router\Annotation\Method; -use Sunrise\Http\Router\Dictionary\RequestMethod; /** * @since 3.0.0 @@ -25,6 +24,6 @@ final class PutMethod extends Method { public function __construct() { - parent::__construct(RequestMethod::PUT); + parent::__construct(self::METHOD_PUT); } } diff --git a/src/Annotation/ProducesJson.php b/src/Annotation/ProducesJson.php index 018c7530..356ac287 100644 --- a/src/Annotation/ProducesJson.php +++ b/src/Annotation/ProducesJson.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\JsonMediaType; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ProducesJson extends Produces { public function __construct() { - parent::__construct(new JsonMediaType()); + parent::__construct(MediaTypeFactory::json()); } } diff --git a/src/Annotation/ProducesXml.php b/src/Annotation/ProducesXml.php index 703d206a..5b4c9dd5 100644 --- a/src/Annotation/ProducesXml.php +++ b/src/Annotation/ProducesXml.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\XmlMediaType; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ProducesXml extends Produces { public function __construct() { - parent::__construct(new XmlMediaType()); + parent::__construct(MediaTypeFactory::xml()); } } diff --git a/src/Annotation/RequestVariable.php b/src/Annotation/RequestVariable.php index 24a1ff16..53fd86b5 100644 --- a/src/Annotation/RequestVariable.php +++ b/src/Annotation/RequestVariable.php @@ -25,6 +25,7 @@ public function __construct( public readonly ?string $name = null, public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, + public readonly bool $validation = true, ) { } } diff --git a/src/Annotation/ResponseStatus.php b/src/Annotation/ResponseStatus.php index d8742e69..00d3cbf8 100644 --- a/src/Annotation/ResponseStatus.php +++ b/src/Annotation/ResponseStatus.php @@ -14,12 +14,15 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; +use Fig\Http\Message\StatusCodeInterface; /** + * Pay attention to the {@see StatusCodeInterface} dictionary. + * * @since 3.0.0 */ #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] -final class ResponseStatus +final class ResponseStatus implements StatusCodeInterface { public function __construct( public readonly int $code, diff --git a/src/Command/RouterClearCacheCommand.php b/src/Command/RouterClearDescriptorsCacheCommand.php similarity index 68% rename from src/Command/RouterClearCacheCommand.php rename to src/Command/RouterClearDescriptorsCacheCommand.php index d3a0c0d1..ce32f35d 100644 --- a/src/Command/RouterClearCacheCommand.php +++ b/src/Command/RouterClearDescriptorsCacheCommand.php @@ -13,8 +13,7 @@ namespace Sunrise\Http\Router\Command; -use Psr\SimpleCache\CacheInterface; -use Sunrise\Http\Router\Dictionary\CacheKey; +use Sunrise\Http\Router\Loader\DescriptorLoader; use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputInterface; @@ -23,11 +22,12 @@ /** * @since 3.0.0 */ -#[AsCommand('router:clear-cache', 'Clears the cache.')] -final class RouterClearCacheCommand extends Command +#[AsCommand('router:clear-descriptors-cache', 'Clears the descriptors cache.')] +final class RouterClearDescriptorsCacheCommand extends Command { - public function __construct(private readonly ?CacheInterface $cache) - { + public function __construct( + private readonly DescriptorLoader $descriptorLoader, + ) { parent::__construct(); } @@ -36,9 +36,9 @@ public function __construct(private readonly ?CacheInterface $cache) */ protected function execute(InputInterface $input, OutputInterface $output): int { - $this->cache?->delete(CacheKey::DESCRIPTORS); + $this->descriptorLoader->clearCache(); - $output->writeln('Done'); + $output->writeln('Ok'); return self::SUCCESS; } diff --git a/src/Command/RouterListRoutesCommand.php b/src/Command/RouterListRoutesCommand.php index 376a89c1..fe18dedb 100644 --- a/src/Command/RouterListRoutesCommand.php +++ b/src/Command/RouterListRoutesCommand.php @@ -28,8 +28,9 @@ #[AsCommand('router:list-routes', 'Lists routes.')] final class RouterListRoutesCommand extends Command { - public function __construct(private readonly RouterInterface $router) - { + public function __construct( + private readonly RouterInterface $router, + ) { parent::__construct(); } diff --git a/src/Dictionary/CacheKey.php b/src/Dictionary/CacheKey.php deleted file mode 100644 index ffd4ca4e..00000000 --- a/src/Dictionary/CacheKey.php +++ /dev/null @@ -1,22 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Dictionary; - -/** - * @since 3.0.0 - */ -final class CacheKey -{ - public const DESCRIPTORS = 'router_descriptors'; -} diff --git a/src/Dictionary/Charset.php b/src/Dictionary/Charset.php deleted file mode 100644 index 141dde84..00000000 --- a/src/Dictionary/Charset.php +++ /dev/null @@ -1,91 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Dictionary; - -/** - * @since 3.0.0 - */ -final class Charset -{ - /** - * @link https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.3 - */ - public const RFC7230_OWS = [ - "\x09" => 1, "\x20" => 1, - ]; - - /** - * @link https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6 - */ - public const RFC7230_TOKEN = [ - "\x21" => 1, "\x23" => 1, "\x24" => 1, "\x25" => 1, "\x26" => 1, "\x27" => 1, "\x2a" => 1, "\x2b" => 1, - "\x2d" => 1, "\x2e" => 1, "\x30" => 1, "\x31" => 1, "\x32" => 1, "\x33" => 1, "\x34" => 1, "\x35" => 1, - "\x36" => 1, "\x37" => 1, "\x38" => 1, "\x39" => 1, "\x41" => 1, "\x42" => 1, "\x43" => 1, "\x44" => 1, - "\x45" => 1, "\x46" => 1, "\x47" => 1, "\x48" => 1, "\x49" => 1, "\x4a" => 1, "\x4b" => 1, "\x4c" => 1, - "\x4d" => 1, "\x4e" => 1, "\x4f" => 1, "\x50" => 1, "\x51" => 1, "\x52" => 1, "\x53" => 1, "\x54" => 1, - "\x55" => 1, "\x56" => 1, "\x57" => 1, "\x58" => 1, "\x59" => 1, "\x5a" => 1, "\x5e" => 1, "\x5f" => 1, - "\x60" => 1, "\x61" => 1, "\x62" => 1, "\x63" => 1, "\x64" => 1, "\x65" => 1, "\x66" => 1, "\x67" => 1, - "\x68" => 1, "\x69" => 1, "\x6a" => 1, "\x6b" => 1, "\x6c" => 1, "\x6d" => 1, "\x6e" => 1, "\x6f" => 1, - "\x70" => 1, "\x71" => 1, "\x72" => 1, "\x73" => 1, "\x74" => 1, "\x75" => 1, "\x76" => 1, "\x77" => 1, - "\x78" => 1, "\x79" => 1, "\x7a" => 1, "\x7c" => 1, "\x7e" => 1, - ]; - - /** - * @link https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6 - */ - public const RFC7230_FIELD_VALUE = [ - "\x09" => 1, "\x20" => 1, "\x21" => 1, "\x22" => 1, "\x23" => 1, "\x24" => 1, "\x25" => 1, "\x26" => 1, - "\x27" => 1, "\x28" => 1, "\x29" => 1, "\x2a" => 1, "\x2b" => 1, "\x2c" => 1, "\x2d" => 1, "\x2e" => 1, - "\x2f" => 1, "\x30" => 1, "\x31" => 1, "\x32" => 1, "\x33" => 1, "\x34" => 1, "\x35" => 1, "\x36" => 1, - "\x37" => 1, "\x38" => 1, "\x39" => 1, "\x3a" => 1, "\x3b" => 1, "\x3c" => 1, "\x3d" => 1, "\x3e" => 1, - "\x3f" => 1, "\x40" => 1, "\x41" => 1, "\x42" => 1, "\x43" => 1, "\x44" => 1, "\x45" => 1, "\x46" => 1, - "\x47" => 1, "\x48" => 1, "\x49" => 1, "\x4a" => 1, "\x4b" => 1, "\x4c" => 1, "\x4d" => 1, "\x4e" => 1, - "\x4f" => 1, "\x50" => 1, "\x51" => 1, "\x52" => 1, "\x53" => 1, "\x54" => 1, "\x55" => 1, "\x56" => 1, - "\x57" => 1, "\x58" => 1, "\x59" => 1, "\x5a" => 1, "\x5b" => 1, "\x5c" => 1, "\x5d" => 1, "\x5e" => 1, - "\x5f" => 1, "\x60" => 1, "\x61" => 1, "\x62" => 1, "\x63" => 1, "\x64" => 1, "\x65" => 1, "\x66" => 1, - "\x67" => 1, "\x68" => 1, "\x69" => 1, "\x6a" => 1, "\x6b" => 1, "\x6c" => 1, "\x6d" => 1, "\x6e" => 1, - "\x6f" => 1, "\x70" => 1, "\x71" => 1, "\x72" => 1, "\x73" => 1, "\x74" => 1, "\x75" => 1, "\x76" => 1, - "\x77" => 1, "\x78" => 1, "\x79" => 1, "\x7a" => 1, "\x7b" => 1, "\x7c" => 1, "\x7d" => 1, "\x7e" => 1, - "\x80" => 1, "\x81" => 1, "\x82" => 1, "\x83" => 1, "\x84" => 1, "\x85" => 1, "\x86" => 1, "\x87" => 1, - "\x88" => 1, "\x89" => 1, "\x8a" => 1, "\x8b" => 1, "\x8c" => 1, "\x8d" => 1, "\x8e" => 1, "\x8f" => 1, - "\x90" => 1, "\x91" => 1, "\x92" => 1, "\x93" => 1, "\x94" => 1, "\x95" => 1, "\x96" => 1, "\x97" => 1, - "\x98" => 1, "\x99" => 1, "\x9a" => 1, "\x9b" => 1, "\x9c" => 1, "\x9d" => 1, "\x9e" => 1, "\x9f" => 1, - "\xa0" => 1, "\xa1" => 1, "\xa2" => 1, "\xa3" => 1, "\xa4" => 1, "\xa5" => 1, "\xa6" => 1, "\xa7" => 1, - "\xa8" => 1, "\xa9" => 1, "\xaa" => 1, "\xab" => 1, "\xac" => 1, "\xad" => 1, "\xae" => 1, "\xaf" => 1, - "\xb0" => 1, "\xb1" => 1, "\xb2" => 1, "\xb3" => 1, "\xb4" => 1, "\xb5" => 1, "\xb6" => 1, "\xb7" => 1, - "\xb8" => 1, "\xb9" => 1, "\xba" => 1, "\xbb" => 1, "\xbc" => 1, "\xbd" => 1, "\xbe" => 1, "\xbf" => 1, - "\xc0" => 1, "\xc1" => 1, "\xc2" => 1, "\xc3" => 1, "\xc4" => 1, "\xc5" => 1, "\xc6" => 1, "\xc7" => 1, - "\xc8" => 1, "\xc9" => 1, "\xca" => 1, "\xcb" => 1, "\xcc" => 1, "\xcd" => 1, "\xce" => 1, "\xcf" => 1, - "\xd0" => 1, "\xd1" => 1, "\xd2" => 1, "\xd3" => 1, "\xd4" => 1, "\xd5" => 1, "\xd6" => 1, "\xd7" => 1, - "\xd8" => 1, "\xd9" => 1, "\xda" => 1, "\xdb" => 1, "\xdc" => 1, "\xdd" => 1, "\xde" => 1, "\xdf" => 1, - "\xe0" => 1, "\xe1" => 1, "\xe2" => 1, "\xe3" => 1, "\xe4" => 1, "\xe5" => 1, "\xe6" => 1, "\xe7" => 1, - "\xe8" => 1, "\xe9" => 1, "\xea" => 1, "\xeb" => 1, "\xec" => 1, "\xed" => 1, "\xee" => 1, "\xef" => 1, - "\xf0" => 1, "\xf1" => 1, "\xf2" => 1, "\xf3" => 1, "\xf4" => 1, "\xf5" => 1, "\xf6" => 1, "\xf7" => 1, - "\xf8" => 1, "\xf9" => 1, "\xfa" => 1, "\xfb" => 1, "\xfc" => 1, "\xfd" => 1, "\xfe" => 1, "\xff" => 1, - ]; - - /** - * @link https://www.pcre.org/original/doc/html/pcrepattern.html#SEC16 - */ - public const PCRE_SUBPATTERN_NAME = [ - "\x30" => 1, "\x31" => 1, "\x32" => 1, "\x33" => 1, "\x34" => 1, "\x35" => 1, "\x36" => 1, "\x37" => 1, - "\x38" => 1, "\x39" => 1, "\x41" => 1, "\x42" => 1, "\x43" => 1, "\x44" => 1, "\x45" => 1, "\x46" => 1, - "\x47" => 1, "\x48" => 1, "\x49" => 1, "\x4a" => 1, "\x4b" => 1, "\x4c" => 1, "\x4d" => 1, "\x4e" => 1, - "\x4f" => 1, "\x50" => 1, "\x51" => 1, "\x52" => 1, "\x53" => 1, "\x54" => 1, "\x55" => 1, "\x56" => 1, - "\x57" => 1, "\x58" => 1, "\x59" => 1, "\x5a" => 1, "\x5f" => 1, "\x61" => 1, "\x62" => 1, "\x63" => 1, - "\x64" => 1, "\x65" => 1, "\x66" => 1, "\x67" => 1, "\x68" => 1, "\x69" => 1, "\x6a" => 1, "\x6b" => 1, - "\x6c" => 1, "\x6d" => 1, "\x6e" => 1, "\x6f" => 1, "\x70" => 1, "\x71" => 1, "\x72" => 1, "\x73" => 1, - "\x74" => 1, "\x75" => 1, "\x76" => 1, "\x77" => 1, "\x78" => 1, "\x79" => 1, "\x7a" => 1, - ]; -} diff --git a/src/Dictionary/MediaType.php b/src/Dictionary/MediaType.php deleted file mode 100644 index 6c96fd68..00000000 --- a/src/Dictionary/MediaType.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Dictionary; - -/** - * @since 3.0.0 - */ -final class MediaType -{ - public const JSON = 'application/json'; - public const XML = 'application/xml'; -} diff --git a/src/Dictionary/RequestMethod.php b/src/Dictionary/RequestMethod.php deleted file mode 100644 index 335af52d..00000000 --- a/src/Dictionary/RequestMethod.php +++ /dev/null @@ -1,29 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Dictionary; - -/** - * @since 3.0.0 - */ -final class RequestMethod -{ - public const OPTIONS = 'OPTIONS'; - public const HEAD = 'HEAD'; - public const GET = 'GET'; - public const POST = 'POST'; - public const PUT = 'PUT'; - public const PATCH = 'PATCH'; - public const DELETE = 'DELETE'; - public const PURGE = 'PURGE'; -} diff --git a/src/Dictionary/VariablePattern.php b/src/Dictionary/VariablePattern.php index 22b770b8..7ef130a9 100644 --- a/src/Dictionary/VariablePattern.php +++ b/src/Dictionary/VariablePattern.php @@ -18,7 +18,7 @@ */ final class VariablePattern { - public const UNSIGNED_INTEGER = '[0-9]+'; public const ASCII_SLUG = '[0-9A-Za-z]+(?:-[0-9A-Za-z]+)*'; + public const UNSIGNED_INTEGER = '[0-9]+'; public const UUID = '[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}'; } diff --git a/src/Entity/Language/Language.php b/src/Entity/Language/Language.php new file mode 100644 index 00000000..0f94654a --- /dev/null +++ b/src/Entity/Language/Language.php @@ -0,0 +1,35 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Entity\Language; + +/** + * @since 3.0.0 + */ +final class Language implements LanguageInterface +{ + public function __construct( + private readonly string $code, + ) { + } + + public static function create(string $code): self + { + return new self(code: $code); + } + + public function getCode(): string + { + return $this->code; + } +} diff --git a/src/Entity/Language/StringableLanguage.php b/src/Entity/Language/StringableLanguage.php index 36532d7a..092892d2 100644 --- a/src/Entity/Language/StringableLanguage.php +++ b/src/Entity/Language/StringableLanguage.php @@ -20,13 +20,14 @@ */ final class StringableLanguage implements LanguageInterface, Stringable { - public function __construct(private readonly LanguageInterface $language) - { + public function __construct( + private readonly LanguageInterface $language, + ) { } public static function create(LanguageInterface $language): self { - return new self($language); + return new self(language: $language); } public function getCode(): string diff --git a/src/Entity/MediaType/JsonMediaType.php b/src/Entity/MediaType/MediaType.php similarity index 60% rename from src/Entity/MediaType/JsonMediaType.php rename to src/Entity/MediaType/MediaType.php index 7585f2b0..00d4a940 100644 --- a/src/Entity/MediaType/JsonMediaType.php +++ b/src/Entity/MediaType/MediaType.php @@ -13,15 +13,23 @@ namespace Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Dictionary\MediaType; - /** * @since 3.0.0 */ -final class JsonMediaType implements MediaTypeInterface +final class MediaType implements MediaTypeInterface { + public function __construct( + private readonly string $identifier, + ) { + } + + public static function create(string $identifier): self + { + return new self(identifier: $identifier); + } + public function getIdentifier(): string { - return MediaType::JSON; + return $this->identifier; } } diff --git a/src/Entity/MediaType/XmlMediaType.php b/src/Entity/MediaType/MediaTypeFactory.php similarity index 51% rename from src/Entity/MediaType/XmlMediaType.php rename to src/Entity/MediaType/MediaTypeFactory.php index a18e278a..f1c2de94 100644 --- a/src/Entity/MediaType/XmlMediaType.php +++ b/src/Entity/MediaType/MediaTypeFactory.php @@ -13,15 +13,23 @@ namespace Sunrise\Http\Router\Entity\MediaType; -use Sunrise\Http\Router\Dictionary\MediaType; - /** * @since 3.0.0 */ -final class XmlMediaType implements MediaTypeInterface +final class MediaTypeFactory { - public function getIdentifier(): string + public static function create(string $identifier): MediaTypeInterface + { + return new MediaType($identifier); + } + + public static function json(): MediaTypeInterface + { + return self::create(identifier: 'application/json'); + } + + public static function xml(): MediaTypeInterface { - return MediaType::XML; + return self::create(identifier: 'application/xml'); } } diff --git a/src/Entity/MediaType/StringableMediaType.php b/src/Entity/MediaType/StringableMediaType.php index 5c4d5b30..1aa1affd 100644 --- a/src/Entity/MediaType/StringableMediaType.php +++ b/src/Entity/MediaType/StringableMediaType.php @@ -20,13 +20,14 @@ */ final class StringableMediaType implements MediaTypeInterface, Stringable { - public function __construct(private readonly MediaTypeInterface $mediaType) - { + public function __construct( + private readonly MediaTypeInterface $mediaType, + ) { } public static function create(MediaTypeInterface $mediaType): self { - return new self($mediaType); + return new self(mediaType: $mediaType); } public function getIdentifier(): string diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index b05913cb..3a94bdd2 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -116,7 +116,7 @@ final public function addConstraintViolation(ConstraintViolationInterface ...$co return $this; } - final public function addHydratorConstraintViolations( + final public function addHydratorConstraintViolation( \Sunrise\Hydrator\Exception\InvalidValueException ...$constraintViolations ): static { return $this->addConstraintViolation(...array_map( @@ -125,7 +125,7 @@ final public function addHydratorConstraintViolations( )); } - final public function addValidatorConstraintViolations( + final public function addValidatorConstraintViolation( \Symfony\Component\Validator\ConstraintViolationInterface ...$constraintViolations ): static { return $this->addConstraintViolation(...array_map( diff --git a/src/Exception/HttpExceptionInterface.php b/src/Exception/HttpExceptionInterface.php index dd11599b..50aa12d3 100644 --- a/src/Exception/HttpExceptionInterface.php +++ b/src/Exception/HttpExceptionInterface.php @@ -13,12 +13,13 @@ namespace Sunrise\Http\Router\Exception; +use Fig\Http\Message\StatusCodeInterface; use Sunrise\Http\Router\Validation\ConstraintViolationInterface; /** * @since 3.0.0 */ -interface HttpExceptionInterface extends ExceptionInterface +interface HttpExceptionInterface extends ExceptionInterface, StatusCodeInterface { /** * Returns the exception's non-interpolated message. diff --git a/src/Helper/ClassFinder.php b/src/Helper/ClassFinder.php index aa35ca84..45269911 100644 --- a/src/Helper/ClassFinder.php +++ b/src/Helper/ClassFinder.php @@ -35,7 +35,7 @@ final class ClassFinder { /** - * @return Generator> + * @return Generator> * * @throws InvalidArgumentException * @throws ReflectionException @@ -52,24 +52,25 @@ public static function getDirClasses(string $dirname): Generator /** @var array $filenames */ $filenames = []; foreach ($files as $file) { - $filenames[$file->getRealPath()] = true; + $filename = $file->getRealPath(); + $filenames[$filename] = true; (static function (string $filename): void { /** @psalm-suppress UnresolvableInclude */ require_once $filename; - })($file->getRealPath()); + })($filename); } foreach (get_declared_classes() as $className) { $classReflection = new ReflectionClass($className); if (isset($filenames[$classReflection->getFileName()])) { - yield $className => $classReflection; + yield $classReflection; } } } /** - * @return Generator> + * @return Generator> * * @throws InvalidArgumentException * @throws ReflectionException @@ -91,7 +92,7 @@ public static function getFileClasses(string $filename): Generator foreach (get_declared_classes() as $className) { $classReflection = new ReflectionClass($className); if ($classReflection->getFileName() === $filename) { - yield $className => $classReflection; + yield $classReflection; } } } diff --git a/src/Helper/HeaderParser.php b/src/Helper/HeaderParser.php index 0f2bd051..e369d300 100644 --- a/src/Helper/HeaderParser.php +++ b/src/Helper/HeaderParser.php @@ -13,8 +13,6 @@ namespace Sunrise\Http\Router\Helper; -use Sunrise\Http\Router\Dictionary\Charset; - use function trim; /** @@ -28,6 +26,40 @@ final class HeaderParser private const IN_QUOTED_STRING = 8; private const IN_QUOTED_PAIR = 16; + /** + * @link https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6 + */ + private const RFC7230_FIELD_VALUE = [ + "\x09" => 1, "\x20" => 1, "\x21" => 1, "\x22" => 1, "\x23" => 1, "\x24" => 1, "\x25" => 1, "\x26" => 1, + "\x27" => 1, "\x28" => 1, "\x29" => 1, "\x2a" => 1, "\x2b" => 1, "\x2c" => 1, "\x2d" => 1, "\x2e" => 1, + "\x2f" => 1, "\x30" => 1, "\x31" => 1, "\x32" => 1, "\x33" => 1, "\x34" => 1, "\x35" => 1, "\x36" => 1, + "\x37" => 1, "\x38" => 1, "\x39" => 1, "\x3a" => 1, "\x3b" => 1, "\x3c" => 1, "\x3d" => 1, "\x3e" => 1, + "\x3f" => 1, "\x40" => 1, "\x41" => 1, "\x42" => 1, "\x43" => 1, "\x44" => 1, "\x45" => 1, "\x46" => 1, + "\x47" => 1, "\x48" => 1, "\x49" => 1, "\x4a" => 1, "\x4b" => 1, "\x4c" => 1, "\x4d" => 1, "\x4e" => 1, + "\x4f" => 1, "\x50" => 1, "\x51" => 1, "\x52" => 1, "\x53" => 1, "\x54" => 1, "\x55" => 1, "\x56" => 1, + "\x57" => 1, "\x58" => 1, "\x59" => 1, "\x5a" => 1, "\x5b" => 1, "\x5c" => 1, "\x5d" => 1, "\x5e" => 1, + "\x5f" => 1, "\x60" => 1, "\x61" => 1, "\x62" => 1, "\x63" => 1, "\x64" => 1, "\x65" => 1, "\x66" => 1, + "\x67" => 1, "\x68" => 1, "\x69" => 1, "\x6a" => 1, "\x6b" => 1, "\x6c" => 1, "\x6d" => 1, "\x6e" => 1, + "\x6f" => 1, "\x70" => 1, "\x71" => 1, "\x72" => 1, "\x73" => 1, "\x74" => 1, "\x75" => 1, "\x76" => 1, + "\x77" => 1, "\x78" => 1, "\x79" => 1, "\x7a" => 1, "\x7b" => 1, "\x7c" => 1, "\x7d" => 1, "\x7e" => 1, + "\x80" => 1, "\x81" => 1, "\x82" => 1, "\x83" => 1, "\x84" => 1, "\x85" => 1, "\x86" => 1, "\x87" => 1, + "\x88" => 1, "\x89" => 1, "\x8a" => 1, "\x8b" => 1, "\x8c" => 1, "\x8d" => 1, "\x8e" => 1, "\x8f" => 1, + "\x90" => 1, "\x91" => 1, "\x92" => 1, "\x93" => 1, "\x94" => 1, "\x95" => 1, "\x96" => 1, "\x97" => 1, + "\x98" => 1, "\x99" => 1, "\x9a" => 1, "\x9b" => 1, "\x9c" => 1, "\x9d" => 1, "\x9e" => 1, "\x9f" => 1, + "\xa0" => 1, "\xa1" => 1, "\xa2" => 1, "\xa3" => 1, "\xa4" => 1, "\xa5" => 1, "\xa6" => 1, "\xa7" => 1, + "\xa8" => 1, "\xa9" => 1, "\xaa" => 1, "\xab" => 1, "\xac" => 1, "\xad" => 1, "\xae" => 1, "\xaf" => 1, + "\xb0" => 1, "\xb1" => 1, "\xb2" => 1, "\xb3" => 1, "\xb4" => 1, "\xb5" => 1, "\xb6" => 1, "\xb7" => 1, + "\xb8" => 1, "\xb9" => 1, "\xba" => 1, "\xbb" => 1, "\xbc" => 1, "\xbd" => 1, "\xbe" => 1, "\xbf" => 1, + "\xc0" => 1, "\xc1" => 1, "\xc2" => 1, "\xc3" => 1, "\xc4" => 1, "\xc5" => 1, "\xc6" => 1, "\xc7" => 1, + "\xc8" => 1, "\xc9" => 1, "\xca" => 1, "\xcb" => 1, "\xcc" => 1, "\xcd" => 1, "\xce" => 1, "\xcf" => 1, + "\xd0" => 1, "\xd1" => 1, "\xd2" => 1, "\xd3" => 1, "\xd4" => 1, "\xd5" => 1, "\xd6" => 1, "\xd7" => 1, + "\xd8" => 1, "\xd9" => 1, "\xda" => 1, "\xdb" => 1, "\xdc" => 1, "\xdd" => 1, "\xde" => 1, "\xdf" => 1, + "\xe0" => 1, "\xe1" => 1, "\xe2" => 1, "\xe3" => 1, "\xe4" => 1, "\xe5" => 1, "\xe6" => 1, "\xe7" => 1, + "\xe8" => 1, "\xe9" => 1, "\xea" => 1, "\xeb" => 1, "\xec" => 1, "\xed" => 1, "\xee" => 1, "\xef" => 1, + "\xf0" => 1, "\xf1" => 1, "\xf2" => 1, "\xf3" => 1, "\xf4" => 1, "\xf5" => 1, "\xf6" => 1, "\xf7" => 1, + "\xf8" => 1, "\xf9" => 1, "\xfa" => 1, "\xfb" => 1, "\xfc" => 1, "\xfd" => 1, "\xfe" => 1, "\xff" => 1, + ]; + /** * @return array, array{0: string, 1: array}> */ @@ -45,7 +77,7 @@ public static function parseHeader(string $header): array $values = []; for ($offset = 0; isset($header[$offset]) && $offset < 1024; $offset++) { - if (!isset(Charset::RFC7230_FIELD_VALUE[$header[$offset]])) { + if (!isset(self::RFC7230_FIELD_VALUE[$header[$offset]])) { continue; } diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index f868e9bb..3d419bbf 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -30,7 +30,7 @@ final class RouteBuilder { /** - * @param array $values + * @param array $values Values for the route's variables. * * @throws InvalidArgumentException */ @@ -89,7 +89,7 @@ public static function buildRoute(string $route, array $values = []): string * * @throws InvalidArgumentException */ - public static function stringifyValue(mixed $value): string + private static function stringifyValue(mixed $value): string { if (is_string($value)) { return $value; diff --git a/src/Helper/RouteCompiler.php b/src/Helper/RouteCompiler.php index 8136c517..38e72559 100644 --- a/src/Helper/RouteCompiler.php +++ b/src/Helper/RouteCompiler.php @@ -24,8 +24,6 @@ */ final class RouteCompiler { - public const PATTERN_DELIMITER = '#'; - /** * @param array $patterns * diff --git a/src/Helper/RouteMatcher.php b/src/Helper/RouteMatcher.php index f29c906b..81ee5f79 100644 --- a/src/Helper/RouteMatcher.php +++ b/src/Helper/RouteMatcher.php @@ -33,21 +33,6 @@ */ final class RouteMatcher { - /** - * @param array $patterns - * @param ?array $matches - * @param-out array $matches - * - * @throws InvalidArgumentException - * @throws UnexpectedValueException - */ - public static function matchRoute(string $route, array $patterns, string $subject, ?array &$matches = null): bool - { - $pattern = RouteCompiler::compileRoute($route, $patterns); - - return self::matchPattern($route, $pattern, $subject, $matches); - } - /** * @param non-empty-string $pattern * @param ?array $matches @@ -56,7 +41,7 @@ public static function matchRoute(string $route, array $patterns, string $subjec * @throws InvalidArgumentException * @throws UnexpectedValueException */ - public static function matchPattern(string $route, string $pattern, string $subject, ?array &$matches = null): bool + public static function matchRoute(string $route, string $pattern, string $subject, ?array &$matches = null): bool { try { if (($result = @preg_match($pattern, $subject, $matches, PREG_UNMATCHED_AS_NULL)) === false) { diff --git a/src/Helper/RouteParser.php b/src/Helper/RouteParser.php index 2d6db1ed..5a3f1653 100644 --- a/src/Helper/RouteParser.php +++ b/src/Helper/RouteParser.php @@ -14,7 +14,6 @@ namespace Sunrise\Http\Router\Helper; use InvalidArgumentException; -use Sunrise\Http\Router\Dictionary\Charset; use function sprintf; @@ -29,6 +28,22 @@ final class RouteParser private const IN_OPTIONAL_PART = 16; private const IN_OCCUPIED_PART = 32; + /** + * @link https://www.pcre.org/original/doc/html/pcrepattern.html#SEC16 + */ + private const PCRE_SUBPATTERN_NAME = [ + "\x30" => 1, "\x31" => 1, "\x32" => 1, "\x33" => 1, "\x34" => 1, "\x35" => 1, "\x36" => 1, "\x37" => 1, + "\x38" => 1, "\x39" => 1, "\x41" => 1, "\x42" => 1, "\x43" => 1, "\x44" => 1, "\x45" => 1, "\x46" => 1, + "\x47" => 1, "\x48" => 1, "\x49" => 1, "\x4a" => 1, "\x4b" => 1, "\x4c" => 1, "\x4d" => 1, "\x4e" => 1, + "\x4f" => 1, "\x50" => 1, "\x51" => 1, "\x52" => 1, "\x53" => 1, "\x54" => 1, "\x55" => 1, "\x56" => 1, + "\x57" => 1, "\x58" => 1, "\x59" => 1, "\x5a" => 1, "\x5f" => 1, "\x61" => 1, "\x62" => 1, "\x63" => 1, + "\x64" => 1, "\x65" => 1, "\x66" => 1, "\x67" => 1, "\x68" => 1, "\x69" => 1, "\x6a" => 1, "\x6b" => 1, + "\x6c" => 1, "\x6d" => 1, "\x6e" => 1, "\x6f" => 1, "\x70" => 1, "\x71" => 1, "\x72" => 1, "\x73" => 1, + "\x74" => 1, "\x75" => 1, "\x76" => 1, "\x77" => 1, "\x78" => 1, "\x79" => 1, "\x7a" => 1, + ]; + + private const REGEX_DELIMITER = '#'; + /** * Parses the given route and returns its variables * @@ -217,7 +232,7 @@ public static function parseRoute(string $route): array $offset, )); } - if (!isset(Charset::PCRE_SUBPATTERN_NAME[$route[$offset]])) { + if (!isset(self::PCRE_SUBPATTERN_NAME[$route[$offset]])) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An invalid character was found at position %d. ' . @@ -242,7 +257,7 @@ public static function parseRoute(string $route): array } if (($cursor & self::IN_VARIABLE_PATTERN)) { - if ($route[$offset] === RouteCompiler::PATTERN_DELIMITER) { + if ($route[$offset] === self::REGEX_DELIMITER) { throw new InvalidArgumentException(sprintf( 'The route %s could not be parsed due to a syntax error. ' . 'An invalid character was found at position %d. ' . @@ -250,7 +265,7 @@ public static function parseRoute(string $route): array 'use an octal or hexadecimal sequence instead.', $route, $offset, - RouteCompiler::PATTERN_DELIMITER, + self::REGEX_DELIMITER, )); } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 8dba8137..8753b229 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -39,7 +39,6 @@ use Sunrise\Http\Router\Annotation\Route as Descriptor; use Sunrise\Http\Router\Annotation\Summary; use Sunrise\Http\Router\Annotation\Tag; -use Sunrise\Http\Router\Dictionary\CacheKey; use Sunrise\Http\Router\Helper\ClassFinder; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Route; @@ -58,6 +57,11 @@ */ final class DescriptorLoader implements LoaderInterface { + /** + * @since 3.0.0 + */ + public const DESCRIPTORS_CACHE_KEY = 'sunrise_http_router_descriptors'; + public function __construct( /** @var array */ private readonly array $resources, @@ -95,6 +99,16 @@ public function load(): Generator } } + /** + * @throws CacheException + * + * @since 3.0.0 + */ + public function clearCache(): void + { + $this->cache?->delete(self::DESCRIPTORS_CACHE_KEY); + } + /** * @return list * @@ -105,7 +119,7 @@ public function load(): Generator private function getDescriptors(): array { /** @var list|null $descriptors */ - $descriptors = $this->cache?->get(CacheKey::DESCRIPTORS); + $descriptors = $this->cache?->get(self::DESCRIPTORS_CACHE_KEY); if ($descriptors !== null) { return $descriptors; } @@ -119,7 +133,7 @@ private function getDescriptors(): array usort($descriptors, static fn(Descriptor $a, Descriptor $b): int => $b->priority <=> $a->priority); - $this->cache?->set(CacheKey::DESCRIPTORS, $descriptors); + $this->cache?->set(self::DESCRIPTORS_CACHE_KEY, $descriptors); return $descriptors; } diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index e81f07c1..d9813c65 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -18,7 +18,6 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Entity\MediaType\JsonMediaType; use Sunrise\Http\Router\Exception\HttpExceptionFactory; use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ServerRequest; @@ -57,8 +56,12 @@ public function __construct( */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if (ServerRequest::create($request)->clientProducesMediaType(new JsonMediaType())) { - $request = $request->withParsedBody($this->decodePayload((string) $request->getBody())); + if (ServerRequest::create($request)->isJsonPayload()) { + $request = $request->withParsedBody( + $this->decodePayload( + (string) $request->getBody() + ) + ); } return $handler->handle($request); diff --git a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php index 23276705..8addfbb5 100644 --- a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php +++ b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php @@ -57,7 +57,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface if (!$serverRequest->clientProducesMediaType(...$serverConsumedMediaTypes)) { throw HttpExceptionFactory::unsupportedMediaType($this->errorMessage, $this->errorStatusCode) - ->addMessagePlaceholder('{{ media_type }}', $clientProducedMediaType) + ->addMessagePlaceholder('{{ media_type }}', $clientProducedMediaType->getIdentifier()) ->addHeaderField('Accept', ...array_map(StringableMediaType::create(...), $serverConsumedMediaTypes)); } diff --git a/src/Middleware/WhitespaceTrimmingMiddleware.php b/src/Middleware/WhitespaceTrimmingMiddleware.php index 13e41b60..3955a185 100644 --- a/src/Middleware/WhitespaceTrimmingMiddleware.php +++ b/src/Middleware/WhitespaceTrimmingMiddleware.php @@ -29,40 +29,29 @@ final class WhitespaceTrimmingMiddleware implements MiddlewareInterface { /** - * @var callable - * - * @readonly + * @inheritDoc */ - private $walker; - - /** - * @param ?callable(string):string $trimmer - */ - public function __construct(?callable $trimmer = null) - { - $trimmer ??= trim(...); - - $this->walker = static function (mixed &$value) use ($trimmer): void { - if (is_string($value)) { - $value = $trimmer($value); - } - }; - } - public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { $parsedBody = $request->getParsedBody(); if ($parsedBody !== [] && is_array($parsedBody)) { - array_walk_recursive($parsedBody, $this->walker); + array_walk_recursive($parsedBody, self::trim(...)); $request = $request->withParsedBody($parsedBody); } $queryParams = $request->getQueryParams(); if ($queryParams !== []) { - array_walk_recursive($queryParams, $this->walker); + array_walk_recursive($queryParams, self::trim(...)); $request = $request->withQueryParams($queryParams); } return $handler->handle($request); } + + private static function trim(mixed &$value): void + { + if (is_string($value)) { + $value = trim($value); + } + } } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index 6d9a1647..b16bb1ff 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -82,13 +82,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->hydrate($className, (array) $context->getParsedBody()); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidBody($errorMessage, $errorStatusCode, previous: $e) - ->addHydratorConstraintViolations(...$e->getExceptions()); + ->addHydratorConstraintViolation(...$e->getExceptions()); } if ($processParams->validation && $this->validator !== null) { if (($violations = $this->validator->validate($argument))->count() > 0) { throw HttpExceptionFactory::invalidBody($errorMessage, $errorStatusCode) - ->addValidatorConstraintViolations(...$violations); + ->addValidatorConstraintViolation(...$violations); } } diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index 7e9cccbe..cfc3e0e2 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -89,22 +89,24 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } catch (InvalidValueException $e) { throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder(self::PLACEHOLDER_COOKIE_NAME, $cookieName) - ->addHydratorConstraintViolations($e); + ->addHydratorConstraintViolation($e); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder(self::PLACEHOLDER_COOKIE_NAME, $cookieName) - ->addHydratorConstraintViolations(...$e->getExceptions()); + ->addHydratorConstraintViolation(...$e->getExceptions()); } if ($processParams->validation && $this->validator !== null) { - $violations = $this->validator->startContext() + $violations = $this->validator + ->startContext() ->atPath($cookieName) ->validate($argument, new ArgumentConstraint($parameter)) ->getViolations(); + if ($violations->count() > 0) { throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode) ->addMessagePlaceholder(self::PLACEHOLDER_COOKIE_NAME, $cookieName) - ->addValidatorConstraintViolations(...$violations); + ->addValidatorConstraintViolation(...$violations); } } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 39440a2f..79abb96d 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -87,22 +87,24 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } catch (InvalidValueException $e) { throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder(self::PLACEHOLDER_HEADER_NAME, $headerName) - ->addHydratorConstraintViolations($e); + ->addHydratorConstraintViolation($e); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder(self::PLACEHOLDER_HEADER_NAME, $headerName) - ->addHydratorConstraintViolations(...$e->getExceptions()); + ->addHydratorConstraintViolation(...$e->getExceptions()); } if ($processParams->validation && $this->validator !== null) { - $violations = $this->validator->startContext() + $violations = $this->validator + ->startContext() ->atPath($headerName) ->validate($argument, new ArgumentConstraint($parameter)) ->getViolations(); + if ($violations->count() > 0) { throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode) ->addMessagePlaceholder(self::PLACEHOLDER_HEADER_NAME, $headerName) - ->addValidatorConstraintViolations(...$violations); + ->addValidatorConstraintViolation(...$violations); } } diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 97a33905..66864e2d 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -82,13 +82,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->hydrate($className, $context->getQueryParams()); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidQuery($errorMessage, $errorStatusCode, previous: $e) - ->addHydratorConstraintViolations(...$e->getExceptions()); + ->addHydratorConstraintViolation(...$e->getExceptions()); } if ($processParams->validation && $this->validator !== null) { if (($violations = $this->validator->validate($argument))->count() > 0) { throw HttpExceptionFactory::invalidQuery($errorMessage, $errorStatusCode) - ->addValidatorConstraintViolations(...$violations); + ->addValidatorConstraintViolation(...$violations); } } diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index 77310389..5c977cdf 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -103,27 +103,27 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder(self::PLACEHOLDER_VARIABLE_NAME, $variableName) ->addMessagePlaceholder(self::PLACEHOLDER_ROUTE_URI, RouteSimplifier::simplifyRoute($route->getPath())) - ->addHydratorConstraintViolations($e); + ->addHydratorConstraintViolation($e); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode, previous: $e) ->addMessagePlaceholder(self::PLACEHOLDER_VARIABLE_NAME, $variableName) ->addMessagePlaceholder(self::PLACEHOLDER_ROUTE_URI, RouteSimplifier::simplifyRoute($route->getPath())) - ->addHydratorConstraintViolations(...$e->getExceptions()); + ->addHydratorConstraintViolation(...$e->getExceptions()); } - if ($this->validator !== null) { - $violations = $this->validator->startContext() + if ($processParams->validation && $this->validator !== null) { + $violations = $this->validator + ->startContext() ->atPath($variableName) ->validate($argument, new ArgumentConstraint($parameter)) ->getViolations(); + if ($violations->count() > 0) { throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode) ->addMessagePlaceholder(self::PLACEHOLDER_VARIABLE_NAME, $variableName) - ->addMessagePlaceholder( - self::PLACEHOLDER_ROUTE_URI, - RouteSimplifier::simplifyRoute($route->getPath()), - ) - ->addValidatorConstraintViolations(...$violations); + // phpcs:ignore Generic.Files.LineLength.TooLong + ->addMessagePlaceholder(self::PLACEHOLDER_ROUTE_URI, RouteSimplifier::simplifyRoute($route->getPath())) + ->addValidatorConstraintViolation(...$violations); } } diff --git a/src/ResponseResolver/ResponseJsonResolver.php b/src/ResponseResolver/ResponseJsonResolver.php index fb3dce4d..5d651a9f 100644 --- a/src/ResponseResolver/ResponseJsonResolver.php +++ b/src/ResponseResolver/ResponseJsonResolver.php @@ -78,7 +78,8 @@ public function resolveResponse( ), previous: $e); } - $jsonResponse = $this->responseFactory->createResponse(StatusCodeInterface::STATUS_OK) + $jsonResponse = $this->responseFactory + ->createResponse(StatusCodeInterface::STATUS_OK) ->withHeader('Content-Type', 'application/json; charset=UTF-8'); $jsonResponse->getBody()->write($payload); diff --git a/src/Router.php b/src/Router.php index 16d6d027..0249a875 100644 --- a/src/Router.php +++ b/src/Router.php @@ -148,10 +148,10 @@ public function match(ServerRequestInterface $request): RouteInterface $allowedMethods = []; foreach ($routes as $route) { - $routeRegex = $this->compileRoute($route); + $routePattern = $this->compileRoute($route); try { - if (!RouteMatcher::matchPattern($route->getPath(), $routeRegex, $requestPath, $matches)) { + if (!RouteMatcher::matchRoute($route->getName(), $routePattern, $requestPath, $matches)) { continue; } } catch (UnexpectedValueException $e) { @@ -236,7 +236,7 @@ public function buildRoute(RouteInterface|string $route, array $values = [], boo $result = RouteBuilder::buildRoute($route->getPath(), $values + $route->getAttributes()); - if ($strictly && !RouteMatcher::matchPattern($route->getPath(), $this->compileRoute($route), $result)) { + if ($strictly && !RouteMatcher::matchRoute($route->getName(), $this->compileRoute($route), $result)) { throw new InvalidArgumentException(sprintf( 'The route %s could not be built because one of the values does not match its pattern.', $route->getName(), diff --git a/src/RouterInterface.php b/src/RouterInterface.php index 9dc85db3..0016798c 100644 --- a/src/RouterInterface.php +++ b/src/RouterInterface.php @@ -74,7 +74,7 @@ public function handle(ServerRequestInterface $request): ResponseInterface; public function runRoute(RouteInterface|string $route, ServerRequestInterface $request): ResponseInterface; /** - * @param array $values + * @param array $values * * @throws InvalidArgumentException * diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 0f659376..e818968d 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -25,6 +25,7 @@ use Sunrise\Http\Router\Entity\MediaType\ClientMediaType; use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparatorInterface; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; use Sunrise\Http\Router\Helper\HeaderParser; @@ -215,6 +216,16 @@ public function clientProducesMediaType(MediaTypeInterface ...$serverConsumedMed return false; } + public function isJsonPayload(): bool + { + return $this->clientProducesMediaType(MediaTypeFactory::json()); + } + + public function isXmlPayload(): bool + { + return $this->clientProducesMediaType(MediaTypeFactory::xml()); + } + /** * @inheritDoc */ diff --git a/src/Validation/ConstraintViolation.php b/src/Validation/ConstraintViolation.php index ec10cece..21426b41 100644 --- a/src/Validation/ConstraintViolation.php +++ b/src/Validation/ConstraintViolation.php @@ -21,7 +21,7 @@ final class ConstraintViolation implements ConstraintViolationInterface public function __construct( private readonly string $message, private readonly string $messageTemplate, - /** @var array */ + /** @var array */ private readonly array $messagePlaceholders, private readonly string $propertyPath, private readonly ?string $code, diff --git a/src/Validation/ConstraintViolation/ValidatorConstraintViolationAdapter.php b/src/Validation/ConstraintViolation/ValidatorConstraintViolationAdapter.php index c3636ca4..146479c6 100644 --- a/src/Validation/ConstraintViolation/ValidatorConstraintViolationAdapter.php +++ b/src/Validation/ConstraintViolation/ValidatorConstraintViolationAdapter.php @@ -48,6 +48,7 @@ public function getMessageTemplate(): string */ public function getMessagePlaceholders(): array { + /** @var array */ return $this->validatorConstraintViolation->getParameters(); } diff --git a/src/Validation/ConstraintViolationInterface.php b/src/Validation/ConstraintViolationInterface.php index 4c840523..41b43856 100644 --- a/src/Validation/ConstraintViolationInterface.php +++ b/src/Validation/ConstraintViolationInterface.php @@ -23,7 +23,7 @@ public function getMessage(): string; public function getMessageTemplate(): string; /** - * @return array + * @return array */ public function getMessagePlaceholders(): array; diff --git a/src/functions.php b/src/functions/emit.php similarity index 100% rename from src/functions.php rename to src/functions/emit.php diff --git a/tests/Command/RouterClearCacheCommandTest.php b/tests/Command/RouterClearCacheCommandTest.php index ac7d8840..4d9b7b69 100644 --- a/tests/Command/RouterClearCacheCommandTest.php +++ b/tests/Command/RouterClearCacheCommandTest.php @@ -7,8 +7,8 @@ use PHPUnit\Framework\MockObject\MockObject; use PHPUnit\Framework\TestCase; use Psr\SimpleCache\CacheInterface; -use Sunrise\Http\Router\Command\RouterClearCacheCommand; -use Sunrise\Http\Router\Dictionary\CacheKey; +use Sunrise\Http\Router\Command\RouterClearDescriptorsCacheCommand; +use Sunrise\Http\Router\Loader\DescriptorLoader; use Symfony\Component\Console\Tester\CommandTester; final class RouterClearCacheCommandTest extends TestCase @@ -24,16 +24,18 @@ public function testExecuteWithCache(): void { $this->cacheMock->expects(self::once()) ->method('delete') - ->with(CacheKey::DESCRIPTORS); + ->with(DescriptorLoader::DESCRIPTORS_CACHE_KEY); - $command = new RouterClearCacheCommand($this->cacheMock); + $descriptorLoader = new DescriptorLoader([], $this->cacheMock); + $command = new RouterClearDescriptorsCacheCommand($descriptorLoader); $commandTester = new CommandTester($command); $this->assertSame(0, $commandTester->execute([])); } public function testExecuteWithoutCache(): void { - $command = new RouterClearCacheCommand(null); + $descriptorLoader = new DescriptorLoader([]); + $command = new RouterClearDescriptorsCacheCommand($descriptorLoader); $commandTester = new CommandTester($command); $this->assertSame(0, $commandTester->execute([])); } diff --git a/tests/Exception/HttpExceptionTest.php b/tests/Exception/HttpExceptionTest.php index 74d2b45b..79b9aec0 100644 --- a/tests/Exception/HttpExceptionTest.php +++ b/tests/Exception/HttpExceptionTest.php @@ -114,8 +114,8 @@ public function testAddHydratorConstraintViolations(): void ); $httpException = new HttpException('foo', 400); - $httpException->addHydratorConstraintViolations(...$hydratorConstraintViolations); - $httpException->addHydratorConstraintViolations($additionalHydratorConstraintViolation); + $httpException->addHydratorConstraintViolation(...$hydratorConstraintViolations); + $httpException->addHydratorConstraintViolation($additionalHydratorConstraintViolation); $constraintViolations = $httpException->getConstraintViolations(); $this->assertCount(3, $constraintViolations); @@ -181,8 +181,8 @@ public function testAddValidatorConstraintViolations(): void ); $httpException = new HttpException('foo', 400); - $httpException->addValidatorConstraintViolations(...$validatorConstraintViolations); - $httpException->addValidatorConstraintViolations($additionalValidatorConstraintViolation); + $httpException->addValidatorConstraintViolation(...$validatorConstraintViolations); + $httpException->addValidatorConstraintViolation($additionalValidatorConstraintViolation); $constraintViolations = $httpException->getConstraintViolations(); $this->assertCount(3, $constraintViolations); From 8f810eac307220a04632afa44048c369c16d6ae0 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 7 Nov 2024 03:13:08 +0100 Subject: [PATCH 173/180] v3 --- benchmarks/.gitkeep | 0 composer.json | 1 + resources/definitions/router.php | 6 +- src/Annotation/ConsumesJson.php | 4 +- src/Annotation/ConsumesXml.php | 4 +- src/Annotation/ProducesJson.php | 4 +- src/Annotation/ProducesXml.php | 4 +- .../RouterClearDescriptorsCacheCommand.php | 4 +- src/Command/RouterListRoutesCommand.php | 6 +- src/Entity/Language/ClientLanguage.php | 46 ------- src/Entity/Language/StringableLanguage.php | 42 ------ .../Language.php => Locale/Locale.php} | 15 ++- src/Entity/Locale/LocaleComparator.php | 53 ++++++++ .../LocaleComparatorInterface.php} | 6 +- .../LocaleInterface.php} | 14 +- src/Entity/MediaType/ClientMediaType.php | 40 ------ src/Entity/MediaType/MediaType.php | 12 +- src/Entity/MediaType/MediaTypeComparator.php | 23 +++- src/Entity/MediaType/MediaTypeFactory.php | 35 ----- src/Entity/MediaType/StringableMediaType.php | 2 +- src/Exception/HttpExceptionFactory.php | 92 ++++++------- src/Exception/HttpExceptionInterface.php | 2 +- src/Helper/HeaderParser.php | 2 +- src/Loader/DescriptorLoader.php | 4 +- .../DescriptorLoaderInterface.php} | 6 +- .../JsonPayloadDecodingMiddleware.php | 16 +-- .../WhitespaceTrimmingMiddleware.php | 12 +- src/MiddlewareResolver.php | 6 +- src/ParameterResolverChain.php | 10 +- src/RequestHandlerResolver.php | 6 +- src/ResponseResolverChain.php | 10 +- src/ServerRequest.php | 127 +++++++++--------- .../Constraint/ArgumentConstraint.php | 7 +- .../ArgumentConstraintValidator.php | 5 +- src/functions/emit.php | 3 + tests/Command/RouterClearCacheCommandTest.php | 24 +--- tests/Entity/Language/ClientLanguageTest.php | 8 +- .../Language/LanguageComparatorTest.php | 12 +- 38 files changed, 287 insertions(+), 386 deletions(-) delete mode 100644 benchmarks/.gitkeep delete mode 100644 src/Entity/Language/ClientLanguage.php delete mode 100644 src/Entity/Language/StringableLanguage.php rename src/Entity/{Language/Language.php => Locale/Locale.php} (55%) create mode 100644 src/Entity/Locale/LocaleComparator.php rename src/Entity/{Language/LanguageComparatorInterface.php => Locale/LocaleComparatorInterface.php} (71%) rename src/Entity/{Language/LanguageComparator.php => Locale/LocaleInterface.php} (51%) delete mode 100644 src/Entity/MediaType/ClientMediaType.php delete mode 100644 src/Entity/MediaType/MediaTypeFactory.php rename src/{Entity/Language/LanguageInterface.php => Loader/DescriptorLoaderInterface.php} (72%) diff --git a/benchmarks/.gitkeep b/benchmarks/.gitkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/composer.json b/composer.json index ff297364..7469a9fe 100644 --- a/composer.json +++ b/composer.json @@ -41,6 +41,7 @@ "phpstan/phpstan": "^1.12", "phpunit/phpunit": "^10.5", "squizlabs/php_codesniffer": "^3.10", + "sunrise/http-message": "^3.2", "sunrise/hydrator": "^3.13", "symfony/console": "^6.4", "symfony/validator": "^6.4", diff --git a/resources/definitions/router.php b/resources/definitions/router.php index f0c964ad..d8a4abea 100644 --- a/resources/definitions/router.php +++ b/resources/definitions/router.php @@ -5,8 +5,8 @@ use Psr\Container\ContainerInterface; use Sunrise\Http\Router\ClassResolver; use Sunrise\Http\Router\ClassResolverInterface; -use Sunrise\Http\Router\Entity\Language\LanguageComparator; -use Sunrise\Http\Router\Entity\Language\LanguageComparatorInterface; +use Sunrise\Http\Router\Entity\Locale\LocaleComparator; +use Sunrise\Http\Router\Entity\Locale\LocaleComparatorInterface; use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparatorInterface; use Sunrise\Http\Router\MiddlewareResolver; @@ -79,5 +79,5 @@ ), MediaTypeComparatorInterface::class => create(MediaTypeComparator::class), - LanguageComparatorInterface::class => create(LanguageComparator::class), + LocaleComparatorInterface::class => create(LocaleComparator::class), ]; diff --git a/src/Annotation/ConsumesJson.php b/src/Annotation/ConsumesJson.php index 3524279d..362b75b1 100644 --- a/src/Annotation/ConsumesJson.php +++ b/src/Annotation/ConsumesJson.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\MediaType; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ConsumesJson extends Consumes { public function __construct() { - parent::__construct(MediaTypeFactory::json()); + parent::__construct(MediaType::json()); } } diff --git a/src/Annotation/ConsumesXml.php b/src/Annotation/ConsumesXml.php index c810ee07..929d03a9 100644 --- a/src/Annotation/ConsumesXml.php +++ b/src/Annotation/ConsumesXml.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\MediaType; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ConsumesXml extends Consumes { public function __construct() { - parent::__construct(MediaTypeFactory::xml()); + parent::__construct(MediaType::xml()); } } diff --git a/src/Annotation/ProducesJson.php b/src/Annotation/ProducesJson.php index 356ac287..778a8331 100644 --- a/src/Annotation/ProducesJson.php +++ b/src/Annotation/ProducesJson.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\MediaType; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ProducesJson extends Produces { public function __construct() { - parent::__construct(MediaTypeFactory::json()); + parent::__construct(MediaType::json()); } } diff --git a/src/Annotation/ProducesXml.php b/src/Annotation/ProducesXml.php index 5b4c9dd5..e3716c54 100644 --- a/src/Annotation/ProducesXml.php +++ b/src/Annotation/ProducesXml.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; +use Sunrise\Http\Router\Entity\MediaType\MediaType; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ProducesXml extends Produces { public function __construct() { - parent::__construct(MediaTypeFactory::xml()); + parent::__construct(MediaType::xml()); } } diff --git a/src/Command/RouterClearDescriptorsCacheCommand.php b/src/Command/RouterClearDescriptorsCacheCommand.php index ce32f35d..f929a9e6 100644 --- a/src/Command/RouterClearDescriptorsCacheCommand.php +++ b/src/Command/RouterClearDescriptorsCacheCommand.php @@ -13,7 +13,7 @@ namespace Sunrise\Http\Router\Command; -use Sunrise\Http\Router\Loader\DescriptorLoader; +use Sunrise\Http\Router\Loader\DescriptorLoaderInterface; use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputInterface; @@ -26,7 +26,7 @@ final class RouterClearDescriptorsCacheCommand extends Command { public function __construct( - private readonly DescriptorLoader $descriptorLoader, + private readonly DescriptorLoaderInterface $descriptorLoader, ) { parent::__construct(); } diff --git a/src/Command/RouterListRoutesCommand.php b/src/Command/RouterListRoutesCommand.php index fe18dedb..ea06a3ab 100644 --- a/src/Command/RouterListRoutesCommand.php +++ b/src/Command/RouterListRoutesCommand.php @@ -41,11 +41,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int { $table = new Table($output); - $table->setHeaders([ - 'Name', - 'Path', - 'Methods', - ]); + $table->setHeaders(['NAME', 'PATH', 'VERBS']); foreach ($this->router->getRoutes() as $route) { $table->addRow([ diff --git a/src/Entity/Language/ClientLanguage.php b/src/Entity/Language/ClientLanguage.php deleted file mode 100644 index b1b22afd..00000000 --- a/src/Entity/Language/ClientLanguage.php +++ /dev/null @@ -1,46 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Entity\Language; - -/** - * @since 3.0.0 - */ -final class ClientLanguage implements LanguageInterface -{ - public function __construct( - private readonly string $code, - private readonly string $locale, - /** @var array */ - private readonly array $parameters, - ) { - } - - public function getCode(): string - { - return $this->code; - } - - public function getLocale(): string - { - return $this->locale; - } - - /** - * @return array - */ - public function getParameters(): array - { - return $this->parameters; - } -} diff --git a/src/Entity/Language/StringableLanguage.php b/src/Entity/Language/StringableLanguage.php deleted file mode 100644 index 092892d2..00000000 --- a/src/Entity/Language/StringableLanguage.php +++ /dev/null @@ -1,42 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Entity\Language; - -use Stringable; - -/** - * @since 3.0.0 - */ -final class StringableLanguage implements LanguageInterface, Stringable -{ - public function __construct( - private readonly LanguageInterface $language, - ) { - } - - public static function create(LanguageInterface $language): self - { - return new self(language: $language); - } - - public function getCode(): string - { - return $this->language->getCode(); - } - - public function __toString(): string - { - return $this->getCode(); - } -} diff --git a/src/Entity/Language/Language.php b/src/Entity/Locale/Locale.php similarity index 55% rename from src/Entity/Language/Language.php rename to src/Entity/Locale/Locale.php index 0f94654a..bda26121 100644 --- a/src/Entity/Language/Language.php +++ b/src/Entity/Locale/Locale.php @@ -11,25 +11,26 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Entity\Language; +namespace Sunrise\Http\Router\Entity\Locale; /** * @since 3.0.0 */ -final class Language implements LanguageInterface +final class Locale implements LocaleInterface { public function __construct( - private readonly string $code, + private readonly string $languageCode, + private readonly ?string $regionCode, ) { } - public static function create(string $code): self + public function getLanguageCode(): string { - return new self(code: $code); + return $this->languageCode; } - public function getCode(): string + public function getRegionCode(): string { - return $this->code; + return $this->regionCode; } } diff --git a/src/Entity/Locale/LocaleComparator.php b/src/Entity/Locale/LocaleComparator.php new file mode 100644 index 00000000..f83b0439 --- /dev/null +++ b/src/Entity/Locale/LocaleComparator.php @@ -0,0 +1,53 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Entity\Locale; + +/** + * @since 3.0.0 + */ +final class LocaleComparator implements LocaleComparatorInterface +{ + /** + * @inheritDoc + */ + public function compare(LocaleInterface $a, LocaleInterface $b): int + { + $aLanguageCode = $a->getLanguageCode(); + if ($aLanguageCode === '*') { + return 0; + } + + $bLanguageCode = $b->getLanguageCode(); + if ($bLanguageCode === '*') { + return 0; + } + + $languagesCmp = $aLanguageCode <=> $bLanguageCode; + if ($languagesCmp !== 0) { + return $languagesCmp; + } + + $aRegionCode = $a->getRegionCode(); + if ($aRegionCode === null) { + return 0; + } + + $bRegionCode = $b->getRegionCode(); + if ($bRegionCode === null) { + return 0; + } + + return $aRegionCode <=> $bRegionCode; + } +} diff --git a/src/Entity/Language/LanguageComparatorInterface.php b/src/Entity/Locale/LocaleComparatorInterface.php similarity index 71% rename from src/Entity/Language/LanguageComparatorInterface.php rename to src/Entity/Locale/LocaleComparatorInterface.php index 0a269412..0f4f94df 100644 --- a/src/Entity/Language/LanguageComparatorInterface.php +++ b/src/Entity/Locale/LocaleComparatorInterface.php @@ -11,15 +11,15 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Entity\Language; +namespace Sunrise\Http\Router\Entity\Locale; /** * @since 3.0.0 */ -interface LanguageComparatorInterface +interface LocaleComparatorInterface { /** * @return int<-1, 1> */ - public function compare(LanguageInterface $a, LanguageInterface $b): int; + public function compare(LocaleInterface $a, LocaleInterface $b): int; } diff --git a/src/Entity/Language/LanguageComparator.php b/src/Entity/Locale/LocaleInterface.php similarity index 51% rename from src/Entity/Language/LanguageComparator.php rename to src/Entity/Locale/LocaleInterface.php index abc0620e..b01c8912 100644 --- a/src/Entity/Language/LanguageComparator.php +++ b/src/Entity/Locale/LocaleInterface.php @@ -11,18 +11,14 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Entity\Language; +namespace Sunrise\Http\Router\Entity\Locale; /** * @since 3.0.0 */ -final class LanguageComparator implements LanguageComparatorInterface +interface LocaleInterface { - /** - * @inheritDoc - */ - public function compare(LanguageInterface $a, LanguageInterface $b): int - { - return ($a->getCode() === '*' || $b->getCode() === '*') ? 0 : $a->getCode() <=> $b->getCode(); - } + public function getLanguageCode(): string; + + public function getRegionCode(): ?string; } diff --git a/src/Entity/MediaType/ClientMediaType.php b/src/Entity/MediaType/ClientMediaType.php deleted file mode 100644 index 8718cd24..00000000 --- a/src/Entity/MediaType/ClientMediaType.php +++ /dev/null @@ -1,40 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Entity\MediaType; - -/** - * @since 3.0.0 - */ -final class ClientMediaType implements MediaTypeInterface -{ - public function __construct( - private readonly string $identifier, - /** @var array */ - private readonly array $parameters, - ) { - } - - public function getIdentifier(): string - { - return $this->identifier; - } - - /** - * @return array - */ - public function getParameters(): array - { - return $this->parameters; - } -} diff --git a/src/Entity/MediaType/MediaType.php b/src/Entity/MediaType/MediaType.php index 00d4a940..fb1c9f4f 100644 --- a/src/Entity/MediaType/MediaType.php +++ b/src/Entity/MediaType/MediaType.php @@ -18,14 +18,22 @@ */ final class MediaType implements MediaTypeInterface { + public const IDENTIFIER_JSON = 'application/json'; + public const IDENTIFIER_XML = 'application/xml'; + public function __construct( private readonly string $identifier, ) { } - public static function create(string $identifier): self + public static function json(): self + { + return new self(self::IDENTIFIER_JSON); + } + + public static function xml(): self { - return new self(identifier: $identifier); + return new self(self::IDENTIFIER_XML); } public function getIdentifier(): string diff --git a/src/Entity/MediaType/MediaTypeComparator.php b/src/Entity/MediaType/MediaTypeComparator.php index 2e8ed001..4520e319 100644 --- a/src/Entity/MediaType/MediaTypeComparator.php +++ b/src/Entity/MediaType/MediaTypeComparator.php @@ -26,16 +26,31 @@ final class MediaTypeComparator implements MediaTypeComparatorInterface */ public function compare(MediaTypeInterface $a, MediaTypeInterface $b): int { - $aId = strtolower($a->getIdentifier()); + $aId = $a->getIdentifier(); + if ($aId === '*/*') { + return 0; + } + + $bId = $b->getIdentifier(); + if ($bId === '*/*') { + return 0; + } + + $aId = strtolower($aId); + $bId = strtolower($bId); + + if ($aId === $bId) { + return 0; + } + $aParts = explode('/', $aId, 2); $aParts[1] ??= ''; - $bId = strtolower($b->getIdentifier()); $bParts = explode('/', $bId, 2); $bParts[1] ??= ''; - $sameTypes = $aParts[0] === '*' || $bParts[0] === '*' || $aParts[0] === $bParts[0]; - $sameSubtypes = $aParts[1] === '*' || $bParts[1] === '*' || $aParts[1] === $bParts[1]; + $sameTypes = $aParts[0] === $bParts[0] || $aParts[0] === '*' || $bParts[0] === '*'; + $sameSubtypes = $aParts[1] === $bParts[1] || $aParts[1] === '*' || $bParts[1] === '*'; return ($sameTypes && $sameSubtypes) ? 0 : $aId <=> $bId; } diff --git a/src/Entity/MediaType/MediaTypeFactory.php b/src/Entity/MediaType/MediaTypeFactory.php deleted file mode 100644 index f1c2de94..00000000 --- a/src/Entity/MediaType/MediaTypeFactory.php +++ /dev/null @@ -1,35 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Entity\MediaType; - -/** - * @since 3.0.0 - */ -final class MediaTypeFactory -{ - public static function create(string $identifier): MediaTypeInterface - { - return new MediaType($identifier); - } - - public static function json(): MediaTypeInterface - { - return self::create(identifier: 'application/json'); - } - - public static function xml(): MediaTypeInterface - { - return self::create(identifier: 'application/xml'); - } -} diff --git a/src/Entity/MediaType/StringableMediaType.php b/src/Entity/MediaType/StringableMediaType.php index 1aa1affd..54287888 100644 --- a/src/Entity/MediaType/StringableMediaType.php +++ b/src/Entity/MediaType/StringableMediaType.php @@ -27,7 +27,7 @@ public function __construct( public static function create(MediaTypeInterface $mediaType): self { - return new self(mediaType: $mediaType); + return new self($mediaType); } public function getIdentifier(): string diff --git a/src/Exception/HttpExceptionFactory.php b/src/Exception/HttpExceptionFactory.php index aef16ce7..a85654ce 100644 --- a/src/Exception/HttpExceptionFactory.php +++ b/src/Exception/HttpExceptionFactory.php @@ -20,7 +20,7 @@ /** * @since 3.0.0 */ -final class HttpExceptionFactory +final class HttpExceptionFactory implements StatusCodeInterface { public static function malformedUri( ?string $message = null, @@ -28,9 +28,9 @@ public static function malformedUri( ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::MALFORMED_URI, - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - previous: $previous, + $message ?? ErrorMessage::MALFORMED_URI, + $code ?? self::STATUS_BAD_REQUEST, + $previous, ); } @@ -40,9 +40,9 @@ public static function resourceNotFound( ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::RESOURCE_NOT_FOUND, - code: $code ?? StatusCodeInterface::STATUS_NOT_FOUND, - previous: $previous, + $message ?? ErrorMessage::RESOURCE_NOT_FOUND, + $code ?? self::STATUS_NOT_FOUND, + $previous, ); } @@ -52,9 +52,9 @@ public static function methodNotAllowed( ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::METHOD_NOT_ALLOWED, - code: $code ?? StatusCodeInterface::STATUS_METHOD_NOT_ALLOWED, - previous: $previous, + $message ?? ErrorMessage::METHOD_NOT_ALLOWED, + $code ?? self::STATUS_METHOD_NOT_ALLOWED, + $previous, ); } @@ -64,9 +64,9 @@ public static function missingContentType( ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::MISSING_CONTENT_TYPE, - code: $code ?? StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE, - previous: $previous, + $message ?? ErrorMessage::MISSING_CONTENT_TYPE, + $code ?? self::STATUS_UNSUPPORTED_MEDIA_TYPE, + $previous, ); } @@ -76,9 +76,9 @@ public static function unsupportedMediaType( ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::UNSUPPORTED_MEDIA_TYPE, - code: $code ?? StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE, - previous: $previous, + $message ?? ErrorMessage::UNSUPPORTED_MEDIA_TYPE, + $code ?? self::STATUS_UNSUPPORTED_MEDIA_TYPE, + $previous, ); } @@ -88,9 +88,9 @@ public static function invalidVariable( ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::INVALID_VARIABLE, - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - previous: $previous, + $message ?? ErrorMessage::INVALID_VARIABLE, + $code ?? self::STATUS_BAD_REQUEST, + $previous, ); } @@ -100,9 +100,9 @@ public static function invalidQuery( ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::INVALID_QUERY, - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - previous: $previous, + $message ?? ErrorMessage::INVALID_QUERY, + $code ?? self::STATUS_BAD_REQUEST, + $previous, ); } @@ -112,9 +112,9 @@ public static function missingHeader( ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::MISSING_HEADER, - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - previous: $previous, + $message ?? ErrorMessage::MISSING_HEADER, + $code ?? self::STATUS_BAD_REQUEST, + $previous, ); } @@ -124,9 +124,9 @@ public static function invalidHeader( ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::INVALID_HEADER, - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - previous: $previous, + $message ?? ErrorMessage::INVALID_HEADER, + $code ?? self::STATUS_BAD_REQUEST, + $previous, ); } @@ -136,9 +136,9 @@ public static function missingCookie( ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::MISSING_COOKIE, - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - previous: $previous, + $message ?? ErrorMessage::MISSING_COOKIE, + $code ?? self::STATUS_BAD_REQUEST, + $previous, ); } @@ -148,9 +148,9 @@ public static function invalidCookie( ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::INVALID_COOKIE, - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - previous: $previous, + $message ?? ErrorMessage::INVALID_COOKIE, + $code ?? self::STATUS_BAD_REQUEST, + $previous, ); } @@ -160,9 +160,9 @@ public static function invalidBody( ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::INVALID_BODY, - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - previous: $previous, + $message ?? ErrorMessage::INVALID_BODY, + $code ?? self::STATUS_BAD_REQUEST, + $previous, ); } @@ -172,9 +172,9 @@ public static function emptyJsonPayload( ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::EMPTY_JSON_PAYLOAD, - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - previous: $previous, + $message ?? ErrorMessage::EMPTY_JSON_PAYLOAD, + $code ?? self::STATUS_BAD_REQUEST, + $previous, ); } @@ -184,9 +184,9 @@ public static function invalidJsonPayload( ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::INVALID_JSON_PAYLOAD, - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - previous: $previous, + $message ?? ErrorMessage::INVALID_JSON_PAYLOAD, + $code ?? self::STATUS_BAD_REQUEST, + $previous, ); } @@ -196,9 +196,9 @@ public static function invalidJsonPayloadFormat( ?Throwable $previous = null, ): HttpException { return new HttpException( - message: $message ?? ErrorMessage::INVALID_JSON_PAYLOAD_FORMAT, - code: $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, - previous: $previous, + $message ?? ErrorMessage::INVALID_JSON_PAYLOAD_FORMAT, + $code ?? self::STATUS_BAD_REQUEST, + $previous, ); } } diff --git a/src/Exception/HttpExceptionInterface.php b/src/Exception/HttpExceptionInterface.php index 50aa12d3..72f10b3d 100644 --- a/src/Exception/HttpExceptionInterface.php +++ b/src/Exception/HttpExceptionInterface.php @@ -22,7 +22,7 @@ interface HttpExceptionInterface extends ExceptionInterface, StatusCodeInterface { /** - * Returns the exception's non-interpolated message. + * Returns the exception's non-interpolated message. */ public function getMessageTemplate(): string; diff --git a/src/Helper/HeaderParser.php b/src/Helper/HeaderParser.php index e369d300..a21afa52 100644 --- a/src/Helper/HeaderParser.php +++ b/src/Helper/HeaderParser.php @@ -76,7 +76,7 @@ public static function parseHeader(string $header): array /** @var array, array{0?: string, 1?: array, array{0?: string, 1?: string}>}> $values */ $values = []; - for ($offset = 0; isset($header[$offset]) && $offset < 1024; $offset++) { + for ($offset = 0; isset($header[$offset]) && $offset < 512; $offset++) { if (!isset(self::RFC7230_FIELD_VALUE[$header[$offset]])) { continue; } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 8753b229..0d3decbd 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -55,7 +55,7 @@ /** * @since 2.10.0 */ -final class DescriptorLoader implements LoaderInterface +final class DescriptorLoader implements DescriptorLoaderInterface { /** * @since 3.0.0 @@ -101,8 +101,6 @@ public function load(): Generator /** * @throws CacheException - * - * @since 3.0.0 */ public function clearCache(): void { diff --git a/src/Entity/Language/LanguageInterface.php b/src/Loader/DescriptorLoaderInterface.php similarity index 72% rename from src/Entity/Language/LanguageInterface.php rename to src/Loader/DescriptorLoaderInterface.php index 3941bde7..13dd5e89 100644 --- a/src/Entity/Language/LanguageInterface.php +++ b/src/Loader/DescriptorLoaderInterface.php @@ -11,12 +11,12 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Entity\Language; +namespace Sunrise\Http\Router\Loader; /** * @since 3.0.0 */ -interface LanguageInterface +interface DescriptorLoaderInterface extends LoaderInterface { - public function getCode(): string; + public function clearCache(): void; } diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index d9813c65..30cdcf92 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -32,6 +32,8 @@ * JSON payload decoding middleware * * @since 2.15.0 + * + * @todo Use the Simdjson extension as needed. */ final class JsonPayloadDecodingMiddleware implements MiddlewareInterface { @@ -57,11 +59,7 @@ public function __construct( public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { if (ServerRequest::create($request)->isJsonPayload()) { - $request = $request->withParsedBody( - $this->decodePayload( - (string) $request->getBody() - ) - ); + $request = $request->withParsedBody($this->decodeJson((string) $request->getBody())); } return $handler->handle($request); @@ -70,11 +68,11 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface /** * @return array * - * @throws HttpExceptionInterface If the payload couldn't be decoded. + * @throws HttpExceptionInterface If the JSON couldn't be decoded. */ - private function decodePayload(string $payload): array + private function decodeJson(string $json): array { - if ($payload === '') { + if ($json === '') { throw HttpExceptionFactory::emptyJsonPayload($this->errorMessage, $this->errorStatusCode); } @@ -83,7 +81,7 @@ private function decodePayload(string $payload): array $decodingDepth = $this->decodingDepth ?? self::DEFAULT_DECODING_DEPTH; try { - $data = json_decode($payload, true, $decodingDepth, $decodingFlags | JSON_THROW_ON_ERROR); + $data = json_decode($json, true, $decodingDepth, $decodingFlags | JSON_THROW_ON_ERROR); } catch (JsonException $e) { throw HttpExceptionFactory::invalidJsonPayload($this->errorMessage, $this->errorStatusCode, previous: $e); } diff --git a/src/Middleware/WhitespaceTrimmingMiddleware.php b/src/Middleware/WhitespaceTrimmingMiddleware.php index 3955a185..e40005f4 100644 --- a/src/Middleware/WhitespaceTrimmingMiddleware.php +++ b/src/Middleware/WhitespaceTrimmingMiddleware.php @@ -33,18 +33,18 @@ final class WhitespaceTrimmingMiddleware implements MiddlewareInterface */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - $parsedBody = $request->getParsedBody(); - if ($parsedBody !== [] && is_array($parsedBody)) { - array_walk_recursive($parsedBody, self::trim(...)); - $request = $request->withParsedBody($parsedBody); - } - $queryParams = $request->getQueryParams(); if ($queryParams !== []) { array_walk_recursive($queryParams, self::trim(...)); $request = $request->withQueryParams($queryParams); } + $parsedBody = $request->getParsedBody(); + if ($parsedBody !== [] && is_array($parsedBody)) { + array_walk_recursive($parsedBody, self::trim(...)); + $request = $request->withParsedBody($parsedBody); + } + return $handler->handle($request); } diff --git a/src/MiddlewareResolver.php b/src/MiddlewareResolver.php index 88e86a66..19990f1b 100644 --- a/src/MiddlewareResolver.php +++ b/src/MiddlewareResolver.php @@ -59,7 +59,7 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface } if ($reference instanceof Closure) { - return new CallableMiddleware($this->createCallback($reference, new ReflectionFunction($reference))); + return new CallableMiddleware($this->normalizeCallback($reference, new ReflectionFunction($reference))); } if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { @@ -79,7 +79,7 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface /** @var callable $reference */ - return new CallableMiddleware($this->createCallback($reference, $reflection)); + return new CallableMiddleware($this->normalizeCallback($reference, $reflection)); } } @@ -95,7 +95,7 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface * @throws InvalidArgumentException * @throws LogicException */ - private function createCallback(callable $callback, ReflectionMethod|ReflectionFunction $reflection): callable + private function normalizeCallback(callable $callback, ReflectionMethod|ReflectionFunction $reflection): callable { return fn(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface => ( $this->responseResolverChain->resolveResponse( diff --git a/src/ParameterResolverChain.php b/src/ParameterResolverChain.php index e137f6dc..c9c777de 100644 --- a/src/ParameterResolverChain.php +++ b/src/ParameterResolverChain.php @@ -94,10 +94,12 @@ private function resolveParameter(ReflectionParameter $parameter, mixed $context private function sortResolvers(): void { - $this->isSorted = usort($this->resolvers, static fn( - ParameterResolverInterface $a, - ParameterResolverInterface $b, - ): int => $b->getWeight() <=> $a->getWeight()); + $this->isSorted = usort($this->resolvers, self::resolversSorter(...)); + } + + private static function resolversSorter(ParameterResolverInterface $a, ParameterResolverInterface $b): int + { + return $b->getWeight() <=> $a->getWeight(); } public static function stringifyParameter(ReflectionParameter $parameter): string diff --git a/src/RequestHandlerResolver.php b/src/RequestHandlerResolver.php index afac8697..6fd72916 100644 --- a/src/RequestHandlerResolver.php +++ b/src/RequestHandlerResolver.php @@ -58,7 +58,7 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface } if ($reference instanceof Closure) { - return new CallableRequestHandler($this->createCallback($reference, new ReflectionFunction($reference))); + return new CallableRequestHandler($this->normalizeCallback($reference, new ReflectionFunction($reference))); } // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 @@ -74,7 +74,7 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface /** @var callable $reference */ - return new CallableRequestHandler($this->createCallback($reference, $reflection)); + return new CallableRequestHandler($this->normalizeCallback($reference, $reflection)); } } @@ -94,7 +94,7 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface * @throws InvalidArgumentException * @throws LogicException */ - private function createCallback(callable $callback, ReflectionMethod|ReflectionFunction $reflection): callable + private function normalizeCallback(callable $callback, ReflectionMethod|ReflectionFunction $reflection): callable { return fn(ServerRequestInterface $request): ResponseInterface => ( $this->responseResolverChain->resolveResponse( diff --git a/src/ResponseResolverChain.php b/src/ResponseResolverChain.php index 1eedc250..c72df536 100644 --- a/src/ResponseResolverChain.php +++ b/src/ResponseResolverChain.php @@ -92,10 +92,12 @@ private static function completeResponse( private function sortResolvers(): void { - $this->isSorted = usort($this->resolvers, static fn( - ResponseResolverInterface $a, - ResponseResolverInterface $b, - ): int => $b->getWeight() <=> $a->getWeight()); + $this->isSorted = usort($this->resolvers, self::resolversSorter(...)); + } + + private static function resolversSorter(ResponseResolverInterface $a, ResponseResolverInterface $b): int + { + return $b->getWeight() <=> $a->getWeight(); } public static function stringifyResponder(ReflectionMethod|ReflectionFunction $responder): string diff --git a/src/ServerRequest.php b/src/ServerRequest.php index e818968d..5f81d32e 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -18,17 +18,17 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\StreamInterface; use Psr\Http\Message\UriInterface; -use Sunrise\Http\Router\Entity\Language\ClientLanguage; -use Sunrise\Http\Router\Entity\Language\LanguageComparator; -use Sunrise\Http\Router\Entity\Language\LanguageComparatorInterface; -use Sunrise\Http\Router\Entity\Language\LanguageInterface; -use Sunrise\Http\Router\Entity\MediaType\ClientMediaType; +use Sunrise\Http\Router\Entity\Locale\Locale; +use Sunrise\Http\Router\Entity\Locale\LocaleComparator; +use Sunrise\Http\Router\Entity\Locale\LocaleComparatorInterface; +use Sunrise\Http\Router\Entity\Locale\LocaleInterface; +use Sunrise\Http\Router\Entity\MediaType\MediaType; use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparatorInterface; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeFactory; use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; use Sunrise\Http\Router\Helper\HeaderParser; +use function extension_loaded; use function preg_match; use function reset; use function usort; @@ -38,16 +38,21 @@ */ final class ServerRequest implements ServerRequestInterface { - private ?LanguageComparatorInterface $languageComparator = null; - private ?MediaTypeComparatorInterface $mediaTypeComparator = null; + private readonly LocaleComparatorInterface $localeComparator; + private readonly MediaTypeComparatorInterface $mediaTypeComparator; - public function __construct(private ServerRequestInterface $request) - { + public function __construct( + private ServerRequestInterface $request, + ?LocaleComparatorInterface $localeComparator = null, + ?MediaTypeComparatorInterface $mediaTypeComparator = null, + ) { + $this->localeComparator = $localeComparator ?? new LocaleComparator(); + $this->mediaTypeComparator = $mediaTypeComparator ?? new MediaTypeComparator(); } public static function create(ServerRequestInterface $request): self { - return new self($request); + return ($request instanceof self) ? $request : new self($request); } public function getOriginalRequest(): ServerRequestInterface @@ -55,32 +60,6 @@ public function getOriginalRequest(): ServerRequestInterface return ($this->request instanceof self) ? $this->request->getOriginalRequest() : $this->request; } - public function getLanguageComparator(): LanguageComparatorInterface - { - return $this->languageComparator ??= new LanguageComparator(); - } - - public function withLanguageComparator(LanguageComparatorInterface $languageComparator): self - { - $clone = clone $this; - $clone->languageComparator = $languageComparator; - - return $clone; - } - - public function getMediaTypeComparator(): MediaTypeComparatorInterface - { - return $this->mediaTypeComparator ??= new MediaTypeComparator(); - } - - public function withMediaTypeComparator(MediaTypeComparatorInterface $mediaTypeComparator): self - { - $clone = clone $this; - $clone->mediaTypeComparator = $mediaTypeComparator; - - return $clone; - } - /** * @throws LogicException If the request doesn't contain a route. */ @@ -97,26 +76,35 @@ public function getRoute(): RouteInterface return $route; } - public function getClientProducedMediaType(): ?ClientMediaType + public function getClientProducedMediaType(): ?MediaType { $values = HeaderParser::parseHeader($this->request->getHeaderLine('Content-Type')); if ($values === []) { return null; } - [$identifier, $parameters] = reset($values); + [$identifier] = reset($values); if (preg_match('|^([^/*]+)/([^/*]+)$|', $identifier) === 1) { - return new ClientMediaType($identifier, $parameters); + return new MediaType($identifier); } return null; } /** - * @return Generator, ClientLanguage> + * @return Generator + * + * @throws LogicException */ - public function getClientConsumedLanguages(): Generator + public function getClientConsumedLocales(): Generator { + if (!extension_loaded('intl')) { + throw new LogicException( + 'To get the locales consumed by the client, ' . + 'the Intl (https://www.php.net/intl) extension must be installed.' + ); + } + $values = HeaderParser::parseHeader($this->request->getHeaderLine('Accept-Language')); if ($values === []) { return; @@ -127,16 +115,16 @@ public function getClientConsumedLanguages(): Generator (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') )); - /** @phpstan-var int<0, max> $index */ - foreach ($values as $index => [$identifier, $parameters]) { - if (preg_match('|^(?:i-)?([^-]+)(?:-[^-]+)*$|', $identifier, $matches) === 1) { - yield $index => new ClientLanguage($matches[1], $identifier, $parameters); + foreach ($values as [$identifier]) { + $subtags = \Locale::parseLocale($identifier); + if (isset($subtags['language'])) { + yield new Locale($subtags['language'], $subtags['region'] ?? null); } } } /** - * @return Generator, ClientMediaType> + * @return Generator, MediaType> */ public function getClientConsumedMediaTypes(): Generator { @@ -151,24 +139,30 @@ public function getClientConsumedMediaTypes(): Generator )); /** @phpstan-var int<0, max> $index */ - foreach ($values as $index => [$identifier, $parameters]) { + foreach ($values as $index => [$identifier]) { if (preg_match('|^([^/]+)/([^/]+)$|', $identifier) === 1) { - yield $index => new ClientMediaType($identifier, $parameters); + yield $index => new MediaType($identifier); } } } - public function getClientPreferredLanguage(LanguageInterface ...$serverProducedLanguages): ?ClientLanguage + /** + * @param T ...$serverProducedLocales + * + * @return T|null + * + * @template T of LocaleInterface + */ + public function getClientPreferredLocale(LocaleInterface ...$serverProducedLocales): ?LocaleInterface { - if ($serverProducedLanguages === []) { + if ($serverProducedLocales === []) { return null; } - $languageComparator = $this->getLanguageComparator(); - foreach ($this->getClientConsumedLanguages() as $clientConsumedLanguage) { - foreach ($serverProducedLanguages as $serverProducedLanguage) { - if ($languageComparator->compare($clientConsumedLanguage, $serverProducedLanguage) === 0) { - return $clientConsumedLanguage; + foreach ($this->getClientConsumedLocales() as $clientConsumedLanguage) { + foreach ($serverProducedLocales as $serverProducedLanguage) { + if ($this->localeComparator->compare($clientConsumedLanguage, $serverProducedLanguage) === 0) { + return $serverProducedLanguage; } } } @@ -176,17 +170,23 @@ public function getClientPreferredLanguage(LanguageInterface ...$serverProducedL return null; } - public function getClientPreferredMediaType(MediaTypeInterface ...$serverProducedMediaTypes): ?ClientMediaType + /** + * @param T ...$serverProducedMediaTypes + * + * @return T|null + * + * @template T of MediaTypeInterface + */ + public function getClientPreferredMediaType(MediaTypeInterface ...$serverProducedMediaTypes): ?MediaTypeInterface { if ($serverProducedMediaTypes === []) { return null; } - $mediaTypeComparator = $this->getMediaTypeComparator(); foreach ($this->getClientConsumedMediaTypes() as $clientConsumedMediaType) { foreach ($serverProducedMediaTypes as $serverProducedMediaType) { - if ($mediaTypeComparator->compare($clientConsumedMediaType, $serverProducedMediaType) === 0) { - return $clientConsumedMediaType; + if ($this->mediaTypeComparator->compare($clientConsumedMediaType, $serverProducedMediaType) === 0) { + return $serverProducedMediaType; } } } @@ -206,9 +206,8 @@ public function clientProducesMediaType(MediaTypeInterface ...$serverConsumedMed return false; } - $mediaTypeComparator = $this->getMediaTypeComparator(); foreach ($serverConsumedMediaTypes as $serverConsumedMediaType) { - if ($mediaTypeComparator->compare($clientProducedMediaType, $serverConsumedMediaType) === 0) { + if ($this->mediaTypeComparator->compare($clientProducedMediaType, $serverConsumedMediaType) === 0) { return true; } } @@ -218,12 +217,12 @@ public function clientProducesMediaType(MediaTypeInterface ...$serverConsumedMed public function isJsonPayload(): bool { - return $this->clientProducesMediaType(MediaTypeFactory::json()); + return $this->clientProducesMediaType(MediaType::json()); } public function isXmlPayload(): bool { - return $this->clientProducesMediaType(MediaTypeFactory::xml()); + return $this->clientProducesMediaType(MediaType::xml()); } /** diff --git a/src/Validation/Constraint/ArgumentConstraint.php b/src/Validation/Constraint/ArgumentConstraint.php index ec2639fc..11db47a6 100644 --- a/src/Validation/Constraint/ArgumentConstraint.php +++ b/src/Validation/Constraint/ArgumentConstraint.php @@ -19,12 +19,13 @@ /** * @since 3.0.0 * - * @psalm-suppress PropertyNotSetInConstructor See {@see parent::$groups}. + * @psalm-suppress PropertyNotSetInConstructor {@see parent::$groups} */ final class ArgumentConstraint extends Constraint { - public function __construct(private readonly ReflectionParameter $parameter) - { + public function __construct( + private readonly ReflectionParameter $parameter, + ) { parent::__construct(); } diff --git a/src/Validation/Constraint/ArgumentConstraintValidator.php b/src/Validation/Constraint/ArgumentConstraintValidator.php index fe3147ee..9cb02448 100644 --- a/src/Validation/Constraint/ArgumentConstraintValidator.php +++ b/src/Validation/Constraint/ArgumentConstraintValidator.php @@ -53,6 +53,9 @@ public function validate(mixed $value, Constraint $constraint): void return; } - $this->context->getValidator()->inContext($this->context)->validate($value, $constraints); + $this->context + ->getValidator() + ->inContext($this->context) + ->validate($value, $constraints); } } diff --git a/src/functions/emit.php b/src/functions/emit.php index 31bb9bf2..d7c55e2a 100644 --- a/src/functions/emit.php +++ b/src/functions/emit.php @@ -18,6 +18,9 @@ use function header; use function sprintf; +/** + * @since 2.0.0 + */ function emit(ResponseInterface $response): void { header(sprintf( diff --git a/tests/Command/RouterClearCacheCommandTest.php b/tests/Command/RouterClearCacheCommandTest.php index 4d9b7b69..aeb7ecdf 100644 --- a/tests/Command/RouterClearCacheCommandTest.php +++ b/tests/Command/RouterClearCacheCommandTest.php @@ -6,36 +6,24 @@ use PHPUnit\Framework\MockObject\MockObject; use PHPUnit\Framework\TestCase; -use Psr\SimpleCache\CacheInterface; use Sunrise\Http\Router\Command\RouterClearDescriptorsCacheCommand; -use Sunrise\Http\Router\Loader\DescriptorLoader; +use Sunrise\Http\Router\Loader\DescriptorLoaderInterface; use Symfony\Component\Console\Tester\CommandTester; final class RouterClearCacheCommandTest extends TestCase { - private CacheInterface&MockObject $cacheMock; + private DescriptorLoaderInterface&MockObject $descriptorLoader; protected function setUp(): void { - $this->cacheMock = $this->createMock(CacheInterface::class); + $this->descriptorLoader = $this->createMock(DescriptorLoaderInterface::class); } - public function testExecuteWithCache(): void + public function testExecute(): void { - $this->cacheMock->expects(self::once()) - ->method('delete') - ->with(DescriptorLoader::DESCRIPTORS_CACHE_KEY); + $this->descriptorLoader->expects(self::once())->method('clearCache'); - $descriptorLoader = new DescriptorLoader([], $this->cacheMock); - $command = new RouterClearDescriptorsCacheCommand($descriptorLoader); - $commandTester = new CommandTester($command); - $this->assertSame(0, $commandTester->execute([])); - } - - public function testExecuteWithoutCache(): void - { - $descriptorLoader = new DescriptorLoader([]); - $command = new RouterClearDescriptorsCacheCommand($descriptorLoader); + $command = new RouterClearDescriptorsCacheCommand($this->descriptorLoader); $commandTester = new CommandTester($command); $this->assertSame(0, $commandTester->execute([])); } diff --git a/tests/Entity/Language/ClientLanguageTest.php b/tests/Entity/Language/ClientLanguageTest.php index 94fb7411..4c6558dd 100644 --- a/tests/Entity/Language/ClientLanguageTest.php +++ b/tests/Entity/Language/ClientLanguageTest.php @@ -5,15 +5,15 @@ namespace Sunrise\Http\Router\Tests\Entity\Language; use PHPUnit\Framework\TestCase; -use Sunrise\Http\Router\Entity\Language\ClientLanguage; +use Sunrise\Http\Router\Entity\Locale\Locale; final class ClientLanguageTest extends TestCase { public function testConstructor(): void { - $clientLanguage = new ClientLanguage('sr', 'sr-RS', ['q' => '1.0']); - $this->assertSame('sr', $clientLanguage->getCode()); - $this->assertSame('sr-RS', $clientLanguage->getLocale()); + $clientLanguage = new Locale('sr', 'sr-RS', ['q' => '1.0']); + $this->assertSame('sr', $clientLanguage->getLanguageCode()); + $this->assertSame('sr-RS', $clientLanguage->getLanguageCode()); $this->assertSame(['q' => '1.0'], $clientLanguage->getParameters()); } } diff --git a/tests/Entity/Language/LanguageComparatorTest.php b/tests/Entity/Language/LanguageComparatorTest.php index 8adf4229..d32fae5e 100644 --- a/tests/Entity/Language/LanguageComparatorTest.php +++ b/tests/Entity/Language/LanguageComparatorTest.php @@ -7,8 +7,8 @@ use PHPUnit\Framework\Attributes\DataProvider; use PHPUnit\Framework\MockObject\MockObject; use PHPUnit\Framework\TestCase; -use Sunrise\Http\Router\Entity\Language\LanguageComparator; -use Sunrise\Http\Router\Entity\Language\LanguageInterface; +use Sunrise\Http\Router\Entity\Locale\LocaleComparator; +use Sunrise\Http\Router\Entity\Locale\LocaleInterface; final class LanguageComparatorTest extends TestCase { @@ -18,7 +18,7 @@ public function testCompare(string $aCode, string $bCode, int $expected): void $a = $this->mockLanguage(code: $aCode); $b = $this->mockLanguage(code: $bCode); - $this->assertSame($expected, (new LanguageComparator())->compare($a, $b)); + $this->assertSame($expected, (new LocaleComparator())->compare($a, $b)); } public static function compareDataProvider(): iterable @@ -90,10 +90,10 @@ public static function compareDataProvider(): iterable ]; } - private function mockLanguage(string $code): LanguageInterface&MockObject + private function mockLanguage(string $code): LocaleInterface&MockObject { - $language = $this->createMock(LanguageInterface::class); - $language->method('getCode')->willReturn($code); + $language = $this->createMock(LocaleInterface::class); + $language->method('getLanguageCode')->willReturn($code); return $language; } From 3c89c7f25f2480051f6bc853a98473bce10e90f3 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 7 Nov 2024 16:09:47 +0100 Subject: [PATCH 174/180] v3 --- src/Entity/MediaType/MediaTypeComparator.php | 19 ++----------------- 1 file changed, 2 insertions(+), 17 deletions(-) diff --git a/src/Entity/MediaType/MediaTypeComparator.php b/src/Entity/MediaType/MediaTypeComparator.php index 4520e319..ca0044f4 100644 --- a/src/Entity/MediaType/MediaTypeComparator.php +++ b/src/Entity/MediaType/MediaTypeComparator.php @@ -26,26 +26,11 @@ final class MediaTypeComparator implements MediaTypeComparatorInterface */ public function compare(MediaTypeInterface $a, MediaTypeInterface $b): int { - $aId = $a->getIdentifier(); - if ($aId === '*/*') { - return 0; - } - - $bId = $b->getIdentifier(); - if ($bId === '*/*') { - return 0; - } - - $aId = strtolower($aId); - $bId = strtolower($bId); - - if ($aId === $bId) { - return 0; - } - + $aId = strtolower($a->getIdentifier()); $aParts = explode('/', $aId, 2); $aParts[1] ??= ''; + $bId = strtolower($b->getIdentifier()); $bParts = explode('/', $bId, 2); $bParts[1] ??= ''; From d8edc827de485490a36bd4ccd5135a4249dd117c Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 9 Jan 2025 15:00:50 +0100 Subject: [PATCH 175/180] v3 --- src/Annotation/ConsumesJson.php | 4 +- src/Annotation/ConsumesXml.php | 4 +- src/Annotation/{Method => }/DeleteMethod.php | 6 +-- .../{Response => }/EmptyResponse.php | 2 +- src/Annotation/{Method => }/GetMethod.php | 6 +-- src/Annotation/{Method => }/HeadMethod.php | 6 +-- .../{Response => }/JsonResponse.php | 2 +- src/Annotation/{Method => }/OptionsMethod.php | 6 +-- src/Annotation/{Method => }/PatchMethod.php | 6 +-- src/Annotation/{Method => }/PostMethod.php | 6 +-- src/Annotation/ProducesJson.php | 4 +- src/Annotation/ProducesXml.php | 4 +- src/Annotation/{Method => }/PurgeMethod.php | 6 +-- src/Annotation/{Method => }/PutMethod.php | 6 +-- .../AsciiSlugPattern.php => SlugPattern.php} | 7 ++- ...gnedIntegerPattern.php => UintPattern.php} | 7 ++- src/Annotation/{Pattern => }/UuidPattern.php | 3 +- .../RouterClearDescriptorsCacheCommand.php | 2 +- src/Command/RouterListRoutesCommand.php | 10 +++-- .../MediaType.php} | 17 +++++--- src/Entity/Locale/Locale.php | 2 +- src/Entity/Locale/LocaleComparator.php | 6 +-- src/Entity/MediaType/MediaType.php | 13 ------ src/Entity/MediaType/MediaTypeComparator.php | 8 ++-- .../MediaTypeComparatorInterface.php | 25 ----------- src/Event/RoutePostRunEvent.php | 26 ++--------- src/Event/RoutePreRunEvent.php | 19 +------- src/Exception/ExceptionInterface.php | 23 ---------- src/Exception/HttpException.php | 40 +++++------------ src/Exception/HttpExceptionFactory.php | 32 +++++++------- src/Exception/HttpExceptionInterface.php | 43 ------------------- ...outerClearDescriptorsCacheCommandTest.php} | 0 .../LocaleComparatorTest.php} | 0 .../LocaleTest.php} | 0 ...entMediaTypeTest.php => MediaTypeTest.php} | 0 35 files changed, 99 insertions(+), 252 deletions(-) rename src/Annotation/{Method => }/DeleteMethod.php (78%) rename src/Annotation/{Response => }/EmptyResponse.php (90%) rename src/Annotation/{Method => }/GetMethod.php (78%) rename src/Annotation/{Method => }/HeadMethod.php (78%) rename src/Annotation/{Response => }/JsonResponse.php (92%) rename src/Annotation/{Method => }/OptionsMethod.php (78%) rename src/Annotation/{Method => }/PatchMethod.php (78%) rename src/Annotation/{Method => }/PostMethod.php (78%) rename src/Annotation/{Method => }/PurgeMethod.php (78%) rename src/Annotation/{Method => }/PutMethod.php (78%) rename src/Annotation/{Pattern/AsciiSlugPattern.php => SlugPattern.php} (73%) rename src/Annotation/{Pattern/UnsignedIntegerPattern.php => UintPattern.php} (72%) rename src/Annotation/{Pattern => }/UuidPattern.php (88%) rename src/{Entity/Locale/LocaleComparatorInterface.php => Dictionary/MediaType.php} (53%) delete mode 100644 src/Entity/MediaType/MediaTypeComparatorInterface.php delete mode 100644 src/Exception/ExceptionInterface.php delete mode 100644 src/Exception/HttpExceptionInterface.php rename tests/Command/{RouterClearCacheCommandTest.php => RouterClearDescriptorsCacheCommandTest.php} (100%) rename tests/Entity/{Language/LanguageComparatorTest.php => Locale/LocaleComparatorTest.php} (100%) rename tests/Entity/{Language/ClientLanguageTest.php => Locale/LocaleTest.php} (100%) rename tests/Entity/MediaType/{ClientMediaTypeTest.php => MediaTypeTest.php} (100%) diff --git a/src/Annotation/ConsumesJson.php b/src/Annotation/ConsumesJson.php index 362b75b1..3d289ae9 100644 --- a/src/Annotation/ConsumesJson.php +++ b/src/Annotation/ConsumesJson.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaType; +use Sunrise\Http\Router\Dictionary\MediaType; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ConsumesJson extends Consumes { public function __construct() { - parent::__construct(MediaType::json()); + parent::__construct(MediaType::JSON); } } diff --git a/src/Annotation/ConsumesXml.php b/src/Annotation/ConsumesXml.php index 929d03a9..e09458f9 100644 --- a/src/Annotation/ConsumesXml.php +++ b/src/Annotation/ConsumesXml.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaType; +use Sunrise\Http\Router\Dictionary\MediaType; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ConsumesXml extends Consumes { public function __construct() { - parent::__construct(MediaType::xml()); + parent::__construct(MediaType::XML); } } diff --git a/src/Annotation/Method/DeleteMethod.php b/src/Annotation/DeleteMethod.php similarity index 78% rename from src/Annotation/Method/DeleteMethod.php rename to src/Annotation/DeleteMethod.php index ea98d321..d9918cc2 100644 --- a/src/Annotation/Method/DeleteMethod.php +++ b/src/Annotation/DeleteMethod.php @@ -11,10 +11,10 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Method; +namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Annotation\Method; +use Fig\Http\Message\RequestMethodInterface; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class DeleteMethod extends Method { public function __construct() { - parent::__construct(self::METHOD_DELETE); + parent::__construct(RequestMethodInterface::METHOD_DELETE); } } diff --git a/src/Annotation/Response/EmptyResponse.php b/src/Annotation/EmptyResponse.php similarity index 90% rename from src/Annotation/Response/EmptyResponse.php rename to src/Annotation/EmptyResponse.php index 73ed8e39..20fed114 100644 --- a/src/Annotation/Response/EmptyResponse.php +++ b/src/Annotation/EmptyResponse.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Response; +namespace Sunrise\Http\Router\Annotation; use Attribute; diff --git a/src/Annotation/Method/GetMethod.php b/src/Annotation/GetMethod.php similarity index 78% rename from src/Annotation/Method/GetMethod.php rename to src/Annotation/GetMethod.php index e2c4408e..c8c8754c 100644 --- a/src/Annotation/Method/GetMethod.php +++ b/src/Annotation/GetMethod.php @@ -11,10 +11,10 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Method; +namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Annotation\Method; +use Fig\Http\Message\RequestMethodInterface; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class GetMethod extends Method { public function __construct() { - parent::__construct(self::METHOD_GET); + parent::__construct(RequestMethodInterface::METHOD_GET); } } diff --git a/src/Annotation/Method/HeadMethod.php b/src/Annotation/HeadMethod.php similarity index 78% rename from src/Annotation/Method/HeadMethod.php rename to src/Annotation/HeadMethod.php index 3de0e88b..4ab35b09 100644 --- a/src/Annotation/Method/HeadMethod.php +++ b/src/Annotation/HeadMethod.php @@ -11,10 +11,10 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Method; +namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Annotation\Method; +use Fig\Http\Message\RequestMethodInterface; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class HeadMethod extends Method { public function __construct() { - parent::__construct(self::METHOD_HEAD); + parent::__construct(RequestMethodInterface::METHOD_HEAD); } } diff --git a/src/Annotation/Response/JsonResponse.php b/src/Annotation/JsonResponse.php similarity index 92% rename from src/Annotation/Response/JsonResponse.php rename to src/Annotation/JsonResponse.php index 1acd3c9a..9910aac6 100644 --- a/src/Annotation/Response/JsonResponse.php +++ b/src/Annotation/JsonResponse.php @@ -11,7 +11,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Response; +namespace Sunrise\Http\Router\Annotation; use Attribute; diff --git a/src/Annotation/Method/OptionsMethod.php b/src/Annotation/OptionsMethod.php similarity index 78% rename from src/Annotation/Method/OptionsMethod.php rename to src/Annotation/OptionsMethod.php index 22442b97..a9cc090a 100644 --- a/src/Annotation/Method/OptionsMethod.php +++ b/src/Annotation/OptionsMethod.php @@ -11,10 +11,10 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Method; +namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Annotation\Method; +use Fig\Http\Message\RequestMethodInterface; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class OptionsMethod extends Method { public function __construct() { - parent::__construct(self::METHOD_OPTIONS); + parent::__construct(RequestMethodInterface::METHOD_OPTIONS); } } diff --git a/src/Annotation/Method/PatchMethod.php b/src/Annotation/PatchMethod.php similarity index 78% rename from src/Annotation/Method/PatchMethod.php rename to src/Annotation/PatchMethod.php index 77106487..23858358 100644 --- a/src/Annotation/Method/PatchMethod.php +++ b/src/Annotation/PatchMethod.php @@ -11,10 +11,10 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Method; +namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Annotation\Method; +use Fig\Http\Message\RequestMethodInterface; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class PatchMethod extends Method { public function __construct() { - parent::__construct(self::METHOD_PATCH); + parent::__construct(RequestMethodInterface::METHOD_PATCH); } } diff --git a/src/Annotation/Method/PostMethod.php b/src/Annotation/PostMethod.php similarity index 78% rename from src/Annotation/Method/PostMethod.php rename to src/Annotation/PostMethod.php index 4775b357..ad439e12 100644 --- a/src/Annotation/Method/PostMethod.php +++ b/src/Annotation/PostMethod.php @@ -11,10 +11,10 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Method; +namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Annotation\Method; +use Fig\Http\Message\RequestMethodInterface; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class PostMethod extends Method { public function __construct() { - parent::__construct(self::METHOD_POST); + parent::__construct(RequestMethodInterface::METHOD_POST); } } diff --git a/src/Annotation/ProducesJson.php b/src/Annotation/ProducesJson.php index 778a8331..324413bf 100644 --- a/src/Annotation/ProducesJson.php +++ b/src/Annotation/ProducesJson.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaType; +use Sunrise\Http\Router\Dictionary\MediaType; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ProducesJson extends Produces { public function __construct() { - parent::__construct(MediaType::json()); + parent::__construct(MediaType::JSON); } } diff --git a/src/Annotation/ProducesXml.php b/src/Annotation/ProducesXml.php index e3716c54..deca49dd 100644 --- a/src/Annotation/ProducesXml.php +++ b/src/Annotation/ProducesXml.php @@ -14,7 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Entity\MediaType\MediaType; +use Sunrise\Http\Router\Dictionary\MediaType; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class ProducesXml extends Produces { public function __construct() { - parent::__construct(MediaType::xml()); + parent::__construct(MediaType::XML); } } diff --git a/src/Annotation/Method/PurgeMethod.php b/src/Annotation/PurgeMethod.php similarity index 78% rename from src/Annotation/Method/PurgeMethod.php rename to src/Annotation/PurgeMethod.php index 835c4372..59cf127b 100644 --- a/src/Annotation/Method/PurgeMethod.php +++ b/src/Annotation/PurgeMethod.php @@ -11,10 +11,10 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Method; +namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Annotation\Method; +use Fig\Http\Message\RequestMethodInterface; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class PurgeMethod extends Method { public function __construct() { - parent::__construct(self::METHOD_PURGE); + parent::__construct(RequestMethodInterface::METHOD_PURGE); } } diff --git a/src/Annotation/Method/PutMethod.php b/src/Annotation/PutMethod.php similarity index 78% rename from src/Annotation/Method/PutMethod.php rename to src/Annotation/PutMethod.php index 35c6b530..abb1a392 100644 --- a/src/Annotation/Method/PutMethod.php +++ b/src/Annotation/PutMethod.php @@ -11,10 +11,10 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Method; +namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Annotation\Method; +use Fig\Http\Message\RequestMethodInterface; /** * @since 3.0.0 @@ -24,6 +24,6 @@ final class PutMethod extends Method { public function __construct() { - parent::__construct(self::METHOD_PUT); + parent::__construct(RequestMethodInterface::METHOD_PUT); } } diff --git a/src/Annotation/Pattern/AsciiSlugPattern.php b/src/Annotation/SlugPattern.php similarity index 73% rename from src/Annotation/Pattern/AsciiSlugPattern.php rename to src/Annotation/SlugPattern.php index be4dcae3..2138a54a 100644 --- a/src/Annotation/Pattern/AsciiSlugPattern.php +++ b/src/Annotation/SlugPattern.php @@ -11,20 +11,19 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Pattern; +namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Annotation\Pattern; use Sunrise\Http\Router\Dictionary\VariablePattern; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class AsciiSlugPattern extends Pattern +final class SlugPattern extends Pattern { public function __construct(string $variableName) { - parent::__construct($variableName, VariablePattern::ASCII_SLUG); + parent::__construct($variableName, VariablePattern::SLUG); } } diff --git a/src/Annotation/Pattern/UnsignedIntegerPattern.php b/src/Annotation/UintPattern.php similarity index 72% rename from src/Annotation/Pattern/UnsignedIntegerPattern.php rename to src/Annotation/UintPattern.php index 6d3c7059..c503aa48 100644 --- a/src/Annotation/Pattern/UnsignedIntegerPattern.php +++ b/src/Annotation/UintPattern.php @@ -11,20 +11,19 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Pattern; +namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Annotation\Pattern; use Sunrise\Http\Router\Dictionary\VariablePattern; /** * @since 3.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] -final class UnsignedIntegerPattern extends Pattern +final class UintPattern extends Pattern { public function __construct(string $variableName) { - parent::__construct($variableName, VariablePattern::UNSIGNED_INTEGER); + parent::__construct($variableName, VariablePattern::UINT); } } diff --git a/src/Annotation/Pattern/UuidPattern.php b/src/Annotation/UuidPattern.php similarity index 88% rename from src/Annotation/Pattern/UuidPattern.php rename to src/Annotation/UuidPattern.php index 5b5cb53f..bd7b486a 100644 --- a/src/Annotation/Pattern/UuidPattern.php +++ b/src/Annotation/UuidPattern.php @@ -11,10 +11,9 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Annotation\Pattern; +namespace Sunrise\Http\Router\Annotation; use Attribute; -use Sunrise\Http\Router\Annotation\Pattern; use Sunrise\Http\Router\Dictionary\VariablePattern; /** diff --git a/src/Command/RouterClearDescriptorsCacheCommand.php b/src/Command/RouterClearDescriptorsCacheCommand.php index f929a9e6..420ef01b 100644 --- a/src/Command/RouterClearDescriptorsCacheCommand.php +++ b/src/Command/RouterClearDescriptorsCacheCommand.php @@ -38,7 +38,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int { $this->descriptorLoader->clearCache(); - $output->writeln('Ok'); + $output->writeln('Done'); return self::SUCCESS; } diff --git a/src/Command/RouterListRoutesCommand.php b/src/Command/RouterListRoutesCommand.php index ea06a3ab..c3d1841c 100644 --- a/src/Command/RouterListRoutesCommand.php +++ b/src/Command/RouterListRoutesCommand.php @@ -20,7 +20,7 @@ use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; -use function join; +use function implode; /** * @since 2.9.0 @@ -41,13 +41,17 @@ protected function execute(InputInterface $input, OutputInterface $output): int { $table = new Table($output); - $table->setHeaders(['NAME', 'PATH', 'VERBS']); + $table->setHeaders([ + 'NAME', + 'PATH', + 'METHOD(S)', + ]); foreach ($this->router->getRoutes() as $route) { $table->addRow([ $route->getName(), $route->getPath(), - $route->getMethods() === [] ? '*' : join(', ', $route->getMethods()), + $route->getMethods() === [] ? '*' : implode(', ', $route->getMethods()), ]); } diff --git a/src/Entity/Locale/LocaleComparatorInterface.php b/src/Dictionary/MediaType.php similarity index 53% rename from src/Entity/Locale/LocaleComparatorInterface.php rename to src/Dictionary/MediaType.php index 0f4f94df..744b9463 100644 --- a/src/Entity/Locale/LocaleComparatorInterface.php +++ b/src/Dictionary/MediaType.php @@ -11,15 +11,20 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Entity\Locale; +namespace Sunrise\Http\Router\Dictionary; + +use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; /** * @since 3.0.0 */ -interface LocaleComparatorInterface +enum MediaType: string implements MediaTypeInterface { - /** - * @return int<-1, 1> - */ - public function compare(LocaleInterface $a, LocaleInterface $b): int; + case Json = 'application/json'; + case Xml = 'application/xml'; + + public function getIdentifier(): string + { + return $this->value; + } } diff --git a/src/Entity/Locale/Locale.php b/src/Entity/Locale/Locale.php index bda26121..b23189a0 100644 --- a/src/Entity/Locale/Locale.php +++ b/src/Entity/Locale/Locale.php @@ -29,7 +29,7 @@ public function getLanguageCode(): string return $this->languageCode; } - public function getRegionCode(): string + public function getRegionCode(): ?string { return $this->regionCode; } diff --git a/src/Entity/Locale/LocaleComparator.php b/src/Entity/Locale/LocaleComparator.php index f83b0439..7a91595c 100644 --- a/src/Entity/Locale/LocaleComparator.php +++ b/src/Entity/Locale/LocaleComparator.php @@ -16,12 +16,12 @@ /** * @since 3.0.0 */ -final class LocaleComparator implements LocaleComparatorInterface +final class LocaleComparator { /** - * @inheritDoc + * @return int<-1, 1> */ - public function compare(LocaleInterface $a, LocaleInterface $b): int + public static function compare(LocaleInterface $a, LocaleInterface $b): int { $aLanguageCode = $a->getLanguageCode(); if ($aLanguageCode === '*') { diff --git a/src/Entity/MediaType/MediaType.php b/src/Entity/MediaType/MediaType.php index fb1c9f4f..a0020200 100644 --- a/src/Entity/MediaType/MediaType.php +++ b/src/Entity/MediaType/MediaType.php @@ -18,24 +18,11 @@ */ final class MediaType implements MediaTypeInterface { - public const IDENTIFIER_JSON = 'application/json'; - public const IDENTIFIER_XML = 'application/xml'; - public function __construct( private readonly string $identifier, ) { } - public static function json(): self - { - return new self(self::IDENTIFIER_JSON); - } - - public static function xml(): self - { - return new self(self::IDENTIFIER_XML); - } - public function getIdentifier(): string { return $this->identifier; diff --git a/src/Entity/MediaType/MediaTypeComparator.php b/src/Entity/MediaType/MediaTypeComparator.php index ca0044f4..2bcd4bbf 100644 --- a/src/Entity/MediaType/MediaTypeComparator.php +++ b/src/Entity/MediaType/MediaTypeComparator.php @@ -19,12 +19,12 @@ /** * @since 3.0.0 */ -final class MediaTypeComparator implements MediaTypeComparatorInterface +final class MediaTypeComparator { /** - * @inheritDoc + * @return int<-1, 1> */ - public function compare(MediaTypeInterface $a, MediaTypeInterface $b): int + public static function compare(MediaTypeInterface $a, MediaTypeInterface $b): int { $aId = strtolower($a->getIdentifier()); $aParts = explode('/', $aId, 2); @@ -37,6 +37,6 @@ public function compare(MediaTypeInterface $a, MediaTypeInterface $b): int $sameTypes = $aParts[0] === $bParts[0] || $aParts[0] === '*' || $bParts[0] === '*'; $sameSubtypes = $aParts[1] === $bParts[1] || $aParts[1] === '*' || $bParts[1] === '*'; - return ($sameTypes && $sameSubtypes) ? 0 : $aId <=> $bId; + return $sameTypes && $sameSubtypes ? 0 : $aId <=> $bId; } } diff --git a/src/Entity/MediaType/MediaTypeComparatorInterface.php b/src/Entity/MediaType/MediaTypeComparatorInterface.php deleted file mode 100644 index 3380a7fe..00000000 --- a/src/Entity/MediaType/MediaTypeComparatorInterface.php +++ /dev/null @@ -1,25 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Entity\MediaType; - -/** - * @since 3.0.0 - */ -interface MediaTypeComparatorInterface -{ - /** - * @return int<-1, 1> - */ - public function compare(MediaTypeInterface $a, MediaTypeInterface $b): int; -} diff --git a/src/Event/RoutePostRunEvent.php b/src/Event/RoutePostRunEvent.php index 53c1c356..42b3c3d9 100644 --- a/src/Event/RoutePostRunEvent.php +++ b/src/Event/RoutePostRunEvent.php @@ -23,29 +23,9 @@ final class RoutePostRunEvent { public function __construct( - private readonly RouteInterface $route, - private readonly ServerRequestInterface $request, - private ResponseInterface $response, + public readonly RouteInterface $route, + public readonly ServerRequestInterface $request, + public ResponseInterface $response, ) { } - - public function getRoute(): RouteInterface - { - return $this->route; - } - - public function getRequest(): ServerRequestInterface - { - return $this->request; - } - - public function getResponse(): ResponseInterface - { - return $this->response; - } - - public function setResponse(ResponseInterface $response): void - { - $this->response = $response; - } } diff --git a/src/Event/RoutePreRunEvent.php b/src/Event/RoutePreRunEvent.php index 2633e0d8..97b80419 100644 --- a/src/Event/RoutePreRunEvent.php +++ b/src/Event/RoutePreRunEvent.php @@ -22,23 +22,8 @@ final class RoutePreRunEvent { public function __construct( - private readonly RouteInterface $route, - private ServerRequestInterface $request, + public readonly RouteInterface $route, + public ServerRequestInterface $request, ) { } - - public function getRoute(): RouteInterface - { - return $this->route; - } - - public function getRequest(): ServerRequestInterface - { - return $this->request; - } - - public function setRequest(ServerRequestInterface $request): void - { - $this->request = $request; - } } diff --git a/src/Exception/ExceptionInterface.php b/src/Exception/ExceptionInterface.php deleted file mode 100644 index 27c430aa..00000000 --- a/src/Exception/ExceptionInterface.php +++ /dev/null @@ -1,23 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use Throwable; - -/** - * @since 2.0.0 - */ -interface ExceptionInterface extends Throwable -{ -} diff --git a/src/Exception/HttpException.php b/src/Exception/HttpException.php index 3a94bdd2..527916e2 100644 --- a/src/Exception/HttpException.php +++ b/src/Exception/HttpException.php @@ -13,21 +13,19 @@ namespace Sunrise\Http\Router\Exception; +use Fig\Http\Message\StatusCodeInterface; use RuntimeException; use Stringable; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Http\Router\Validation\ConstraintViolationInterface; use Throwable; -use function array_map; -use function join; +use function implode; use function strtr; /** * @since 3.0.0 */ -class HttpException extends RuntimeException implements HttpExceptionInterface +class HttpException extends RuntimeException implements StatusCodeInterface { /** * The exception's non-interpolated message. @@ -40,12 +38,12 @@ class HttpException extends RuntimeException implements HttpExceptionInterface private array $messagePlaceholders = []; /** - * @var array + * @var list */ private array $headerFields = []; /** - * @var array + * @var list */ private array $constraintViolations = []; @@ -57,7 +55,7 @@ public function __construct(string $message, int $code, ?Throwable $previous = n } /** - * @inheritDoc + * Returns the exception's non-interpolated message. */ final public function getMessageTemplate(): string { @@ -65,7 +63,7 @@ final public function getMessageTemplate(): string } /** - * @inheritDoc + * @return array */ final public function getMessagePlaceholders(): array { @@ -73,7 +71,7 @@ final public function getMessagePlaceholders(): array } /** - * @inheritDoc + * @return list */ final public function getHeaderFields(): array { @@ -81,7 +79,7 @@ final public function getHeaderFields(): array } /** - * @inheritDoc + * @return list */ final public function getConstraintViolations(): array { @@ -100,7 +98,7 @@ final public function addMessagePlaceholder(string $placeholder, mixed $replacem final public function addHeaderField(string $fieldName, string|Stringable ...$fieldValues): static { // https://datatracker.ietf.org/doc/html/rfc7230#section-7 - $fieldValue = join(', ', $fieldValues); + $fieldValue = implode(', ', $fieldValues); $this->headerFields[] = [$fieldName, $fieldValue]; @@ -115,22 +113,4 @@ final public function addConstraintViolation(ConstraintViolationInterface ...$co return $this; } - - final public function addHydratorConstraintViolation( - \Sunrise\Hydrator\Exception\InvalidValueException ...$constraintViolations - ): static { - return $this->addConstraintViolation(...array_map( - HydratorConstraintViolationAdapter::create(...), - $constraintViolations, - )); - } - - final public function addValidatorConstraintViolation( - \Symfony\Component\Validator\ConstraintViolationInterface ...$constraintViolations - ): static { - return $this->addConstraintViolation(...array_map( - ValidatorConstraintViolationAdapter::create(...), - $constraintViolations, - )); - } } diff --git a/src/Exception/HttpExceptionFactory.php b/src/Exception/HttpExceptionFactory.php index a85654ce..3604661c 100644 --- a/src/Exception/HttpExceptionFactory.php +++ b/src/Exception/HttpExceptionFactory.php @@ -20,7 +20,7 @@ /** * @since 3.0.0 */ -final class HttpExceptionFactory implements StatusCodeInterface +final class HttpExceptionFactory { public static function malformedUri( ?string $message = null, @@ -29,7 +29,7 @@ public static function malformedUri( ): HttpException { return new HttpException( $message ?? ErrorMessage::MALFORMED_URI, - $code ?? self::STATUS_BAD_REQUEST, + $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, $previous, ); } @@ -41,7 +41,7 @@ public static function resourceNotFound( ): HttpException { return new HttpException( $message ?? ErrorMessage::RESOURCE_NOT_FOUND, - $code ?? self::STATUS_NOT_FOUND, + $code ?? StatusCodeInterface::STATUS_NOT_FOUND, $previous, ); } @@ -53,7 +53,7 @@ public static function methodNotAllowed( ): HttpException { return new HttpException( $message ?? ErrorMessage::METHOD_NOT_ALLOWED, - $code ?? self::STATUS_METHOD_NOT_ALLOWED, + $code ?? StatusCodeInterface::STATUS_METHOD_NOT_ALLOWED, $previous, ); } @@ -65,7 +65,7 @@ public static function missingContentType( ): HttpException { return new HttpException( $message ?? ErrorMessage::MISSING_CONTENT_TYPE, - $code ?? self::STATUS_UNSUPPORTED_MEDIA_TYPE, + $code ?? StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE, $previous, ); } @@ -77,7 +77,7 @@ public static function unsupportedMediaType( ): HttpException { return new HttpException( $message ?? ErrorMessage::UNSUPPORTED_MEDIA_TYPE, - $code ?? self::STATUS_UNSUPPORTED_MEDIA_TYPE, + $code ?? StatusCodeInterface::STATUS_UNSUPPORTED_MEDIA_TYPE, $previous, ); } @@ -89,7 +89,7 @@ public static function invalidVariable( ): HttpException { return new HttpException( $message ?? ErrorMessage::INVALID_VARIABLE, - $code ?? self::STATUS_BAD_REQUEST, + $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, $previous, ); } @@ -101,7 +101,7 @@ public static function invalidQuery( ): HttpException { return new HttpException( $message ?? ErrorMessage::INVALID_QUERY, - $code ?? self::STATUS_BAD_REQUEST, + $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, $previous, ); } @@ -113,7 +113,7 @@ public static function missingHeader( ): HttpException { return new HttpException( $message ?? ErrorMessage::MISSING_HEADER, - $code ?? self::STATUS_BAD_REQUEST, + $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, $previous, ); } @@ -125,7 +125,7 @@ public static function invalidHeader( ): HttpException { return new HttpException( $message ?? ErrorMessage::INVALID_HEADER, - $code ?? self::STATUS_BAD_REQUEST, + $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, $previous, ); } @@ -137,7 +137,7 @@ public static function missingCookie( ): HttpException { return new HttpException( $message ?? ErrorMessage::MISSING_COOKIE, - $code ?? self::STATUS_BAD_REQUEST, + $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, $previous, ); } @@ -149,7 +149,7 @@ public static function invalidCookie( ): HttpException { return new HttpException( $message ?? ErrorMessage::INVALID_COOKIE, - $code ?? self::STATUS_BAD_REQUEST, + $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, $previous, ); } @@ -161,7 +161,7 @@ public static function invalidBody( ): HttpException { return new HttpException( $message ?? ErrorMessage::INVALID_BODY, - $code ?? self::STATUS_BAD_REQUEST, + $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, $previous, ); } @@ -173,7 +173,7 @@ public static function emptyJsonPayload( ): HttpException { return new HttpException( $message ?? ErrorMessage::EMPTY_JSON_PAYLOAD, - $code ?? self::STATUS_BAD_REQUEST, + $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, $previous, ); } @@ -185,7 +185,7 @@ public static function invalidJsonPayload( ): HttpException { return new HttpException( $message ?? ErrorMessage::INVALID_JSON_PAYLOAD, - $code ?? self::STATUS_BAD_REQUEST, + $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, $previous, ); } @@ -197,7 +197,7 @@ public static function invalidJsonPayloadFormat( ): HttpException { return new HttpException( $message ?? ErrorMessage::INVALID_JSON_PAYLOAD_FORMAT, - $code ?? self::STATUS_BAD_REQUEST, + $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, $previous, ); } diff --git a/src/Exception/HttpExceptionInterface.php b/src/Exception/HttpExceptionInterface.php deleted file mode 100644 index 72f10b3d..00000000 --- a/src/Exception/HttpExceptionInterface.php +++ /dev/null @@ -1,43 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\Exception; - -use Fig\Http\Message\StatusCodeInterface; -use Sunrise\Http\Router\Validation\ConstraintViolationInterface; - -/** - * @since 3.0.0 - */ -interface HttpExceptionInterface extends ExceptionInterface, StatusCodeInterface -{ - /** - * Returns the exception's non-interpolated message. - */ - public function getMessageTemplate(): string; - - /** - * @return array - */ - public function getMessagePlaceholders(): array; - - /** - * @return array - */ - public function getHeaderFields(): array; - - /** - * @return array - */ - public function getConstraintViolations(): array; -} diff --git a/tests/Command/RouterClearCacheCommandTest.php b/tests/Command/RouterClearDescriptorsCacheCommandTest.php similarity index 100% rename from tests/Command/RouterClearCacheCommandTest.php rename to tests/Command/RouterClearDescriptorsCacheCommandTest.php diff --git a/tests/Entity/Language/LanguageComparatorTest.php b/tests/Entity/Locale/LocaleComparatorTest.php similarity index 100% rename from tests/Entity/Language/LanguageComparatorTest.php rename to tests/Entity/Locale/LocaleComparatorTest.php diff --git a/tests/Entity/Language/ClientLanguageTest.php b/tests/Entity/Locale/LocaleTest.php similarity index 100% rename from tests/Entity/Language/ClientLanguageTest.php rename to tests/Entity/Locale/LocaleTest.php diff --git a/tests/Entity/MediaType/ClientMediaTypeTest.php b/tests/Entity/MediaType/MediaTypeTest.php similarity index 100% rename from tests/Entity/MediaType/ClientMediaTypeTest.php rename to tests/Entity/MediaType/MediaTypeTest.php From a7fce748b6e9958cb2a66b9c8010e58a840bac21 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Thu, 9 Jan 2025 15:01:15 +0100 Subject: [PATCH 176/180] v3 --- src/Dictionary/MediaType.php | 4 ++-- src/Dictionary/VariablePattern.php | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/Dictionary/MediaType.php b/src/Dictionary/MediaType.php index 744b9463..f719501c 100644 --- a/src/Dictionary/MediaType.php +++ b/src/Dictionary/MediaType.php @@ -20,8 +20,8 @@ */ enum MediaType: string implements MediaTypeInterface { - case Json = 'application/json'; - case Xml = 'application/xml'; + case JSON = 'application/json'; + case XML = 'application/xml'; public function getIdentifier(): string { diff --git a/src/Dictionary/VariablePattern.php b/src/Dictionary/VariablePattern.php index 7ef130a9..c46a0b90 100644 --- a/src/Dictionary/VariablePattern.php +++ b/src/Dictionary/VariablePattern.php @@ -18,7 +18,7 @@ */ final class VariablePattern { - public const ASCII_SLUG = '[0-9A-Za-z]+(?:-[0-9A-Za-z]+)*'; - public const UNSIGNED_INTEGER = '[0-9]+'; - public const UUID = '[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}'; + public const SLUG = '[0-9A-Za-z]+(?:-[0-9A-Za-z]+)*'; + public const UINT = '[0-9]+'; + public const UUID = '[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}'; } From 8e9818e174218c79ef6f7a718147204b82120c53 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Fri, 10 Jan 2025 08:06:29 +0100 Subject: [PATCH 177/180] v3 --- .editorconfig | 2 +- composer.json | 152 +++++++++--------- phpcs.xml.dist | 1 - psalm.xml.dist | 1 + resources/definitions/router.php | 7 - resources/translations/ru.php | 4 + resources/translations/sr.php | 4 + src/Annotation/RequestBody.php | 2 +- src/Annotation/RequestCookie.php | 2 +- src/Annotation/RequestHeader.php | 2 +- src/Annotation/RequestQuery.php | 2 +- src/Annotation/RequestQueryParam.php | 31 ++++ src/Annotation/RequestVariable.php | 2 +- src/ClassResolver.php | 10 +- src/Dictionary/ErrorMessage.php | 2 + src/Dictionary/HeaderName.php | 25 +++ src/Dictionary/PlaceholderCode.php | 29 ++++ src/Exception/HttpExceptionFactory.php | 24 +++ src/Helper/ClassFinder.php | 28 +++- src/Helper/HeaderParser.php | 14 +- src/Helper/RouteBuilder.php | 14 +- src/Helper/RouteCompiler.php | 3 +- src/Helper/RouteParser.php | 93 ++++++----- src/Helper/RouteSimplifier.php | 3 +- src/Loader/DescriptorLoader.php | 8 +- .../JsonPayloadDecodingMiddleware.php | 19 +-- .../PayloadMediaTypeNegotiationMiddleware.php | 18 ++- src/MiddlewareResolver.php | 39 +++-- .../RequestBodyParameterResolver.php | 25 ++- .../RequestCookieParameterResolver.php | 37 +++-- .../RequestHeaderParameterResolver.php | 37 +++-- .../RequestQueryParamParameterResolver.php | 131 +++++++++++++++ .../RequestQueryParameterResolver.php | 25 ++- .../RequestVariableParameterResolver.php | 41 +++-- src/ParameterResolverChain.php | 7 +- src/RequestHandlerResolver.php | 43 +++-- .../ResponseEmptyResolver.php | 4 +- src/ResponseResolver/ResponseJsonResolver.php | 9 +- src/ResponseResolverChain.php | 1 - src/Route.php | 1 - src/Router.php | 33 ++-- src/RouterInterface.php | 6 +- src/ServerRequest.php | 55 +++---- .../ArgumentConstraintValidator.php | 1 - src/functions/emit.php | 2 +- ...RouterClearDescriptorsCacheCommandTest.php | 15 +- tests/Command/RouterListRoutesCommandTest.php | 29 ++-- tests/Entity/Locale/LocaleComparatorTest.php | 101 ++++-------- tests/Entity/Locale/LocaleTest.php | 11 +- .../MediaType/MediaTypeComparatorTest.php | 39 +++-- tests/Entity/MediaType/MediaTypeTest.php | 9 +- tests/Event/RoutePostRunEventTest.php | 31 ++-- tests/Event/RoutePreRunEventTest.php | 24 ++- tests/Exception/HttpExceptionTest.php | 37 ----- 54 files changed, 755 insertions(+), 540 deletions(-) create mode 100644 src/Annotation/RequestQueryParam.php create mode 100644 src/Dictionary/HeaderName.php create mode 100644 src/Dictionary/PlaceholderCode.php create mode 100644 src/ParameterResolver/RequestQueryParamParameterResolver.php diff --git a/.editorconfig b/.editorconfig index 91aebb87..0beac55a 100644 --- a/.editorconfig +++ b/.editorconfig @@ -11,5 +11,5 @@ indent_size = 4 trim_trailing_whitespace = true insert_final_newline = true -[*.yml] +[*{.json,.yml}] indent_size = 2 diff --git a/composer.json b/composer.json index 7469a9fe..4bffb653 100644 --- a/composer.json +++ b/composer.json @@ -1,82 +1,78 @@ { - "name": "sunrise/http-router", - "homepage": "https://github.com/sunrise-php/http-router", - "description": "HTTP router for PHP 8.1+ based on PSR-7 and PSR-15 with support for attributes and Swagger", - "license": "MIT", - "keywords": [ - "fenric", - "sunrise", - "http", - "router", - "request-handler", - "middlewares", - "attributes", - "openapi", - "swagger", - "psr-7", - "psr-15", - "php8" - ], - "authors": [ - { - "name": "Anatoly Nekhay", - "email": "afenric@gmail.com", - "homepage": "https://github.com/fenric" - } + "name": "sunrise/http-router", + "homepage": "https://github.com/sunrise-php/http-router", + "description": "HTTP router for PHP 8.1+ based on PSR-7 and PSR-15", + "license": "MIT", + "keywords": [ + "fenric", + "sunrise", + "http", + "router", + "openapi", + "swagger", + "psr-7", + "psr-15" + ], + "authors": [ + { + "name": "Anatoly Nekhay", + "email": "afenric@gmail.com", + "homepage": "https://github.com/fenric" + } + ], + "require": { + "php": ">=8.1", + "fig/http-message-util": "^1.1", + "psr/container": "^1.0 || ^2.0", + "psr/event-dispatcher": "^1.0", + "psr/http-factory": "^1.0", + "psr/http-message": "^1.0 || ^2.0", + "psr/http-server-handler": "^1.0", + "psr/http-server-middleware": "^1.0", + "psr/log": "^1.0 || ^2.0 || ^3.0", + "psr/simple-cache": "^1.0 || ^2.0 || ^3.0" + }, + "require-dev": { + "php-di/php-di": "^7.0", + "phpstan/phpstan": "^1.12", + "phpunit/phpunit": "^10.5", + "squizlabs/php_codesniffer": "^3.10", + "sunrise/http-message": "^3.2", + "sunrise/hydrator": "^3.13", + "symfony/console": "^6.4", + "symfony/validator": "^6.4", + "vimeo/psalm": "^5.26" + }, + "autoload": { + "files": [ + "src/functions/emit.php" ], - "require": { - "php": ">=8.1", - "fig/http-message-util": "^1.1", - "psr/container": "^1.0 || ^2.0", - "psr/event-dispatcher": "^1.0", - "psr/http-factory": "^1.0", - "psr/http-message": "^1.0 || ^2.0", - "psr/http-server-handler": "^1.0", - "psr/http-server-middleware": "^1.0", - "psr/log": "^1.0 || ^2.0 || ^3.0", - "psr/simple-cache": "^1.0 || ^2.0 || ^3.0" - }, - "require-dev": { - "php-di/php-di": "^7.0", - "phpstan/phpstan": "^1.12", - "phpunit/phpunit": "^10.5", - "squizlabs/php_codesniffer": "^3.10", - "sunrise/http-message": "^3.2", - "sunrise/hydrator": "^3.13", - "symfony/console": "^6.4", - "symfony/validator": "^6.4", - "vimeo/psalm": "^5.26" - }, - "autoload": { - "files": [ - "src/functions/emit.php" - ], - "psr-4": { - "Sunrise\\Http\\Router\\": "src/" - } - }, - "autoload-dev": { - "psr-4": { - "Sunrise\\Http\\Router\\Tests\\": "tests/" - } - }, - "scripts": { - "phpcs": "phpcs --colors", - "psalm": "psalm --no-cache", - "phpstan": "phpstan analyse src --level=9 --memory-limit=-1", - "phpunit": "XDEBUG_MODE=coverage phpunit --coverage-text --colors=always", - "test": [ - "@phpcs", - "@psalm", - "@phpstan", - "@phpunit" - ], - "build": [ - "phpdoc -d src/ -t phpdoc/", - "XDEBUG_MODE=coverage phpunit --coverage-html coverage/" - ] - }, - "config": { - "sort-packages": true + "psr-4": { + "Sunrise\\Http\\Router\\": "src/" } + }, + "autoload-dev": { + "psr-4": { + "Sunrise\\Http\\Router\\Tests\\": "tests/" + } + }, + "scripts": { + "phpcs": "phpcs --colors", + "psalm": "psalm --no-cache", + "phpstan": "phpstan analyse src --level=9 --memory-limit=-1", + "phpunit": "XDEBUG_MODE=coverage phpunit --coverage-text --colors=always", + "test": [ + "@phpcs", + "@psalm", + "@phpstan", + "@phpunit" + ], + "build": [ + "phpdoc -d src/ -t phpdoc/", + "XDEBUG_MODE=coverage phpunit --coverage-html coverage/" + ] + }, + "config": { + "sort-packages": true + } } diff --git a/phpcs.xml.dist b/phpcs.xml.dist index 724b8a1c..ae1272cf 100644 --- a/phpcs.xml.dist +++ b/phpcs.xml.dist @@ -7,7 +7,6 @@ tests/* - benchmarks src tests diff --git a/psalm.xml.dist b/psalm.xml.dist index 3fe0c565..43a0a144 100644 --- a/psalm.xml.dist +++ b/psalm.xml.dist @@ -14,6 +14,7 @@ + diff --git a/resources/definitions/router.php b/resources/definitions/router.php index d8a4abea..7aec47b2 100644 --- a/resources/definitions/router.php +++ b/resources/definitions/router.php @@ -5,10 +5,6 @@ use Psr\Container\ContainerInterface; use Sunrise\Http\Router\ClassResolver; use Sunrise\Http\Router\ClassResolverInterface; -use Sunrise\Http\Router\Entity\Locale\LocaleComparator; -use Sunrise\Http\Router\Entity\Locale\LocaleComparatorInterface; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparatorInterface; use Sunrise\Http\Router\MiddlewareResolver; use Sunrise\Http\Router\MiddlewareResolverInterface; use Sunrise\Http\Router\ParameterResolverChain; @@ -77,7 +73,4 @@ referenceResolver: get(ReferenceResolverInterface::class), eventDispatcher: get('router.event_dispatcher'), ), - - MediaTypeComparatorInterface::class => create(MediaTypeComparator::class), - LocaleComparatorInterface::class => create(LocaleComparator::class), ]; diff --git a/resources/translations/ru.php b/resources/translations/ru.php index 4c8e8480..f0c554ce 100644 --- a/resources/translations/ru.php +++ b/resources/translations/ru.php @@ -5,6 +5,7 @@ use Sunrise\Http\Router\Dictionary\ErrorMessage; return [ + // phpcs:disable Generic.Files.LineLength.TooLong ErrorMessage::MALFORMED_URI => 'URI запроса невалиден и не может быть принят сервером.', ErrorMessage::RESOURCE_NOT_FOUND => 'Запрашиваемый ресурс не найден для данного URI.', ErrorMessage::METHOD_NOT_ALLOWED => 'Запрашиваемый метод не разрешен для данного ресурса; Проверьте заголовок ответа "Allow" на разрешенные методы.', @@ -12,6 +13,8 @@ ErrorMessage::UNSUPPORTED_MEDIA_TYPE => 'Тип медиа {{ media_type }} не поддерживается; Проверьте заголовок ответа "Accept" на поддерживаемые типы медиа.', ErrorMessage::INVALID_VARIABLE => 'Значение переменной {{{ variable_name }}} в URI запроса {{ route_uri }} невалидно.', ErrorMessage::INVALID_QUERY => 'Параметры запроса невалидны.', + ErrorMessage::MISSING_QUERY_PARAM => 'Параметр запроса {{ query_param_name }} должен быть предоставлен.', + ErrorMessage::INVALID_QUERY_PARAM => 'Параметр запроса {{ query_param_name }} невалиден.', ErrorMessage::MISSING_HEADER => 'Заголовок запроса {{ header_name }} должен быть предоставлен.', ErrorMessage::INVALID_HEADER => 'Заголовок запроса {{ header_name }} невалиден.', ErrorMessage::MISSING_COOKIE => 'Отсутствует cookie {{ cookie_name }}.', @@ -20,4 +23,5 @@ ErrorMessage::EMPTY_JSON_PAYLOAD => 'JSON payload не может быть пустым.', ErrorMessage::INVALID_JSON_PAYLOAD => 'JSON payload невалидно.', ErrorMessage::INVALID_JSON_PAYLOAD_FORMAT => 'JSON payload должен быть в формате массива или объекта.', + // phpcs:enable Generic.Files.LineLength.TooLong ]; diff --git a/resources/translations/sr.php b/resources/translations/sr.php index eb441816..f4eff27e 100644 --- a/resources/translations/sr.php +++ b/resources/translations/sr.php @@ -5,6 +5,7 @@ use Sunrise\Http\Router\Dictionary\ErrorMessage; return [ + // phpcs:disable Generic.Files.LineLength.TooLong ErrorMessage::MALFORMED_URI => 'URI zahtev je nevažeći i ne može biti prihvaćen od strane servera.', ErrorMessage::RESOURCE_NOT_FOUND => 'Zatraženi resurs nije pronađen za ovaj URI.', ErrorMessage::METHOD_NOT_ALLOWED => 'Zatražena metoda nije dozvoljena za ovaj resurs; Proverite zaglavlje odgovora "Allow" za dozvoljene metode.', @@ -12,6 +13,8 @@ ErrorMessage::UNSUPPORTED_MEDIA_TYPE => 'Tip medija {{ media_type }} nije podržan; Proverite zaglavlje odgovora "Accept" za podržane tipove medija.', ErrorMessage::INVALID_VARIABLE => 'Vrednost promenljive {{{ variable_name }}} u URI zahtevu {{ route_uri }} nije validna.', ErrorMessage::INVALID_QUERY => 'Parametri upita zahteva nisu validni.', + ErrorMessage::MISSING_QUERY_PARAM => 'Parametr zahteva {{ query_param_name }} mora biti navedeno.', + ErrorMessage::INVALID_QUERY_PARAM => 'Parametr zahteva {{ query_param_name }} nije validno.', ErrorMessage::MISSING_HEADER => 'Zaglavlje zahteva {{ header_name }} mora biti navedeno.', ErrorMessage::INVALID_HEADER => 'Zaglavlje zahteva {{ header_name }} nije validno.', ErrorMessage::MISSING_COOKIE => 'Kolačić {{ cookie_name }} nedostaje.', @@ -20,4 +23,5 @@ ErrorMessage::EMPTY_JSON_PAYLOAD => 'JSON sadržaj ne može biti prazan.', ErrorMessage::INVALID_JSON_PAYLOAD => 'JSON sadržaj nije validan.', ErrorMessage::INVALID_JSON_PAYLOAD_FORMAT => 'JSON sadržaj mora biti u formatu niza ili objekta.', + // phpcs:enable Generic.Files.LineLength.TooLong ]; diff --git a/src/Annotation/RequestBody.php b/src/Annotation/RequestBody.php index 6e8fd13b..f1266408 100644 --- a/src/Annotation/RequestBody.php +++ b/src/Annotation/RequestBody.php @@ -24,7 +24,7 @@ final class RequestBody public function __construct( public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, - public readonly bool $validation = true, + public readonly ?bool $validationEnabled = null, ) { } } diff --git a/src/Annotation/RequestCookie.php b/src/Annotation/RequestCookie.php index ab708645..c3cba4aa 100644 --- a/src/Annotation/RequestCookie.php +++ b/src/Annotation/RequestCookie.php @@ -25,7 +25,7 @@ public function __construct( public readonly string $name, public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, - public readonly bool $validation = true, + public readonly ?bool $validationEnabled = null, ) { } } diff --git a/src/Annotation/RequestHeader.php b/src/Annotation/RequestHeader.php index b804aaa8..1fcb6df1 100644 --- a/src/Annotation/RequestHeader.php +++ b/src/Annotation/RequestHeader.php @@ -25,7 +25,7 @@ public function __construct( public readonly string $name, public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, - public readonly bool $validation = true, + public readonly ?bool $validationEnabled = null, ) { } } diff --git a/src/Annotation/RequestQuery.php b/src/Annotation/RequestQuery.php index cbaf352d..e9995486 100644 --- a/src/Annotation/RequestQuery.php +++ b/src/Annotation/RequestQuery.php @@ -24,7 +24,7 @@ final class RequestQuery public function __construct( public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, - public readonly bool $validation = true, + public readonly ?bool $validationEnabled = null, ) { } } diff --git a/src/Annotation/RequestQueryParam.php b/src/Annotation/RequestQueryParam.php new file mode 100644 index 00000000..96abc9fb --- /dev/null +++ b/src/Annotation/RequestQueryParam.php @@ -0,0 +1,31 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_PARAMETER)] +final class RequestQueryParam +{ + public function __construct( + public readonly string $name, + public readonly ?int $errorStatusCode = null, + public readonly ?string $errorMessage = null, + public readonly ?bool $validationEnabled = null, + ) { + } +} diff --git a/src/Annotation/RequestVariable.php b/src/Annotation/RequestVariable.php index 53fd86b5..0310a90c 100644 --- a/src/Annotation/RequestVariable.php +++ b/src/Annotation/RequestVariable.php @@ -25,7 +25,7 @@ public function __construct( public readonly ?string $name = null, public readonly ?int $errorStatusCode = null, public readonly ?string $errorMessage = null, - public readonly bool $validation = true, + public readonly ?bool $validationEnabled = null, ) { } } diff --git a/src/ClassResolver.php b/src/ClassResolver.php index fbebdc6d..3faf690a 100644 --- a/src/ClassResolver.php +++ b/src/ClassResolver.php @@ -34,7 +34,7 @@ final class ClassResolver implements ClassResolverInterface public function __construct( private readonly ParameterResolverChainInterface $parameterResolverChain, - private readonly ?ContainerInterface $container = null, + private readonly ?ContainerInterface $container, ) { } @@ -53,14 +53,14 @@ public function __construct( */ public function resolveClass(string $className): object { - if (isset($this->resolvedClasses[$className])) { + if ($this->container?->has($className) === true) { /** @var T */ - return $this->resolvedClasses[$className]; + return $this->container->get($className); } - if ($this->container?->has($className)) { + if (isset($this->resolvedClasses[$className])) { /** @var T */ - return $this->container->get($className); + return $this->resolvedClasses[$className]; } if (!class_exists($className)) { diff --git a/src/Dictionary/ErrorMessage.php b/src/Dictionary/ErrorMessage.php index d0409bdc..3e9d4b19 100644 --- a/src/Dictionary/ErrorMessage.php +++ b/src/Dictionary/ErrorMessage.php @@ -26,6 +26,8 @@ final class ErrorMessage public const UNSUPPORTED_MEDIA_TYPE = 'The media type {{ media_type }} is not supported; Check the Accept response header for supported media types.'; public const INVALID_VARIABLE = 'The value of the variable {{{ variable_name }}} in the request URI {{ route_uri }} is invalid.'; public const INVALID_QUERY = 'The request query parameters are invalid.'; + public const MISSING_QUERY_PARAM = 'The query parameter {{ query_param_name }} is missing.'; + public const INVALID_QUERY_PARAM = 'The query parameter {{ query_param_name }} is invalid.'; public const MISSING_HEADER = 'The request header {{ header_name }} must be provided.'; public const INVALID_HEADER = 'The request header {{ header_name }} is invalid.'; public const MISSING_COOKIE = 'The cookie {{ cookie_name }} is missing.'; diff --git a/src/Dictionary/HeaderName.php b/src/Dictionary/HeaderName.php new file mode 100644 index 00000000..53563ac5 --- /dev/null +++ b/src/Dictionary/HeaderName.php @@ -0,0 +1,25 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Dictionary; + +/** + * @since 3.0.0 + */ +final class HeaderName +{ + public const ACCEPT = 'Accept'; + public const ACCEPT_LANGUAGE = 'Accept-Language'; + public const ALLOW = 'Allow'; + public const CONTENT_TYPE = 'Content-Type'; +} diff --git a/src/Dictionary/PlaceholderCode.php b/src/Dictionary/PlaceholderCode.php new file mode 100644 index 00000000..85ff87e7 --- /dev/null +++ b/src/Dictionary/PlaceholderCode.php @@ -0,0 +1,29 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Dictionary; + +/** + * @since 3.0.0 + */ +final class PlaceholderCode +{ + public const COOKIE_NAME = '{{ cookie_name }}'; + public const HEADER_NAME = '{{ header_name }}'; + public const MEDIA_TYPE = '{{ media_type }}'; + public const QUERY_PARAM_NAME = '{{ query_param_name }}'; + public const REQUEST_METHOD = '{{ request_method }}'; + public const REQUEST_URI = '{{ request_uri }}'; + public const ROUTE_URI = '{{ route_uri }}'; + public const VARIABLE_NAME = '{{ variable_name }}'; +} diff --git a/src/Exception/HttpExceptionFactory.php b/src/Exception/HttpExceptionFactory.php index 3604661c..1af9a397 100644 --- a/src/Exception/HttpExceptionFactory.php +++ b/src/Exception/HttpExceptionFactory.php @@ -106,6 +106,30 @@ public static function invalidQuery( ); } + public static function missingQueryParam( + ?string $message = null, + ?int $code = null, + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + $message ?? ErrorMessage::MISSING_QUERY_PARAM, + $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + $previous, + ); + } + + public static function invalidQueryParam( + ?string $message = null, + ?int $code = null, + ?Throwable $previous = null, + ): HttpException { + return new HttpException( + $message ?? ErrorMessage::INVALID_QUERY_PARAM, + $code ?? StatusCodeInterface::STATUS_BAD_REQUEST, + $previous, + ); + } + public static function missingHeader( ?string $message = null, ?int $code = null, diff --git a/src/Helper/ClassFinder.php b/src/Helper/ClassFinder.php index 45269911..ddc1e7a8 100644 --- a/src/Helper/ClassFinder.php +++ b/src/Helper/ClassFinder.php @@ -35,7 +35,7 @@ final class ClassFinder { /** - * @return Generator> + * @return Generator> * * @throws InvalidArgumentException * @throws ReflectionException @@ -43,34 +43,43 @@ final class ClassFinder public static function getDirClasses(string $dirname): Generator { if (!is_dir($dirname)) { - throw new InvalidArgumentException(sprintf('The directory %s does not exist.', $dirname)); + throw new InvalidArgumentException(sprintf( + 'The directory "%s" does not exist.', + $dirname, + )); } /** @var iterable $files */ - $files = new RegexIterator(new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dirname)), '/\.php$/'); + $files = new RegexIterator( + new RecursiveIteratorIterator( + new RecursiveDirectoryIterator($dirname) + ), + '/\.php$/', + ); /** @var array $filenames */ $filenames = []; foreach ($files as $file) { $filename = $file->getRealPath(); - $filenames[$filename] = true; (static function (string $filename): void { /** @psalm-suppress UnresolvableInclude */ require_once $filename; })($filename); + + $filenames[$filename] = true; } foreach (get_declared_classes() as $className) { $classReflection = new ReflectionClass($className); if (isset($filenames[$classReflection->getFileName()])) { - yield $classReflection; + yield $className => $classReflection; } } } /** - * @return Generator> + * @return Generator> * * @throws InvalidArgumentException * @throws ReflectionException @@ -78,7 +87,10 @@ public static function getDirClasses(string $dirname): Generator public static function getFileClasses(string $filename): Generator { if (!is_file($filename)) { - throw new InvalidArgumentException(sprintf('The file %s does not exist.', $filename)); + throw new InvalidArgumentException(sprintf( + 'The file "%s" does not exist.', + $filename, + )); } /** @var string $filename */ @@ -92,7 +104,7 @@ public static function getFileClasses(string $filename): Generator foreach (get_declared_classes() as $className) { $classReflection = new ReflectionClass($className); if ($classReflection->getFileName() === $filename) { - yield $classReflection; + yield $className => $classReflection; } } } diff --git a/src/Helper/HeaderParser.php b/src/Helper/HeaderParser.php index a21afa52..9cae4654 100644 --- a/src/Helper/HeaderParser.php +++ b/src/Helper/HeaderParser.php @@ -26,10 +26,12 @@ final class HeaderParser private const IN_QUOTED_STRING = 8; private const IN_QUOTED_PAIR = 16; + private const MAX_FIELD_VALUE_LENGTH = 512; + /** * @link https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6 */ - private const RFC7230_FIELD_VALUE = [ + private const RFC7230_FIELD_VALUE_CHARSET = [ "\x09" => 1, "\x20" => 1, "\x21" => 1, "\x22" => 1, "\x23" => 1, "\x24" => 1, "\x25" => 1, "\x26" => 1, "\x27" => 1, "\x28" => 1, "\x29" => 1, "\x2a" => 1, "\x2b" => 1, "\x2c" => 1, "\x2d" => 1, "\x2e" => 1, "\x2f" => 1, "\x30" => 1, "\x31" => 1, "\x32" => 1, "\x33" => 1, "\x34" => 1, "\x35" => 1, "\x36" => 1, @@ -76,8 +78,8 @@ public static function parseHeader(string $header): array /** @var array, array{0?: string, 1?: array, array{0?: string, 1?: string}>}> $values */ $values = []; - for ($offset = 0; isset($header[$offset]) && $offset < 512; $offset++) { - if (!isset(self::RFC7230_FIELD_VALUE[$header[$offset]])) { + for ($offset = 0; isset($header[$offset]) && $offset < self::MAX_FIELD_VALUE_LENGTH; $offset++) { + if (!isset(self::RFC7230_FIELD_VALUE_CHARSET[$header[$offset]])) { continue; } @@ -105,17 +107,17 @@ public static function parseHeader(string $header): array continue; } - if ($cursor & self::IN_IDENTIFIER) { + if (($cursor & self::IN_IDENTIFIER)) { $values[$value][0] ??= ''; $values[$value][0] .= $header[$offset]; continue; } - if ($cursor & self::IN_PARAMETER_NAME) { + if (($cursor & self::IN_PARAMETER_NAME)) { $values[$value][1][$param][0] ??= ''; $values[$value][1][$param][0] .= $header[$offset]; continue; } - if ($cursor & self::IN_PARAMETER_VALUE) { + if (($cursor & self::IN_PARAMETER_VALUE)) { $values[$value][1][$param][1] ??= ''; $values[$value][1][$param][1] .= $header[$offset]; $cursor &= ~self::IN_QUOTED_PAIR; diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index 3d419bbf..24391aa4 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -22,7 +22,6 @@ use function is_string; use function sprintf; use function str_replace; -use function substr; /** * @since 3.0.0 @@ -41,14 +40,9 @@ public static function buildRoute(string $route, array $values = []): string $search = []; $replace = []; foreach ($variables as $variable) { - $statement = substr($route, $variable['offset'], $variable['length']); - if (isset($values[$variable['name']])) { - /** @var mixed $value */ - $value = $values[$variable['name']]; - try { - $value = self::stringifyValue($value); + $value = self::stringifyValue($values[$variable['name']]); } catch (InvalidArgumentException $e) { throw new InvalidArgumentException(sprintf( 'The route %s could not be built due to an invalid value for the variable {%s}: %s.', @@ -58,13 +52,13 @@ public static function buildRoute(string $route, array $values = []): string )); } - $search[] = $statement; + $search[] = $variable['statement']; $replace[] = $value; continue; } - if (isset($variable['optional'])) { - $search[] = '(' . $variable['optional']['left'] . $statement . $variable['optional']['right'] . ')'; + if (isset($variable['optional_part'])) { + $search[] = $variable['optional_part']; $replace[] = ''; continue; } diff --git a/src/Helper/RouteCompiler.php b/src/Helper/RouteCompiler.php index 38e72559..bb1fc184 100644 --- a/src/Helper/RouteCompiler.php +++ b/src/Helper/RouteCompiler.php @@ -17,7 +17,6 @@ use function addcslashes; use function str_replace; -use function substr; /** * @since 3.0.0 @@ -38,7 +37,7 @@ public static function compileRoute(string $route, array $patterns = []): string $search = []; $replace = []; foreach ($variables as $variable) { - $search[] = substr($route, $variable['offset'], $variable['length']); + $search[] = $variable['statement']; $replace[] = '{' . $variable['name'] . '}'; } diff --git a/src/Helper/RouteParser.php b/src/Helper/RouteParser.php index 5a3f1653..d04fd740 100644 --- a/src/Helper/RouteParser.php +++ b/src/Helper/RouteParser.php @@ -31,7 +31,7 @@ final class RouteParser /** * @link https://www.pcre.org/original/doc/html/pcrepattern.html#SEC16 */ - private const PCRE_SUBPATTERN_NAME = [ + private const PCRE_SUBPATTERN_NAME_CHARSET = [ "\x30" => 1, "\x31" => 1, "\x32" => 1, "\x33" => 1, "\x34" => 1, "\x35" => 1, "\x36" => 1, "\x37" => 1, "\x38" => 1, "\x39" => 1, "\x41" => 1, "\x42" => 1, "\x43" => 1, "\x44" => 1, "\x45" => 1, "\x46" => 1, "\x47" => 1, "\x48" => 1, "\x49" => 1, "\x4a" => 1, "\x4b" => 1, "\x4c" => 1, "\x4d" => 1, "\x4e" => 1, @@ -47,16 +47,7 @@ final class RouteParser /** * Parses the given route and returns its variables * - * @return list + * @return list * * @throws InvalidArgumentException */ @@ -65,16 +56,19 @@ public static function parseRoute(string $route): array $cursor = 0; $variable = -1; - /** @var list $variables */ + /** @var list $variables */ $variables = []; + /** @var array $names */ + $names = []; + $left = $right = ''; for ($offset = 0; isset($route[$offset]); $offset++) { if ($route[$offset] === '(' && !($cursor & self::IN_VARIABLE)) { if (($cursor & self::IN_OPTIONAL_PART)) { throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . + 'The route "%s" could not be parsed due to a syntax error. ' . 'The attempt to open an optional part at position %d failed ' . 'because nested optional parts are not supported.', $route, @@ -88,7 +82,7 @@ public static function parseRoute(string $route): array if ($route[$offset] === ')' && !($cursor & self::IN_VARIABLE)) { if (!($cursor & self::IN_OPTIONAL_PART)) { throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . + 'The route "%s" could not be parsed due to a syntax error. ' . 'The attempt to close an optional part at position %d failed ' . 'because an open optional part was not found.', $route, @@ -98,8 +92,8 @@ public static function parseRoute(string $route): array if (($cursor & self::IN_OCCUPIED_PART)) { $cursor &= ~self::IN_OCCUPIED_PART; - $variables[$variable]['optional']['left'] = $left; - $variables[$variable]['optional']['right'] = $right; + // phpcs:ignore Generic.Files.LineLength.TooLong + $variables[$variable]['optional_part'] = '(' . $left . ($variables[$variable]['statement'] ?? '') . $right . ')'; } $cursor &= ~self::IN_OPTIONAL_PART; @@ -110,7 +104,7 @@ public static function parseRoute(string $route): array if ($route[$offset] === '{' && !($cursor & self::IN_VARIABLE_PATTERN)) { if (($cursor & self::IN_VARIABLE)) { throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . + 'The route "%s" could not be parsed due to a syntax error. ' . 'The attempt to open a variable at position %d failed ' . 'because nested variables are not supported.', $route, @@ -119,7 +113,7 @@ public static function parseRoute(string $route): array } if (($cursor & self::IN_OCCUPIED_PART)) { throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . + 'The route "%s" could not be parsed due to a syntax error. ' . 'The attempt to open a variable at position %d failed ' . 'because more than one variable inside an optional part is not supported.', $route, @@ -127,20 +121,18 @@ public static function parseRoute(string $route): array )); } - $variable++; - if (($cursor & self::IN_OPTIONAL_PART)) { $cursor |= self::IN_OCCUPIED_PART; } $cursor |= self::IN_VARIABLE | self::IN_VARIABLE_NAME; - $variables[$variable]['offset'] = $offset; + $variable++; continue; } if ($route[$offset] === '}' && !($cursor & self::IN_VARIABLE_PATTERN)) { if (!($cursor & self::IN_VARIABLE)) { throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . + 'The route "%s" could not be parsed due to a syntax error. ' . 'The attempt to close a variable at position %d failed ' . 'because an open variable was not found.', $route, @@ -149,23 +141,38 @@ public static function parseRoute(string $route): array } if (!isset($variables[$variable]['name'])) { throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . + 'The route "%s" could not be parsed due to a syntax error. ' . 'The attempt to close a variable at position %d failed ' . 'because its name is required for its declaration.', $route, $offset, )); } + if (isset($names[$variables[$variable]['name']])) { + throw new InvalidArgumentException(sprintf( + 'The route "%s" at position %d could not be parsed ' . + 'because the variable name "%s" is already in use.', + $route, + $offset, + $variables[$variable]['name'], + )); + } $cursor &= ~(self::IN_VARIABLE | self::IN_VARIABLE_NAME); - $variables[$variable]['length'] = $offset - $variables[$variable]['offset'] + 1; + $variables[$variable]['statement'] = '{' . ($variables[$variable]['statement'] ?? '') . '}'; + $names[$variables[$variable]['name']] = true; // @phpstan-ignore-line continue; } + if (($cursor & self::IN_VARIABLE)) { + $variables[$variable]['statement'] ??= ''; + $variables[$variable]['statement'] .= $route[$offset]; + } + if ($route[$offset] === '<' && ($cursor & self::IN_VARIABLE)) { if (($cursor & self::IN_VARIABLE_PATTERN)) { throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . + 'The route "%s" could not be parsed due to a syntax error. ' . 'The attempt to open a variable pattern at position %d failed ' . 'because nested patterns are not supported.', $route, @@ -174,7 +181,7 @@ public static function parseRoute(string $route): array } if (!($cursor & self::IN_VARIABLE_NAME)) { throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . + 'The route "%s" could not be parsed due to a syntax error. ' . 'The attempt to open a variable pattern at position %d failed ' . 'because the pattern must be preceded by the variable name.', $route, @@ -182,13 +189,13 @@ public static function parseRoute(string $route): array )); } - $cursor = ($cursor | self::IN_VARIABLE_PATTERN) & ~self::IN_VARIABLE_NAME; + $cursor = $cursor & ~self::IN_VARIABLE_NAME | self::IN_VARIABLE_PATTERN; continue; } if ($route[$offset] === '>' && ($cursor & self::IN_VARIABLE)) { if (!($cursor & self::IN_VARIABLE_PATTERN)) { throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . + 'The route "%s" could not be parsed due to a syntax error. ' . 'The attempt to close a variable pattern at position %d failed ' . 'because an open pattern was not found.', $route, @@ -197,7 +204,7 @@ public static function parseRoute(string $route): array } if (!isset($variables[$variable]['pattern'])) { throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . + 'The route "%s" could not be parsed due to a syntax error. ' . 'The attempt to close a variable pattern at position %d failed ' . 'because its content is required for its declaration.', $route, @@ -209,7 +216,7 @@ public static function parseRoute(string $route): array continue; } - // (left{foo}right) + // (left{var}right) // ~^^^^~~~~~^^^^^~ if (($cursor & self::IN_OPTIONAL_PART) && !($cursor & self::IN_VARIABLE)) { if (!($cursor & self::IN_OCCUPIED_PART)) { @@ -225,16 +232,16 @@ public static function parseRoute(string $route): array if (($cursor & self::IN_VARIABLE_NAME)) { if (!isset($variables[$variable]['name']) && $route[$offset] >= '0' && $route[$offset] <= '9') { throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . + 'The route "%s" could not be parsed due to a syntax error. ' . 'An invalid character was found at position %d. ' . 'Please note that variable names cannot start with digits.', $route, $offset, )); } - if (!isset(self::PCRE_SUBPATTERN_NAME[$route[$offset]])) { + if (!isset(self::PCRE_SUBPATTERN_NAME_CHARSET[$route[$offset]])) { throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . + 'The route "%s" could not be parsed due to a syntax error. ' . 'An invalid character was found at position %d. ' . 'Please note that variable names must consist only of digits, letters and underscores.', $route, @@ -243,7 +250,7 @@ public static function parseRoute(string $route): array } if (isset($variables[$variable]['name'][31])) { throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . + 'The route "%s" could not be parsed due to a syntax error. ' . 'An extra character was found at position %d. ' . 'Please note that variable names must not exceed 32 characters.', $route, @@ -259,9 +266,9 @@ public static function parseRoute(string $route): array if (($cursor & self::IN_VARIABLE_PATTERN)) { if ($route[$offset] === self::REGEX_DELIMITER) { throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . + 'The route "%s" could not be parsed due to a syntax error. ' . 'An invalid character was found at position %d. ' . - 'Please note that variable patterns cannot contain the character %s; ' . + 'Please note that variable patterns cannot contain the character "%s"; ' . 'use an octal or hexadecimal sequence instead.', $route, $offset, @@ -274,12 +281,13 @@ public static function parseRoute(string $route): array continue; } - // {foo<\w+>xxx} + // {var<\w+>xxx} // ~~~~~~~~~^^^~ if (($cursor & self::IN_VARIABLE)) { throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . - 'An unexpected character was found at position %d; a variable at this position must be closed.', + 'The route "%s" could not be parsed due to a syntax error. ' . + 'An unexpected character was found at position %d; ' . + 'a variable at this position must be closed.', $route, $offset, )); @@ -288,13 +296,14 @@ public static function parseRoute(string $route): array if (($cursor & self::IN_VARIABLE) || ($cursor & self::IN_OPTIONAL_PART)) { throw new InvalidArgumentException(sprintf( - 'The route %s could not be parsed due to a syntax error. ' . - 'The attempt to parse the route failed because it contains an unclosed optional part or variable.', + 'The route "%s" could not be parsed due to a syntax error. ' . + 'The attempt to parse the route failed ' . + 'because it contains an unclosed variable or optional part.', $route, )); } - /** @var list */ + /** @var list */ return $variables; } } diff --git a/src/Helper/RouteSimplifier.php b/src/Helper/RouteSimplifier.php index c2852ad8..52a003f8 100644 --- a/src/Helper/RouteSimplifier.php +++ b/src/Helper/RouteSimplifier.php @@ -16,7 +16,6 @@ use InvalidArgumentException; use function str_replace; -use function substr; /** * @since 3.0.0 @@ -33,7 +32,7 @@ public static function simplifyRoute(string $route): string $search = []; $replace = []; foreach ($variables as $variable) { - $search[] = substr($route, $variable['offset'], $variable['length']); + $search[] = $variable['statement']; $replace[] = '{' . $variable['name'] . '}'; } diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 0d3decbd..b910faeb 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -45,9 +45,9 @@ use function array_map; use function class_exists; +use function implode; use function is_dir; use function is_file; -use function join; use function sprintf; use function strtoupper; use function usort; @@ -293,7 +293,6 @@ private static function enrichDescriptorFromClassOrMethod( $annotations = $classOrMethod->getAttributes(Middleware::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - /** @var mixed $value */ foreach ($annotation->values as $value) { $descriptor->middlewares[] = $value; } @@ -303,7 +302,6 @@ private static function enrichDescriptorFromClassOrMethod( $annotations = $classOrMethod->getAttributes(Constraint::class); foreach ($annotations as $annotation) { $annotation = $annotation->newInstance(); - /** @var mixed $value */ foreach ($annotation->values as $value) { $descriptor->constraints[] = $value; } @@ -369,8 +367,8 @@ private static function enrichDescriptorFromClassOrMethod( */ private static function completeDescriptor(Descriptor $descriptor): void { - $descriptor->name = join($descriptor->namePrefixes) . $descriptor->name; - $descriptor->path = join($descriptor->pathPrefixes) . $descriptor->path; + $descriptor->name = implode($descriptor->namePrefixes) . $descriptor->name; + $descriptor->path = implode($descriptor->pathPrefixes) . $descriptor->path; $descriptor->methods = array_map(strtoupper(...), $descriptor->methods); diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index 30cdcf92..d410a3f6 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -18,8 +18,9 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\Dictionary\MediaType; +use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ServerRequest; use function is_array; @@ -32,13 +33,11 @@ * JSON payload decoding middleware * * @since 2.15.0 - * - * @todo Use the Simdjson extension as needed. */ final class JsonPayloadDecodingMiddleware implements MiddlewareInterface { - public const DEFAULT_DECODING_FLAGS = JSON_BIGINT_AS_STRING; - public const DEFAULT_DECODING_DEPTH = 512; + private const DEFAULT_DECODING_FLAGS = JSON_BIGINT_AS_STRING; + private const DEFAULT_DECODING_DEPTH = 512; /** * @since 3.0.0 @@ -54,12 +53,14 @@ public function __construct( /** * @inheritDoc * - * @throws HttpExceptionInterface If the request's payload couldn't be decoded. + * @throws HttpException If the request's payload couldn't be decoded. */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { - if (ServerRequest::create($request)->isJsonPayload()) { - $request = $request->withParsedBody($this->decodeJson((string) $request->getBody())); + if (ServerRequest::create($request)->clientProducesMediaType(MediaType::JSON)) { + $request = $request->withParsedBody( + $this->decodeJson((string) $request->getBody()) + ); } return $handler->handle($request); @@ -68,7 +69,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface /** * @return array * - * @throws HttpExceptionInterface If the JSON couldn't be decoded. + * @throws HttpException If the JSON couldn't be decoded. */ private function decodeJson(string $json): array { diff --git a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php index 8addfbb5..3da295b3 100644 --- a/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php +++ b/src/Middleware/PayloadMediaTypeNegotiationMiddleware.php @@ -17,9 +17,11 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\MiddlewareInterface; use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\Dictionary\HeaderName; +use Sunrise\Http\Router\Dictionary\PlaceholderCode; use Sunrise\Http\Router\Entity\MediaType\StringableMediaType; +use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ServerRequest; use function array_map; @@ -39,7 +41,7 @@ public function __construct( /** * @inheritDoc * - * @throws HttpExceptionInterface If the request payload's media type isn't supported by the server. + * @throws HttpException If the request payload's media type isn't supported by the server. */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { @@ -52,13 +54,19 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface $clientProducedMediaType = $serverRequest->getClientProducedMediaType(); if ($clientProducedMediaType === null) { throw HttpExceptionFactory::missingContentType($this->errorMessage, $this->errorStatusCode) - ->addHeaderField('Accept', ...array_map(StringableMediaType::create(...), $serverConsumedMediaTypes)); + ->addHeaderField(HeaderName::ACCEPT, ...array_map( + StringableMediaType::create(...), + $serverConsumedMediaTypes, + )); } if (!$serverRequest->clientProducesMediaType(...$serverConsumedMediaTypes)) { throw HttpExceptionFactory::unsupportedMediaType($this->errorMessage, $this->errorStatusCode) - ->addMessagePlaceholder('{{ media_type }}', $clientProducedMediaType->getIdentifier()) - ->addHeaderField('Accept', ...array_map(StringableMediaType::create(...), $serverConsumedMediaTypes)); + ->addMessagePlaceholder(PlaceholderCode::MEDIA_TYPE, $clientProducedMediaType->getIdentifier()) + ->addHeaderField(HeaderName::ACCEPT, ...array_map( + StringableMediaType::create(...), + $serverConsumedMediaTypes, + )); } return $handler->handle($request); diff --git a/src/MiddlewareResolver.php b/src/MiddlewareResolver.php index 19990f1b..51e30fa3 100644 --- a/src/MiddlewareResolver.php +++ b/src/MiddlewareResolver.php @@ -26,7 +26,6 @@ use Sunrise\Http\Router\Middleware\CallableMiddleware; use Sunrise\Http\Router\ParameterResolver\DirectObjectInjectionParameterResolver; -use function class_exists; use function is_array; use function is_callable; use function is_string; @@ -59,7 +58,7 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface } if ($reference instanceof Closure) { - return new CallableMiddleware($this->normalizeCallback($reference, new ReflectionFunction($reference))); + return $this->resolveCallback($reference, new ReflectionFunction($reference)); } if (is_string($reference) && is_subclass_of($reference, MiddlewareInterface::class)) { @@ -68,18 +67,14 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 if (is_array($reference) && is_callable($reference, true)) { - /** @var array{0: string|object, 1: string} $reference */ - if (is_string($reference[0]) && class_exists($reference[0])) { + /** @var array{0: class-string|object, 1: string} $reference */ + + if (is_string($reference[0])) { $reference[0] = $this->classResolver->resolveClass($reference[0]); } if (is_callable($reference)) { - /** @var array{0: class-string|object, 1: non-empty-string} $reference */ - $reflection = new ReflectionMethod($reference[0], $reference[1]); - - /** @var callable $reference */ - - return new CallableMiddleware($this->normalizeCallback($reference, $reflection)); + return $this->resolveCallback($reference, new ReflectionMethod($reference[0], $reference[1])); } } @@ -90,26 +85,28 @@ public function resolveMiddleware(mixed $reference): MiddlewareInterface } /** - * @return callable(ServerRequestInterface, RequestHandlerInterface): ResponseInterface - * * @throws InvalidArgumentException * @throws LogicException */ - private function normalizeCallback(callable $callback, ReflectionMethod|ReflectionFunction $reflection): callable - { - return fn(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface => ( - $this->responseResolverChain->resolveResponse( - $callback( - ...$this->parameterResolverChain + private function resolveCallback( + callable $callback, + ReflectionMethod|ReflectionFunction $reflection, + ): MiddlewareInterface { + return new CallableMiddleware( + fn(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface => ( + $this->responseResolverChain->resolveResponse( + $callback( + ...$this->parameterResolverChain ->withContext($request) ->withResolver( new DirectObjectInjectionParameterResolver($request), new DirectObjectInjectionParameterResolver($handler), ) ->resolveParameters(...$reflection->getParameters()) - ), - $reflection, - $request, + ), + $reflection, + $request, + ) ) ); } diff --git a/src/ParameterResolver/RequestBodyParameterResolver.php b/src/ParameterResolver/RequestBodyParameterResolver.php index b16bb1ff..e54b6864 100644 --- a/src/ParameterResolver/RequestBodyParameterResolver.php +++ b/src/ParameterResolver/RequestBodyParameterResolver.php @@ -20,15 +20,18 @@ use ReflectionNamedType; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestBody; +use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ParameterResolverChain; use Sunrise\Http\Router\ParameterResolverInterface; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; +use function array_map; use function sprintf; /** @@ -41,13 +44,14 @@ public function __construct( private readonly ?ValidatorInterface $validator = null, private readonly ?int $defaultErrorStatusCode = null, private readonly ?string $defaultErrorMessage = null, + private readonly bool $defaultValidationEnabled = true, ) { } /** * @inheritDoc * - * @throws HttpExceptionInterface + * @throws HttpException * @throws InvalidArgumentException * @throws InvalidObjectException */ @@ -82,13 +86,22 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->hydrate($className, (array) $context->getParsedBody()); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidBody($errorMessage, $errorStatusCode, previous: $e) - ->addHydratorConstraintViolation(...$e->getExceptions()); + ->addConstraintViolation(...array_map( + HydratorConstraintViolationAdapter::create(...), + $e->getExceptions(), + )); } - if ($processParams->validation && $this->validator !== null) { - if (($violations = $this->validator->validate($argument))->count() > 0) { + $validationEnabled = $processParams->validationEnabled ?? $this->defaultValidationEnabled; + + if ($this->validator !== null && $validationEnabled) { + $violations = $this->validator->validate($argument); + if ($violations->count() > 0) { throw HttpExceptionFactory::invalidBody($errorMessage, $errorStatusCode) - ->addValidatorConstraintViolation(...$violations); + ->addConstraintViolation(...array_map( + ValidatorConstraintViolationAdapter::create(...), + [...$violations], + )); } } diff --git a/src/ParameterResolver/RequestCookieParameterResolver.php b/src/ParameterResolver/RequestCookieParameterResolver.php index cfc3e0e2..0599f3ed 100644 --- a/src/ParameterResolver/RequestCookieParameterResolver.php +++ b/src/ParameterResolver/RequestCookieParameterResolver.php @@ -18,11 +18,14 @@ use ReflectionAttribute; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestCookie; +use Sunrise\Http\Router\Dictionary\PlaceholderCode; +use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ServerRequest; use Sunrise\Http\Router\Validation\Constraint\ArgumentConstraint; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\Exception\InvalidValueException; @@ -30,25 +33,26 @@ use Sunrise\Hydrator\Type; use Symfony\Component\Validator\Validator\ValidatorInterface; +use function array_map; + /** * @since 3.0.0 */ final class RequestCookieParameterResolver implements ParameterResolverInterface { - private const PLACEHOLDER_COOKIE_NAME = '{{ cookie_name }}'; - public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, private readonly ?int $defaultErrorStatusCode = null, private readonly ?string $defaultErrorMessage = null, + private readonly bool $defaultValidationEnabled = true, ) { } /** * @inheritDoc * - * @throws HttpExceptionInterface + * @throws HttpException * @throws InvalidObjectException */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator @@ -76,11 +80,10 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } throw HttpExceptionFactory::missingCookie($errorMessage, $errorStatusCode) - ->addMessagePlaceholder(self::PLACEHOLDER_COOKIE_NAME, $cookieName); + ->addMessagePlaceholder(PlaceholderCode::COOKIE_NAME, $cookieName); } try { - /** @var mixed $argument */ $argument = $this->hydrator->castValue( $request->getCookieParam($cookieName), Type::fromParameter($parameter), @@ -88,15 +91,20 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } catch (InvalidValueException $e) { throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder(self::PLACEHOLDER_COOKIE_NAME, $cookieName) - ->addHydratorConstraintViolation($e); + ->addMessagePlaceholder(PlaceholderCode::COOKIE_NAME, $cookieName) + ->addConstraintViolation(new HydratorConstraintViolationAdapter($e)); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder(self::PLACEHOLDER_COOKIE_NAME, $cookieName) - ->addHydratorConstraintViolation(...$e->getExceptions()); + ->addMessagePlaceholder(PlaceholderCode::COOKIE_NAME, $cookieName) + ->addConstraintViolation(...array_map( + HydratorConstraintViolationAdapter::create(...), + $e->getExceptions(), + )); } - if ($processParams->validation && $this->validator !== null) { + $validationEnabled = $processParams->validationEnabled ?? $this->defaultValidationEnabled; + + if ($this->validator !== null && $validationEnabled) { $violations = $this->validator ->startContext() ->atPath($cookieName) @@ -105,8 +113,11 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if ($violations->count() > 0) { throw HttpExceptionFactory::invalidCookie($errorMessage, $errorStatusCode) - ->addMessagePlaceholder(self::PLACEHOLDER_COOKIE_NAME, $cookieName) - ->addValidatorConstraintViolation(...$violations); + ->addMessagePlaceholder(PlaceholderCode::COOKIE_NAME, $cookieName) + ->addConstraintViolation(...array_map( + ValidatorConstraintViolationAdapter::create(...), + [...$violations], + )); } } diff --git a/src/ParameterResolver/RequestHeaderParameterResolver.php b/src/ParameterResolver/RequestHeaderParameterResolver.php index 79abb96d..ede1ce6b 100644 --- a/src/ParameterResolver/RequestHeaderParameterResolver.php +++ b/src/ParameterResolver/RequestHeaderParameterResolver.php @@ -18,10 +18,13 @@ use ReflectionAttribute; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestHeader; +use Sunrise\Http\Router\Dictionary\PlaceholderCode; +use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\Validation\Constraint\ArgumentConstraint; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\Exception\InvalidValueException; @@ -29,25 +32,26 @@ use Sunrise\Hydrator\Type; use Symfony\Component\Validator\Validator\ValidatorInterface; +use function array_map; + /** * @since 3.0.0 */ final class RequestHeaderParameterResolver implements ParameterResolverInterface { - private const PLACEHOLDER_HEADER_NAME = '{{ header_name }}'; - public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, private readonly ?int $defaultErrorStatusCode = null, private readonly ?string $defaultErrorMessage = null, + private readonly bool $defaultValidationEnabled = true, ) { } /** * @inheritDoc * - * @throws HttpExceptionInterface + * @throws HttpException * @throws InvalidObjectException */ public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator @@ -74,11 +78,10 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } throw HttpExceptionFactory::missingHeader($errorMessage, $errorStatusCode) - ->addMessagePlaceholder(self::PLACEHOLDER_HEADER_NAME, $headerName); + ->addMessagePlaceholder(PlaceholderCode::HEADER_NAME, $headerName); } try { - /** @var mixed $argument */ $argument = $this->hydrator->castValue( $context->getHeaderLine($headerName), Type::fromParameter($parameter), @@ -86,15 +89,20 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } catch (InvalidValueException $e) { throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder(self::PLACEHOLDER_HEADER_NAME, $headerName) - ->addHydratorConstraintViolation($e); + ->addMessagePlaceholder(PlaceholderCode::HEADER_NAME, $headerName) + ->addConstraintViolation(new HydratorConstraintViolationAdapter($e)); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder(self::PLACEHOLDER_HEADER_NAME, $headerName) - ->addHydratorConstraintViolation(...$e->getExceptions()); + ->addMessagePlaceholder(PlaceholderCode::HEADER_NAME, $headerName) + ->addConstraintViolation(...array_map( + HydratorConstraintViolationAdapter::create(...), + $e->getExceptions(), + )); } - if ($processParams->validation && $this->validator !== null) { + $validationEnabled = $processParams->validationEnabled ?? $this->defaultValidationEnabled; + + if ($this->validator !== null && $validationEnabled) { $violations = $this->validator ->startContext() ->atPath($headerName) @@ -103,8 +111,11 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if ($violations->count() > 0) { throw HttpExceptionFactory::invalidHeader($errorMessage, $errorStatusCode) - ->addMessagePlaceholder(self::PLACEHOLDER_HEADER_NAME, $headerName) - ->addValidatorConstraintViolation(...$violations); + ->addMessagePlaceholder(PlaceholderCode::HEADER_NAME, $headerName) + ->addConstraintViolation(...array_map( + ValidatorConstraintViolationAdapter::create(...), + [...$violations], + )); } } diff --git a/src/ParameterResolver/RequestQueryParamParameterResolver.php b/src/ParameterResolver/RequestQueryParamParameterResolver.php new file mode 100644 index 00000000..2beb7bcc --- /dev/null +++ b/src/ParameterResolver/RequestQueryParamParameterResolver.php @@ -0,0 +1,131 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\ParameterResolver; + +use Generator; +use Psr\Http\Message\ServerRequestInterface; +use ReflectionAttribute; +use ReflectionParameter; +use Sunrise\Http\Router\Annotation\RequestQueryParam; +use Sunrise\Http\Router\Dictionary\PlaceholderCode; +use Sunrise\Http\Router\Exception\HttpException; +use Sunrise\Http\Router\Exception\HttpExceptionFactory; +use Sunrise\Http\Router\ParameterResolverInterface; +use Sunrise\Http\Router\ServerRequest; +use Sunrise\Http\Router\Validation\Constraint\ArgumentConstraint; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; +use Sunrise\Hydrator\Exception\InvalidDataException; +use Sunrise\Hydrator\Exception\InvalidObjectException; +use Sunrise\Hydrator\Exception\InvalidValueException; +use Sunrise\Hydrator\HydratorInterface; +use Sunrise\Hydrator\Type; +use Symfony\Component\Validator\Validator\ValidatorInterface; + +use function array_map; + +/** + * @since 3.0.0 + */ +final class RequestQueryParamParameterResolver implements ParameterResolverInterface +{ + public function __construct( + private readonly HydratorInterface $hydrator, + private readonly ?ValidatorInterface $validator = null, + private readonly ?int $defaultErrorStatusCode = null, + private readonly ?string $defaultErrorMessage = null, + private readonly bool $defaultValidationEnabled = true, + ) { + } + + /** + * @inheritDoc + * + * @throws HttpException + * @throws InvalidObjectException + */ + public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + { + if (! $context instanceof ServerRequestInterface) { + return; + } + + /** @var list> $annotations */ + $annotations = $parameter->getAttributes(RequestQueryParam::class); + if ($annotations === []) { + return; + } + + $request = ServerRequest::create($context); + $processParams = $annotations[0]->newInstance(); + + $queryParamName = $processParams->name; + $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; + $errorMessage = $processParams->errorMessage ?? $this->defaultErrorMessage; + + if (!$request->hasQueryParam($queryParamName)) { + if ($parameter->isDefaultValueAvailable()) { + return yield $parameter->getDefaultValue(); + } + + throw HttpExceptionFactory::missingQueryParam($errorMessage, $errorStatusCode) + ->addMessagePlaceholder(PlaceholderCode::QUERY_PARAM_NAME, $queryParamName); + } + + try { + $argument = $this->hydrator->castValue( + $request->getQueryParam($queryParamName), + Type::fromParameter($parameter), + path: [$queryParamName], + ); + } catch (InvalidValueException $e) { + throw HttpExceptionFactory::invalidQueryParam($errorMessage, $errorStatusCode, previous: $e) + ->addMessagePlaceholder(PlaceholderCode::QUERY_PARAM_NAME, $queryParamName) + ->addConstraintViolation(new HydratorConstraintViolationAdapter($e)); + } catch (InvalidDataException $e) { + throw HttpExceptionFactory::invalidQueryParam($errorMessage, $errorStatusCode, previous: $e) + ->addMessagePlaceholder(PlaceholderCode::QUERY_PARAM_NAME, $queryParamName) + ->addConstraintViolation(...array_map( + HydratorConstraintViolationAdapter::create(...), + $e->getExceptions(), + )); + } + + $validationEnabled = $processParams->validationEnabled ?? $this->defaultValidationEnabled; + + if ($this->validator !== null && $validationEnabled) { + $violations = $this->validator + ->startContext() + ->atPath($queryParamName) + ->validate($argument, new ArgumentConstraint($parameter)) + ->getViolations(); + + if ($violations->count() > 0) { + throw HttpExceptionFactory::invalidQueryParam($errorMessage, $errorStatusCode) + ->addMessagePlaceholder(PlaceholderCode::QUERY_PARAM_NAME, $queryParamName) + ->addConstraintViolation(...array_map( + ValidatorConstraintViolationAdapter::create(...), + [...$violations], + )); + } + } + + yield $argument; + } + + public function getWeight(): int + { + return 0; + } +} diff --git a/src/ParameterResolver/RequestQueryParameterResolver.php b/src/ParameterResolver/RequestQueryParameterResolver.php index 66864e2d..2dfc94c5 100644 --- a/src/ParameterResolver/RequestQueryParameterResolver.php +++ b/src/ParameterResolver/RequestQueryParameterResolver.php @@ -20,15 +20,18 @@ use ReflectionNamedType; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestQuery; +use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\ParameterResolverChain; use Sunrise\Http\Router\ParameterResolverInterface; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\HydratorInterface; use Symfony\Component\Validator\Validator\ValidatorInterface; +use function array_map; use function sprintf; /** @@ -41,13 +44,14 @@ public function __construct( private readonly ?ValidatorInterface $validator = null, private readonly ?int $defaultErrorStatusCode = null, private readonly ?string $defaultErrorMessage = null, + private readonly bool $defaultValidationEnabled = true, ) { } /** * @inheritDoc * - * @throws HttpExceptionInterface + * @throws HttpException * @throws InvalidArgumentException * @throws InvalidObjectException */ @@ -82,13 +86,22 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) $argument = $this->hydrator->hydrate($className, $context->getQueryParams()); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidQuery($errorMessage, $errorStatusCode, previous: $e) - ->addHydratorConstraintViolation(...$e->getExceptions()); + ->addConstraintViolation(...array_map( + HydratorConstraintViolationAdapter::create(...), + $e->getExceptions(), + )); } - if ($processParams->validation && $this->validator !== null) { - if (($violations = $this->validator->validate($argument))->count() > 0) { + $validationEnabled = $processParams->validationEnabled ?? $this->defaultValidationEnabled; + + if ($this->validator !== null && $validationEnabled) { + $violations = $this->validator->validate($argument); + if ($violations->count() > 0) { throw HttpExceptionFactory::invalidQuery($errorMessage, $errorStatusCode) - ->addValidatorConstraintViolation(...$violations); + ->addConstraintViolation(...array_map( + ValidatorConstraintViolationAdapter::create(...), + [...$violations], + )); } } diff --git a/src/ParameterResolver/RequestVariableParameterResolver.php b/src/ParameterResolver/RequestVariableParameterResolver.php index 5c977cdf..857ef687 100644 --- a/src/ParameterResolver/RequestVariableParameterResolver.php +++ b/src/ParameterResolver/RequestVariableParameterResolver.php @@ -19,13 +19,16 @@ use ReflectionAttribute; use ReflectionParameter; use Sunrise\Http\Router\Annotation\RequestVariable; +use Sunrise\Http\Router\Dictionary\PlaceholderCode; +use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\Helper\RouteSimplifier; use Sunrise\Http\Router\ParameterResolverChain; use Sunrise\Http\Router\ParameterResolverInterface; use Sunrise\Http\Router\ServerRequest; use Sunrise\Http\Router\Validation\Constraint\ArgumentConstraint; +use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; +use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; use Sunrise\Hydrator\Exception\InvalidDataException; use Sunrise\Hydrator\Exception\InvalidObjectException; use Sunrise\Hydrator\Exception\InvalidValueException; @@ -33,6 +36,7 @@ use Sunrise\Hydrator\Type; use Symfony\Component\Validator\Validator\ValidatorInterface; +use function array_map; use function sprintf; /** @@ -40,21 +44,19 @@ */ final class RequestVariableParameterResolver implements ParameterResolverInterface { - private const PLACEHOLDER_VARIABLE_NAME = '{{ variable_name }}'; - private const PLACEHOLDER_ROUTE_URI = '{{ route_uri }}'; - public function __construct( private readonly HydratorInterface $hydrator, private readonly ?ValidatorInterface $validator = null, private readonly ?int $defaultErrorStatusCode = null, private readonly ?string $defaultErrorMessage = null, + private readonly bool $defaultValidationEnabled = true, ) { } /** * @inheritDoc * - * @throws HttpExceptionInterface + * @throws HttpException * @throws InvalidArgumentException * @throws InvalidObjectException */ @@ -93,7 +95,6 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) } try { - /** @var mixed $argument */ $argument = $this->hydrator->castValue( $route->getAttribute($variableName), Type::fromParameter($parameter), @@ -101,17 +102,22 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) ); } catch (InvalidValueException $e) { throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder(self::PLACEHOLDER_VARIABLE_NAME, $variableName) - ->addMessagePlaceholder(self::PLACEHOLDER_ROUTE_URI, RouteSimplifier::simplifyRoute($route->getPath())) - ->addHydratorConstraintViolation($e); + ->addMessagePlaceholder(PlaceholderCode::VARIABLE_NAME, $variableName) + ->addMessagePlaceholder(PlaceholderCode::ROUTE_URI, RouteSimplifier::simplifyRoute($route->getPath())) + ->addConstraintViolation(new HydratorConstraintViolationAdapter($e)); } catch (InvalidDataException $e) { throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder(self::PLACEHOLDER_VARIABLE_NAME, $variableName) - ->addMessagePlaceholder(self::PLACEHOLDER_ROUTE_URI, RouteSimplifier::simplifyRoute($route->getPath())) - ->addHydratorConstraintViolation(...$e->getExceptions()); + ->addMessagePlaceholder(PlaceholderCode::VARIABLE_NAME, $variableName) + ->addMessagePlaceholder(PlaceholderCode::ROUTE_URI, RouteSimplifier::simplifyRoute($route->getPath())) + ->addConstraintViolation(...array_map( + HydratorConstraintViolationAdapter::create(...), + $e->getExceptions(), + )); } - if ($processParams->validation && $this->validator !== null) { + $validationEnabled = $processParams->validationEnabled ?? $this->defaultValidationEnabled; + + if ($this->validator !== null && $validationEnabled) { $violations = $this->validator ->startContext() ->atPath($variableName) @@ -120,10 +126,13 @@ public function resolveParameter(ReflectionParameter $parameter, mixed $context) if ($violations->count() > 0) { throw HttpExceptionFactory::invalidVariable($errorMessage, $errorStatusCode) - ->addMessagePlaceholder(self::PLACEHOLDER_VARIABLE_NAME, $variableName) + ->addMessagePlaceholder(PlaceholderCode::VARIABLE_NAME, $variableName) // phpcs:ignore Generic.Files.LineLength.TooLong - ->addMessagePlaceholder(self::PLACEHOLDER_ROUTE_URI, RouteSimplifier::simplifyRoute($route->getPath())) - ->addValidatorConstraintViolation(...$violations); + ->addMessagePlaceholder(PlaceholderCode::ROUTE_URI, RouteSimplifier::simplifyRoute($route->getPath())) + ->addConstraintViolation(...array_map( + ValidatorConstraintViolationAdapter::create(...), + [...$violations], + )); } } diff --git a/src/ParameterResolverChain.php b/src/ParameterResolverChain.php index c9c777de..3bc47d92 100644 --- a/src/ParameterResolverChain.php +++ b/src/ParameterResolverChain.php @@ -65,9 +65,8 @@ public function withResolver(ParameterResolverInterface ...$resolvers): static public function resolveParameters(ReflectionParameter ...$parameters): Generator { $this->isSorted or $this->sortResolvers(); - foreach ($parameters as $parameter) { - yield from $this->resolveParameter($parameter, $this->context); + yield from $this->resolveParameter($parameter); } } @@ -77,10 +76,10 @@ public function resolveParameters(ReflectionParameter ...$parameters): Generator * @throws InvalidArgumentException * @throws LogicException */ - private function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator + private function resolveParameter(ReflectionParameter $parameter): Generator { foreach ($this->resolvers as $resolver) { - $arguments = $resolver->resolveParameter($parameter, $context); + $arguments = $resolver->resolveParameter($parameter, $this->context); if ($arguments->valid()) { return yield from $arguments; } diff --git a/src/RequestHandlerResolver.php b/src/RequestHandlerResolver.php index 6fd72916..64924319 100644 --- a/src/RequestHandlerResolver.php +++ b/src/RequestHandlerResolver.php @@ -25,7 +25,6 @@ use Sunrise\Http\Router\ParameterResolver\DirectObjectInjectionParameterResolver; use Sunrise\Http\Router\RequestHandler\CallableRequestHandler; -use function class_exists; use function is_array; use function is_callable; use function is_string; @@ -58,23 +57,19 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface } if ($reference instanceof Closure) { - return new CallableRequestHandler($this->normalizeCallback($reference, new ReflectionFunction($reference))); + return $this->resolveCallback($reference, new ReflectionFunction($reference)); } // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 if (is_array($reference) && is_callable($reference, true)) { - /** @var array{0: string|object, 1: string} $reference */ - if (is_string($reference[0]) && class_exists($reference[0])) { + /** @var array{0: class-string|object, 1: string} $reference */ + + if (is_string($reference[0])) { $reference[0] = $this->classResolver->resolveClass($reference[0]); } if (is_callable($reference)) { - /** @var array{0: class-string|object, 1: non-empty-string} $reference */ - $reflection = new ReflectionMethod($reference[0], $reference[1]); - - /** @var callable $reference */ - - return new CallableRequestHandler($this->normalizeCallback($reference, $reflection)); + return $this->resolveCallback($reference, new ReflectionMethod($reference[0], $reference[1])); } } @@ -89,25 +84,25 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface } /** - * @return callable(ServerRequestInterface): ResponseInterface - * * @throws InvalidArgumentException * @throws LogicException */ - private function normalizeCallback(callable $callback, ReflectionMethod|ReflectionFunction $reflection): callable - { - return fn(ServerRequestInterface $request): ResponseInterface => ( - $this->responseResolverChain->resolveResponse( - $callback( - ...$this->parameterResolverChain + private function resolveCallback( + callable $callback, + ReflectionMethod|ReflectionFunction $reflection, + ): RequestHandlerInterface { + return new CallableRequestHandler( + fn(ServerRequestInterface $request): ResponseInterface => ( + $this->responseResolverChain->resolveResponse( + $callback( + ...$this->parameterResolverChain ->withContext($request) - ->withResolver( - new DirectObjectInjectionParameterResolver($request), - ) + ->withResolver(new DirectObjectInjectionParameterResolver($request)) ->resolveParameters(...$reflection->getParameters()) - ), - $reflection, - $request, + ), + $reflection, + $request, + ) ) ); } diff --git a/src/ResponseResolver/ResponseEmptyResolver.php b/src/ResponseResolver/ResponseEmptyResolver.php index 0ff09c6c..f5e91212 100644 --- a/src/ResponseResolver/ResponseEmptyResolver.php +++ b/src/ResponseResolver/ResponseEmptyResolver.php @@ -19,7 +19,7 @@ use Psr\Http\Message\ServerRequestInterface; use ReflectionFunction; use ReflectionMethod; -use Sunrise\Http\Router\Annotation\Response\EmptyResponse; +use Sunrise\Http\Router\Annotation\EmptyResponse; use Sunrise\Http\Router\ResponseResolverInterface; /** @@ -27,7 +27,7 @@ */ final class ResponseEmptyResolver implements ResponseResolverInterface { - public const DEFAULT_STATUS_CODE = StatusCodeInterface::STATUS_NO_CONTENT; + private const DEFAULT_STATUS_CODE = StatusCodeInterface::STATUS_NO_CONTENT; public function __construct( private readonly ResponseFactoryInterface $responseFactory, diff --git a/src/ResponseResolver/ResponseJsonResolver.php b/src/ResponseResolver/ResponseJsonResolver.php index 5d651a9f..99f417b5 100644 --- a/src/ResponseResolver/ResponseJsonResolver.php +++ b/src/ResponseResolver/ResponseJsonResolver.php @@ -22,7 +22,8 @@ use ReflectionFunction; use ReflectionMethod; use RuntimeException; -use Sunrise\Http\Router\Annotation\Response\JsonResponse; +use Sunrise\Http\Router\Annotation\JsonResponse; +use Sunrise\Http\Router\Dictionary\HeaderName; use Sunrise\Http\Router\ResponseResolverChain; use Sunrise\Http\Router\ResponseResolverInterface; @@ -36,8 +37,8 @@ */ final class ResponseJsonResolver implements ResponseResolverInterface { - public const DEFAULT_ENCODING_FLAGS = 0; - public const DEFAULT_ENCODING_DEPTH = 512; + private const DEFAULT_ENCODING_FLAGS = 0; + private const DEFAULT_ENCODING_DEPTH = 512; public function __construct( private readonly ResponseFactoryInterface $responseFactory, @@ -80,7 +81,7 @@ public function resolveResponse( $jsonResponse = $this->responseFactory ->createResponse(StatusCodeInterface::STATUS_OK) - ->withHeader('Content-Type', 'application/json; charset=UTF-8'); + ->withHeader(HeaderName::CONTENT_TYPE, 'application/json; charset=UTF-8'); $jsonResponse->getBody()->write($payload); diff --git a/src/ResponseResolverChain.php b/src/ResponseResolverChain.php index c72df536..5ddbec12 100644 --- a/src/ResponseResolverChain.php +++ b/src/ResponseResolverChain.php @@ -55,7 +55,6 @@ public function resolveResponse( } $this->isSorted or $this->sortResolvers(); - foreach ($this->resolvers as $resolver) { $result = $resolver->resolveResponse($response, $responder, $request); if ($result instanceof ResponseInterface) { diff --git a/src/Route.php b/src/Route.php index 9dc0e2d9..963cd9f0 100644 --- a/src/Route.php +++ b/src/Route.php @@ -115,7 +115,6 @@ public function hasAttribute(string $name): bool public function withAddedAttributes(array $attributes): static { $clone = clone $this; - /** @var mixed $value */ foreach ($attributes as $name => $value) { $clone->attributes[$name] = $value; } diff --git a/src/Router.php b/src/Router.php index 0249a875..faf1b9ae 100644 --- a/src/Router.php +++ b/src/Router.php @@ -19,10 +19,12 @@ use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; +use Sunrise\Http\Router\Dictionary\HeaderName; +use Sunrise\Http\Router\Dictionary\PlaceholderCode; use Sunrise\Http\Router\Event\RoutePostRunEvent; use Sunrise\Http\Router\Event\RoutePreRunEvent; +use Sunrise\Http\Router\Exception\HttpException; use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\Exception\HttpExceptionInterface; use Sunrise\Http\Router\Helper\RouteBuilder; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Helper\RouteMatcher; @@ -131,7 +133,7 @@ public function addRoute(RouteInterface ...$routes): void /** * @inheritDoc * - * @throws HttpExceptionInterface + * @throws HttpException * @throws InvalidArgumentException * @throws LogicException */ @@ -168,18 +170,18 @@ public function match(ServerRequestInterface $request): RouteInterface if ($allowedMethods !== []) { throw HttpExceptionFactory::methodNotAllowed() - ->addMessagePlaceholder('{{ request_method }}', $requestMethod) - ->addHeaderField('Allow', ...array_keys($allowedMethods)); + ->addMessagePlaceholder(PlaceholderCode::REQUEST_METHOD, $requestMethod) + ->addHeaderField(HeaderName::ALLOW, ...array_keys($allowedMethods)); } throw HttpExceptionFactory::resourceNotFound() - ->addMessagePlaceholder('{{ request_uri }}', $requestPath); + ->addMessagePlaceholder(PlaceholderCode::REQUEST_URI, $requestPath); } /** * @inheritDoc * - * @throws HttpExceptionInterface + * @throws HttpException * @throws InvalidArgumentException * @throws LogicException */ @@ -199,7 +201,6 @@ public function runRoute(RouteInterface|string $route, ServerRequestInterface $r $route = $this->getRoute($route); } - /** @var mixed $value */ foreach ($route->getAttributes() as $name => $value) { $request = $request->withAttribute($name, $value); } @@ -209,7 +210,7 @@ public function runRoute(RouteInterface|string $route, ServerRequestInterface $r if ($this->eventDispatcher !== null) { $event = new RoutePreRunEvent($route, $request); $this->eventDispatcher->dispatch($event); - $request = $event->getRequest(); + $request = $event->request; } $response = $this->getRouteRequestHandler($route)->handle($request); @@ -217,7 +218,7 @@ public function runRoute(RouteInterface|string $route, ServerRequestInterface $r if ($this->eventDispatcher !== null) { $event = new RoutePostRunEvent($route, $request, $response); $this->eventDispatcher->dispatch($event); - $response = $event->getResponse(); + $response = $event->response; } return $response; @@ -283,9 +284,10 @@ public function getRouteRequestHandler(RouteInterface|string $route): RequestHan $middlewares = array_merge($this->routeMiddlewares, $route->getMiddlewares()); if ($middlewares !== []) { $this->routeRequestHandlers[$name] = new QueueableRequestHandler($this->routeRequestHandlers[$name]); - /** @var mixed $middleware */ foreach ($middlewares as $middleware) { - $this->routeRequestHandlers[$name]->enqueue($this->referenceResolver->resolveMiddleware($middleware)); + $this->routeRequestHandlers[$name]->enqueue( + $this->referenceResolver->resolveMiddleware($middleware) + ); } } @@ -294,8 +296,6 @@ public function getRouteRequestHandler(RouteInterface|string $route): RequestHan /** * @throws InvalidArgumentException - * - * @since 3.0.0 */ private function getRequestHandler(): RequestHandlerInterface { @@ -310,9 +310,10 @@ private function getRequestHandler(): RequestHandlerInterface if ($this->middlewares !== []) { $this->requestHandler = new QueueableRequestHandler($this->requestHandler); - /** @var mixed $middleware */ foreach ($this->middlewares as $middleware) { - $this->requestHandler->enqueue($this->referenceResolver->resolveMiddleware($middleware)); + $this->requestHandler->enqueue( + $this->referenceResolver->resolveMiddleware($middleware) + ); } } @@ -322,7 +323,7 @@ private function getRequestHandler(): RequestHandlerInterface /** * @throws InvalidArgumentException * - * @since 3.0.0 The method was removed from the contract. + * @since 3.0.0 This method has become private. */ private function load(): void { diff --git a/src/RouterInterface.php b/src/RouterInterface.php index 0016798c..9e1257ab 100644 --- a/src/RouterInterface.php +++ b/src/RouterInterface.php @@ -17,7 +17,7 @@ use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Server\RequestHandlerInterface; -use Sunrise\Http\Router\Exception\HttpExceptionInterface; +use Sunrise\Http\Router\Exception\HttpException; /** * @since 3.0.0 @@ -51,7 +51,7 @@ public function hasRoute(string $name): bool; public function addRoute(RouteInterface ...$routes): void; /** - * @throws HttpExceptionInterface + * @throws HttpException * * @since 1.0.0 */ @@ -60,7 +60,7 @@ public function match(ServerRequestInterface $request): RouteInterface; /** * @inheritDoc * - * @throws HttpExceptionInterface + * @throws HttpException * * @since 1.0.0 */ diff --git a/src/ServerRequest.php b/src/ServerRequest.php index 5f81d32e..a29a6a93 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -18,13 +18,12 @@ use Psr\Http\Message\ServerRequestInterface; use Psr\Http\Message\StreamInterface; use Psr\Http\Message\UriInterface; +use Sunrise\Http\Router\Dictionary\HeaderName; use Sunrise\Http\Router\Entity\Locale\Locale; use Sunrise\Http\Router\Entity\Locale\LocaleComparator; -use Sunrise\Http\Router\Entity\Locale\LocaleComparatorInterface; use Sunrise\Http\Router\Entity\Locale\LocaleInterface; use Sunrise\Http\Router\Entity\MediaType\MediaType; use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparator; -use Sunrise\Http\Router\Entity\MediaType\MediaTypeComparatorInterface; use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; use Sunrise\Http\Router\Helper\HeaderParser; @@ -38,16 +37,9 @@ */ final class ServerRequest implements ServerRequestInterface { - private readonly LocaleComparatorInterface $localeComparator; - private readonly MediaTypeComparatorInterface $mediaTypeComparator; - public function __construct( private ServerRequestInterface $request, - ?LocaleComparatorInterface $localeComparator = null, - ?MediaTypeComparatorInterface $mediaTypeComparator = null, ) { - $this->localeComparator = $localeComparator ?? new LocaleComparator(); - $this->mediaTypeComparator = $mediaTypeComparator ?? new MediaTypeComparator(); } public static function create(ServerRequestInterface $request): self @@ -55,11 +47,6 @@ public static function create(ServerRequestInterface $request): self return ($request instanceof self) ? $request : new self($request); } - public function getOriginalRequest(): ServerRequestInterface - { - return ($this->request instanceof self) ? $this->request->getOriginalRequest() : $this->request; - } - /** * @throws LogicException If the request doesn't contain a route. */ @@ -76,9 +63,9 @@ public function getRoute(): RouteInterface return $route; } - public function getClientProducedMediaType(): ?MediaType + public function getClientProducedMediaType(): ?MediaTypeInterface { - $values = HeaderParser::parseHeader($this->request->getHeaderLine('Content-Type')); + $values = HeaderParser::parseHeader($this->request->getHeaderLine(HeaderName::CONTENT_TYPE)); if ($values === []) { return null; } @@ -92,7 +79,7 @@ public function getClientProducedMediaType(): ?MediaType } /** - * @return Generator + * @return Generator * * @throws LogicException */ @@ -105,7 +92,7 @@ public function getClientConsumedLocales(): Generator ); } - $values = HeaderParser::parseHeader($this->request->getHeaderLine('Accept-Language')); + $values = HeaderParser::parseHeader($this->request->getHeaderLine(HeaderName::ACCEPT_LANGUAGE)); if ($values === []) { return; } @@ -118,17 +105,22 @@ public function getClientConsumedLocales(): Generator foreach ($values as [$identifier]) { $subtags = \Locale::parseLocale($identifier); if (isset($subtags['language'])) { - yield new Locale($subtags['language'], $subtags['region'] ?? null); + /** @var string $languageCode */ + $languageCode = $subtags['language']; + /** @var string|null $regionCode */ + $regionCode = $subtags['region'] ?? null; + + yield new Locale($languageCode, $regionCode); } } } /** - * @return Generator, MediaType> + * @return Generator, MediaTypeInterface> */ public function getClientConsumedMediaTypes(): Generator { - $values = HeaderParser::parseHeader($this->request->getHeaderLine('Accept')); + $values = HeaderParser::parseHeader($this->request->getHeaderLine(HeaderName::ACCEPT)); if ($values === []) { return; } @@ -138,10 +130,9 @@ public function getClientConsumedMediaTypes(): Generator (float) ($b[1]['q'] ?? '1') <=> (float) ($a[1]['q'] ?? '1') )); - /** @phpstan-var int<0, max> $index */ - foreach ($values as $index => [$identifier]) { + foreach ($values as [$identifier]) { if (preg_match('|^([^/]+)/([^/]+)$|', $identifier) === 1) { - yield $index => new MediaType($identifier); + yield new MediaType($identifier); } } } @@ -161,7 +152,7 @@ public function getClientPreferredLocale(LocaleInterface ...$serverProducedLocal foreach ($this->getClientConsumedLocales() as $clientConsumedLanguage) { foreach ($serverProducedLocales as $serverProducedLanguage) { - if ($this->localeComparator->compare($clientConsumedLanguage, $serverProducedLanguage) === 0) { + if (LocaleComparator::compare($clientConsumedLanguage, $serverProducedLanguage) === 0) { return $serverProducedLanguage; } } @@ -185,7 +176,7 @@ public function getClientPreferredMediaType(MediaTypeInterface ...$serverProduce foreach ($this->getClientConsumedMediaTypes() as $clientConsumedMediaType) { foreach ($serverProducedMediaTypes as $serverProducedMediaType) { - if ($this->mediaTypeComparator->compare($clientConsumedMediaType, $serverProducedMediaType) === 0) { + if (MediaTypeComparator::compare($clientConsumedMediaType, $serverProducedMediaType) === 0) { return $serverProducedMediaType; } } @@ -207,7 +198,7 @@ public function clientProducesMediaType(MediaTypeInterface ...$serverConsumedMed } foreach ($serverConsumedMediaTypes as $serverConsumedMediaType) { - if ($this->mediaTypeComparator->compare($clientProducedMediaType, $serverConsumedMediaType) === 0) { + if (MediaTypeComparator::compare($clientProducedMediaType, $serverConsumedMediaType) === 0) { return true; } } @@ -215,16 +206,6 @@ public function clientProducesMediaType(MediaTypeInterface ...$serverConsumedMed return false; } - public function isJsonPayload(): bool - { - return $this->clientProducesMediaType(MediaType::json()); - } - - public function isXmlPayload(): bool - { - return $this->clientProducesMediaType(MediaType::xml()); - } - /** * @inheritDoc */ diff --git a/src/Validation/Constraint/ArgumentConstraintValidator.php b/src/Validation/Constraint/ArgumentConstraintValidator.php index 9cb02448..d62fe6d9 100644 --- a/src/Validation/Constraint/ArgumentConstraintValidator.php +++ b/src/Validation/Constraint/ArgumentConstraintValidator.php @@ -41,7 +41,6 @@ public function validate(mixed $value, Constraint $constraint): void $constraintAnnotations = $constraint->getParameter()->getAttributes(ConstraintAnnotation::class); foreach ($constraintAnnotations as $constraintAnnotation) { $parameterConstraints = $constraintAnnotation->newInstance()->values; - /** @var mixed $parameterConstraint */ foreach ($parameterConstraints as $parameterConstraint) { if ($parameterConstraint instanceof Constraint) { $constraints[] = $parameterConstraint; diff --git a/src/functions/emit.php b/src/functions/emit.php index d7c55e2a..672906b4 100644 --- a/src/functions/emit.php +++ b/src/functions/emit.php @@ -27,7 +27,7 @@ function emit(ResponseInterface $response): void 'HTTP/%s %d %s', $response->getProtocolVersion(), $response->getStatusCode(), - $response->getReasonPhrase() + $response->getReasonPhrase(), )); foreach ($response->getHeaders() as $name => $values) { diff --git a/tests/Command/RouterClearDescriptorsCacheCommandTest.php b/tests/Command/RouterClearDescriptorsCacheCommandTest.php index aeb7ecdf..782da2a0 100644 --- a/tests/Command/RouterClearDescriptorsCacheCommandTest.php +++ b/tests/Command/RouterClearDescriptorsCacheCommandTest.php @@ -8,23 +8,26 @@ use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Command\RouterClearDescriptorsCacheCommand; use Sunrise\Http\Router\Loader\DescriptorLoaderInterface; +use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Tester\CommandTester; -final class RouterClearCacheCommandTest extends TestCase +final class RouterClearDescriptorsCacheCommandTest extends TestCase { - private DescriptorLoaderInterface&MockObject $descriptorLoader; + private DescriptorLoaderInterface&MockObject $mockedDescriptorLoader; protected function setUp(): void { - $this->descriptorLoader = $this->createMock(DescriptorLoaderInterface::class); + $this->mockedDescriptorLoader = $this->createMock(DescriptorLoaderInterface::class); } public function testExecute(): void { - $this->descriptorLoader->expects(self::once())->method('clearCache'); + $this->mockedDescriptorLoader + ->expects(self::once()) + ->method('clearCache'); - $command = new RouterClearDescriptorsCacheCommand($this->descriptorLoader); + $command = new RouterClearDescriptorsCacheCommand($this->mockedDescriptorLoader); $commandTester = new CommandTester($command); - $this->assertSame(0, $commandTester->execute([])); + $this->assertSame(Command::SUCCESS, $commandTester->execute([])); } } diff --git a/tests/Command/RouterListRoutesCommandTest.php b/tests/Command/RouterListRoutesCommandTest.php index 5386c4fc..0c47f270 100644 --- a/tests/Command/RouterListRoutesCommandTest.php +++ b/tests/Command/RouterListRoutesCommandTest.php @@ -9,43 +9,50 @@ use Sunrise\Http\Router\Command\RouterListRoutesCommand; use Sunrise\Http\Router\RouteInterface; use Sunrise\Http\Router\RouterInterface; +use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Tester\CommandTester; final class RouterListRoutesCommandTest extends TestCase { - private RouterInterface&MockObject $routerMock; + private RouterInterface&MockObject $mockedRouter; /** @var array */ - private array $routeMocks = []; + private array $mockedRoutes = []; protected function setUp(): void { - $this->routerMock = $this->createMock(RouterInterface::class); - $this->routeMocks = []; + $this->mockedRouter = $this->createMock(RouterInterface::class); + $this->mockedRoutes = []; } public function testExecuteWithRoutes(): void { $this->mockRoute(); - $this->routerMock->expects(self::once()) + $this->mockedRouter + ->expects(self::once()) ->method('getRoutes') - ->willReturn($this->routeMocks); + ->willReturn($this->mockedRoutes); - $command = new RouterListRoutesCommand($this->routerMock); + $command = new RouterListRoutesCommand($this->mockedRouter); $commandTester = new CommandTester($command); - $this->assertSame(0, $commandTester->execute([])); + $this->assertSame(Command::SUCCESS, $commandTester->execute([])); } public function testExecuteWithoutRoutes(): void { - $command = new RouterListRoutesCommand($this->routerMock); + $this->mockedRouter + ->expects(self::once()) + ->method('getRoutes') + ->willReturn([]); + + $command = new RouterListRoutesCommand($this->mockedRouter); $commandTester = new CommandTester($command); - $this->assertSame(0, $commandTester->execute([])); + $this->assertSame(Command::SUCCESS, $commandTester->execute([])); } private function mockRoute(): RouteInterface&MockObject { - return $this->routeMocks[] = $this->createMock(RouteInterface::class); + return $this->mockedRoutes[] = $this->createMock(RouteInterface::class); } } diff --git a/tests/Entity/Locale/LocaleComparatorTest.php b/tests/Entity/Locale/LocaleComparatorTest.php index d32fae5e..de6c7c1e 100644 --- a/tests/Entity/Locale/LocaleComparatorTest.php +++ b/tests/Entity/Locale/LocaleComparatorTest.php @@ -2,7 +2,7 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Tests\Entity\Language; +namespace Sunrise\Http\Router\Tests\Entity\Locale; use PHPUnit\Framework\Attributes\DataProvider; use PHPUnit\Framework\MockObject\MockObject; @@ -10,90 +10,47 @@ use Sunrise\Http\Router\Entity\Locale\LocaleComparator; use Sunrise\Http\Router\Entity\Locale\LocaleInterface; -final class LanguageComparatorTest extends TestCase +final class LocaleComparatorTest extends TestCase { #[DataProvider('compareDataProvider')] - public function testCompare(string $aCode, string $bCode, int $expected): void - { - $a = $this->mockLanguage(code: $aCode); - $b = $this->mockLanguage(code: $bCode); - - $this->assertSame($expected, (new LocaleComparator())->compare($a, $b)); + public function testCompare( + string $aLanguageCode, + ?string $aRegionCode, + string $bLanguageCode, + ?string $bRegionCode, + int $expectedResult, + ): void { + $a = $this->mockLocale($aLanguageCode, $aRegionCode); + $b = $this->mockLocale($bLanguageCode, $bRegionCode); + + $actualResult = LocaleComparator::compare($a, $b); + + $this->assertSame($expectedResult, $actualResult); } public static function compareDataProvider(): iterable { - yield [ - 'sr', - 'sr', - 0, - ]; - - yield [ - '*', - '*', - 0, - ]; - - yield [ - '*', - 'sr', - 0, - ]; - - yield [ - 'sr', - '*', - 0, - ]; - - yield [ - 'sr', - 'bs', - 1, - ]; - - yield [ - 'bs', - 'sr', - -1, - ]; - - yield [ - 'it', - 'IT', - 1, - ]; - - yield [ - 'IT', - 'it', - -1, - ]; + yield ['sr', null, 'sr', null, 0]; + yield ['sr', null, 'bs', null, 1]; + yield ['bs', null, 'sr', null, -1]; - yield [ - '', - '', - 0, - ]; + yield ['sr', null, 'SR', null, 1]; + yield ['SR', null, 'sr', null, -1]; - yield [ - 'sr', - '', - 1, - ]; + yield ['*', null, '*', null, 0]; + yield ['sr', null, '*', null, 0]; + yield ['*', null, 'sr', null, 0]; - yield [ - '', - 'sr', - -1, - ]; + yield ['sr', 'RS', 'sr', 'RS', 0]; + yield ['sr', 'RS', 'sr', 'ME', 1]; + yield ['sr', 'ME', 'sr', 'RS', -1]; } - private function mockLanguage(string $code): LocaleInterface&MockObject + private function mockLocale(string $languageCode, ?string $regionCode = null): LocaleInterface&MockObject { $language = $this->createMock(LocaleInterface::class); - $language->method('getLanguageCode')->willReturn($code); + $language->method('getLanguageCode')->willReturn($languageCode); + $language->method('getRegionCode')->willReturn($regionCode); return $language; } diff --git a/tests/Entity/Locale/LocaleTest.php b/tests/Entity/Locale/LocaleTest.php index 4c6558dd..b89c2f32 100644 --- a/tests/Entity/Locale/LocaleTest.php +++ b/tests/Entity/Locale/LocaleTest.php @@ -2,18 +2,17 @@ declare(strict_types=1); -namespace Sunrise\Http\Router\Tests\Entity\Language; +namespace Sunrise\Http\Router\Tests\Entity\Locale; use PHPUnit\Framework\TestCase; use Sunrise\Http\Router\Entity\Locale\Locale; -final class ClientLanguageTest extends TestCase +final class LocaleTest extends TestCase { public function testConstructor(): void { - $clientLanguage = new Locale('sr', 'sr-RS', ['q' => '1.0']); - $this->assertSame('sr', $clientLanguage->getLanguageCode()); - $this->assertSame('sr-RS', $clientLanguage->getLanguageCode()); - $this->assertSame(['q' => '1.0'], $clientLanguage->getParameters()); + $locale = new Locale('sr', 'RS'); + $this->assertSame('sr', $locale->getLanguageCode()); + $this->assertSame('RS', $locale->getRegionCode()); } } diff --git a/tests/Entity/MediaType/MediaTypeComparatorTest.php b/tests/Entity/MediaType/MediaTypeComparatorTest.php index 2b758b52..8469b170 100644 --- a/tests/Entity/MediaType/MediaTypeComparatorTest.php +++ b/tests/Entity/MediaType/MediaTypeComparatorTest.php @@ -13,12 +13,17 @@ final class MediaTypeComparatorTest extends TestCase { #[DataProvider('compareDataProvider')] - public function testCompare(string $aId, string $bId, int $expected): void - { - $a = $this->mockMediaType(identifier: $aId); - $b = $this->mockMediaType(identifier: $bId); + public function testCompare( + string $aIdentifier, + string $bIdentifier, + int $expectedResult, + ): void { + $a = $this->mockMediaType($aIdentifier); + $b = $this->mockMediaType($bIdentifier); + + $actualResult = MediaTypeComparator::compare($a, $b); - $this->assertSame($expected, (new MediaTypeComparator())->compare($a, $b)); + $this->assertSame($expectedResult, $actualResult); } public static function compareDataProvider(): iterable @@ -29,6 +34,18 @@ public static function compareDataProvider(): iterable 0, ]; + yield [ + 'application/json', + 'application/xml', + -1, + ]; + + yield [ + 'application/xml', + 'application/json', + 1, + ]; + yield [ 'application/json', 'APPLICATION/JSON', @@ -106,18 +123,6 @@ public static function compareDataProvider(): iterable '*/png', -1, ]; - - yield [ - 'application/json', - 'application/xml', - -1, - ]; - - yield [ - 'application/xml', - 'application/json', - 1, - ]; } private function mockMediaType(string $identifier): MediaTypeInterface&MockObject diff --git a/tests/Entity/MediaType/MediaTypeTest.php b/tests/Entity/MediaType/MediaTypeTest.php index 08085256..8d772127 100644 --- a/tests/Entity/MediaType/MediaTypeTest.php +++ b/tests/Entity/MediaType/MediaTypeTest.php @@ -5,14 +5,13 @@ namespace Sunrise\Http\Router\Tests\Entity\MediaType; use PHPUnit\Framework\TestCase; -use Sunrise\Http\Router\Entity\MediaType\ClientMediaType; +use Sunrise\Http\Router\Entity\MediaType\MediaType; -final class ClientMediaTypeTest extends TestCase +final class MediaTypeTest extends TestCase { public function testConstructor(): void { - $clientMediaType = new ClientMediaType('application/json', ['q' => '1.0']); - $this->assertSame('application/json', $clientMediaType->getIdentifier()); - $this->assertSame(['q' => '1.0'], $clientMediaType->getParameters()); + $mediaType = new MediaType('application/json'); + $this->assertSame('application/json', $mediaType->getIdentifier()); } } diff --git a/tests/Event/RoutePostRunEventTest.php b/tests/Event/RoutePostRunEventTest.php index f9748169..d2ecb2aa 100644 --- a/tests/Event/RoutePostRunEventTest.php +++ b/tests/Event/RoutePostRunEventTest.php @@ -13,30 +13,27 @@ final class RoutePostRunEventTest extends TestCase { - private RouteInterface&MockObject $routeMock; - private ServerRequestInterface&MockObject $serverRequestMock; - private ResponseInterface&MockObject $responseMock; + private RouteInterface&MockObject $mockedRoute; + private ServerRequestInterface&MockObject $mockedServerRequest; + private ResponseInterface&MockObject $mockedResponse; protected function setUp(): void { - $this->routeMock = $this->createMock(RouteInterface::class); - $this->serverRequestMock = $this->createMock(ServerRequestInterface::class); - $this->responseMock = $this->createMock(ResponseInterface::class); + $this->mockedRoute = $this->createMock(RouteInterface::class); + $this->mockedServerRequest = $this->createMock(ServerRequestInterface::class); + $this->mockedResponse = $this->createMock(ResponseInterface::class); } public function testConstructor(): void { - $event = new RoutePostRunEvent($this->routeMock, $this->serverRequestMock, $this->responseMock); - $this->assertSame($this->routeMock, $event->getRoute()); - $this->assertSame($this->serverRequestMock, $event->getRequest()); - $this->assertSame($this->responseMock, $event->getResponse()); - } + $event = new RoutePostRunEvent( + $this->mockedRoute, + $this->mockedServerRequest, + $this->mockedResponse, + ); - public function testSetResponse(): void - { - $event = new RoutePostRunEvent($this->routeMock, $this->serverRequestMock, $this->responseMock); - $newResponse = $this->createMock(ResponseInterface::class); - $event->setResponse($newResponse); - $this->assertSame($newResponse, $event->getResponse()); + $this->assertSame($this->mockedRoute, $event->route); + $this->assertSame($this->mockedServerRequest, $event->request); + $this->assertSame($this->mockedResponse, $event->response); } } diff --git a/tests/Event/RoutePreRunEventTest.php b/tests/Event/RoutePreRunEventTest.php index d439b6ef..59cbebb9 100644 --- a/tests/Event/RoutePreRunEventTest.php +++ b/tests/Event/RoutePreRunEventTest.php @@ -12,27 +12,23 @@ final class RoutePreRunEventTest extends TestCase { - private RouteInterface&MockObject $routeMock; - private ServerRequestInterface&MockObject $serverRequestMock; + private RouteInterface&MockObject $mockedRoute; + private ServerRequestInterface&MockObject $mockedServerRequest; protected function setUp(): void { - $this->routeMock = $this->createMock(RouteInterface::class); - $this->serverRequestMock = $this->createMock(ServerRequestInterface::class); + $this->mockedRoute = $this->createMock(RouteInterface::class); + $this->mockedServerRequest = $this->createMock(ServerRequestInterface::class); } public function testConstructor(): void { - $event = new RoutePreRunEvent($this->routeMock, $this->serverRequestMock); - $this->assertSame($this->routeMock, $event->getRoute()); - $this->assertSame($this->serverRequestMock, $event->getRequest()); - } + $event = new RoutePreRunEvent( + $this->mockedRoute, + $this->mockedServerRequest, + ); - public function testSetRequest(): void - { - $event = new RoutePreRunEvent($this->routeMock, $this->serverRequestMock); - $newServerRequest = $this->createMock(ServerRequestInterface::class); - $event->setRequest($newServerRequest); - $this->assertSame($newServerRequest, $event->getRequest()); + $this->assertSame($this->mockedRoute, $event->route); + $this->assertSame($this->mockedServerRequest, $event->request); } } diff --git a/tests/Exception/HttpExceptionTest.php b/tests/Exception/HttpExceptionTest.php index 79b9aec0..c44fbe7c 100644 --- a/tests/Exception/HttpExceptionTest.php +++ b/tests/Exception/HttpExceptionTest.php @@ -218,41 +218,4 @@ private function mockStringableObject(string $string): Stringable&MockObject return $stringableObjectMock; } - - private function createHydratorConstraintViolation( - string $message, - string $messageTemplate, - array $messagePlaceholders, - array $propertyPath, - string $errorCode, - mixed $invalidValue = null, - ): \Sunrise\Hydrator\Exception\InvalidValueException { - return new \Sunrise\Hydrator\Exception\InvalidValueException( - message: $message, - errorCode: $errorCode, - propertyPath: $propertyPath, - messageTemplate: $messageTemplate, - messagePlaceholders: $messagePlaceholders, - invalidValue: $invalidValue, - ); - } - - private function mockValidatorConstraintViolation( - string $message, - string $messageTemplate, - array $messagePlaceholders, - string $propertyPath, - string $errorCode, - mixed $invalidValue = null, - ): \Symfony\Component\Validator\ConstraintViolationInterface&MockObject { - $constraintViolationMock = $this->createMock(\Symfony\Component\Validator\ConstraintViolationInterface::class); - $constraintViolationMock->method('getMessage')->willReturn($message); - $constraintViolationMock->method('getMessageTemplate')->willReturn($messageTemplate); - $constraintViolationMock->method('getParameters')->willReturn($messagePlaceholders); - $constraintViolationMock->method('getPropertyPath')->willReturn($propertyPath); - $constraintViolationMock->method('getCode')->willReturn($errorCode); - $constraintViolationMock->method('getInvalidValue')->willReturn($invalidValue); - - return $constraintViolationMock; - } } From 62b104a68988bb2898d974d355d3cf2a2a2d77d7 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Mon, 13 Jan 2025 02:10:38 +0100 Subject: [PATCH 178/180] v3 --- resources/definitions/router.php | 4 + resources/translations/ru.php | 2 - resources/translations/sr.php | 2 - src/Annotation/ApiOperation.php | 41 ++ ...tQueryParam.php => DeleteApiOperation.php} | 13 +- src/Annotation/GetApiOperation.php | 28 + src/Annotation/HeadApiOperation.php | 28 + src/Annotation/JsonResponse.php | 2 +- src/Annotation/OptionsApiOperation.php | 28 + src/Annotation/PatchApiOperation.php | 28 + src/Annotation/PostApiOperation.php | 28 + src/Annotation/PurgeApiOperation.php | 28 + src/Annotation/PutApiOperation.php | 28 + src/Annotation/Route.php | 8 +- src/Annotation/SerializableResponse.php | 24 + .../RouterGenerateOpenApiDocumentCommand.php | 508 ++++++++++++++++++ src/Dictionary/ErrorMessage.php | 2 - src/Dictionary/PlaceholderCode.php | 1 - src/Helper/RouteBuilder.php | 2 +- src/Loader/DescriptorLoader.php | 55 +- .../JsonPayloadDecodingMiddleware.php | 4 +- .../RequestQueryParamParameterResolver.php | 131 ----- src/RequestHandler/CallableRequestHandler.php | 8 - src/RequestHandlerReflector.php | 65 +++ src/RequestHandlerReflectorInterface.php | 32 ++ src/RequestHandlerResolver.php | 8 +- ...Resolver.php => EmptyResponseResolver.php} | 2 +- ...nResolver.php => JsonResponseResolver.php} | 11 +- src/Route.php | 44 +- src/RouteInterface.php | 35 +- src/ServerRequest.php | 2 +- 31 files changed, 968 insertions(+), 234 deletions(-) create mode 100644 src/Annotation/ApiOperation.php rename src/Annotation/{RequestQueryParam.php => DeleteApiOperation.php} (57%) create mode 100644 src/Annotation/GetApiOperation.php create mode 100644 src/Annotation/HeadApiOperation.php create mode 100644 src/Annotation/OptionsApiOperation.php create mode 100644 src/Annotation/PatchApiOperation.php create mode 100644 src/Annotation/PostApiOperation.php create mode 100644 src/Annotation/PurgeApiOperation.php create mode 100644 src/Annotation/PutApiOperation.php create mode 100644 src/Annotation/SerializableResponse.php create mode 100644 src/Command/RouterGenerateOpenApiDocumentCommand.php delete mode 100644 src/ParameterResolver/RequestQueryParamParameterResolver.php create mode 100644 src/RequestHandlerReflector.php create mode 100644 src/RequestHandlerReflectorInterface.php rename src/ResponseResolver/{ResponseEmptyResolver.php => EmptyResponseResolver.php} (96%) rename src/ResponseResolver/{ResponseJsonResolver.php => JsonResponseResolver.php} (88%) diff --git a/resources/definitions/router.php b/resources/definitions/router.php index 7aec47b2..9806e95d 100644 --- a/resources/definitions/router.php +++ b/resources/definitions/router.php @@ -11,6 +11,8 @@ use Sunrise\Http\Router\ParameterResolverChainInterface; use Sunrise\Http\Router\ReferenceResolver; use Sunrise\Http\Router\ReferenceResolverInterface; +use Sunrise\Http\Router\RequestHandlerReflector; +use Sunrise\Http\Router\RequestHandlerReflectorInterface; use Sunrise\Http\Router\RequestHandlerResolver; use Sunrise\Http\Router\RequestHandlerResolverInterface; use Sunrise\Http\Router\ResponseResolverChain; @@ -65,6 +67,8 @@ get(RequestHandlerResolverInterface::class), ), + RequestHandlerReflectorInterface::class => create(RequestHandlerReflector::class), + RouterInterface::class => create(Router::class) ->constructor( loaders: get('router.loaders'), diff --git a/resources/translations/ru.php b/resources/translations/ru.php index f0c554ce..48997d72 100644 --- a/resources/translations/ru.php +++ b/resources/translations/ru.php @@ -13,8 +13,6 @@ ErrorMessage::UNSUPPORTED_MEDIA_TYPE => 'Тип медиа {{ media_type }} не поддерживается; Проверьте заголовок ответа "Accept" на поддерживаемые типы медиа.', ErrorMessage::INVALID_VARIABLE => 'Значение переменной {{{ variable_name }}} в URI запроса {{ route_uri }} невалидно.', ErrorMessage::INVALID_QUERY => 'Параметры запроса невалидны.', - ErrorMessage::MISSING_QUERY_PARAM => 'Параметр запроса {{ query_param_name }} должен быть предоставлен.', - ErrorMessage::INVALID_QUERY_PARAM => 'Параметр запроса {{ query_param_name }} невалиден.', ErrorMessage::MISSING_HEADER => 'Заголовок запроса {{ header_name }} должен быть предоставлен.', ErrorMessage::INVALID_HEADER => 'Заголовок запроса {{ header_name }} невалиден.', ErrorMessage::MISSING_COOKIE => 'Отсутствует cookie {{ cookie_name }}.', diff --git a/resources/translations/sr.php b/resources/translations/sr.php index f4eff27e..468e8fb8 100644 --- a/resources/translations/sr.php +++ b/resources/translations/sr.php @@ -13,8 +13,6 @@ ErrorMessage::UNSUPPORTED_MEDIA_TYPE => 'Tip medija {{ media_type }} nije podržan; Proverite zaglavlje odgovora "Accept" za podržane tipove medija.', ErrorMessage::INVALID_VARIABLE => 'Vrednost promenljive {{{ variable_name }}} u URI zahtevu {{ route_uri }} nije validna.', ErrorMessage::INVALID_QUERY => 'Parametri upita zahteva nisu validni.', - ErrorMessage::MISSING_QUERY_PARAM => 'Parametr zahteva {{ query_param_name }} mora biti navedeno.', - ErrorMessage::INVALID_QUERY_PARAM => 'Parametr zahteva {{ query_param_name }} nije validno.', ErrorMessage::MISSING_HEADER => 'Zaglavlje zahteva {{ header_name }} mora biti navedeno.', ErrorMessage::INVALID_HEADER => 'Zaglavlje zahteva {{ header_name }} nije validno.', ErrorMessage::MISSING_COOKIE => 'Kolačić {{ cookie_name }} nedostaje.', diff --git a/src/Annotation/ApiOperation.php b/src/Annotation/ApiOperation.php new file mode 100644 index 00000000..1585b19d --- /dev/null +++ b/src/Annotation/ApiOperation.php @@ -0,0 +1,41 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] +class ApiOperation extends Route +{ + /** + * @param string|array $method + */ + public function __construct( + string $name, + string $path = '', + string|array $method = [], + array $fields = [], + ) { + parent::__construct( + name: $name, + path: $path, + methods: (array) $method, + isApiOperation: true, + apiOperationFields: $fields, + ); + } +} diff --git a/src/Annotation/RequestQueryParam.php b/src/Annotation/DeleteApiOperation.php similarity index 57% rename from src/Annotation/RequestQueryParam.php rename to src/Annotation/DeleteApiOperation.php index 96abc9fb..e9be79c5 100644 --- a/src/Annotation/RequestQueryParam.php +++ b/src/Annotation/DeleteApiOperation.php @@ -18,14 +18,11 @@ /** * @since 3.0.0 */ -#[Attribute(Attribute::TARGET_PARAMETER)] -final class RequestQueryParam +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] +final class DeleteApiOperation extends ApiOperation { - public function __construct( - public readonly string $name, - public readonly ?int $errorStatusCode = null, - public readonly ?string $errorMessage = null, - public readonly ?bool $validationEnabled = null, - ) { + public function __construct(string $name, string $path = '', array $fields = []) + { + parent::__construct($name, $path, self::METHOD_DELETE, $fields); } } diff --git a/src/Annotation/GetApiOperation.php b/src/Annotation/GetApiOperation.php new file mode 100644 index 00000000..968f235f --- /dev/null +++ b/src/Annotation/GetApiOperation.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] +final class GetApiOperation extends ApiOperation +{ + public function __construct(string $name, string $path = '', array $fields = []) + { + parent::__construct($name, $path, self::METHOD_GET, $fields); + } +} diff --git a/src/Annotation/HeadApiOperation.php b/src/Annotation/HeadApiOperation.php new file mode 100644 index 00000000..c7182a5e --- /dev/null +++ b/src/Annotation/HeadApiOperation.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] +final class HeadApiOperation extends ApiOperation +{ + public function __construct(string $name, string $path = '', array $fields = []) + { + parent::__construct($name, $path, self::METHOD_HEAD, $fields); + } +} diff --git a/src/Annotation/JsonResponse.php b/src/Annotation/JsonResponse.php index 9910aac6..5fd1132f 100644 --- a/src/Annotation/JsonResponse.php +++ b/src/Annotation/JsonResponse.php @@ -19,7 +19,7 @@ * @since 3.0.0 */ #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] -final class JsonResponse +final class JsonResponse extends SerializableResponse { public function __construct( public readonly ?int $encodingFlags = null, diff --git a/src/Annotation/OptionsApiOperation.php b/src/Annotation/OptionsApiOperation.php new file mode 100644 index 00000000..3387888c --- /dev/null +++ b/src/Annotation/OptionsApiOperation.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] +final class OptionsApiOperation extends ApiOperation +{ + public function __construct(string $name, string $path = '', array $fields = []) + { + parent::__construct($name, $path, self::METHOD_OPTIONS, $fields); + } +} diff --git a/src/Annotation/PatchApiOperation.php b/src/Annotation/PatchApiOperation.php new file mode 100644 index 00000000..259211aa --- /dev/null +++ b/src/Annotation/PatchApiOperation.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] +final class PatchApiOperation extends ApiOperation +{ + public function __construct(string $name, string $path = '', array $fields = []) + { + parent::__construct($name, $path, self::METHOD_PATCH, $fields); + } +} diff --git a/src/Annotation/PostApiOperation.php b/src/Annotation/PostApiOperation.php new file mode 100644 index 00000000..4ae3fc64 --- /dev/null +++ b/src/Annotation/PostApiOperation.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] +final class PostApiOperation extends ApiOperation +{ + public function __construct(string $name, string $path = '', array $fields = []) + { + parent::__construct($name, $path, self::METHOD_POST, $fields); + } +} diff --git a/src/Annotation/PurgeApiOperation.php b/src/Annotation/PurgeApiOperation.php new file mode 100644 index 00000000..e1c63b6b --- /dev/null +++ b/src/Annotation/PurgeApiOperation.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] +final class PurgeApiOperation extends ApiOperation +{ + public function __construct(string $name, string $path = '', array $fields = []) + { + parent::__construct($name, $path, self::METHOD_PURGE, $fields); + } +} diff --git a/src/Annotation/PutApiOperation.php b/src/Annotation/PutApiOperation.php new file mode 100644 index 00000000..5e0ef048 --- /dev/null +++ b/src/Annotation/PutApiOperation.php @@ -0,0 +1,28 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] +final class PutApiOperation extends ApiOperation +{ + public function __construct(string $name, string $path = '', array $fields = []) + { + parent::__construct($name, $path, self::METHOD_PUT, $fields); + } +} diff --git a/src/Annotation/Route.php b/src/Annotation/Route.php index c4b0b886..114818af 100644 --- a/src/Annotation/Route.php +++ b/src/Annotation/Route.php @@ -14,13 +14,14 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; +use Fig\Http\Message\RequestMethodInterface; use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; /** * @since 2.0.0 */ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] -final class Route +class Route implements RequestMethodInterface { public mixed $holder = null; @@ -44,8 +45,6 @@ public function __construct( public array $attributes = [], /** @var array */ public array $middlewares = [], - /** @var array */ - public array $constraints = [], /** @var array */ public array $consumes = [], /** @var array */ @@ -55,6 +54,9 @@ public function __construct( public string $summary = '', public string $description = '', public bool $isDeprecated = false, + public bool $isApiOperation = false, + /** @var array|object|null */ + public array|object|null $apiOperationFields = null, public int $priority = 0, ) { } diff --git a/src/Annotation/SerializableResponse.php b/src/Annotation/SerializableResponse.php new file mode 100644 index 00000000..483edc04 --- /dev/null +++ b/src/Annotation/SerializableResponse.php @@ -0,0 +1,24 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Annotation; + +use Attribute; + +/** + * @since 3.0.0 + */ +#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] +abstract class SerializableResponse +{ +} diff --git a/src/Command/RouterGenerateOpenApiDocumentCommand.php b/src/Command/RouterGenerateOpenApiDocumentCommand.php new file mode 100644 index 00000000..75a3c79b --- /dev/null +++ b/src/Command/RouterGenerateOpenApiDocumentCommand.php @@ -0,0 +1,508 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router\Command; + +use ArrayAccess; +use BackedEnum; +use DateTimeImmutable; +use DateTimeInterface; +use DateTimeZone; +use ReflectionAttribute; +use ReflectionClass; +use ReflectionEnum; +use ReflectionException; +use ReflectionMethod; +use ReflectionNamedType; +use ReflectionParameter; +use ReflectionProperty; +use ReflectionType; +use Sunrise\Http\Message\Response; +use Sunrise\Http\Router\Annotation\RequestBody; +use Sunrise\Http\Router\Annotation\RequestCookie; +use Sunrise\Http\Router\Annotation\RequestHeader; +use Sunrise\Http\Router\Annotation\ResponseStatus; +use Sunrise\Http\Router\Annotation\SerializableResponse; +use Sunrise\Http\Router\Helper\RouteBuilder; +use Sunrise\Http\Router\Helper\RouteParser; +use Sunrise\Http\Router\Helper\RouteSimplifier; +use Sunrise\Http\Router\RequestHandlerReflectorInterface; +use Sunrise\Http\Router\RouteInterface; +use Sunrise\Http\Router\RouterInterface; +use Sunrise\Hydrator\Annotation\Alias; +use Symfony\Component\Console\Attribute\AsCommand; +use Symfony\Component\Console\Command\Command; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Output\OutputInterface; + +use function array_merge; +use function class_exists; +use function compact; +use function date; +use function end; +use function in_array; +use function is_a; +use function is_subclass_of; +use function json_encode; +use function sprintf; +use function strtolower; + +use function strtr; +use const JSON_PRETTY_PRINT; +use const JSON_UNESCAPED_SLASHES; +use const JSON_UNESCAPED_UNICODE; +use const PHP_INT_SIZE; + +/** + * @since 3.0.0 + */ +#[AsCommand('router:generate-open-api-document', 'Generates OpenAPI Document.')] +final class RouterGenerateOpenApiDocumentCommand extends Command +{ + private const BUILT_IN_TYPE_BOOL = 'bool'; + private const BUILT_IN_TYPE_INT = 'int'; + private const BUILT_IN_TYPE_FLOAT = 'float'; + private const BUILT_IN_TYPE_STRING = 'string'; + private const BUILT_IN_TYPE_ARRAY = 'array'; + + private static array $schemas = []; + + public function __construct( + private readonly RouterInterface $router, + private readonly RequestHandlerReflectorInterface $requestHandlerReflector, + private readonly array $document, + private readonly string $dateTimeFormat, + ) { + parent::__construct(); + } + + /** + * @inheritDoc + */ + protected function execute(InputInterface $input, OutputInterface $output): int + { + $document = $this->document; + + foreach ($this->router->getRoutes() as $route) { + if (!$route->isApiOperation()) { + continue; + } + + $controller = $this->requestHandlerReflector->reflectRequestHandler($route->getRequestHandler()); + if (! $controller instanceof ReflectionMethod) { + continue; + } + + self::enrichDocumentWithPaths($route, $controller, $document); + } + + foreach (self::$schemas as $name => $schema) { + $document['components']['schemas'][$name] = $schema; + } + + /** @var string $json */ + $json = json_encode($document, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES); + + $output->writeln($json); + + return self::SUCCESS; + } + + private static function enrichDocumentWithPaths( + RouteInterface $route, + ReflectionMethod $controller, + array &$document, + ): void { + $operation = $route->getApiOperationFields(); + $operation['operationId'] = $route->getName(); + $operation['tags'] = $route->getTags(); + $operation['summary'] = $route->getSummary(); + $operation['description'] = $route->getDescription(); + $operation['deprecated'] = $route->isDeprecated(); + + self::enrichOperationWithPathParameters($route, $operation); + self::enrichOperationWithCookieAndHeaderParameters($controller, $operation); + self::enrichOperationWithRequestBody($route, $controller, $operation); + self::enrichOperationWithResponses($route, $controller, $operation); + + $routePath = RouteSimplifier::simplifyRoute($route->getPath()); + foreach ($route->getMethods() as $routeMethod) { + $routeMethod = strtolower($routeMethod); + $document['paths'][$routePath][$routeMethod] = $operation; + } + } + + private static function enrichOperationWithPathParameters(RouteInterface $route, array &$operation): void + { + $routeVars = RouteParser::parseRoute($route->getPath()); + $routePatterns = $route->getPatterns(); + $routeAttributes = $route->getAttributes(); + + foreach ($routeVars as $routeVar) { + $parameter = []; + $parameter['in'] = 'path'; + $parameter['name'] = $routeVar['name']; + $parameter['schema']['type'] = 'string'; + + $pattern = $routeVar['pattern'] ?? $routePatterns[$routeVar['name']] ?? null; + if ($pattern !== null) { + $parameter['schema']['pattern'] = '^' . $pattern . '$'; + } + + if (isset($routeAttributes[$routeVar['name']])) { + $default = RouteBuilder::stringifyValue($routeAttributes[$routeVar['name']]); + $parameter['schema']['default'] = $default; + } + + if (!isset($routeVar['optional_part'])) { + $parameter['required'] = true; + } + + $operation['parameters'][] = $parameter; + } + } + + private static function enrichOperationWithCookieAndHeaderParameters( + ReflectionMethod $endpoint, + array &$operation, + ): void { + foreach ($endpoint->getParameters() as $endpointParameter) { + /** @var list> $annotations */ + $annotations = array_merge( + $endpointParameter->getAttributes(RequestCookie::class), + $endpointParameter->getAttributes(RequestHeader::class), + ); + + foreach ($annotations as $annotation) { + $annotation = $annotation->newInstance(); + + $operationParameter = []; + + $operationParameter['in'] = match ($annotation::class) { + RequestCookie::class => 'cookie', + RequestHeader::class => 'header', + }; + + $operationParameter['name'] = $annotation->name; + $operationParameter['schema'] = self::getStringSchema(); + + if (!$endpointParameter->isDefaultValueAvailable()) { + $operationParameter['required'] = true; + } + + $operation['parameters'][] = $operationParameter; + } + } + } + + private static function enrichOperationWithRequestBody( + RouteInterface $route, + ReflectionMethod $controller, + array &$operation, + ): void { + foreach ($controller->getParameters() as $parameter) { + if ($parameter->getAttributes(RequestBody::class) === []) { + continue; + } + + $schema = self::getTypeSchema($parameter->getType()); + + foreach ($route->getConsumedMediaTypes() as $mediaType) { + $operation['requestBody']['content'][$mediaType->getIdentifier()]['schema'] = $schema; + } + + return; + } + } + + private static function enrichOperationWithResponses( + RouteInterface $route, + ReflectionMethod $controller, + array &$operation, + ): void { + if ($controller->getAttributes(SerializableResponse::class, ReflectionAttribute::IS_INSTANCEOF) === []) { + return; + } + + $schema = self::getTypeSchema($controller->getReturnType()); + + $responseStatusCode = 200; + $responseStatusPhrase = 'Ok'; + + /** @var list> $annotations */ + $annotations = $controller->getAttributes(ResponseStatus::class); + if (isset($annotations[0])) { + $responseStatus = $annotations[0]->newInstance(); + $responseStatusCode = $responseStatus->code; + } + + foreach ($route->getProducedMediaTypes() as $mediaType) { + $operation['responses'][$responseStatusCode]['content'][$mediaType->getIdentifier()]['schema'] = $schema; + $operation['responses'][$responseStatusCode]['description'] = $responseStatusPhrase; + } + } + + /** + * @throws ReflectionException + */ + private static function getTypeSchema(?ReflectionType $type): array + { + if ($type === null) { + return []; + } + + $schema = []; + + $typeName = (string) $type; + + if ($typeName === self::BUILT_IN_TYPE_BOOL) { + $schema = self::getBoolSchema(); + } elseif ($typeName === self::BUILT_IN_TYPE_INT) { + $schema = self::getIntSchema(); + } elseif ($typeName === self::BUILT_IN_TYPE_FLOAT) { + $schema = self::getFloatSchema(); + } elseif ($typeName === self::BUILT_IN_TYPE_STRING) { + $schema = self::getStringSchema(); + } elseif ($typeName === self::BUILT_IN_TYPE_ARRAY) { + $schema = self::getArraySchema(); + } elseif (is_subclass_of($typeName, BackedEnum::class)) { + $schema = self::getEnumSchema($typeName, nullable: $type->allowsNull()); + } elseif (is_subclass_of($typeName, ArrayAccess::class)) { + $schema = self::getCollectionSchema($typeName); + } elseif (is_a($typeName, DateTimeImmutable::class, true)) { + $schema = self::getStringSchema(); + $schema['format'] = 'date-time'; + } elseif (class_exists($typeName)) { + $schema = self::getClassSchema($typeName); + } + + if ($type->allowsNull()) { + $schema['nullable'] = true; + } + + return $schema; + } + + private static function getBoolSchema(): array + { + return [ + 'type' => 'boolean', + ]; + } + + private static function getIntSchema(): array + { + return [ + 'type' => 'integer', + 'format' => PHP_INT_SIZE === 4 ? 'int32' : 'int64', + ]; + } + + private static function getFloatSchema(): array + { + return [ + 'type' => 'number', + 'format' => 'double', + ]; + } + + private static function getStringSchema(): array + { + return [ + 'type' => 'string', + ]; + } + + /** + * @return array{oneOf: array{0: array{type: 'array'}, 1: array{type: 'object'}}} + */ + private static function getArraySchema(): array + { + return [ + 'oneOf' => [ + [ + 'type' => 'array', + ], + [ + 'type' => 'object', + ], + ], + ]; + } + + /** + * @param class-string $enumName + * + * @throws ReflectionException + */ + private static function getEnumSchema(string $enumName, bool $nullable = false): array + { + $schemaName = strtr($enumName, '\\', '.'); + $schemaRef = self::getSchemaRef($schemaName); + + if (isset(self::$schemas[$schemaName])) { + return $schemaRef; + } + + $schema = match ((string) (new ReflectionEnum($enumName))->getBackingType()) { + self::BUILT_IN_TYPE_INT => self::getIntSchema(), + self::BUILT_IN_TYPE_STRING => self::getStringSchema(), + }; + + $schema['enum'] = []; + foreach ($enumName::cases() as $case) { + $schema['enum'][] = $case->value; + } + + // https://swagger.io/docs/specification/data-models/enums/#nullable + if ($nullable) { + $schema['enum'][] = null; + } + + self::$schemas[$schemaName] = $schema; + + return $schemaRef; + } + + /** + * @link https://github.com/sunrise-php/hydrator/blob/main/README.md#array + * + * @param class-string $className + * + * @throws ReflectionException + */ + private static function getCollectionSchema(string $className): array + { + $schemaName = strtr($className, '\\', '.'); + $schemaRef = self::getSchemaRef($schemaName); + + if (isset(self::$schemas[$schemaName])) { + return $schemaRef; + } + + $class = new ReflectionClass($className); + + $schema = self::getArraySchema(); + + $constructor = $class->getConstructor(); + if ($constructor === null) { + return $schema; + } + + $parameters = $constructor->getParameters(); + if ($parameters === []) { + return $schema; + } + + /** @var ReflectionParameter $parameter */ + $parameter = end($parameters); + if (!$parameter->isVariadic()) { + return $schema; + } + + $type = $parameter->getType(); + if ($type === null) { + return $schema; + } + + $elementSchema = self::getTypeSchema($type); + + $schema['oneOf'][0]['items'] = $elementSchema; + $schema['oneOf'][1]['additionalProperties'] = $elementSchema; + + self::$schemas[$schemaName] = $schema; + + return $schemaRef; + } + + /** + * @param class-string $className + * + * @throws ReflectionException + */ + private static function getClassSchema(string $className): array + { + $schemaName = strtr($className, '\\', '.'); + $schemaRef = self::getSchemaRef($schemaName); + + if (isset(self::$schemas[$schemaName])) { + return $schemaRef; + } + + $class = new ReflectionClass($className); + + $schema = [ + 'type' => 'object', + 'additionalProperties' => false, + ]; + + foreach ($class->getProperties() as $property) { + $propertyName = self::getPropertyName($property); + $propertySchema = self::getTypeSchema($property->getType()); + + $schema['properties'][$propertyName] = $propertySchema; + + if (!self::isOptionalProperty($property)) { + $schema['required'][] = $propertyName; + } + } + + self::$schemas[$schemaName] = $schema; + + return $schemaRef; + } + + /** + * @link https://github.com/sunrise-php/hydrator/blob/main/README.md#property-alias + */ + private static function getPropertyName(ReflectionProperty $property): string + { + /** @var list> $annotations */ + $annotations = $property->getAttributes(Alias::class); + if (isset($annotations[0])) { + $alias = $annotations[0]->newInstance(); + return $alias->value; + } + + return $property->getName(); + } + + /** + * @link https://github.com/sunrise-php/hydrator/blob/main/README.md#optional + */ + private static function isOptionalProperty(ReflectionProperty $property): bool + { + if ($property->hasDefaultValue()) { + return true; + } + + if (!$property->isPromoted()) { + return false; + } + + foreach ($property->getDeclaringClass()->getConstructor()?->getParameters() ?? [] as $parameter) { + if ($parameter->getName() === $property->getName()) { + return $parameter->isDefaultValueAvailable(); + } + } + + return false; // will never get here... + } + + private static function getSchemaRef(string $schemaName): array + { + return [ + '$ref' => '#/components/schemas/' . $schemaName, + ]; + } +} diff --git a/src/Dictionary/ErrorMessage.php b/src/Dictionary/ErrorMessage.php index 3e9d4b19..d0409bdc 100644 --- a/src/Dictionary/ErrorMessage.php +++ b/src/Dictionary/ErrorMessage.php @@ -26,8 +26,6 @@ final class ErrorMessage public const UNSUPPORTED_MEDIA_TYPE = 'The media type {{ media_type }} is not supported; Check the Accept response header for supported media types.'; public const INVALID_VARIABLE = 'The value of the variable {{{ variable_name }}} in the request URI {{ route_uri }} is invalid.'; public const INVALID_QUERY = 'The request query parameters are invalid.'; - public const MISSING_QUERY_PARAM = 'The query parameter {{ query_param_name }} is missing.'; - public const INVALID_QUERY_PARAM = 'The query parameter {{ query_param_name }} is invalid.'; public const MISSING_HEADER = 'The request header {{ header_name }} must be provided.'; public const INVALID_HEADER = 'The request header {{ header_name }} is invalid.'; public const MISSING_COOKIE = 'The cookie {{ cookie_name }} is missing.'; diff --git a/src/Dictionary/PlaceholderCode.php b/src/Dictionary/PlaceholderCode.php index 85ff87e7..f7076864 100644 --- a/src/Dictionary/PlaceholderCode.php +++ b/src/Dictionary/PlaceholderCode.php @@ -21,7 +21,6 @@ final class PlaceholderCode public const COOKIE_NAME = '{{ cookie_name }}'; public const HEADER_NAME = '{{ header_name }}'; public const MEDIA_TYPE = '{{ media_type }}'; - public const QUERY_PARAM_NAME = '{{ query_param_name }}'; public const REQUEST_METHOD = '{{ request_method }}'; public const REQUEST_URI = '{{ request_uri }}'; public const ROUTE_URI = '{{ route_uri }}'; diff --git a/src/Helper/RouteBuilder.php b/src/Helper/RouteBuilder.php index 24391aa4..dd20ce50 100644 --- a/src/Helper/RouteBuilder.php +++ b/src/Helper/RouteBuilder.php @@ -83,7 +83,7 @@ public static function buildRoute(string $route, array $values = []): string * * @throws InvalidArgumentException */ - private static function stringifyValue(mixed $value): string + public static function stringifyValue(mixed $value): string { if (is_string($value)) { return $value; diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index b910faeb..4e4081bd 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -22,11 +22,11 @@ use ReflectionClass; use ReflectionException; use ReflectionMethod; -use Sunrise\Http\Router\Annotation\Constraint; use Sunrise\Http\Router\Annotation\Consumes; use Sunrise\Http\Router\Annotation\DefaultAttribute; use Sunrise\Http\Router\Annotation\Deprecated; use Sunrise\Http\Router\Annotation\Description; +use Sunrise\Http\Router\Annotation\JsonResponse; use Sunrise\Http\Router\Annotation\Method; use Sunrise\Http\Router\Annotation\Middleware; use Sunrise\Http\Router\Annotation\NamePrefix; @@ -39,6 +39,7 @@ use Sunrise\Http\Router\Annotation\Route as Descriptor; use Sunrise\Http\Router\Annotation\Summary; use Sunrise\Http\Router\Annotation\Tag; +use Sunrise\Http\Router\Dictionary\MediaType; use Sunrise\Http\Router\Helper\ClassFinder; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Route; @@ -80,21 +81,22 @@ public function load(): Generator { foreach ($this->getDescriptors() as $descriptor) { yield new Route( - $descriptor->name, - $descriptor->path, - $descriptor->holder, - $descriptor->patterns, - $descriptor->methods, - $descriptor->attributes, - $descriptor->middlewares, - $descriptor->constraints, - $descriptor->consumes, - $descriptor->produces, - $descriptor->tags, - $descriptor->summary, - $descriptor->description, - $descriptor->isDeprecated, - $descriptor->pattern, + name: $descriptor->name, + path: $descriptor->path, + requestHandler: $descriptor->holder, + patterns: $descriptor->patterns, + methods: $descriptor->methods, + attributes: $descriptor->attributes, + middlewares: $descriptor->middlewares, + consumes: $descriptor->consumes, + produces: $descriptor->produces, + tags: $descriptor->tags, + summary: $descriptor->summary, + description: $descriptor->description, + isDeprecated: $descriptor->isDeprecated, + isApiOperation: $descriptor->isApiOperation, + apiOperationFields: $descriptor->apiOperationFields, + pattern: $descriptor->pattern, ); } } @@ -189,7 +191,7 @@ private static function getClassDescriptors(ReflectionClass $class): Generator if ($class->isSubclassOf(RequestHandlerInterface::class)) { /** @var list> $annotations */ - $annotations = $class->getAttributes(Descriptor::class); + $annotations = $class->getAttributes(Descriptor::class, ReflectionAttribute::IS_INSTANCEOF); if (isset($annotations[0])) { $descriptor = $annotations[0]->newInstance(); $descriptor->holder = $class->getName(); @@ -206,7 +208,7 @@ private static function getClassDescriptors(ReflectionClass $class): Generator } /** @var list> $annotations */ - $annotations = $method->getAttributes(Descriptor::class); + $annotations = $method->getAttributes(Descriptor::class, ReflectionAttribute::IS_INSTANCEOF); if (isset($annotations[0])) { $descriptor = $annotations[0]->newInstance(); $descriptor->holder = [$class->getName(), $method->getName()]; @@ -246,7 +248,7 @@ private static function enrichDescriptorFromClassOrMethod( } /** @var list> $annotations */ - $annotations = $classOrMethod->getAttributes(Path::class, ReflectionAttribute::IS_INSTANCEOF); + $annotations = $classOrMethod->getAttributes(Path::class); if (isset($annotations[0])) { $annotation = $annotations[0]->newInstance(); $descriptor->path = $annotation->value; @@ -298,15 +300,6 @@ private static function enrichDescriptorFromClassOrMethod( } } - /** @var list> $annotations */ - $annotations = $classOrMethod->getAttributes(Constraint::class); - foreach ($annotations as $annotation) { - $annotation = $annotation->newInstance(); - foreach ($annotation->values as $value) { - $descriptor->constraints[] = $value; - } - } - /** @var list> $annotations */ $annotations = $classOrMethod->getAttributes(Consumes::class, ReflectionAttribute::IS_INSTANCEOF); foreach ($annotations as $annotation) { @@ -325,6 +318,12 @@ private static function enrichDescriptorFromClassOrMethod( } } + /** @var list> $annotations */ + $annotations = $classOrMethod->getAttributes(JsonResponse::class); + if (isset($annotations[0])) { + $descriptor->produces[] = MediaType::JSON; + } + /** @var list> $annotations */ $annotations = $classOrMethod->getAttributes(Tag::class); foreach ($annotations as $annotation) { diff --git a/src/Middleware/JsonPayloadDecodingMiddleware.php b/src/Middleware/JsonPayloadDecodingMiddleware.php index d410a3f6..b8642e66 100644 --- a/src/Middleware/JsonPayloadDecodingMiddleware.php +++ b/src/Middleware/JsonPayloadDecodingMiddleware.php @@ -58,9 +58,7 @@ public function __construct( public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { if (ServerRequest::create($request)->clientProducesMediaType(MediaType::JSON)) { - $request = $request->withParsedBody( - $this->decodeJson((string) $request->getBody()) - ); + $request = $request->withParsedBody($this->decodeJson((string) $request->getBody())); } return $handler->handle($request); diff --git a/src/ParameterResolver/RequestQueryParamParameterResolver.php b/src/ParameterResolver/RequestQueryParamParameterResolver.php deleted file mode 100644 index 2beb7bcc..00000000 --- a/src/ParameterResolver/RequestQueryParamParameterResolver.php +++ /dev/null @@ -1,131 +0,0 @@ - - * @copyright Copyright (c) 2018, Anatoly Nekhay - * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE - * @link https://github.com/sunrise-php/http-router - */ - -declare(strict_types=1); - -namespace Sunrise\Http\Router\ParameterResolver; - -use Generator; -use Psr\Http\Message\ServerRequestInterface; -use ReflectionAttribute; -use ReflectionParameter; -use Sunrise\Http\Router\Annotation\RequestQueryParam; -use Sunrise\Http\Router\Dictionary\PlaceholderCode; -use Sunrise\Http\Router\Exception\HttpException; -use Sunrise\Http\Router\Exception\HttpExceptionFactory; -use Sunrise\Http\Router\ParameterResolverInterface; -use Sunrise\Http\Router\ServerRequest; -use Sunrise\Http\Router\Validation\Constraint\ArgumentConstraint; -use Sunrise\Http\Router\Validation\ConstraintViolation\HydratorConstraintViolationAdapter; -use Sunrise\Http\Router\Validation\ConstraintViolation\ValidatorConstraintViolationAdapter; -use Sunrise\Hydrator\Exception\InvalidDataException; -use Sunrise\Hydrator\Exception\InvalidObjectException; -use Sunrise\Hydrator\Exception\InvalidValueException; -use Sunrise\Hydrator\HydratorInterface; -use Sunrise\Hydrator\Type; -use Symfony\Component\Validator\Validator\ValidatorInterface; - -use function array_map; - -/** - * @since 3.0.0 - */ -final class RequestQueryParamParameterResolver implements ParameterResolverInterface -{ - public function __construct( - private readonly HydratorInterface $hydrator, - private readonly ?ValidatorInterface $validator = null, - private readonly ?int $defaultErrorStatusCode = null, - private readonly ?string $defaultErrorMessage = null, - private readonly bool $defaultValidationEnabled = true, - ) { - } - - /** - * @inheritDoc - * - * @throws HttpException - * @throws InvalidObjectException - */ - public function resolveParameter(ReflectionParameter $parameter, mixed $context): Generator - { - if (! $context instanceof ServerRequestInterface) { - return; - } - - /** @var list> $annotations */ - $annotations = $parameter->getAttributes(RequestQueryParam::class); - if ($annotations === []) { - return; - } - - $request = ServerRequest::create($context); - $processParams = $annotations[0]->newInstance(); - - $queryParamName = $processParams->name; - $errorStatusCode = $processParams->errorStatusCode ?? $this->defaultErrorStatusCode; - $errorMessage = $processParams->errorMessage ?? $this->defaultErrorMessage; - - if (!$request->hasQueryParam($queryParamName)) { - if ($parameter->isDefaultValueAvailable()) { - return yield $parameter->getDefaultValue(); - } - - throw HttpExceptionFactory::missingQueryParam($errorMessage, $errorStatusCode) - ->addMessagePlaceholder(PlaceholderCode::QUERY_PARAM_NAME, $queryParamName); - } - - try { - $argument = $this->hydrator->castValue( - $request->getQueryParam($queryParamName), - Type::fromParameter($parameter), - path: [$queryParamName], - ); - } catch (InvalidValueException $e) { - throw HttpExceptionFactory::invalidQueryParam($errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder(PlaceholderCode::QUERY_PARAM_NAME, $queryParamName) - ->addConstraintViolation(new HydratorConstraintViolationAdapter($e)); - } catch (InvalidDataException $e) { - throw HttpExceptionFactory::invalidQueryParam($errorMessage, $errorStatusCode, previous: $e) - ->addMessagePlaceholder(PlaceholderCode::QUERY_PARAM_NAME, $queryParamName) - ->addConstraintViolation(...array_map( - HydratorConstraintViolationAdapter::create(...), - $e->getExceptions(), - )); - } - - $validationEnabled = $processParams->validationEnabled ?? $this->defaultValidationEnabled; - - if ($this->validator !== null && $validationEnabled) { - $violations = $this->validator - ->startContext() - ->atPath($queryParamName) - ->validate($argument, new ArgumentConstraint($parameter)) - ->getViolations(); - - if ($violations->count() > 0) { - throw HttpExceptionFactory::invalidQueryParam($errorMessage, $errorStatusCode) - ->addMessagePlaceholder(PlaceholderCode::QUERY_PARAM_NAME, $queryParamName) - ->addConstraintViolation(...array_map( - ValidatorConstraintViolationAdapter::create(...), - [...$violations], - )); - } - } - - yield $argument; - } - - public function getWeight(): int - { - return 0; - } -} diff --git a/src/RequestHandler/CallableRequestHandler.php b/src/RequestHandler/CallableRequestHandler.php index e2bb91b0..c12adf00 100644 --- a/src/RequestHandler/CallableRequestHandler.php +++ b/src/RequestHandler/CallableRequestHandler.php @@ -37,14 +37,6 @@ public function __construct(callable $callback) $this->callback = $callback; } - /** - * @since 2.10.0 - */ - public function getCallback(): callable - { - return $this->callback; - } - /** * @inheritDoc */ diff --git a/src/RequestHandlerReflector.php b/src/RequestHandlerReflector.php new file mode 100644 index 00000000..8812f9af --- /dev/null +++ b/src/RequestHandlerReflector.php @@ -0,0 +1,65 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router; + +use Closure; +use InvalidArgumentException; +use Psr\Http\Server\RequestHandlerInterface; +use ReflectionClass; +use ReflectionException; +use ReflectionFunction; +use ReflectionMethod; + +use function is_array; +use function is_callable; +use function is_string; +use function is_subclass_of; +use function sprintf; + +/** + * @since 3.0.0 + */ +final class RequestHandlerReflector implements RequestHandlerReflectorInterface +{ + /** + * @inheritDoc + * + * @throws InvalidArgumentException + * @throws ReflectionException + */ + public function reflectRequestHandler(mixed $reference): ReflectionClass|ReflectionMethod|ReflectionFunction + { + if ($reference instanceof RequestHandlerInterface) { + return new ReflectionClass($reference); + } + + if ($reference instanceof Closure) { + return new ReflectionFunction($reference); + } + + if (is_string($reference) && is_subclass_of($reference, RequestHandlerInterface::class)) { + return new ReflectionClass($reference); + } + + // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 + if (is_array($reference) && is_callable($reference, true, $method)) { + return new ReflectionMethod($method); + } + + throw new InvalidArgumentException(sprintf( + 'The request handler reference %s could not be reflected.', + ReferenceResolver::stringifyReference($reference), + )); + } +} diff --git a/src/RequestHandlerReflectorInterface.php b/src/RequestHandlerReflectorInterface.php new file mode 100644 index 00000000..1fe2329f --- /dev/null +++ b/src/RequestHandlerReflectorInterface.php @@ -0,0 +1,32 @@ + + * @copyright Copyright (c) 2018, Anatoly Nekhay + * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE + * @link https://github.com/sunrise-php/http-router + */ + +declare(strict_types=1); + +namespace Sunrise\Http\Router; + +use InvalidArgumentException; +use ReflectionClass; +use ReflectionFunction; +use ReflectionMethod; + +/** + * @since 3.0.0 + */ +interface RequestHandlerReflectorInterface +{ + /** + * @return ReflectionClass|ReflectionMethod|ReflectionFunction + * + * @throws InvalidArgumentException + */ + public function reflectRequestHandler(mixed $reference): ReflectionClass|ReflectionMethod|ReflectionFunction; +} diff --git a/src/RequestHandlerResolver.php b/src/RequestHandlerResolver.php index 64924319..d9eafb09 100644 --- a/src/RequestHandlerResolver.php +++ b/src/RequestHandlerResolver.php @@ -60,6 +60,10 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface return $this->resolveCallback($reference, new ReflectionFunction($reference)); } + if (is_string($reference) && is_subclass_of($reference, RequestHandlerInterface::class)) { + return $this->classResolver->resolveClass($reference); + } + // https://github.com/php/php-src/blob/3ed526441400060aa4e618b91b3352371fcd02a8/Zend/zend_API.c#L3884-L3932 if (is_array($reference) && is_callable($reference, true)) { /** @var array{0: class-string|object, 1: string} $reference */ @@ -73,10 +77,6 @@ public function resolveRequestHandler(mixed $reference): RequestHandlerInterface } } - if (is_string($reference) && is_subclass_of($reference, RequestHandlerInterface::class)) { - return $this->classResolver->resolveClass($reference); - } - throw new InvalidArgumentException(sprintf( 'The request handler reference %s could not be resolved.', ReferenceResolver::stringifyReference($reference), diff --git a/src/ResponseResolver/ResponseEmptyResolver.php b/src/ResponseResolver/EmptyResponseResolver.php similarity index 96% rename from src/ResponseResolver/ResponseEmptyResolver.php rename to src/ResponseResolver/EmptyResponseResolver.php index f5e91212..68f4a113 100644 --- a/src/ResponseResolver/ResponseEmptyResolver.php +++ b/src/ResponseResolver/EmptyResponseResolver.php @@ -25,7 +25,7 @@ /** * @since 3.0.0 */ -final class ResponseEmptyResolver implements ResponseResolverInterface +final class EmptyResponseResolver implements ResponseResolverInterface { private const DEFAULT_STATUS_CODE = StatusCodeInterface::STATUS_NO_CONTENT; diff --git a/src/ResponseResolver/ResponseJsonResolver.php b/src/ResponseResolver/JsonResponseResolver.php similarity index 88% rename from src/ResponseResolver/ResponseJsonResolver.php rename to src/ResponseResolver/JsonResponseResolver.php index 99f417b5..c98b27dc 100644 --- a/src/ResponseResolver/ResponseJsonResolver.php +++ b/src/ResponseResolver/JsonResponseResolver.php @@ -35,7 +35,7 @@ /** * @since 3.0.0 */ -final class ResponseJsonResolver implements ResponseResolverInterface +final class JsonResponseResolver implements ResponseResolverInterface { private const DEFAULT_ENCODING_FLAGS = 0; private const DEFAULT_ENCODING_DEPTH = 512; @@ -65,9 +65,14 @@ public function resolveResponse( $processParams = $annotations[0]->newInstance(); - $encodingFlags = $processParams->encodingFlags ?? $this->defaultEncodingFlags ?? self::DEFAULT_ENCODING_FLAGS; + $encodingFlags = $processParams->encodingFlags + ?? $this->defaultEncodingFlags + ?? self::DEFAULT_ENCODING_FLAGS; + /** @psalm-var int<1, 2147483647> $encodingDepth */ - $encodingDepth = $processParams->encodingDepth ?? $this->defaultEncodingDepth ?? self::DEFAULT_ENCODING_DEPTH; + $encodingDepth = $processParams->encodingDepth + ?? $this->defaultEncodingDepth + ?? self::DEFAULT_ENCODING_DEPTH; try { $payload = json_encode($response, $encodingFlags | JSON_THROW_ON_ERROR, $encodingDepth); diff --git a/src/Route.php b/src/Route.php index 963cd9f0..2de6bfcd 100644 --- a/src/Route.php +++ b/src/Route.php @@ -15,7 +15,6 @@ use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; -use function array_key_exists; use function in_array; /** @@ -35,8 +34,6 @@ public function __construct( private array $attributes = [], /** @var array */ private readonly array $middlewares = [], - /** @var array */ - private readonly array $constraints = [], /** @var array */ private readonly array $consumes = [], /** @var array */ @@ -46,6 +43,9 @@ public function __construct( private readonly string $summary = '', private readonly string $description = '', private readonly bool $isDeprecated = false, + private readonly bool $isApiOperation = false, + /** @var array|object|null */ + private readonly array|object|null $apiOperationFields = null, /** @var non-empty-string|null */ private readonly ?string $pattern = null, ) { @@ -84,11 +84,7 @@ public function getMethods(): array public function allowsMethod(string $method): bool { - if ($this->methods === []) { - return true; - } - - return in_array($method, $this->methods, true); + return $this->methods === [] || in_array($method, $this->methods, true); } /** @@ -99,14 +95,14 @@ public function getAttributes(): array return $this->attributes; } - public function getAttribute(string $name, mixed $default = null): mixed + public function hasAttribute(string $name): bool { - return $this->attributes[$name] ?? $default; + return isset($this->attributes[$name]); } - public function hasAttribute(string $name): bool + public function getAttribute(string $name, mixed $default = null): mixed { - return array_key_exists($name, $this->attributes); + return $this->attributes[$name] ?? $default; } /** @@ -130,14 +126,6 @@ public function getMiddlewares(): array return $this->middlewares; } - /** - * @inheritDoc - */ - public function getConstraints(): array - { - return $this->constraints; - } - /** * @inheritDoc */ @@ -177,6 +165,22 @@ public function isDeprecated(): bool return $this->isDeprecated; } + /** + * @inheritDoc + */ + public function isApiOperation(): bool + { + return $this->isApiOperation; + } + + /** + * @inheritDoc + */ + public function getApiOperationFields(): array|object|null + { + return $this->apiOperationFields; + } + /** * @inheritDoc */ diff --git a/src/RouteInterface.php b/src/RouteInterface.php index b30d70aa..bf230b6b 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -40,7 +40,7 @@ public function getRequestHandler(): mixed; public function getPatterns(): array; /** - * @return array + * @return string[] */ public function getMethods(): array; @@ -57,12 +57,12 @@ public function getAttributes(): array; /** * @since 3.0.0 */ - public function getAttribute(string $name, mixed $default = null): mixed; + public function hasAttribute(string $name): bool; /** * @since 3.0.0 */ - public function hasAttribute(string $name): bool; + public function getAttribute(string $name, mixed $default = null): mixed; /** * @param array $attributes @@ -72,35 +72,26 @@ public function hasAttribute(string $name): bool; public function withAddedAttributes(array $attributes): static; /** - * @return array - * * @since 2.0.0 */ public function getMiddlewares(): array; /** - * @return array - * - * @since 3.0.0 - */ - public function getConstraints(): array; - - /** - * @return array + * @return MediaTypeInterface[] * * @since 3.0.0 */ public function getConsumedMediaTypes(): array; /** - * @return array + * @return MediaTypeInterface[] * * @since 3.0.0 */ public function getProducedMediaTypes(): array; /** - * @return array + * @return string[] * * @since 2.4.0 */ @@ -121,6 +112,20 @@ public function getDescription(): string; */ public function isDeprecated(): bool; + /** + * @since 3.0.0 + */ + public function isApiOperation(): bool; + + /** + * @since 3.0.0 + * + * @return array|object|null + * + * @link https://github.com/OAI/OpenAPI-Specification/blob/bba1da7bfd9cb9a4f47ed6b91e824bb1cef12fdc/versions/3.1.1.md#fixed-fields-8 + */ + public function getApiOperationFields(): array|object|null; + /** * @return non-empty-string|null * diff --git a/src/ServerRequest.php b/src/ServerRequest.php index a29a6a93..dd5348ad 100644 --- a/src/ServerRequest.php +++ b/src/ServerRequest.php @@ -116,7 +116,7 @@ public function getClientConsumedLocales(): Generator } /** - * @return Generator, MediaTypeInterface> + * @return Generator */ public function getClientConsumedMediaTypes(): Generator { From f75b624d01e1b7bf720a5cfc7a3fef5242a23f27 Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Mon, 13 Jan 2025 02:23:08 +0100 Subject: [PATCH 179/180] v3 --- src/Annotation/JsonResponse.php | 9 +++++++++ src/Annotation/SerializableResponse.php | 5 +++++ src/Command/RouterGenerateOpenApiDocumentCommand.php | 4 ++-- src/Loader/DescriptorLoader.php | 12 +++++++----- src/RouteInterface.php | 8 ++++---- 5 files changed, 27 insertions(+), 11 deletions(-) diff --git a/src/Annotation/JsonResponse.php b/src/Annotation/JsonResponse.php index 5fd1132f..d8cbcd7a 100644 --- a/src/Annotation/JsonResponse.php +++ b/src/Annotation/JsonResponse.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; +use Sunrise\Http\Router\Dictionary\MediaType; /** * @since 3.0.0 @@ -26,4 +27,12 @@ public function __construct( public readonly ?int $encodingDepth = null, ) { } + + /** + * @inheritDoc + */ + public function getMediaTypes(): array + { + return [MediaType::JSON]; + } } diff --git a/src/Annotation/SerializableResponse.php b/src/Annotation/SerializableResponse.php index 483edc04..1ef67ef5 100644 --- a/src/Annotation/SerializableResponse.php +++ b/src/Annotation/SerializableResponse.php @@ -14,6 +14,7 @@ namespace Sunrise\Http\Router\Annotation; use Attribute; +use Sunrise\Http\Router\Entity\MediaType\MediaTypeInterface; /** * @since 3.0.0 @@ -21,4 +22,8 @@ #[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_FUNCTION)] abstract class SerializableResponse { + /** + * @return array + */ + abstract public function getMediaTypes(): array; } diff --git a/src/Command/RouterGenerateOpenApiDocumentCommand.php b/src/Command/RouterGenerateOpenApiDocumentCommand.php index 75a3c79b..3326021a 100644 --- a/src/Command/RouterGenerateOpenApiDocumentCommand.php +++ b/src/Command/RouterGenerateOpenApiDocumentCommand.php @@ -133,7 +133,7 @@ private static function enrichDocumentWithPaths( self::enrichOperationWithPathParameters($route, $operation); self::enrichOperationWithCookieAndHeaderParameters($controller, $operation); self::enrichOperationWithRequestBody($route, $controller, $operation); - self::enrichOperationWithResponses($route, $controller, $operation); + self::enrichOperationWithSerializableResponse($route, $controller, $operation); $routePath = RouteSimplifier::simplifyRoute($route->getPath()); foreach ($route->getMethods() as $routeMethod) { @@ -225,7 +225,7 @@ private static function enrichOperationWithRequestBody( } } - private static function enrichOperationWithResponses( + private static function enrichOperationWithSerializableResponse( RouteInterface $route, ReflectionMethod $controller, array &$operation, diff --git a/src/Loader/DescriptorLoader.php b/src/Loader/DescriptorLoader.php index 4e4081bd..ea5be9b9 100644 --- a/src/Loader/DescriptorLoader.php +++ b/src/Loader/DescriptorLoader.php @@ -26,7 +26,6 @@ use Sunrise\Http\Router\Annotation\DefaultAttribute; use Sunrise\Http\Router\Annotation\Deprecated; use Sunrise\Http\Router\Annotation\Description; -use Sunrise\Http\Router\Annotation\JsonResponse; use Sunrise\Http\Router\Annotation\Method; use Sunrise\Http\Router\Annotation\Middleware; use Sunrise\Http\Router\Annotation\NamePrefix; @@ -37,9 +36,9 @@ use Sunrise\Http\Router\Annotation\Priority; use Sunrise\Http\Router\Annotation\Produces; use Sunrise\Http\Router\Annotation\Route as Descriptor; +use Sunrise\Http\Router\Annotation\SerializableResponse; use Sunrise\Http\Router\Annotation\Summary; use Sunrise\Http\Router\Annotation\Tag; -use Sunrise\Http\Router\Dictionary\MediaType; use Sunrise\Http\Router\Helper\ClassFinder; use Sunrise\Http\Router\Helper\RouteCompiler; use Sunrise\Http\Router\Route; @@ -318,10 +317,13 @@ private static function enrichDescriptorFromClassOrMethod( } } - /** @var list> $annotations */ - $annotations = $classOrMethod->getAttributes(JsonResponse::class); + /** @var list> $annotations */ + $annotations = $classOrMethod->getAttributes(SerializableResponse::class, ReflectionAttribute::IS_INSTANCEOF); if (isset($annotations[0])) { - $descriptor->produces[] = MediaType::JSON; + $annotation = $annotations[0]->newInstance(); + foreach ($annotation->getMediaTypes() as $mediaType) { + $descriptor->produces[] = $mediaType; + } } /** @var list> $annotations */ diff --git a/src/RouteInterface.php b/src/RouteInterface.php index bf230b6b..97287d73 100644 --- a/src/RouteInterface.php +++ b/src/RouteInterface.php @@ -40,7 +40,7 @@ public function getRequestHandler(): mixed; public function getPatterns(): array; /** - * @return string[] + * @return array */ public function getMethods(): array; @@ -77,21 +77,21 @@ public function withAddedAttributes(array $attributes): static; public function getMiddlewares(): array; /** - * @return MediaTypeInterface[] + * @return array * * @since 3.0.0 */ public function getConsumedMediaTypes(): array; /** - * @return MediaTypeInterface[] + * @return array * * @since 3.0.0 */ public function getProducedMediaTypes(): array; /** - * @return string[] + * @return array * * @since 2.4.0 */ From 0cd585dcb53c8ed0232df3ce723c41c792ea8b2d Mon Sep 17 00:00:00 2001 From: Anatoly Nekhay Date: Mon, 13 Jan 2025 02:33:04 +0100 Subject: [PATCH 180/180] v3 --- src/Command/RouterGenerateOpenApiDocumentCommand.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Command/RouterGenerateOpenApiDocumentCommand.php b/src/Command/RouterGenerateOpenApiDocumentCommand.php index 3326021a..4da82793 100644 --- a/src/Command/RouterGenerateOpenApiDocumentCommand.php +++ b/src/Command/RouterGenerateOpenApiDocumentCommand.php @@ -237,7 +237,7 @@ private static function enrichOperationWithSerializableResponse( $schema = self::getTypeSchema($controller->getReturnType()); $responseStatusCode = 200; - $responseStatusPhrase = 'Ok'; + $responseStatusPhrase = 'Operation completed successfully.'; /** @var list> $annotations */ $annotations = $controller->getAttributes(ResponseStatus::class);