Add support for not encoding slashes in wildcard last parameter (#500)

* Add failing test * Add/update failing tests * Add support for not URI-encoding last route parameter when it has a wildcard regex * Wip
tighten · Jan 28, 2022 · ed5c2e9 · ed5c2e9
1 parent cbd1843
commit ed5c2e9
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 node_modules/
 vendor/
+*.cache
 *.log
 composer.lock
 phpunit.xml
diff --git a/src/Ziggy.php b/src/Ziggy.php
@@ -109,7 +109,7 @@ private function nameKeyedRoutes()
 
         return $routes->merge($fallbacks)
             ->map(function ($route) use ($bindings) {
-                return collect($route)->only(['uri', 'methods'])
+                return collect($route)->only(['uri', 'methods', 'wheres'])
                     ->put('domain', $route->domain())
                     ->put('bindings', $bindings[$route->getName()] ?? [])
                     ->when($middleware = config('ziggy.middleware'), function ($collection) use ($middleware, $route) {

diff --git a/src/js/Route.js b/src/js/Route.js
@@ -11,6 +11,7 @@ export default class Route {
         this.name = name;
         this.definition = definition;
         this.bindings = definition.bindings ?? {};
+        this.wheres = definition.wheres ?? {};
         this.config = config;
     }
 
@@ -85,6 +86,10 @@ export default class Route {
                 throw new Error(`Ziggy error: '${segment}' parameter is required for route '${this.name}'.`)
             }
 
+            if (this.parameterSegments[this.parameterSegments.length - 1].name === segment && this.wheres[segment] === '.*') {
+                return params[segment] ?? '';
+            }
+
             return encodeURIComponent(params[segment] ?? '');
         }).replace(/\/+$/, '');
     }

diff --git a/tests/Unit/CommandRouteGeneratorTest.php b/tests/Unit/CommandRouteGeneratorTest.php
@@ -4,7 +4,6 @@
 
 use Illuminate\Support\Facades\Artisan;
 use Illuminate\Support\Facades\URL;
-use Illuminate\Support\Str;
 use Tests\TestCase;
 
 class CommandRouteGeneratorTest extends TestCase
@@ -44,6 +43,7 @@ public function can_generate_file_with_named_routes()
     {
         $router = app('router');
         $router->get('posts/{post}/comments', $this->noop())->name('postComments.index');
+        $router->get('slashes/{slug}', $this->noop())->where('slug', '.*')->name('slashes');
         $router->getRoutes()->refreshNameLookups();
 
         Artisan::call('ziggy:generate');
@@ -83,6 +83,7 @@ public function can_generate_file_with_config_applied()
         config(['ziggy.except' => ['admin.*']]);
         $router = app('router');
         $router->get('posts/{post}/comments', $this->noop())->name('postComments.index');
+        $router->get('slashes/{slug}', $this->noop())->where('slug', '.*')->name('slashes');
         $router->get('admin', $this->noop())->name('admin.dashboard'); // Excluded, should NOT be present in file
         $router->getRoutes()->refreshNameLookups();
 

diff --git a/tests/Unit/ZiggyTest.php b/tests/Unit/ZiggyTest.php
@@ -311,6 +311,27 @@ public function can_include_port()
             ]);
     }
 
+    /** @test */
+    public function can_include_wheres()
+    {
+        app('router')->post('slashes/{slug}', function () {
+            return response()->json(new Ziggy);
+        })->where('slug', '.*')->name('slashes');
+        app('router')->getRoutes()->refreshNameLookups();
+
+        $this->post('http://ziggy.dev/slashes/foo/bar')
+            ->assertJson([
+                'routes' => [
+                    'slashes' => [
+                        'uri' => 'slashes/{slug}',
+                        'wheres' => [
+                            'slug' => '.*',
+                        ],
+                    ],
+                ],
+            ]);
+    }
+
     /** @test */
     public function can_include_only_middleware_set_in_config()
     {
@@ -396,6 +417,9 @@ public function can_order_fallback_routes_last()
         $expected['fallback'] = [
             'uri' => '{fallbackPlaceholder}',
             'methods' => ['GET', 'HEAD'],
+            'wheres' => [
+                'fallbackPlaceholder' => '.*',
+            ],
         ];
 
         $this->assertSame($expected, $routes);

diff --git a/tests/fixtures/ziggy.js b/tests/fixtures/ziggy.js
@@ -1,4 +1,4 @@
-const Ziggy = {"url":"http:\/\/ziggy.dev","port":null,"defaults":{},"routes":{"postComments.index":{"uri":"posts\/{post}\/comments","methods":["GET","HEAD"]}}};
+const Ziggy = {"url":"http:\/\/ziggy.dev","port":null,"defaults":{},"routes":{"postComments.index":{"uri":"posts\/{post}\/comments","methods":["GET","HEAD"]},"slashes":{"uri":"slashes\/{slug}","methods":["GET","HEAD"],"wheres":{"slug":".*"}}}};
 
 if (typeof window !== 'undefined' && typeof window.Ziggy !== 'undefined') {
     Object.assign(Ziggy.routes, window.Ziggy.routes);

diff --git a/tests/js/route.test.js b/tests/js/route.test.js
@@ -16,7 +16,7 @@ const defaultZiggy = {
     port: null,
     defaults: { locale: 'en' },
     routes: {
-        'home': {
+        home: {
             uri: '/',
             methods: ['GET', 'HEAD'],
         },
@@ -96,11 +96,11 @@ const defaultZiggy = {
             uri: 'subscribers/{subscriber}/conversations/{type}/{conversation_id?}',
             methods: ['GET', 'HEAD'],
         },
-        'optional': {
+        optional: {
             uri: 'optional/{id}/{slug?}',
             methods: ['GET', 'HEAD'],
         },
-        'optionalId': {
+        optionalId: {
             uri: 'optionalId/{type}/{id?}',
             methods: ['GET', 'HEAD'],
         },
@@ -134,10 +134,17 @@ const defaultZiggy = {
             uri: 'strict-download/file{extension}',
             methods: ['GET', 'HEAD'],
         },
-        'pages': {
+        pages: {
             uri: '{page}',
             methods: ['GET', 'HEAD'],
         },
+        slashes: {
+            uri: 'slashes/{encoded}/{slug}',
+            methods: ['GET', 'HEAD'],
+            wheres: {
+                slug: '.*',
+            },
+        },
     },
 };
 
@@ -525,6 +532,10 @@ describe('route()', () => {
         same(route('pages.optionalExtension', '.html'), 'https://ziggy.dev/download/file.html');
         same(route('pages.optionalExtension', { extension: '.pdf' }), 'https://ziggy.dev/download/file.pdf');
     });
+
+    test('can skip encoding slashes inside last parameter when explicitly allowed', () => {
+        same(route('slashes', ['one/two', 'three/four']), 'https://ziggy.dev/slashes/one%2Ftwo/three/four')
+    });
 });
 
 describe('has()', () => {