Support script_name option

Author: bogdan

CHANGELOG.md

@@ -3,6 +3,18 @@
 ## [2.3.4]
 
 * Migrate to yarn 4
+* Add support for `script_name` [Rails helper option](https://api.rubyonrails.org/classes/ActionDispatch/Routing/UrlFor.html#method-i-url_for).
+
+``` javascript
+Routes.post_path(1, { script_name: "/myapp" })
+  // => /myapp/post/1
+
+Routes.configure({
+  default_url_options: { script_name: "/myapp" }
+})
+
+Routes.post_path(1) // => /myapp/post/1
+```
 
 ## [2.3.3]
 

lib/routes.d.ts

@@ -50,6 +50,7 @@ declare type KeywordUrlOptions = Optional<{
     port: string | number;
     anchor: string;
     trailing_slash: boolean;
+    script_name: string;
     params: RouteParameters;
 }>;
 declare type RouteOptions = KeywordUrlOptions & RouteParameters;

lib/routes.js

@@ -110,6 +110,7 @@ RubyVariables.WRAPPER(
         "host",
         "port",
         "protocol",
+        "script_name",
     ];
     class UtilsClass {
         constructor() {
@@ -275,21 +276,29 @@ RubyVariables.WRAPPER(
         }
         build_route(parts, required_params, default_options, route, absolute, args) {
             const { keyword_parameters, query_parameters } = this.partition_parameters(parts, required_params, default_options, args);
+            let { trailing_slash, anchor, script_name } = keyword_parameters;
             const missing_params = required_params.filter((param) => !hasProp(query_parameters, param) ||
                 this.is_nullable(query_parameters[param]));
             if (missing_params.length) {
                 throw new ParametersMissing(...missing_params);
             }
             let result = this.get_prefix() + this.visit(route, query_parameters);
-            if (keyword_parameters.trailing_slash) {
+            if (trailing_slash) {
                 result = result.replace(/(.*?)[/]?$/, "$1/");
             }
             const url_params = this.serialize(query_parameters);
             if (url_params.length) {
                 result += "?" + url_params;
             }
-            if (keyword_parameters.anchor) {
-                result += "#" + keyword_parameters.anchor;
+            if (anchor) {
+                result += "#" + anchor;
+            }
+            if (script_name) {
+                const last_index = script_name.length - 1;
+                if (script_name[last_index] == "/" && result[0] == "/") {
+                    script_name = script_name.slice(0, last_index);
+                }
+                result = script_name + result;
             }
             if (absolute) {
                 result = this.route_url(keyword_parameters) + result;

lib/routes.ts

@@ -66,6 +66,7 @@ type KeywordUrlOptions = Optional<{
   port: string | number;
   anchor: string;
   trailing_slash: boolean;
+  script_name: string;
   params: RouteParameters;
 }>;
 
@@ -230,7 +231,9 @@ RubyVariables.WRAPPER(
       "host",
       "port",
       "protocol",
+      "script_name",
     ] as const;
+
     type ReservedOption = (typeof ReservedOptions)[any];
 
     class UtilsClass {
@@ -433,6 +436,8 @@ RubyVariables.WRAPPER(
             default_options,
             args
           );
+
+        let { trailing_slash, anchor, script_name } = keyword_parameters;
         const missing_params = required_params.filter(
           (param) =>
             !hasProp(query_parameters, param) ||
@@ -442,15 +447,22 @@ RubyVariables.WRAPPER(
           throw new ParametersMissing(...missing_params);
         }
         let result = this.get_prefix() + this.visit(route, query_parameters);
-        if (keyword_parameters.trailing_slash) {
+        if (trailing_slash) {
           result = result.replace(/(.*?)[/]?$/, "$1/");
         }
         const url_params = this.serialize(query_parameters);
         if (url_params.length) {
           result += "?" + url_params;
         }
-        if (keyword_parameters.anchor) {
-          result += "#" + keyword_parameters.anchor;
+        if (anchor) {
+          result += "#" + anchor;
+        }
+        if (script_name) {
+          const last_index = script_name.length - 1;
+          if (script_name[last_index] == "/" && result[0] == "/") {
+            script_name = script_name.slice(0, last_index);
+          }
+          result = script_name + result;
         }
         if (absolute) {
           result = this.route_url(keyword_parameters) + result;

spec/js_routes/options_spec.rb

@@ -225,11 +225,21 @@
 
       context "when passing options that do not have defaults" do
         it "should use this options to fill the optional parameters" do
-          expectjs("Routes.thing_path(1, { format: 'json' })").to eq test_routes.thing_path(1, { optional_id: "12", format: "json" } ) # test_routes.thing_path needs optional_id here to generate the correct route. Not sure why.
+          # test_routes.thing_path needs optional_id here to generate the correct route. Not sure why.
+          expectjs("Routes.thing_path(1, { format: 'json' })").to eq test_routes.thing_path(1, { optional_id: "12", format: "json" } )
         end
       end
     end
 
+    describe "script_name option" do
+      let(:_options) { { default_url_options: { script_name: "/myapp" } }}
+      it "is supported" do
+        expectjs("Routes.inboxes_path()").to eq(
+          test_routes.inboxes_path(script_name: '/myapp')
+        )
+      end
+    end
+
     context "when overwritten on JS level" do
         let(:_options) { { :default_url_options => { :format => "json" } } }
       it "uses JS defined value" do

spec/js_routes/rails_routes_compatibility_spec.rb

@@ -514,4 +514,30 @@
       end
     end
   end
+
+  describe "script_name option" do
+    it "preceeds the path" do
+      expectjs(
+        "Routes.inboxes_path({ script_name: '/myapp' })"
+      ).to eq(
+        test_routes.inboxes_path(script_name: '/myapp')
+      )
+    end
+
+    it "strips double slash" do
+      expectjs(
+        "Routes.inboxes_path({ script_name: '/myapp/' })"
+      ).to eq(
+        test_routes.inboxes_path(script_name: '/myapp/')
+      )
+    end
+
+    it "preserves no preceding slash" do
+      expectjs(
+        "Routes.inboxes_path({ script_name: 'myapp' })"
+      ).to eq(
+        test_routes.inboxes_path(script_name: 'myapp')
+      )
+    end
+  end
 end