This repository has been archived by the owner on Jan 29, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 89
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'feature/236' into develop
Close #236
- Loading branch information
Showing
8 changed files
with
538 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| <?php | ||
| /** | ||
| * @see https://github.com/zendframework/zend-mvc for the canonical source repository | ||
| * @copyright Copyright (c) 2017 Zend Technologies USA Inc. (http://www.zend.com) | ||
| * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License | ||
| */ | ||
|
|
||
| namespace Zend\Mvc\Controller; | ||
|
|
||
| use Psr\Http\Message\ResponseInterface; | ||
| use Psr\Http\Message\ServerRequestInterface; | ||
| use Zend\EventManager\EventManagerInterface; | ||
| use Zend\Http\Request; | ||
| use Zend\Mvc\Exception\ReachedFinalHandlerException; | ||
| use Zend\Mvc\Exception\RuntimeException; | ||
| use Zend\Mvc\MvcEvent; | ||
| use Zend\Psr7Bridge\Psr7ServerRequest; | ||
| use Zend\Router\RouteMatch; | ||
| use Zend\Stratigility\Delegate\CallableDelegateDecorator; | ||
| use Zend\Stratigility\MiddlewarePipe; | ||
|
|
||
| /** | ||
| * @internal don't use this in your codebase, or else @ocramius will hunt you | ||
| * down. This is just an internal hack to make middleware trigger | ||
| * 'dispatch' events attached to the DispatchableInterface identifier. | ||
| * | ||
| * Specifically, it will receive a @see MiddlewarePipe and a | ||
| * @see ResponseInterface prototype, and then dispatch the pipe whilst still | ||
| * behaving like a normal controller. That is needed for any events | ||
| * attached to the @see \Zend\Stdlib\DispatchableInterface identifier to | ||
| * reach their listeners on any attached | ||
| * @see \Zend\EventManager\SharedEventManagerInterface | ||
| */ | ||
| final class MiddlewareController extends AbstractController | ||
| { | ||
| /** | ||
| * @var MiddlewarePipe | ||
| */ | ||
| private $pipe; | ||
|
|
||
| /** | ||
| * @var ResponseInterface | ||
| */ | ||
| private $responsePrototype; | ||
|
|
||
| public function __construct( | ||
| MiddlewarePipe $pipe, | ||
| ResponseInterface $responsePrototype, | ||
| EventManagerInterface $eventManager, | ||
| MvcEvent $event | ||
| ) { | ||
| $this->eventIdentifier = __CLASS__; | ||
| $this->pipe = $pipe; | ||
| $this->responsePrototype = $responsePrototype; | ||
|
|
||
| $this->setEventManager($eventManager); | ||
| $this->setEvent($event); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| * | ||
| * @throws RuntimeException | ||
| */ | ||
| public function onDispatch(MvcEvent $e) | ||
| { | ||
| $routeMatch = $e->getRouteMatch(); | ||
| $psr7Request = $this->populateRequestParametersFromRoute( | ||
| $this->loadRequest()->withAttribute(RouteMatch::class, $routeMatch), | ||
| $routeMatch | ||
| ); | ||
|
|
||
| $result = $this->pipe->process($psr7Request, new CallableDelegateDecorator( | ||
| function () { | ||
| throw ReachedFinalHandlerException::create(); | ||
| }, | ||
| $this->responsePrototype | ||
| )); | ||
|
|
||
| $e->setResult($result); | ||
|
|
||
| return $result; | ||
| } | ||
|
|
||
| /** | ||
| * @return \Zend\Diactoros\ServerRequest | ||
| * | ||
| * @throws RuntimeException | ||
| */ | ||
| private function loadRequest() | ||
| { | ||
| $request = $this->request; | ||
|
|
||
| if (! $request instanceof Request) { | ||
| throw new RuntimeException(sprintf( | ||
| 'Expected request to be a %s, %s given', | ||
| Request::class, | ||
| get_class($request) | ||
| )); | ||
| } | ||
|
|
||
| return Psr7ServerRequest::fromZend($request); | ||
| } | ||
|
|
||
| /** | ||
| * @param ServerRequestInterface $request | ||
| * @param RouteMatch|null $routeMatch | ||
| * | ||
| * @return ServerRequestInterface | ||
| */ | ||
| private function populateRequestParametersFromRoute(ServerRequestInterface $request, RouteMatch $routeMatch = null) | ||
| { | ||
| if (! $routeMatch) { | ||
| return $request; | ||
| } | ||
|
|
||
| foreach ($routeMatch->getParams() as $key => $value) { | ||
| $request = $request->withAttribute($key, $value); | ||
| } | ||
|
|
||
| return $request; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| <?php | ||
| /** | ||
| * @see https://github.com/zendframework/zend-mvc for the canonical source repository | ||
| * @copyright Copyright (c) 2017 Zend Technologies USA Inc. (http://www.zend.com) | ||
| * @license https://github.com/zendframework/zend-mvc/blob/master/LICENSE.md New BSD License | ||
| */ | ||
|
|
||
| namespace ZendTest\Mvc\Controller; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Psr\Http\Message\ResponseInterface; | ||
| use Zend\EventManager\EventManager; | ||
| use Zend\EventManager\EventManagerInterface; | ||
| use Zend\Http\Request; | ||
| use Zend\Http\Response; | ||
| use Zend\Mvc\Controller\AbstractController; | ||
| use Zend\Mvc\Controller\MiddlewareController; | ||
| use Zend\Mvc\Exception\RuntimeException; | ||
| use Zend\Mvc\MvcEvent; | ||
| use Zend\Stdlib\DispatchableInterface; | ||
| use Zend\Stdlib\RequestInterface; | ||
| use Zend\Stratigility\MiddlewarePipe; | ||
|
|
||
| /** | ||
| * @covers \Zend\Mvc\Controller\MiddlewareController | ||
| */ | ||
| class MiddlewareControllerTest extends TestCase | ||
| { | ||
| /** | ||
| * @var MiddlewarePipe|\PHPUnit_Framework_MockObject_MockObject | ||
| */ | ||
| private $pipe; | ||
|
|
||
| /** | ||
| * @var ResponseInterface|\PHPUnit_Framework_MockObject_MockObject | ||
| */ | ||
| private $responsePrototype; | ||
|
|
||
| /** | ||
| * @var EventManagerInterface | ||
| */ | ||
| private $eventManager; | ||
|
|
||
| /** | ||
| * @var AbstractController|\PHPUnit_Framework_MockObject_MockObject | ||
| */ | ||
| private $controller; | ||
|
|
||
| /** | ||
| * @var MvcEvent | ||
| */ | ||
| private $event; | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| protected function setUp() | ||
| { | ||
| $this->pipe = $this->createMock(MiddlewarePipe::class); | ||
| $this->responsePrototype = $this->createMock(ResponseInterface::class); | ||
| $this->eventManager = $this->createMock(EventManagerInterface::class); | ||
| $this->event = new MvcEvent(); | ||
| $this->eventManager = new EventManager(); | ||
|
|
||
| $this->controller = new MiddlewareController( | ||
| $this->pipe, | ||
| $this->responsePrototype, | ||
| $this->eventManager, | ||
| $this->event | ||
| ); | ||
| } | ||
|
|
||
| public function testWillAssignCorrectEventManagerIdentifiers() | ||
| { | ||
| $identifiers = $this->eventManager->getIdentifiers(); | ||
|
|
||
| self::assertContains(MiddlewareController::class, $identifiers); | ||
| self::assertContains(AbstractController::class, $identifiers); | ||
| self::assertContains(DispatchableInterface::class, $identifiers); | ||
| } | ||
|
|
||
| public function testWillDispatchARequestAndResponseWithAGivenPipe() | ||
| { | ||
| $request = new Request(); | ||
| $response = new Response(); | ||
| $result = $this->createMock(ResponseInterface::class); | ||
| /* @var $dispatchListener callable|\PHPUnit_Framework_MockObject_MockObject */ | ||
| $dispatchListener = $this->getMockBuilder(\stdClass::class)->setMethods(['__invoke'])->getMock(); | ||
|
|
||
| $this->eventManager->attach(MvcEvent::EVENT_DISPATCH, $dispatchListener, 100); | ||
| $this->eventManager->attach(MvcEvent::EVENT_DISPATCH_ERROR, function () { | ||
| self::fail('No dispatch error expected'); | ||
| }, 100); | ||
|
|
||
| $dispatchListener | ||
| ->expects(self::once()) | ||
| ->method('__invoke') | ||
| ->with(self::callback(function (MvcEvent $event) use ($request, $response) { | ||
| self::assertSame($this->event, $event); | ||
| self::assertSame(MvcEvent::EVENT_DISPATCH, $event->getName()); | ||
| self::assertSame($this->controller, $event->getTarget()); | ||
| self::assertSame($request, $event->getRequest()); | ||
| self::assertSame($response, $event->getResponse()); | ||
|
|
||
| return true; | ||
| })); | ||
|
|
||
| $this->pipe->expects(self::once())->method('process')->willReturn($result); | ||
|
|
||
| $controllerResult = $this->controller->dispatch($request, $response); | ||
|
|
||
| self::assertSame($result, $controllerResult); | ||
| self::assertSame($result, $this->event->getResult()); | ||
| } | ||
|
|
||
| public function testWillRefuseDispatchingInvalidRequestTypes() | ||
| { | ||
| /* @var $request RequestInterface */ | ||
| $request = $this->createMock(RequestInterface::class); | ||
| $response = new Response(); | ||
| /* @var $dispatchListener callable|\PHPUnit_Framework_MockObject_MockObject */ | ||
| $dispatchListener = $this->getMockBuilder(\stdClass::class)->setMethods(['__invoke'])->getMock(); | ||
|
|
||
| $this->eventManager->attach(MvcEvent::EVENT_DISPATCH, $dispatchListener, 100); | ||
|
|
||
| $dispatchListener | ||
| ->expects(self::once()) | ||
| ->method('__invoke') | ||
| ->with(self::callback(function (MvcEvent $event) use ($request, $response) { | ||
| self::assertSame($this->event, $event); | ||
| self::assertSame(MvcEvent::EVENT_DISPATCH, $event->getName()); | ||
| self::assertSame($this->controller, $event->getTarget()); | ||
| self::assertSame($request, $event->getRequest()); | ||
| self::assertSame($response, $event->getResponse()); | ||
|
|
||
| return true; | ||
| })); | ||
|
|
||
| $this->pipe->expects(self::never())->method('process'); | ||
|
|
||
| $this->expectException(RuntimeException::class); | ||
|
|
||
| $this->controller->dispatch($request, $response); | ||
| } | ||
| } |
Oops, something went wrong.