Skip to content

Commit 282976e

Browse files
AsisyasAsisyas
committed
v1.0 released
0 parents  commit 282976e

19 files changed

+764
-0
lines changed

‎.gitattributes

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/.github export-ignore
2+
/tests export-ignore
3+
/phpunit.xml.dist export-ignore
4+
/.gitattributes export-ignore
5+
/.gitignore export-ignore
6+
/.php-cs-fixer.dist.php export-ignore
7+
/psalm.xml export-ignore
8+
9+
*.php diff=php

‎.github/workflows/.editorconfig

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[{*.yaml,*.yml}]
2+
indent_size = 2

‎.github/workflows/ci.yaml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Plugin CI
2+
on:
3+
push:
4+
branches: [ 'master' ]
5+
pull_request:
6+
7+
env:
8+
PHP_CS_FIXER_IGNORE_ENV: 1
9+
XDEBUG_MODE: coverage
10+
11+
jobs:
12+
tests:
13+
name: "Tests ${{ matrix.php-version }} deps ${{ matrix.dependency-versions }}"
14+
runs-on: ubuntu-22.04
15+
16+
strategy:
17+
fail-fast: false
18+
matrix:
19+
# normal, highest, non-dev installs
20+
php-version: [ '8.2' ]
21+
dependency-versions: [ 'highest' ]
22+
include:
23+
# testing lowest PHP version with the lowest dependencies
24+
# - php-version: '8.2'
25+
# dependency-versions: 'lowest'
26+
27+
# testing dev versions with the highest PHP
28+
- php-version: '8.2'
29+
dependency-versions: 'highest'
30+
31+
steps:
32+
- name: "Checkout code"
33+
uses: "actions/checkout@v2"
34+
35+
- name: "Install PHP"
36+
uses: "shivammathur/setup-php@v2"
37+
with:
38+
coverage: "none"
39+
php-version: "${{ matrix.php-version }}"
40+
41+
- name: "Composer install"
42+
uses: "ramsey/composer-install@v2"
43+
with:
44+
dependency-versions: "${{ matrix.dependency-versions }}"
45+
composer-options: "--prefer-dist --no-progress"
46+
47+
- name: Run tests
48+
run: composer run test

‎.gitignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.idea
2+
vendor
3+
composer.lock
4+
.phpunit.result.cache
5+
.php-cs-fixer.cache
6+
test-coverage-report
7+
phpunit.xml
8+
.php-cs-fixer.php
9+
phpstan.neon

‎.php-cs-fixer.dist.php

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<?php
2+
3+
if (!file_exists(__DIR__.'/src')) {
4+
exit(0);
5+
}
6+
7+
$finder = (new PhpCsFixer\Finder())
8+
->in(__DIR__.'/src')
9+
->in(__DIR__.'/tests')
10+
;
11+
12+
return (new PhpCsFixer\Config())
13+
->setRules(array(
14+
'@Symfony' => true,
15+
'@Symfony:risky' => true,
16+
'protected_to_private' => false,
17+
'semicolon_after_instruction' => false,
18+
'header_comment' => [
19+
'header' => <<<EOF
20+
This file is part of the Micro framework package.
21+
22+
(c) Stanislau Komar <kost@micro-php.net>
23+
24+
For the full copyright and license information, please view the LICENSE
25+
file that was distributed with this source code.
26+
EOF
27+
]
28+
))
29+
->setRiskyAllowed(true)
30+
->setFinder($finder);

‎composer.json

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
{
2+
"name": "micro/plugin-http-exceptions",
3+
"description": "Micro Framework: Exception response builder.",
4+
"license": "MIT",
5+
"type": "micro-plugin",
6+
"authors": [
7+
{
8+
"name": "Stanislau Komar",
9+
"email": "kost@micro-php.net"
10+
}
11+
],
12+
"require": {
13+
"micro/plugin-http-core": "^1"
14+
},
15+
"require-dev": {
16+
"ergebnis/composer-normalize": "^2.29",
17+
"friendsofphp/php-cs-fixer": "^3.13",
18+
"phpstan/phpstan": "^1.9",
19+
"phpunit/php-code-coverage": "^9.2",
20+
"phpunit/phpunit": "^9.5",
21+
"vimeo/psalm": "^5.2"
22+
},
23+
"autoload": {
24+
"psr-4": {
25+
"Micro\\Plugin\\Http\\": "src/"
26+
}
27+
},
28+
"autoload-dev": {
29+
"psr-4": {
30+
"Micro\\Plugin\\Http\\Test\\Unit\\": "tests/Unit"
31+
}
32+
},
33+
"config": {
34+
"allow-plugins": {
35+
"ergebnis/composer-normalize": true
36+
},
37+
"sort-packages": true
38+
},
39+
"scripts": {
40+
"coverage": "XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-text",
41+
"php-cs-fix": "PHP_CS_FIXER_IGNORE_ENV=1 ./vendor/bin/php-cs-fixer fix --verbose --using-cache=no",
42+
"php-cs-try": "PHP_CS_FIXER_IGNORE_ENV=1 ./vendor/bin/php-cs-fixer fix --verbose --dry-run --using-cache=no",
43+
"phpstan": "./vendor/bin/phpstan analyze --no-progress",
44+
"phpunit": "./vendor/bin/phpunit",
45+
"psalm": "./vendor/bin/psalm --no-progress --show-info=true",
46+
"statics": [
47+
"@phpstan",
48+
"@psalm",
49+
"@php-cs-try"
50+
],
51+
"test": [
52+
"@statics",
53+
"composer validate --strict",
54+
"composer normalize",
55+
"@coverage"
56+
]
57+
}
58+
}

‎phpstan.neon.dist

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
parameters:
2+
level: 7
3+
paths:
4+
- src

‎phpunit.xml.dist

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!-- https://phpunit.readthedocs.io/en/9.5/configuration.html#the-phpunit-element -->
3+
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
5+
backupGlobals="false"
6+
bootstrap="vendor/autoload.php"
7+
colors="true"
8+
failOnRisky="true"
9+
failOnWarning="true"
10+
>
11+
<php>
12+
<ini name="error_reporting" value="-1" force="true"/>
13+
</php>
14+
<testsuites>
15+
<testsuite name="Unit tests">
16+
<directory>tests/Unit</directory>
17+
</testsuite>
18+
</testsuites>
19+
<coverage>
20+
<include>
21+
<directory suffix=".php">src</directory>
22+
</include>
23+
<report>
24+
<html outputDirectory="test-coverage-report/" />
25+
</report>
26+
</coverage>
27+
</phpunit>

‎psalm.xml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<?xml version="1.0"?>
2+
<psalm
3+
errorLevel="2"
4+
resolveFromConfigFile="true"
5+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6+
xmlns="https://getpsalm.org/schema/config"
7+
xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
8+
>
9+
<projectFiles>
10+
<directory name="src" />
11+
<ignoreFiles>
12+
<directory name="vendor" />
13+
</ignoreFiles>
14+
15+
</projectFiles>
16+
17+
<issueHandlers>
18+
19+
<UnnecessaryVarAnnotation>
20+
<errorLevel type="suppress">
21+
<file name="src/HttpExceptionResponsePlugin.php"/>
22+
</errorLevel>
23+
</UnnecessaryVarAnnotation>
24+
25+
<MissingConstructor>
26+
<errorLevel type="suppress">
27+
<file name="src/HttpExceptionResponsePlugin.php"/>
28+
</errorLevel>
29+
</MissingConstructor>
30+
31+
<ImplementedReturnTypeMismatch>
32+
<errorLevel type="suppress">
33+
<file name="src/HttpExceptionResponsePlugin.php"/>
34+
</errorLevel>
35+
</ImplementedReturnTypeMismatch>
36+
</issueHandlers>
37+
38+
</psalm>

‎src/Business/Executor/HttpExceptionExecutorDecorator.php

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
/*
6+
* This file is part of the Micro framework package.
7+
*
8+
* (c) Stanislau Komar <kost@micro-php.net>
9+
*
10+
* For the full copyright and license information, please view the LICENSE
11+
* file that was distributed with this source code.
12+
*/
13+
14+
namespace Micro\Plugin\Http\Business\Executor;
15+
16+
use Micro\Plugin\Http\Exception\HttpException;
17+
use Micro\Plugin\Http\Exception\HttpInternalServerException;
18+
use Symfony\Component\HttpFoundation\Request;
19+
use Symfony\Component\HttpFoundation\Response;
20+
21+
/**
22+
* @author Stanislau Komar <head.trackingsoft@gmail.com>
23+
*/
24+
readonly class HttpExceptionExecutorDecorator implements RouteExecutorInterface
25+
{
26+
public function __construct(
27+
private RouteExecutorInterface $decorated
28+
) {
29+
}
30+
31+
public function execute(Request $request, bool $flush = true): Response
32+
{
33+
try {
34+
return $this->decorated->execute($request, $flush);
35+
} catch (\Throwable $throwable) {
36+
if (!$flush) {
37+
throw $throwable;
38+
}
39+
40+
if (!($throwable instanceof HttpException)) {
41+
$throwable = new HttpInternalServerException('Internal Server Error.', $throwable);
42+
}
43+
44+
$response = new Response(
45+
$throwable->getMessage(),
46+
$throwable->getCode(),
47+
);
48+
49+
$response->send();
50+
51+
return $response;
52+
}
53+
}
54+
}

0 commit comments

Comments
 (0)