Rename MiddlewareStackInterface to MiddlewarePipelineInterface

devanych · web-flow · commit 68da092af996 · 2021-03-18T22:16:44.000+03:00
diff --git a/config/web.php b/config/web.php
@@ -4,10 +4,10 @@
 
 use Yiisoft\Middleware\Dispatcher\MiddlewareFactory;
 use Yiisoft\Middleware\Dispatcher\MiddlewareFactoryInterface;
+use Yiisoft\Middleware\Dispatcher\MiddlewarePipelineInterface;
 use Yiisoft\Middleware\Dispatcher\MiddlewareStack;
-use Yiisoft\Middleware\Dispatcher\MiddlewareStackInterface;
 
 return [
-    MiddlewareStackInterface::class => MiddlewareStack::class,
+    MiddlewarePipelineInterface::class => MiddlewareStack::class,
     MiddlewareFactoryInterface::class => MiddlewareFactory::class,
 ];
diff --git a/src/InvalidMiddlewareDefinitionException.php b/src/InvalidMiddlewareDefinitionException.php
@@ -5,6 +5,7 @@
 namespace Yiisoft\Middleware\Dispatcher;
 
 use InvalidArgumentException;
+
 use function get_class;
 use function is_array;
 use function is_object;
diff --git a/src/MiddlewareDispatcher.php b/src/MiddlewareDispatcher.php
@@ -12,11 +12,11 @@
 final class MiddlewareDispatcher
 {
     /**
-     * Contains a stack of middleware handler.
+     * Contains a middleware pipeline handler.
      *
-     * @var MiddlewareStackInterface stack of middleware
+     * @var MiddlewarePipelineInterface The middleware pipeline.
      */
-    private MiddlewareStackInterface $stack;
+    private MiddlewarePipelineInterface $pipeline;
 
     private MiddlewareFactoryInterface $middlewareFactory;
 
@@ -25,19 +25,19 @@ final class MiddlewareDispatcher
      */
     private array $middlewareDefinitions = [];
 
-    public function __construct(MiddlewareFactoryInterface $middlewareFactory, MiddlewareStackInterface $stack)
+    public function __construct(MiddlewareFactoryInterface $middlewareFactory, MiddlewarePipelineInterface $pipeline)
     {
         $this->middlewareFactory = $middlewareFactory;
-        $this->stack = $stack;
+        $this->pipeline = $pipeline;
     }
 
     public function dispatch(ServerRequestInterface $request, RequestHandlerInterface $fallbackHandler): ResponseInterface
     {
-        if ($this->stack->isEmpty()) {
-            $this->stack = $this->stack->build($this->buildMiddlewares(), $fallbackHandler);
+        if ($this->pipeline->isEmpty()) {
+            $this->pipeline = $this->pipeline->build($this->buildMiddlewares(), $fallbackHandler);
         }
 
-        return $this->stack->handle($request);
+        return $this->pipeline->handle($request);
     }
 
     /**
@@ -57,7 +57,7 @@ public function withMiddlewares(array $middlewareDefinitions): self
     {
         $clone = clone $this;
         $clone->middlewareDefinitions = $middlewareDefinitions;
-        $clone->stack->reset();
+        $clone->pipeline->reset();
 
         return $clone;
     }
diff --git a/src/MiddlewarePipelineInterface.php b/src/MiddlewarePipelineInterface.php
@@ -8,25 +8,25 @@
 use Psr\Http\Server\RequestHandlerInterface;
 
 /**
- * A stack of PSR-15 middlewares to be used with {@see MiddlewareDispatcher}.
+ * A pipeline of PSR-15 middlewares to be used with {@see MiddlewareDispatcher}.
  *
  * @see https://www.php-fig.org/psr/psr-15/
  */
-interface MiddlewareStackInterface extends RequestHandlerInterface
+interface MiddlewarePipelineInterface extends RequestHandlerInterface
 {
     /**
-     * Builds a middleware stack from an array of middleware instances and a fallback request handler.
+     * Builds a middleware pipeline from an array of middleware instances and a fallback request handler.
      * If the middlewares array is empty, only the fallback handler will be used.
      *
-     * @param MiddlewareInterface[] $middlewares Middlewares being composed to stack. Can be empty.
+     * @param MiddlewareInterface[] $middlewares Middlewares being composed to pipeline. Can be empty.
      * @param RequestHandlerInterface $fallbackHandler Fallback request handler.
      *
      * @return self
      */
     public function build(array $middlewares, RequestHandlerInterface $fallbackHandler): self;
 
     /**
-     * Clears the middleware stack and fallback request handler.
+     * Clears the middleware pipeline and fallback request handler.
      */
     public function reset(): void;
 
diff --git a/src/MiddlewareStack.php b/src/MiddlewareStack.php
@@ -13,7 +13,7 @@
 use Yiisoft\Middleware\Dispatcher\Event\AfterMiddleware;
 use Yiisoft\Middleware\Dispatcher\Event\BeforeMiddleware;
 
-final class MiddlewareStack implements MiddlewareStackInterface
+final class MiddlewareStack implements MiddlewarePipelineInterface
 {
     /**
      * Contains a stack of middleware wrapped in handlers.
@@ -30,7 +30,7 @@ public function __construct(EventDispatcherInterface $eventDispatcher)
         $this->eventDispatcher = $eventDispatcher;
     }
 
-    public function build(array $middlewares, RequestHandlerInterface $fallbackHandler): MiddlewareStackInterface
+    public function build(array $middlewares, RequestHandlerInterface $fallbackHandler): MiddlewarePipelineInterface
     {
         $handler = $fallbackHandler;
         foreach ($middlewares as $middleware) {

Original file line number	Diff line number	Diff line change
`@@ -12,11 +12,11 @@`
`12`	`12`	`final class MiddlewareDispatcher`
`13`	`13`	`{`
`14`	`14`	`/**`
`15`		`- * Contains a stack of middleware handler.`
	`15`	`+ * Contains a middleware pipeline handler.`
`16`	`16`	`*`
`17`		`- * @var MiddlewareStackInterface stack of middleware`
	`17`	`+ * @var MiddlewarePipelineInterface The middleware pipeline.`
`18`	`18`	`*/`
`19`		`- private MiddlewareStackInterface $stack;`
	`19`	`+ private MiddlewarePipelineInterface $pipeline;`
`20`	`20`
`21`	`21`	`private MiddlewareFactoryInterface $middlewareFactory;`
`22`	`22`
`@@ -25,19 +25,19 @@ final class MiddlewareDispatcher`
`25`	`25`	`*/`
`26`	`26`	`private array $middlewareDefinitions = [];`
`27`	`27`
`28`		`- public function __construct(MiddlewareFactoryInterface $middlewareFactory, MiddlewareStackInterface $stack)`
	`28`	`+ public function __construct(MiddlewareFactoryInterface $middlewareFactory, MiddlewarePipelineInterface $pipeline)`
`29`	`29`	`{`
`30`	`30`	`$this->middlewareFactory = $middlewareFactory;`
`31`		`- $this->stack = $stack;`
	`31`	`+ $this->pipeline = $pipeline;`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`public function dispatch(ServerRequestInterface $request, RequestHandlerInterface $fallbackHandler): ResponseInterface`
`35`	`35`	`{`
`36`		`- if ($this->stack->isEmpty()) {`
`37`		`- $this->stack = $this->stack->build($this->buildMiddlewares(), $fallbackHandler);`
	`36`	`+ if ($this->pipeline->isEmpty()) {`
	`37`	`+ $this->pipeline = $this->pipeline->build($this->buildMiddlewares(), $fallbackHandler);`
`38`	`38`	`}`
`39`	`39`
`40`		`- return $this->stack->handle($request);`
	`40`	`+ return $this->pipeline->handle($request);`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`/**`
`@@ -57,7 +57,7 @@ public function withMiddlewares(array $middlewareDefinitions): self`
`57`	`57`	`{`
`58`	`58`	`$clone = clone $this;`
`59`	`59`	`$clone->middlewareDefinitions = $middlewareDefinitions;`
`60`		`- $clone->stack->reset();`
	`60`	`+ $clone->pipeline->reset();`
`61`	`61`
`62`	`62`	`return $clone;`
`63`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`use Yiisoft\Middleware\Dispatcher\Event\AfterMiddleware;`
`14`	`14`	`use Yiisoft\Middleware\Dispatcher\Event\BeforeMiddleware;`
`15`	`15`
`16`		`-final class MiddlewareStack implements MiddlewareStackInterface`
	`16`	`+final class MiddlewareStack implements MiddlewarePipelineInterface`
`17`	`17`	`{`
`18`	`18`	`/**`
`19`	`19`	`* Contains a stack of middleware wrapped in handlers.`
`@@ -30,7 +30,7 @@ public function __construct(EventDispatcherInterface $eventDispatcher)`
`30`	`30`	`$this->eventDispatcher = $eventDispatcher;`
`31`	`31`	`}`
`32`	`32`
`33`		`- public function build(array $middlewares, RequestHandlerInterface $fallbackHandler): MiddlewareStackInterface`
	`33`	`+ public function build(array $middlewares, RequestHandlerInterface $fallbackHandler): MiddlewarePipelineInterface`
`34`	`34`	`{`
`35`	`35`	`$handler = $fallbackHandler;`
`36`	`36`	`foreach ($middlewares as $middleware) {`