Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
* text=auto eol=lf

/tests export-ignore
.editorconfig export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.php_cs export-ignore
.travis.yml export-ignore
phpcs.xml.dist export-ignore
phpunit.xml.dist export-ignore
/tests export-ignore
.editorconfig export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.php-cs-fixer.php export-ignore
phpcs.xml.dist export-ignore
phpunit.xml.dist export-ignore
.phpstan.neon export-ignore
47 changes: 22 additions & 25 deletions .github/workflows/main.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: "testing"

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
push:
branches: [ master ]
pull_request:
branches: [ master ]

jobs:
qa:
Expand All @@ -13,19 +13,19 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Validate composer.json and composer.lock
run: composer validate

- name: Cache Composer packages
id: composer-cache
uses: actions/cache@v2
uses: actions/cache@v4
with:
path: vendor
key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
restore-keys: |
${{ runner.os }}-php-
path: vendor
key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
restore-keys: |
${{ runner.os }}-php-

- name: Install dependencies
if: steps.composer-cache.outputs.cache-hit != 'true'
Expand All @@ -40,37 +40,34 @@ jobs:

strategy:
matrix:
php:
- 7.2
- 7.3
- 7.4
composer-args: [ "" ]
include:
- php: 8.0
composer-args: --ignore-platform-reqs
fail-fast: false
php:
- 7.2
- 7.3
- 7.4
- 8.0
- 8.1
- 8.2
- 8.3
- 8.4

steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Install PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}

- name: Cache PHP dependencies
uses: actions/cache@v2
uses: actions/cache@v4
with:
path: vendor
key: ${{ runner.os }}-php-${{ matrix.php }}-composer-${{ hashFiles('**/composer.json') }}
restore-keys: ${{ runner.os }}-php-${{ matrix.php }}-composer-

- name: Install dependencies
run: composer install --prefer-dist --no-progress ${{ matrix.composer-args }}
run: composer install --prefer-dist --no-progress

- name: Tests
run: composer test

- name: Tests coverage
run: composer coverage
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@ vendor
composer.lock
coverage
*.cache
.idea
kit
10 changes: 10 additions & 0 deletions .php-cs-fixer.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?php

return My\PhpCsFixerConfig::create()
->setFinder(
PhpCsFixer\Finder::create()
->files()
->name('*.php')
->in(__DIR__.'/src')
->in(__DIR__.'/tests')
);
6 changes: 6 additions & 0 deletions .phpstan.neon
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
parameters:
level: 8
paths:
- src
- tests
inferPrivatePropertyTypeFromConstructor: true
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [1.1.0] - 2025-03-21
### Added
- Support for PHP 8.4

## [1.0.2] - 2020-12-03
### Added
- Support for PHP 8.0
Expand All @@ -16,5 +20,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
## 1.0.0 - 2019-12-01
First version

[1.1.0]: https://github.com/middlewares/error-response/compare/v1.0.2...v1.1.0
[1.0.2]: https://github.com/middlewares/error-response/compare/v1.0.1...v1.0.2
[1.0.1]: https://github.com/middlewares/error-response/compare/v1.0.0...v1.0.1
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2019
Copyright (c) 2019-2025

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
18 changes: 9 additions & 9 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@
},
"require": {
"php": "^7.2 || ^8.0",
"psr/http-server-middleware": "^1.0"
"psr/http-server-middleware": "^1"
},
"require-dev": {
"middlewares/utils": "^3.0",
"phpunit/phpunit": "^8|^9",
"friendsofphp/php-cs-fixer": "^2.0",
"squizlabs/php_codesniffer": "^3.0",
"oscarotero/php-cs-fixer-config": "^1.0",
"phpstan/phpstan": "^0.12",
"laminas/laminas-diactoros": "^2.3"
"middlewares/utils": "^2 || ^3 || ^4",
"phpunit/phpunit": "^8 || ^9",
"friendsofphp/php-cs-fixer": "^3",
"squizlabs/php_codesniffer": "^3",
"oscarotero/php-cs-fixer-config": "^2",
"phpstan/phpstan": "^1 || ^2",
"laminas/laminas-diactoros": "^2 || ^3"
},
"autoload": {
"psr-4": {
Expand All @@ -45,4 +45,4 @@
"coverage": "phpunit --coverage-text",
"coverage-html": "phpunit --coverage-html=coverage"
}
}
}
16 changes: 16 additions & 0 deletions phpcs.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?xml version="1.0"?>
<ruleset name="Middlewares coding standard">
<description>Middlewares coding standard</description>

<!-- display progress -->
<arg value="p"/>
<arg name="report" value="full"/>
<arg name="colors"/>

<!-- coding standard -->
<rule ref="PSR2"/>

<!-- Paths to check -->
<file>src</file>
<file>tests</file>
</ruleset>
33 changes: 33 additions & 0 deletions phpunit.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="vendor/autoload.php"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
backupGlobals="false"
backupStaticAttributes="false"
beStrictAboutOutputDuringTests="true"
beStrictAboutTestsThatDoNotTestAnything="true"
beStrictAboutTodoAnnotatedTests="true"
colors="true"
verbose="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false"
failOnWarning="true">
<testsuites>
<testsuite name="ErrorResponse test suite">
<directory>tests</directory>
</testsuite>
</testsuites>

<filter>
<whitelist addUncoveredFilesFromWhitelist="true" processUncoveredFilesFromWhitelist="true">
<directory>./src</directory>
<exclude>
<directory>./tests</directory>
<directory>./vendor</directory>
</exclude>
</whitelist>
</filter>
</phpunit>
14 changes: 11 additions & 3 deletions src/ErrorResponder/AbstractResponder.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,21 @@ abstract class AbstractResponder implements ResponderInterface
/** @var StreamFactoryInterface */
protected $streamFactory;

/** @var string[] */
protected $statusCodes = ['/^(4|5)\d\d/'];

/** @var string[] */
protected $contentTypes = [];

/**
* @param StreamFactoryInterface|null $streamFactory
* @param string[]|null $statusCodes
* @param string[]|null $contentTypes
*/
public function __construct(
StreamFactoryInterface $streamFactory = null,
array $statusCodes = null,
array $contentTypes = null
?StreamFactoryInterface $streamFactory = null,
?array $statusCodes = null,
?array $contentTypes = null
) {
$this->streamFactory = $streamFactory ?? Factory::getStreamFactory();

Expand Down
1 change: 1 addition & 0 deletions src/ErrorResponder/HtmlResponder.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

class HtmlResponder extends AbstractResponder
{
/** @var string[] */
protected $contentTypes = ['text/html'];

public function getBodyContent(int $code, string $message): string
Expand Down
1 change: 1 addition & 0 deletions src/ErrorResponder/JsonResponder.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

class JsonResponder extends AbstractResponder
{
/** @var string[] */
protected $contentTypes = ['application/json'];

public function getBodyContent(int $code, string $message): string
Expand Down
16 changes: 10 additions & 6 deletions src/ErrorResponse.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,28 @@

namespace Middlewares;

use Middlewares\ErrorResponder\HtmlResponder;
use Middlewares\ErrorResponder\JsonResponder;
use Middlewares\ErrorResponder\ResponderInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Server\RequestHandlerInterface;

class ErrorResponse implements MiddlewareInterface
{
/** @var ResponderInterface[] */
private $responders;

/**
* @var ErrorResponder\ResponderInterface[]
* @param ResponderInterface[]|null $responders
*/
private $responders = [];

public function __construct(array $responders = null)
public function __construct(?array $responders = null)
{
if ($responders === null) {
$responders = [
new ErrorResponder\HtmlResponder(),
new ErrorResponder\JsonResponder(),
new HtmlResponder(),
new JsonResponder(),
];
}

Expand Down
6 changes: 4 additions & 2 deletions tests/ErrorResponseTest.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<?php

declare(strict_types = 1);

namespace Middlewares\Tests;

use Middlewares\ErrorResponder\HtmlResponder;
Expand All @@ -11,7 +13,7 @@

class ErrorResponseTest extends TestCase
{
public function testHtmlErrorResponse()
public function testHtmlErrorResponse(): void
{
$request = Factory::createServerRequest('GET', '/');

Expand Down Expand Up @@ -45,7 +47,7 @@ function ($req, $next) {
$this->assertEquals($content, (string) $response->getBody());
}

public function testJsonErrorResponse()
public function testJsonErrorResponse(): void
{
$request = Factory::createServerRequest('GET', '/');

Expand Down