js-routes 2.1.1 → 2.2.2

data/lib/routes.ts

@@ -129,6 +129,7 @@ RubyVariables.WRAPPER(
     }[keyof RouteNodes];
 
     const Root = that;
+    const isBroswer = typeof window !== "undefined";
     type ModuleDefinition = {
       define: (routes: RouterExposedMethods) => void;
       isSupported: () => boolean;
@@ -189,7 +190,7 @@ RubyVariables.WRAPPER(
           Utils.namespace(Root, RubyVariables.NAMESPACE, routes);
         },
         isSupported() {
-          return !!Root;
+          return !RubyVariables.NAMESPACE || !!Root;
         },
       },
       DTS: {
@@ -348,7 +349,9 @@ RubyVariables.WRAPPER(
           throw new Error("Too many parameters provided for path");
         }
         let use_all_parts = args.length > required_params.length;
-        const parts_options: RouteParameters = {};
+        const parts_options: RouteParameters = {
+          ...this.configuration.default_url_options,
+        };
         for (const key in options) {
           const value = options[key];
           if (!hasProp(options, key)) continue;
@@ -625,15 +628,17 @@ RubyVariables.WRAPPER(
       }
 
       current_host(): string {
-        return window?.location?.hostname || "";
+        return (isBroswer && window?.location?.hostname) || "";
       }
 
       current_protocol(): string {
-        return window?.location?.protocol?.replace(/:$/, "") || "http";
+        return (
+          (isBroswer && window?.location?.protocol?.replace(/:$/, "")) || "http"
+        );
       }
 
       current_port(): string {
-        return window?.location?.port || "";
+        return (isBroswer && window?.location?.port) || "";
       }
 
       is_object(value: unknown): value is Record<string, unknown> {
@@ -659,17 +664,17 @@ RubyVariables.WRAPPER(
         object: any,
         namespace: string | null | undefined,
         routes: unknown
-      ): unknown {
+      ): void {
         const parts = namespace?.split(".") || [];
         if (parts.length === 0) {
-          return routes;
+          return;
         }
         for (let index = 0; index < parts.length; index++) {
           const part = parts[index];
           if (index < parts.length - 1) {
             object = object[part] || (object[part] = {});
           } else {
-            return (object[part] = routes);
+            object[part] = routes;
           }
         }
       }

data/spec/js_routes/module_types/amd_spec.rb

@@ -3,11 +3,12 @@ require "spec_helper"
 describe JsRoutes, "compatibility with AMD/require.js"  do
 
   before(:each) do
-    evaljs("window.GlobalCheck = {};")
-    evaljs("window.define = function (requirs, callback) { window.GlobalCheck['js-routes'] = callback.call(this); return window.GlobalCheck['js-routes']; };")
-    evaljs("window.define.amd = { jQuery: true };")
+    evaljs("var global = this;", {force: true})
+    evaljs("global.GlobalCheck = {};")
+    evaljs("global.define = function (requirs, callback) { global.GlobalCheck['js-routes'] = callback.call(this); return global.GlobalCheck['js-routes']; };")
+    evaljs("global.define.amd = { jQuery: true };")
     strRequire =<<EOF
-    window.require = function (r, callback) {
+    global.require = function (r, callback) {
       var allArgs, i;
 
       allArgs = (function() {
@@ -15,7 +16,7 @@ describe JsRoutes, "compatibility with AMD/require.js"  do
         _results = [];
         for (_i = 0, _len = r.length; _i < _len; _i++) {
           i = r[_i];
-          _results.push(window.GlobalCheck[i]);
+          _results.push(global.GlobalCheck[i]);
         }
         return _results;
       })();

data/spec/js_routes/module_types/nil_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe JsRoutes, "compatibility with NIL (legacy browser)" do
+  let(:generated_js) do
+    JsRoutes.generate(
+      module_type: nil,
+      include: /book|inboxes|inbox_message/,
+      **_options
+    )
+  end
+
+  let(:_options) { {} }
+  describe "generated js" do
+    subject do
+      generated_js
+    end
+
+    it "should call route function for each route" do
+      is_expected.to include("inboxes_path: __jsr.r(")
+    end
+    it "should have correct function without arguments signature" do
+      is_expected.to include('inboxes_path: __jsr.r({"format":{}}')
+    end
+    it "should have correct function with arguments signature" do
+      is_expected.to include('inbox_message_path: __jsr.r({"inbox_id":{"r":true},"id":{"r":true},"format":{}}')
+    end
+    it "should have correct function signature with unordered hash" do
+      is_expected.to include('inbox_message_attachment_path: __jsr.r({"inbox_id":{"r":true},"message_id":{"r":true},"id":{"r":true},"format":{}}')
+    end
+  end
+
+  describe "inline generation" do
+    let(:_options) { {namespace: nil} }
+    before do
+      evaljs("const r = #{generated_js}")
+    end
+
+    it "should be possible" do
+      expect(evaljs("r.inboxes_path()")).to eq(test_routes.inboxes_path())
+    end
+  end
+
+  describe "namespace option" do
+    let(:_options) { {namespace: "PHM"} }
+    let(:_presetup) { "" }
+    before do
+      evaljs("var window = this;")
+      evaljs(_presetup)
+      evaljs(generated_js)
+    end
+    it "should use this namespace for routing" do
+      expect(evaljs("window.Routes")).to be_nil
+      expect(evaljs("window.PHM.inboxes_path")).not_to be_nil
+    end
+
+    describe "is nested" do
+      context "and defined on client" do
+        let(:_presetup) { "window.PHM = {}" }
+        let(:_options) { {namespace: "PHM.Routes"} }
+
+        it "should use this namespace for routing" do
+          expect(evaljs("PHM.Routes.inboxes_path")).not_to be_nil
+        end
+      end
+
+      context "but undefined on client" do
+        let(:_options) { {namespace: "PHM.Routes"} }
+
+        it "should initialize namespace" do
+          expect(evaljs("window.PHM.Routes.inboxes_path")).not_to be_nil
+        end
+      end
+
+      context "and some parts are defined" do
+        let(:_presetup) { "window.PHM = { Utils: {} };" }
+        let(:_options) { {namespace: "PHM.Routes"} }
+
+        it "should not overwrite existing parts" do
+          expect(evaljs("window.PHM.Utils")).not_to be_nil
+          expect(evaljs("window.PHM.Routes.inboxes_path")).not_to be_nil
+        end
+      end
+    end
+  end
+end
+

data/spec/js_routes/module_types/umd_spec.rb

@@ -2,7 +2,7 @@ require "active_support/core_ext/string/strip"
 require "fileutils"
 require 'spec_helper'
 
-describe JsRoutes do
+describe JsRoutes, "compatibility with UMD" do
   describe "generated js" do
     subject do
       JsRoutes.generate(

data/spec/js_routes/options_spec.rb

@@ -188,55 +188,19 @@ describe JsRoutes, "options" do
     expect(evaljs("Routes.no_format_path({format: 'json'})")).to eq(test_routes.no_format_path(format: 'json'))
   end
 
-  describe "namespace option" do
-    let(:_options) { {:namespace => "PHM"} }
-    it "should use this namespace for routing" do
-      expect(evaljs("window.Routes")).to be_nil
-      expect(evaljs("PHM.inbox_path")).not_to be_nil
-    end
-
-    context "is nil" do
-      let(:_options) { {:namespace => nil, include: /^inbox$/} }
-      it "should use this namespace for routing" do
-        evaljs("window.zz = #{generated_js}")
-        expect(evaljs("window.zz.inbox_path")).not_to be_nil
-      end
-
-    end
-
-    describe "is nested" do
-      context "and defined on client" do
-        let(:_presetup) { "window.PHM = {}" }
-        let(:_options) { {:namespace => "PHM.Routes"} }
-        it "should use this namespace for routing" do
-          expect(evaljs("PHM.Routes.inbox_path")).not_to be_nil
-        end
-      end
-
-      context "but undefined on client" do
-        let(:_options) { {:namespace => "PHM.Routes"} }
-        it "should initialize namespace" do
-          expect(evaljs("window.PHM.Routes.inbox_path")).not_to be_nil
-        end
-      end
-
-      context "and some parts are defined" do
-        let(:_presetup) { "window.PHM = { Utils: {} };" }
-        let(:_options) { {:namespace => "PHM.Routes"} }
-        it "should not overwrite existing parts" do
-          expect(evaljs("window.PHM.Utils")).not_to be_nil
-          expect(evaljs("window.PHM.Routes.inbox_path")).not_to be_nil
-        end
-      end
-    end
-  end
-
   describe "default_url_options" do
     context "with optional route parts" do
-      context "provided" do
+      context "provided by the default_url_options" do
         let(:_options) { { :default_url_options => { :optional_id => "12", :format => "json" } } }
-        it "should use this opions to fill optional parameters" do
-          expect(evaljs("Routes.things_path()")).to eq(test_routes.things_path)
+        it "should use this options to fill optional parameters" do
+          expect(evaljs("Routes.things_path()")).to eq(test_routes.things_path(12))
+        end
+      end
+
+      context "provided inline by the method parameters" do
+        let(:options) { { :default_url_options => { :optional_id => "12" } } }
+        it "should overwrite the default_url_options" do
+          expect(evaljs("Routes.things_path({ optional_id: 34 })")).to eq(test_routes.things_path(optional_id: 34))
         end
       end
 
@@ -249,12 +213,25 @@ describe JsRoutes, "options" do
     end
 
     context "with required route parts" do
-      let(:_options) { {:default_url_options => {:inbox_id => "12"}} }
-      it "should use this opions to fill optional parameters" do
+      let(:_options) { { :default_url_options => { :inbox_id => "12" } } }
+      it "should use this options to fill optional parameters" do
         expect(evaljs("Routes.inbox_messages_path()")).to eq(test_routes.inbox_messages_path)
       end
     end
 
+    context "with optional and required route parts" do
+      let(:_options) { {:default_url_options => { :optional_id => "12" } } }
+      it "should use this options to fill the optional parameters" do
+        expect(evaljs("Routes.thing_path(1)")).to eq test_routes.thing_path(1, { optional_id: "12" })
+      end
+
+      context "when passing options that do not have defaults" do
+        it "should use this options to fill the optional parameters" do
+          expect(evaljs("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.
+        end
+      end
+    end
+
     context "when overwritten on JS level" do
         let(:_options) { { :default_url_options => { :format => "json" } } }
       it "uses JS defined value" do
@@ -421,8 +398,14 @@ describe JsRoutes, "options" do
         host
       end
 
-      before do
-        jscontext.eval("window = {'location': {'protocol': '#{current_protocol}', 'hostname': '#{current_hostname}', 'port': '#{current_port}', 'host': '#{current_host}'}}")
+      let(:_presetup) do
+        window = {location: {
+          protocol: current_protocol,
+          hostname: current_hostname,
+          port: current_port,
+          host: current_host,
+        }}
+        "const window = #{ActiveSupport::JSON.encode(window)}"
       end
 
       context "without specifying a default host" do
@@ -434,7 +417,6 @@ describe JsRoutes, "options" do
           expect(evaljs("Routes.inbox_url(1)")).to eq("http://current.example.com#{test_routes.inbox_path(1)}")
           expect(evaljs("Routes.inbox_url(1, { test_key: \"test_val\" })")).to eq("http://current.example.com#{test_routes.inbox_path(1, :test_key => "test_val")}")
           expect(evaljs("Routes.new_session_url()")).to eq("https://current.example.com#{test_routes.new_session_path}")
-
         end
 
         it "doesn't use current when specified in the route" do

data/spec/spec_helper.rb

@@ -108,11 +108,10 @@ RSpec.configure do |config|
   end
 
   config.before :each do
-    evaljs("var window = this;", {force: true})
-
     log = proc do |*values|
       puts values.map(&:inspect).join(", ")
     end
+
     if defined?(JRUBY_VERSION)
       jscontext[:"console.log"] = lambda do |context, *values|
         log(*values)

data/spec/support/routes.rb

@@ -62,7 +62,7 @@ def draw_routes
 
     resources :portals, :port => 8080, only: [:index]
 
-    get '/with_defaults' => 'foo#foo', defaults: { bar: 'tested', format: :json }, format: :true
+    get '/with_defaults' => 'foo#foo', defaults: { bar: 'tested', format: :json }, format: true
 
     namespace :api, format: true, defaults: {format: 'json'} do
       get "/purchases" => "purchases#index"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-06 00:00:00.000000000 Z
+date: 2022-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -170,8 +170,13 @@ files:
 - js-routes.gemspec
 - lib/js-routes.rb
 - lib/js_routes.rb
+- lib/js_routes/configuration.rb
 - lib/js_routes/engine.rb
+- lib/js_routes/generators/middleware.rb
 - lib/js_routes/generators/webpacker.rb
+- lib/js_routes/instance.rb
+- lib/js_routes/middleware.rb
+- lib/js_routes/route.rb
 - lib/js_routes/version.rb
 - lib/routes.d.ts
 - lib/routes.js
@@ -191,6 +196,7 @@ files:
 - spec/js_routes/module_types/dts/test.spec.ts
 - spec/js_routes/module_types/dts_spec.rb
 - spec/js_routes/module_types/esm_spec.rb
+- spec/js_routes/module_types/nil_spec.rb
 - spec/js_routes/module_types/umd_spec.rb
 - spec/js_routes/options_spec.rb
 - spec/js_routes/rails_routes_compatibility_spec.rb