Merge branch 'feature/561-response-factories' into release-3.0.0

Close #561
Fixes #560

Author: weierophinney

CHANGELOG.md

@@ -15,6 +15,33 @@ All notable changes to this project will be documented in this file, in reverse
   to the `ApplicationFactory`. It now uses the canonical service name for the
   `PathBasedRoutingMiddleware` instead of the `ROUTE_MIDDLEWARE` constant.
 
+- [#561](https://github.com/zendframework/zend-expressive/pull/561) updates to
+  zend-expressive-router 3.0.0alpha3.
+
+- [#561](https://github.com/zendframework/zend-expressive/pull/561) renames
+  `Zend\Expressive\Container\ResponseFactory` to `Zend\Expressive\Container\ResponseFactoryFactory`,
+  and the factory now returns a callable that will return a zend-diactoros
+  `Response` instance, instead of returning the instance itself. Each of the
+  various services named after zend-expressive-router response constants were
+  removed in favor of a single `Psr\Http\Message\ResponseInterface` service
+  resolving to the `ResponseFactoryFactory`.
+
+- [#561](https://github.com/zendframework/zend-expressive/pull/561) modifies the
+  `Zend\Expressive\Handler\NotFoundHandler` to compose a response factory
+  instead of a response prototype. This approach allows it to use the
+  `Psr\Http\Message\ResponseInterface` service defined per the above note.
+
+- [#561](https://github.com/zendframework/zend-expressive/pull/561) renames
+  the `Zend\Expressive\Router\IMPLICIT_HEAD_MIDDLEWARE_STREAM_FACTORY` service
+  to `Psr\Http\Message\StreamInterface`, as this is what zend-expressive-router
+  now expects.
+
+- [#561](https://github.com/zendframework/zend-expressive/pull/561) renames the
+  `Zend\Expressive\ServerRequestFactory` service to
+  `Psr\Http\Message\ServerRequestInterface`. The
+  `Zend\Expressive\SERVER_REQUEST_FACTORY` constant now resolves to the
+  interface name.
+
 ### Deprecated
 
 - Nothing.

composer.json

@@ -28,7 +28,7 @@
         "psr/http-message": "^1.0.1",
         "psr/http-server-middleware": "^1.0",
         "zendframework/zend-diactoros": "^1.3.10",
-        "zendframework/zend-expressive-router": "^3.0.0alpha2",
+        "zendframework/zend-expressive-router": "^3.0.0alpha3",
         "zendframework/zend-expressive-template": "^2.0.0alpha1",
         "zendframework/zend-httphandlerrunner": "^1.0",
         "zendframework/zend-stratigility": "3.0.0alpha3"

composer.lock

@@ -5,12 +5,12 @@
          colors="true">
     <testsuites>
         <testsuite name="zend-expressive-response-factory">
-            <file>./test/Container/ResponseFactoryWithoutDiactorosTest.php</file>
+            <file>./test/Container/ResponseFactoryFactoryWithoutDiactorosTest.php</file>
             <file>./test/Container/StreamFactoryFactoryWithoutDiactorosTest.php</file>
         </testsuite>
         <testsuite name="zend-expressive">
             <directory>./test</directory>
-            <exclude>./test/Container/ResponseFactoryWithoutDiactorosTest.php</exclude>
+            <exclude>./test/Container/ResponseFactoryFactoryWithoutDiactorosTest.php</exclude>
             <exclude>./test/Container/StreamFactoryFactoryWithoutDiactorosTest.php</exclude>
         </testsuite>
     </testsuites>

phpunit.xml.dist

@@ -9,6 +9,9 @@
 
 namespace Zend\Expressive;
 
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Message\StreamInterface;
 use Zend\HttpHandlerRunner\Emitter\EmitterInterface;
 use Zend\HttpHandlerRunner\RequestHandlerRunner;
 use Zend\Stratigility\Middleware\ErrorHandler;
@@ -29,7 +32,6 @@ public function __invoke() : array
 
     public function getDependencies() : array
     {
-        // @codingStandardsIgnoreStart
         return [
             'aliases' => [
                 DEFAULT_DELEGATE            => Handler\NotFoundHandler::class,
@@ -40,25 +42,21 @@ public function getDependencies() : array
                 ROUTE_MIDDLEWARE            => Router\Middleware\PathBasedRoutingMiddleware::class,
             ],
             'factories' => [
-                Application::class                             => Container\ApplicationFactory::class,
-                ApplicationPipeline::class                     => Container\ApplicationPipelineFactory::class,
-                EmitterInterface::class                        => Container\EmitterFactory::class,
-                ErrorHandler::class                            => Container\ErrorHandlerFactory::class,
-                Handler\NotFoundHandler::class                 => Container\NotFoundHandlerFactory::class,
-                MiddlewareContainer::class                     => Container\MiddlewareContainerFactory::class,
-                MiddlewareFactory::class                       => Container\MiddlewareFactoryFactory::class,
+                Application::class                       => Container\ApplicationFactory::class,
+                ApplicationPipeline::class               => Container\ApplicationPipelineFactory::class,
+                EmitterInterface::class                  => Container\EmitterFactory::class,
+                ErrorHandler::class                      => Container\ErrorHandlerFactory::class,
+                Handler\NotFoundHandler::class           => Container\NotFoundHandlerFactory::class,
+                MiddlewareContainer::class               => Container\MiddlewareContainerFactory::class,
+                MiddlewareFactory::class                 => Container\MiddlewareFactoryFactory::class,
                 // Change the following in development to the WhoopsErrorResponseGeneratorFactory:
-                Middleware\ErrorResponseGenerator::class       => Container\ErrorResponseGeneratorFactory::class,
-                NOT_FOUND_RESPONSE                             => Container\ResponseFactory::class,
-                RequestHandlerRunner::class                    => Container\RequestHandlerRunnerFactory::class,
-                Router\IMPLICIT_HEAD_MIDDLEWARE_RESPONSE       => Container\ResponseFactory::class,
-                Router\IMPLICIT_HEAD_MIDDLEWARE_STREAM_FACTORY => Container\StreamFactoryFactory::class,
-                Router\IMPLICIT_OPTIONS_MIDDLEWARE_RESPONSE    => Container\ResponseFactory::class,
-                Router\METHOD_NOT_ALLOWED_MIDDLEWARE_RESPONSE  => Container\ResponseFactory::class,
-                SERVER_REQUEST_ERROR_RESPONSE_GENERATOR        => Container\ServerRequestErrorResponseGeneratorFactory::class,
-                SERVER_REQUEST_FACTORY                         => Container\ServerRequestFactoryFactory::class,
+                Middleware\ErrorResponseGenerator::class => Container\ErrorResponseGeneratorFactory::class,
+                RequestHandlerRunner::class              => Container\RequestHandlerRunnerFactory::class,
+                ResponseInterface::class                 => Container\ResponseFactoryFactory::class,
+                SERVER_REQUEST_ERROR_RESPONSE_GENERATOR  => Container\ServerRequestErrorResponseGeneratorFactory::class,
+                ServerRequestInterface::class            => Container\ServerRequestFactoryFactory::class,
+                StreamInterface::class                   => Container\StreamFactoryFactory::class,
             ],
         ];
-        // @codingStandardsIgnoreEnd
     }
 }

src/ConfigProvider.php

@@ -10,12 +10,10 @@
 namespace Zend\Expressive\Container;
 
 use Psr\Container\ContainerInterface;
+use Psr\Http\Message\ResponseInterface;
 use Zend\Expressive\Handler\NotFoundHandler;
-use Zend\Expressive\Response\NotFoundResponseInterface;
 use Zend\Expressive\Template\TemplateRendererInterface;
 
-use const Zend\Expressive\NOT_FOUND_RESPONSE;
-
 class NotFoundHandlerFactory
 {
     public function __invoke(ContainerInterface $container) : NotFoundHandler
@@ -30,7 +28,7 @@ public function __invoke(ContainerInterface $container) : NotFoundHandler
             ?? NotFoundHandler::LAYOUT_DEFAULT;
 
         return new NotFoundHandler(
-            $container->get(NOT_FOUND_RESPONSE),
+            $container->get(ResponseInterface::class),
             $renderer,
             $template,
             $layout

src/Container/NotFoundHandlerFactory.php

@@ -10,9 +10,9 @@
 namespace Zend\Expressive\Container;
 
 use Psr\Container\ContainerInterface;
+use Psr\Http\Message\ServerRequestInterface;
 use Zend\Expressive\ApplicationPipeline;
 use Zend\Expressive\ServerRequestErrorResponseGenerator;
-use Zend\Expressive\ServerRequestFactory;
 use Zend\HttpHandlerRunner\Emitter\EmitterInterface;
 use Zend\HttpHandlerRunner\RequestHandlerRunner;
 
@@ -25,7 +25,7 @@
  * - Zend\Expressive\ApplicationPipeline, which should resolve to a
  *   Zend\Stratigility\MiddlewarePipeInterface and/or
  *   Psr\Http\Server\RequestHandlerInterface instance.
- * - Zend\Expressive\ServerRequestFactory, which should resolve to a PHP
+ * - Psr\Http\Message\ServerRequestInterface, which should resolve to a PHP
  *   callable that will return a Psr\Http\Message\ServerRequestInterface
  *   instance.
  * - Zend\Expressive\ServerRequestErrorResponseGenerator, which should resolve
@@ -41,7 +41,7 @@ public function __invoke(ContainerInterface $container) : RequestHandlerRunner
         return new RequestHandlerRunner(
             $container->get(ApplicationPipeline::class),
             $container->get(EmitterInterface::class),
-            $container->get(ServerRequestFactory::class),
+            $container->get(ServerRequestInterface::class),
             $container->get(ServerRequestErrorResponseGenerator::class)
         );
     }

src/Container/RequestHandlerRunnerFactory.php

@@ -14,29 +14,27 @@
 use Zend\Diactoros\Response;
 
 /**
- * Produces a response prototype for use with services that need to
- * produce a response. This service should be non-shared, if your
- * container supports that possibility, to ensure that the stream
- * it composes cannot be written to by any other consumer.
+ * Produces a callable capable of producing a response prototype for use with
+ * services that need to produce a response.
  */
-class ResponseFactory
+class ResponseFactoryFactory
 {
-    public function __invoke(ContainerInterface $container) : ResponseInterface
+    public function __invoke(ContainerInterface $container) : callable
     {
         if (! class_exists(Response::class)) {
             throw new Exception\InvalidServiceException(sprintf(
-                'The %s service must map to a factory capable of returning an'
+                'The %1$s service must map to a factory capable of returning an'
                 . ' implementation instance. By default, we assume usage of'
                 . ' zend-diactoros for PSR-7, but it does not appear to be'
                 . ' present on your system. Please install zendframework/zend-diactoros'
-                . ' or provide an alternate factory for the %s service that'
-                . ' can produce an appropriate %s instance.',
-                ResponseInterface::class,
-                ResponseInterface::class,
+                . ' or provide an alternate factory for the %1$s service that'
+                . ' can produce an appropriate %1$s instance.',
                 ResponseInterface::class
             ));
         }
 
-        return new Response();
+        return function () : Response {
+            return new Response();
+        };
     }
 }

src/Container/ResponseFactory.php renamed to src/Container/ResponseFactoryFactory.php

@@ -26,12 +26,9 @@ class NotFoundHandler implements RequestHandlerInterface
     private $renderer;
 
     /**
-     * This duplicates the property in StratigilityNotFoundHandler, but is done
-     * to ensure that we have access to the value in the methods we override.
-     *
-     * @var ResponseInterface
+     * @var callable
      */
-    protected $responsePrototype;
+    private $responseFactory;
 
     /**
      * @var string
@@ -44,12 +41,15 @@ class NotFoundHandler implements RequestHandlerInterface
     private $layout;
 
     public function __construct(
-        ResponseInterface $responsePrototype,
+        callable $responseFactory,
         TemplateRendererInterface $renderer = null,
         string $template = self::TEMPLATE_DEFAULT,
         string $layout = self::LAYOUT_DEFAULT
     ) {
-        $this->responsePrototype = $responsePrototype;
+        // Factory cast to closure in order to provide return type safety.
+        $this->responseFactory = function () use ($responseFactory) : ResponseInterface {
+            return $responseFactory();
+        };
         $this->renderer = $renderer;
         $this->template = $template;
         $this->layout = $layout;
@@ -75,7 +75,7 @@ public function handle(ServerRequestInterface $request) : ResponseInterface
      */
     private function generatePlainTextResponse(ServerRequestInterface $request) : ResponseInterface
     {
-        $response = $this->responsePrototype->withStatus(StatusCodeInterface::STATUS_NOT_FOUND);
+        $response = ($this->responseFactory)()->withStatus(StatusCodeInterface::STATUS_NOT_FOUND);
         $response->getBody()
             ->write(sprintf(
                 'Cannot %s %s',
@@ -93,7 +93,7 @@ private function generatePlainTextResponse(ServerRequestInterface $request) : Re
      */
     private function generateTemplatedResponse(ServerRequestInterface $request) : ResponseInterface
     {
-        $response = $this->responsePrototype->withStatus(StatusCodeInterface::STATUS_NOT_FOUND);
+        $response = ($this->responseFactory)()->withStatus(StatusCodeInterface::STATUS_NOT_FOUND);
         $response->getBody()->write(
             $this->renderer->render($this->template, ['request' => $request, 'layout' => $this->layout])
         );

src/Handler/NotFoundHandler.php

@@ -9,6 +9,8 @@
 
 namespace Zend\Expressive;
 
+use Psr\Http\Message\ServerRequestInterface;
+
 /**
  * Legacy service name for the default delegate referenced in version 2.
  * Should resolve to the Handler\NotFoundHandler class.
@@ -57,14 +59,6 @@
  */
 const NOT_FOUND_MIDDLEWARE = __NAMESPACE__ . '\Middleware\NotFoundMiddleware';
 
-/**
- * Virtual service name that should resolve to a service returning a PSR-7
- * ResponseInterface instance for use with the Handler\NotFoundHandler class.
- *
- * @var string
- */
-const NOT_FOUND_RESPONSE = __NAMESPACE__ . '\Response\NotFoundResponseInterface';
-
 /**
  * Legacy service name for the RouteMiddleware referenced in version 2.
  * Should resolve to the Zend\Expressive\Router\Middleware\PathBasedRoutingMiddleware
@@ -85,9 +79,11 @@
 const SERVER_REQUEST_ERROR_RESPONSE_GENERATOR = __NAMESPACE__ . '\ServerRequestErrorResponseGenerator';
 
 /**
- * Virtual service name that should resolve to a service capable of producing
- * a PSR-7 ServerRequestInterface instance for the application.
+ * Legacy/transitional service name for the ServerRequestFactory virtual
+ * service introduced in 3.0.0alpha6. Should resolve to the
+ * Psr\Http\Message\ServerRequestInterface service.
  *
+ * @deprecated To remove in version 4.0.0.
  * @var string
  */
-const SERVER_REQUEST_FACTORY = __NAMESPACE__ . '\ServerRequestFactory';
+const SERVER_REQUEST_FACTORY = ServerRequestInterface::class;