Merge pull request #390 from symfony-cmf/remove-strict

use request stack rather than a single request

Author: dbu

CHANGELOG.md

@@ -1,6 +1,8 @@
 Changelog
 =========
 
+ * **2017-02-17**: [BC BREAK] DynamicRouter::setRequest has been replaced with DynamicRouter::setRequestStack.
+
 2.0.0-RC2
 ---------
 

src/Resources/config/routing-dynamic.xml

@@ -61,7 +61,7 @@
             <argument>%cmf_routing.uri_filter_regexp%</argument>
             <argument type="service" id="event_dispatcher" on-invalid="ignore"/>
             <argument type="service" id="cmf_routing.route_provider"/>
-            <call method="setRequest"><argument type="service" id="request" on-invalid="null" strict="false"/></call>
+            <call method="setRequestStack"><argument type="service" id="request_stack"/></call>
         </service>
 
         <service id="cmf_routing.nested_matcher" class="Symfony\Cmf\Component\Routing\NestedMatcher\NestedMatcher">

src/Routing/DynamicRouter.php

@@ -14,6 +14,7 @@
 use Symfony\Cmf\Component\Routing\DynamicRouter as BaseDynamicRouter;
 use Symfony\Cmf\Component\Routing\RouteObjectInterface;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\Routing\Exception\ResourceNotFoundException;
 
 /**
@@ -44,9 +45,9 @@ class DynamicRouter extends BaseDynamicRouter
     const CONTENT_TEMPLATE = 'template';
 
     /**
-     * @var Request
+     * @var RequestStack
      */
-    protected $request;
+    private $requestStack;
 
     /**
      * Put content and template name into the request attributes instead of the
@@ -110,24 +111,29 @@ protected function cleanDefaults($defaults, Request $request = null)
     }
 
     /**
-     * @param Request $request
+     * Set the request stack so that we can find the current request.
+     *
+     * @param RequestStack $requestStack
      */
-    public function setRequest(Request $request = null)
+    public function setRequestStack(RequestStack $requestStack)
     {
-        $this->request = $request;
+        $this->requestStack = $requestStack;
     }
 
     /**
+     * Get the current request from the request stack.
+     *
      * @return Request
      *
      * @throws \Symfony\Component\Routing\Exception\ResourceNotFoundException
      */
     public function getRequest()
     {
-        if (null === $this->request) {
-            throw new ResourceNotFoundException('Request object not available from container');
+        $currentRequest = $this->requestStack->getCurrentRequest();
+        if (!$currentRequest) {
+            throw new ResourceNotFoundException('There is no request in the request stack');
         }
 
-        return $this->request;
+        return $currentRequest;
     }
 }

tests/Unit/Routing/DynamicRouterTest.php

@@ -18,6 +18,8 @@
 use Symfony\Cmf\Component\Routing\Test\CmfUnitTestCase;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\Routing\Exception\ResourceNotFoundException;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\Component\Routing\Matcher\UrlMatcherInterface;
 use Symfony\Component\Routing\RequestContext;
@@ -31,6 +33,10 @@ class DynamicRouterTest extends CmfUnitTestCase
     protected $context;
     /** @var Request */
     protected $request;
+    /**
+     * @var RequestStack
+     */
+    private $requestStack;
     /** @var EventDispatcherInterface */
     protected $eventDispatcher;
     protected $container;
@@ -47,10 +53,12 @@ public function setUp()
         $this->generator = $this->createMock(UrlGeneratorInterface::class);
 
         $this->request = Request::create('/foo');
+        $this->requestStack = new RequestStack();
+        $this->requestStack->push($this->request);
         $this->context = $this->createMock(RequestContext::class);
         $this->eventDispatcher = $this->createMock(EventDispatcherInterface::class);
         $this->router = new DynamicRouter($this->context, $this->matcher, $this->generator, '', $this->eventDispatcher);
-        $this->router->setRequest($this->request);
+        $this->router->setRequestStack($this->requestStack);
     }
 
     private function assertRequestAttributes($request)
@@ -91,19 +99,19 @@ public function testMatchRequest()
     }
 
     /**
-     * @expectedException \Symfony\Component\Routing\Exception\ResourceNotFoundException
-     *
      * @group legacy
      */
     public function testMatchNoRequest()
     {
-        $this->router->setRequest(null);
+        $this->router->setRequestStack(new RequestStack());
 
         $this->eventDispatcher->expects($this->once())
             ->method('dispatch')
             ->with(Events::PRE_DYNAMIC_MATCH, $this->equalTo(new RouterMatchEvent()))
         ;
 
+        $this->expectException(ResourceNotFoundException::class);
+
         $this->router->match('/foo');
     }