Implement fromRoute() and getMatchedRoute()

src/RouteResult.php

@@ -51,14 +51,39 @@ class RouteResult
      */
     private $matchedMiddleware;
 
+    /**
+     * Route matched during routing
+     *
+     * @since 1.3.0
+     * @var Route $route
+     */
+    private $route;
+
     /**
      * @var bool Success state of routing.
      */
     private $success;
 
+    /**
+     * Create an instance representing a route succes from the matching route.
+     *
+     * @param Route $route
+     * @param array $params Parameters associated with the matched route, if any.
+     * @return static
+     */
+    public static function fromRoute(Route $route, array $params = [])
+    {
+        $result                = new self();
+        $result->success       = true;
+        $result->route         = $route;
+        $result->matchedParams = $params;
+        return $result;
+    }
+
     /**
      * Create an instance repesenting a route success.
      *
+     * @deprecated since 1.3.0; will be removed in 2.0.0.
      * @param string $name Name of matched route.
      * @param callable|string $middleware Middleware associated with the
      *     matched route.
@@ -107,6 +132,17 @@ public function isSuccess()
         return $this->success;
     }
 
+    /**
+     * Retrieve the route that resulted in the route match.
+     *
+     * @return false|null|Route false if representing a routing failure;
+     *     null if not created via fromRoute(); Route instance otherwise.
+     */
+    public function getMatchedRoute()
+    {
+        return $this->isFailure() ? false : $this->route;
+    }
+
     /**
      * Retrieve the matched route name, if possible.
      *
@@ -121,6 +157,10 @@ public function getMatchedRouteName()
             return false;
         }
 
+        if (! $this->matchedRouteName && $this->route) {
+            $this->matchedRouteName = $this->route->getName();
+        }
+
         return $this->matchedRouteName;
     }
 
@@ -136,6 +176,10 @@ public function getMatchedMiddleware()
             return false;
         }
 
+        if (! $this->matchedMiddleware && $this->route) {
+            $this->matchedMiddleware = $this->route->getMiddleware();
+        }
+
         return $this->matchedMiddleware;
     }
 
@@ -183,7 +227,9 @@ public function isMethodFailure()
     public function getAllowedMethods()
     {
         if ($this->isSuccess()) {
-            return [];
+            return $this->route
+                ? $this->route->getAllowedMethods()
+                : [];
         }
 
         if (null === $this->allowedMethods) {

test/RouteResultTest.php

@@ -107,4 +107,33 @@ public function testRouteSuccessMethodFailure()
         );
         $this->assertFalse($result->isMethodFailure());
     }
+
+    public function testFromRouteShouldComposeRouteInResult()
+    {
+        $route = $this->prophesize(Route::class);
+
+        $result = RouteResult::fromRoute($route->reveal(), ['foo' => 'bar']);
+        $this->assertInstanceOf(RouteResult::class, $result);
+        $this->assertTrue($result->isSuccess());
+        $this->assertSame($route->reveal(), $result->getMatchedRoute());
+
+        return ['route' => $route, 'result' => $result];
+    }
+
+    /**
+     * @depends testFromRouteShouldComposeRouteInResult
+     */
+    public function testAllAccessorsShouldReturnExpectedDataWhenResultCreatedViaFromRoute(array $data)
+    {
+        $result = $data['result'];
+        $route = $data['route'];
+
+        $route->getName()->willReturn('route');
+        $route->getMiddleware()->willReturn(__METHOD__);
+        $route->getAllowedMethods()->willReturn(['HEAD', 'OPTIONS', 'GET']);
+
+        $this->assertEquals('route', $result->getMatchedRouteName());
+        $this->assertEquals(__METHOD__, $result->getMatchedMiddleware());
+        $this->assertEquals(['HEAD', 'OPTIONS', 'GET'], $result->getAllowedMethods());
+    }
 }