Add MiddlewareAllowAllTrait, implements HTTP method check in middleware

Author: Asisyas

src/Business/Middleware/MiddlewareLocator.php

@@ -36,8 +36,15 @@ public function locate(Request $request): \Traversable
 
         /** @var array<int, HttpMiddlewarePluginInterface[]> $pc */
         $pc = [];
+        $requestMethod = strtolower($request->getMethod());
 
+        /** @var HttpMiddlewarePluginInterface $middleware */
         foreach ($it as $middleware) {
+            $methods = array_map('strtolower', $middleware->getRequestMatchMethods());
+            if (!\in_array($requestMethod, $methods)) {
+                continue;
+            }
+
             $middlewareMatch = $middleware->getRequestMatchPath();
             $pattern = '/'.preg_replace('/\//', '\/', $middlewareMatch).'/i';
 

src/Plugin/HttpMiddlewarePluginInterface.php

@@ -20,6 +20,11 @@
  */
 interface HttpMiddlewarePluginInterface
 {
+    /**
+     * @return string[]
+     */
+    public function getRequestMatchMethods(): array;
+
     /**
      * Match pattern.
      */

src/Plugin/MiddlewareAllowAllTrait.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ *  This file is part of the Micro framework package.
+ *
+ *  (c) Stanislau Komar <kost@micro-php.net>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Micro\Plugin\Http\Plugin;
+
+trait MiddlewareAllowAllTrait
+{
+    /**
+     * @return string[]
+     */
+    public function getRequestMatchMethods(): array
+    {
+        return ['get', 'post', 'patch', 'put', 'delete'];
+    }
+
+    public function getRequestMatchPath(): string
+    {
+        return '^/';
+    }
+
+    public function getMiddlewarePriority(): int
+    {
+        return 0;
+    }
+}

tests/Unit/Business/Middleware/MiddlewareLocatorTest.php

@@ -57,19 +57,26 @@ public function middlewareCollectionConfig(): array
     {
         return [
             // Success
-            ['^/one/two', 3],
-            ['/three', 1],
-            ['^/one', null],
-            ['^/one/(\b[a-z]+)/three', 2],
-            ['^/One/(\b[a-z]+)/ThreE/(\d+)/success', 4],
+            ['^/one/two', 3, ['gEt', 'PoSt']],
+            ['/three', 1, ['get']],
+            ['^/one', null, ['get', 'put']],
+            ['^/one/(\b[a-z]+)/three', 2, ['get']],
+            ['^/One/(\b[a-z]+)/ThreE/(\d+)/success', 4, ['get']],
 
             // will no executed
-            ['^/one$', null],
-            ['/none', null],
-            ['/(\d+)/$', null],
-            ['^/one/(\b[a-z]+)/three/four', 2],
-            ['^/one/two/three/four', null],
-            ['/one/two/three/four/', null],
+
+            ['^/one/two', 3, ['PoSt']],
+            ['/three', 1, ['put']],
+            ['^/one', null, ['patch']],
+            ['^/one/(\b[a-z]+)/three', 2, ['put']],
+            ['^/One/(\b[a-z]+)/ThreE/(\d+)/success', 4, ['put']],
+
+            ['^/one$', null, ['get']],
+            ['/none', null, ['get']],
+            ['/(\d+)/$', null, ['get']],
+            ['^/one/(\b[a-z]+)/three/four', 2, ['get']],
+            ['^/one/two/three/four', null, ['get']],
+            ['/one/two/three/four/', null, ['get']],
         ];
     }
 
@@ -81,7 +88,7 @@ protected function createMiddlewareCollection(Request $request)
 
         foreach ($config as $mc) {
             $middlewares[] = $this->createMiddlewareObj(
-                $request,
+                $mc[2],
                 $mc[0],
                 $mc[1],
             );
@@ -90,7 +97,7 @@ protected function createMiddlewareCollection(Request $request)
         return new \ArrayObject($middlewares);
     }
 
-    protected function createMiddlewareObj(Request $request, string $path, int|null $priority)
+    protected function createMiddlewareObj(array $methods, string $path, int|null $priority)
     {
         if (!$priority) {
             $middleware = $this->createMock(HttpMiddlewarePluginInterface::class);
@@ -99,7 +106,12 @@ protected function createMiddlewareObj(Request $request, string $path, int|null
             $middleware->method('getMiddlewarePriority')->willReturn($priority);
         }
 
-        $middleware->expects($this->once())
+        $middleware
+            ->expects($this->once())
+            ->method('getRequestMatchMethods')
+            ->willReturn($methods);
+
+        $middleware
             ->method('getRequestMatchPath')
             ->willReturn($path);
 

tests/Unit/Plugin/MiddlewareAllowAllTraitTest.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ *  This file is part of the Micro framework package.
+ *
+ *  (c) Stanislau Komar <kost@micro-php.net>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Micro\Plugin\Http\Test\Unit\Plugin;
+
+use Micro\Plugin\Http\Plugin\HttpMiddlewareOrderedPluginInterface;
+use Micro\Plugin\Http\Plugin\HttpMiddlewarePluginInterface;
+use Micro\Plugin\Http\Plugin\MiddlewareAllowAllTrait;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+
+class MiddlewareAllowAllTraitTest extends TestCase
+{
+    private HttpMiddlewarePluginInterface $plugin;
+
+    protected function setUp(): void
+    {
+        $this->plugin = new class() implements HttpMiddlewareOrderedPluginInterface {
+            use MiddlewareAllowAllTrait;
+
+            public function processMiddleware(Request $request): void
+            {
+            }
+        };
+    }
+
+    public function testGetRequestMatchMethods()
+    {
+        $this->assertEquals(['get', 'post', 'patch', 'put', 'delete'], $this->plugin->getRequestMatchMethods());
+    }
+
+    public function testGetRequestMatchPath()
+    {
+        $this->assertEquals('^/', $this->plugin->getRequestMatchPath());
+    }
+
+    public function testGetMiddlewarePriority()
+    {
+        $this->assertEquals(0, $this->plugin->getMiddlewarePriority());
+    }
+}