Add BackedEnum for route names (#183)

parijke · taylorotwell · web-flow · commit 940acf1f39b1 · 2024-10-29T09:36:22.000-05:00
* Add BackedEnum for route names

* formatting

---------

Co-authored-by: Taylor Otwell &lt;taylor@laravel.com&gt;
diff --git a/src/Concerns/InteractsWithPages.php b/src/Concerns/InteractsWithPages.php
@@ -2,6 +2,7 @@
 
 namespace Laravel\BrowserKitTesting\Concerns;
 
+use BackedEnum;
 use Closure;
 use Illuminate\Http\UploadedFile;
 use InvalidArgumentException;
@@ -65,7 +66,7 @@ public function visit($uri)
     /**
      * Visit the given named route with a GET request.
      *
-     * @param  string  $route
+     * @param  BackedEnum|string  $route
      * @param  array  $parameters
      * @return $this
      */
@@ -195,7 +196,7 @@ protected function seePageIs($uri)
     /**
      * Assert that the current page matches a given named route.
      *
-     * @param  string  $route
+     * @param  BackedEnum|string  $route
      * @param  array  $parameters
      * @return $this
      */
diff --git a/src/Concerns/MakesHttpRequests.php b/src/Concerns/MakesHttpRequests.php
@@ -2,10 +2,12 @@
 
 namespace Laravel\BrowserKitTesting\Concerns;
 
+use BackedEnum;
 use Illuminate\Cookie\CookieValuePrefix;
 use Illuminate\Http\Request;
 use Illuminate\Http\UploadedFile;
 use Illuminate\Support\Str;
+use InvalidArgumentException;
 use Laravel\BrowserKitTesting\TestResponse;
 use PHPUnit\Framework\ExpectationFailedException;
 use Symfony\Component\HttpFoundation\File\UploadedFile as SymfonyUploadedFile;
@@ -622,7 +624,7 @@ public function action($method, $action, $wildcards = [], $parameters = [], $coo
      * Call a named route and return the Response.
      *
      * @param  string  $method
-     * @param  string  $name
+     * @param  BackedEnum|string  $name
      * @param  array  $routeParameters
      * @param  array  $parameters
      * @param  array  $cookies
@@ -633,6 +635,10 @@ public function action($method, $action, $wildcards = [], $parameters = [], $coo
      */
     public function route($method, $name, $routeParameters = [], $parameters = [], $cookies = [], $files = [], $server = [], $content = null)
     {
+        if ($name instanceof BackedEnum && ! is_string($name = $name->value)) {
+            throw new InvalidArgumentException('Route name must be a string or a BackedEnum.');
+        }
+
         $uri = $this->app['url']->route($name, $routeParameters);
 
         return $this->call($method, $uri, $parameters, $cookies, $files, $server, $content);
@@ -808,7 +814,7 @@ public function assertRedirectedTo($uri, $with = [])
     /**
      * Assert whether the client was redirected to a given route.
      *
-     * @param  string  $name
+     * @param  BackedEnum|string  $name
      * @param  array  $parameters
      * @param  array  $with
      * @return $this
diff --git a/src/TestResponse.php b/src/TestResponse.php
@@ -2,6 +2,7 @@
 
 namespace Laravel\BrowserKitTesting;
 
+use BackedEnum;
 use Illuminate\Testing\Assert as PHPUnit;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 
@@ -49,7 +50,7 @@ public function assertRedirectedTo($uri, $with = [])
     /**
      * Assert whether the client was redirected to a given route.
      *
-     * @param  string  $name
+     * @param  BackedEnum|string  $name
      * @param  array  $parameters
      * @param  array  $with
      * @return $this
