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')
);
5 changes: 5 additions & 0 deletions .phpstan.neon
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
parameters:
level: 8
paths:
- src
- tests
6 changes: 5 additions & 1 deletion 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/).

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

## [2.0.1] - 2020-12-02
### Added
- Support for PHP 8
Expand Down Expand Up @@ -66,7 +70,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
## 0.1.0 - 2016-10-01
First version

[2.0.1]: https://github.com/middlewares/method-override/compare/v2.0.0...v2.0.1
[2.1.0]: https://github.com/middlewares/method-override/compare/v2.0.0...v2.1.0
[2.0.0]: https://github.com/middlewares/method-override/compare/v1.1.0...v2.0.0
[1.1.0]: https://github.com/middlewares/method-override/compare/v1.0.0...v1.1.0
[1.0.0]: https://github.com/middlewares/method-override/compare/v0.5.0...v1.0.0
Expand Down
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",
"middlewares/utils": "^3.0",
"psr/http-server-middleware": "^1.0"
"middlewares/utils": "^2 || ^3 || ^4",
"psr/http-server-middleware": "^1"
},
"require-dev": {
"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"
"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="MethodOverride 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>
15 changes: 11 additions & 4 deletions src/MethodOverride.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,20 @@

class MethodOverride implements MiddlewareInterface
{
const HEADER = 'X-Http-Method-Override';
public const HEADER = 'X-Http-Method-Override';

/**
* @var ResponseFactoryInterface
*/
private $responseFactory;

/**
* @var array Allowed methods overrided in GET
* @var array<string> Allowed methods overrided in GET
*/
private $getMethods = ['HEAD', 'CONNECT', 'TRACE', 'OPTIONS'];

/**
* @var array Allowed methods overrided in POST
* @var array<string> Allowed methods overrided in POST
*/
private $postMethods = ['PATCH', 'PUT', 'DELETE', 'COPY', 'LOCK', 'UNLOCK'];

Expand All @@ -39,13 +39,15 @@ class MethodOverride implements MiddlewareInterface
*/
private $queryParameter;

public function __construct(ResponseFactoryInterface $responseFactory = null)
public function __construct(?ResponseFactoryInterface $responseFactory = null)
{
$this->responseFactory = $responseFactory ?: Factory::getResponseFactory();
}

/**
* Set allowed method for GET.
*
* @param array<string> $getMethods
*/
public function getMethods(array $getMethods): self
{
Expand All @@ -56,6 +58,8 @@ public function getMethods(array $getMethods): self

/**
* Set allowed method for POST.
*
* @param array<string> $postMethods
*/
public function postMethods(array $postMethods): self
{
Expand Down Expand Up @@ -114,6 +118,7 @@ private function getOverrideMethod(ServerRequestInterface $request): string
if ($request->getMethod() === 'POST' && $this->parsedBodyParameter !== null) {
$params = $request->getParsedBody();

// @phpstan-ignore-next-line
if (isset($params[$this->parsedBodyParameter])) {
return strtoupper($params[$this->parsedBodyParameter]);
}
Expand All @@ -131,6 +136,8 @@ private function getOverrideMethod(ServerRequestInterface $request): string
/**
* Returns the allowed override methods.
* @codeCoverageIgnore
*
* @return array<string>
*/
private function getAllowedOverrideMethods(ServerRequestInterface $request): array
{
Expand Down
17 changes: 13 additions & 4 deletions tests/MethodOverrideTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@

class MethodOverrideTest extends TestCase
{
/**
* @return array<int, array<int, int|string>>
*/
public function headersProvider(): array
{
return [
Expand All @@ -28,7 +31,7 @@ public function testHeaders(
string $overrided,
int $status,
string $body
) {
): void {
$response = Dispatcher::run(
[
new MethodOverride(),
Expand All @@ -44,6 +47,9 @@ function ($request) {
$this->assertEquals($body, (string) $response->getBody());
}

/**
* @return array<int, array<int, int|string|array<string,string>>>
*/
public function paramsProvider(): array
{
return [
Expand All @@ -58,14 +64,17 @@ public function paramsProvider(): array

/**
* @dataProvider paramsProvider
*
* @param array<string,string> $queryParams
* @param array<string,string> $parsedBody
*/
public function testParams(
string $original,
array $queryParams,
array $parsedBody,
int $status,
string $body
) {
): void {
$middleware = (new MethodOverride())
->parsedBodyParameter('method')
->queryParameter('method');
Expand All @@ -86,7 +95,7 @@ function ($request) {
$this->assertEquals($body, (string) $response->getBody());
}

public function testCustomGet()
public function testCustomGet(): void
{
$response = Dispatcher::run(
[
Expand All @@ -99,7 +108,7 @@ public function testCustomGet()
$this->assertEquals(405, $response->getStatusCode());
}

public function testCustomPost()
public function testCustomPost(): void
{
$response = Dispatcher::run(
[
Expand Down