Added MiddlewareInterface to the request handler so it can be used either as RequestHandler or as middleware. Introduce BC break

Author: noglitchyo

CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.0] - 2019-07-12
+### Added
+- RequestHandler supports MiddlewareInterface to be use as a middleware as well
+
+### Changed
+- Constructor arguments order for RequestHandler
+- Default handler is now optional
+
+## [1.1.0] - 2019-06-26
+### Added
+- Handful factory methods
+- Updated documentation
+
+## [1.0.0] - 2019-06-23
+- Initial release

README.md

@@ -34,23 +34,31 @@ Comes with a set of middleware collections using different strategy (LIFO, FIFO.
 
 #### Run
 
-Instantiate the RequestHandler class. It requires ony 2 arguments: 
+Create a new instance of the request handler class which can be use as a request handler or as a middleware.
 
-- ***`$defaultRequestHandler`*** : [RequestHandlerInterface](https://github.com/php-fig/http-server-handler/blob/master/src/RequestHandlerInterface.php)
+##### From the constructor 
 
-    ***The default request handler MUST provide a default response if none of the middlewares created one.***
+`RequestHandler::__construct(MiddlewareCollectionInterface $middlewareCollection, RequestHandlerInterface $defaultRequestHandler = null)`
+
+- ***`$middlewareCollection`*** : [MiddlewareCollectionInterface](https://github.com/noglitchyo/middleware-collection-request-handler/blob/master/src/MiddlewareCollectionInterface.php)
+
+    Contains the middlewares and defines the strategy used to store the middlewares and to retrieve the next middleware.
+    Some implementations with common strategies are provided: [stack (LIFO)](https://github.com/noglitchyo/middleware-collection-request-handler/blob/master/src/Collection/SplStackMiddlewareCollection.php), [queue (FIFO)](https://github.com/noglitchyo/middleware-collection-request-handler/blob/master/src/Collection/SplQueueMiddlewareCollection.php).
+
+- ***`$defaultRequestHandler = null`*** : [RequestHandlerInterface](https://github.com/php-fig/http-server-handler/blob/master/src/RequestHandlerInterface.php)
+
+    Provides a default response implementing [ResponseInterface](https://github.com/php-fig/http-message/blob/master/src/ResponseInterface.php) if none of the middlewares in the collection was able to create one.
 
     Some examples of what could be a "default request handler":
     - with the [ADR pattern](https://en.wikipedia.org/wiki/Action%E2%80%93domain%E2%80%93responder), the default request handler might be your action class.*
     - with the [MVC pattern](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller), the default request handler might be the action method of your controller.
 
-    It is possible to directly provide a `callable` and use the factory method `RequestHandler::fromCallable(callable $callable)`. 
-    It will create an anonymous instance of RequestHandlerInterface wrapping the given `callable` inside.
-
-- ***`$middlewareCollection`*** : [MiddlewareCollectionInterface](https://github.com/noglitchyo/middleware-collection-request-handler/blob/master/src/MiddlewareCollectionInterface.php)
+##### From the factory method
 
-    Contains the middlewares and defines the strategy used to store the middlewares and to retrieve the next middleware.
-    Some implementations with common strategies are provided: [stack (LIFO)](https://github.com/noglitchyo/middleware-collection-request-handler/blob/master/src/Collection/SplStackMiddlewareCollection.php), [queue (FIFO)](https://github.com/noglitchyo/middleware-collection-request-handler/blob/master/src/Collection/SplQueueMiddlewareCollection.php).
+`RequestHandler::fromCallable(callable $callable, MiddlewareCollectionInterface $middlewareCollection)`
+ 
+It creates a RequestHandler instance by wrapping the given `callable` inside an anonymous instance of RequestHandlerInterface.
+The callable is the $defaultRequestHandler. **It MUST returns a response implementing [ResponseInterface](https://github.com/php-fig/http-message/blob/master/src/ResponseInterface.php).**
 
 ##### Example
 
@@ -88,6 +96,7 @@ $requestHandler = RequestHandler::fromCallable(
     $middlewareCollection
 );
 
+// As a RequestHandler:
 // Pass the request to the request handler which will dispatch the request to the middlewares.
 $response = $requestHandler->handle(/* ServerRequestInterface */);