Merge branch 'feature/629' into develop

Close #629

Author: weierophinney

CHANGELOG.md

@@ -2,15 +2,22 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
-## 3.1.0 - TBD
+## 3.1.0 - 2018-07-30
 
 ### Added
 
 - Nothing.
 
 ### Changed
 
-- Nothing.
+- [#629](https://github.com/zendframework/zend-expressive/pull/629) changes the constructor of `Zend\Expressive\Middleware\ErrorResponseGenerator`
+  to accept an additional, optional argument, `$layout`, which defaults to a new
+  constant value, `ErrorResponseGenerator::LAYOUT_DEFAULT`, or `layout::default`.
+  `Zend\Expressive\Container\ErrorResponseGeneratorFactory` now also looks for
+  the configuration value `zend-expressive.error_handler.layout`, and will use
+  that value to seed the constructor argument. This change makes the
+  `ErrorResponseGenerator` mirror the `NotFoundHandler`, allowing for a
+  consistent layout between the two error pages.
 
 ### Deprecated
 

docs/book/v3/features/container/factories.md

@@ -81,7 +81,11 @@ When the `config` service is present, the factory can utilize two values:
 - `zend-expressive.error_handler.template_error`, a name of an alternate
   template to use (instead of the default represented in the
   `Zend\Expressive\Middleware\ErrorResponseGenerator::TEMPLATE_DEFAULT`
-  constant).
+  constant, which evaluates to `error::error`).
+- **Since 3.1.0**: `zend-expressive.error_handler.layout`, a name of an
+  alternate layout to use (instead of the default represented in the
+  `Zend\Expressive\Middleware\ErrorResponseGenerator::LAYOUT_DEFAULT` constant,
+  which evaluates to `layout::default`).
 
 As an example:
 
@@ -90,6 +94,7 @@ As an example:
 'zend-expressive' => [
     'error_handler' => [
         'template_error' => 'name of error template',
+        'layout' => 'layout::alternate',
     ],
 ],
 ```
@@ -150,14 +155,21 @@ When the `config` service is present, the factory can utilize two values:
 
 - `zend-expressive.error_handler.template_404`, a name of an alternate
   template to use (instead of the default represented in the
-  `Zend\Expressive\Delegate\NotFoundDelegate::TEMPLATE_DEFAULT` constant).
+  `Zend\Expressive\Delegate\NotFoundDelegate::TEMPLATE_DEFAULT` constant, which
+  evaluates to `error::404`).
+
+- `zend-expressive.error_handler.layout`, a name of an alternate
+  template to use (instead of the default represented in the
+  `Zend\Expressive\Delegate\NotFoundDelegate::TEMPLATE_DEFAULT` constant, which
+  evaluates to `layout::default`).
 
 As an example:
 
 ```php
 'zend-expressive' => [
     'error_handler' => [
         'template_404' => 'name of 404 template',
+        'layout' => 'layout::alternate',
     ],
 ],
 ```

docs/book/v3/features/error-handling.md

@@ -71,6 +71,9 @@ We provide two error response generators for you:
   otherwise, a plain text response is generated that notes the request method
   and URI.
 
+  Since version 3.1.0, it also accepts a layout name, if you want to use one
+  other than `layout::default`.
+
 - `Zend\Expressive\Middleware\WhoopsErrorResponseGenerator`, which uses
   [whoops](http://filp.github.io/whoops/) to present detailed exception
   and request information; this implementation is intended for development

src/Container/ErrorResponseGeneratorFactory.php

@@ -24,10 +24,13 @@ public function __invoke(ContainerInterface $container) : ErrorResponseGenerator
         $template = $config['zend-expressive']['error_handler']['template_error']
             ?? ErrorResponseGenerator::TEMPLATE_DEFAULT;
 
+        $layout   = $config['zend-expressive']['error_handler']['layout']
+            ?? ErrorResponseGenerator::LAYOUT_DEFAULT;
+
         $renderer = $container->has(TemplateRendererInterface::class)
             ? $container->get(TemplateRendererInterface::class)
             : null;
 
-        return new ErrorResponseGenerator($debug, $renderer, $template);
+        return new ErrorResponseGenerator($debug, $renderer, $template, $layout);
     }
 }

src/Middleware/ErrorResponseGenerator.php

@@ -21,15 +21,18 @@ class ErrorResponseGenerator
     use ErrorResponseGeneratorTrait;
 
     public const TEMPLATE_DEFAULT = 'error::error';
+    public const LAYOUT_DEFAULT = 'layout::default';
 
     public function __construct(
         bool $isDevelopmentMode = false,
         TemplateRendererInterface $renderer = null,
-        string $template = self::TEMPLATE_DEFAULT
+        string $template = self::TEMPLATE_DEFAULT,
+        string $layout = self::LAYOUT_DEFAULT
     ) {
         $this->debug     = $isDevelopmentMode;
         $this->renderer  = $renderer;
         $this->template  = $template;
+        $this->layout    = $layout;
     }
 
     public function __invoke(
@@ -49,6 +52,7 @@ public function __invoke(
                     'uri'      => (string) $request->getUri(),
                     'status'   => $response->getStatusCode(),
                     'reason'   => $response->getReasonPhrase(),
+                    'layout'   => $this->layout,
                 ],
                 $this->debug,
                 $response

src/Response/ErrorResponseGeneratorTrait.php

@@ -48,6 +48,13 @@ trait ErrorResponseGeneratorTrait
      */
     private $template;
 
+    /**
+     * Name of the layout to render.
+     *
+     * @var string
+     */
+    private $layout;
+
     private function prepareTemplatedResponse(
         Throwable $e,
         TemplateRendererInterface $renderer,

test/Container/ErrorResponseGeneratorFactoryTest.php

@@ -42,6 +42,7 @@ public function testNoConfigurationCreatesInstanceWithDefaults()
         $this->assertAttributeEquals(false, 'debug', $generator);
         $this->assertAttributeEmpty('renderer', $generator);
         $this->assertAttributeEquals('error::error', 'template', $generator);
+        $this->assertAttributeEquals('layout::default', 'layout', $generator);
     }
 
     public function testUsesDebugConfigurationToSetDebugFlag()
@@ -56,6 +57,7 @@ public function testUsesDebugConfigurationToSetDebugFlag()
         $this->assertAttributeEquals(true, 'debug', $generator);
         $this->assertAttributeEmpty('renderer', $generator);
         $this->assertAttributeEquals('error::error', 'template', $generator);
+        $this->assertAttributeEquals('layout::default', 'layout', $generator);
     }
 
     public function testUsesConfiguredTemplateRenderToSetGeneratorRenderer()
@@ -70,6 +72,7 @@ public function testUsesConfiguredTemplateRenderToSetGeneratorRenderer()
         $this->assertAttributeEquals(false, 'debug', $generator);
         $this->assertAttributeSame($this->renderer->reveal(), 'renderer', $generator);
         $this->assertAttributeEquals('error::error', 'template', $generator);
+        $this->assertAttributeEquals('layout::default', 'layout', $generator);
     }
 
     public function testUsesTemplateConfigurationToSetTemplate()
@@ -79,6 +82,7 @@ public function testUsesTemplateConfigurationToSetTemplate()
             'zend-expressive' => [
                 'error_handler' => [
                     'template_error' => 'error::custom',
+                    'layout' => 'layout::custom',
                 ],
             ],
         ]);
@@ -90,5 +94,6 @@ public function testUsesTemplateConfigurationToSetTemplate()
         $this->assertAttributeEquals(false, 'debug', $generator);
         $this->assertAttributeEmpty('renderer', $generator);
         $this->assertAttributeEquals('error::custom', 'template', $generator);
+        $this->assertAttributeEquals('layout::custom', 'layout', $generator);
     }
 }

test/Middleware/ErrorResponseGeneratorTest.php

@@ -135,6 +135,7 @@ public function testRendersTemplateWithoutErrorDetailsWhenRendererPresentAndNotI
                 'uri'      => 'https://example.com/foo',
                 'status'   => StatusCode::STATUS_INTERNAL_SERVER_ERROR,
                 'reason'   => 'Internal Server Error',
+                'layout'   => 'layout::default',
             ])
             ->willReturn('TEMPLATED CONTENTS');
 
@@ -198,6 +199,7 @@ public function testRendersTemplateWithErrorDetailsWhenRendererPresentAndInDebug
                 'status'   => StatusCode::STATUS_INTERNAL_SERVER_ERROR,
                 'reason'   => 'Network Connect Timeout Error',
                 'error'    => $error,
+                'layout'   => 'layout::default',
             ])
             ->willReturn('TEMPLATED CONTENTS');