js-routes 2.0.8 → 2.2.0

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/js_routes/zzz_last_post_rails_init_spec.rb

@@ -5,7 +5,7 @@
 require 'spec_helper'
 require "fileutils"
 
-describe "after Rails initialization" do
+describe "after Rails initialization", :slow do
   NAME = Rails.root.join('app', 'assets', 'javascripts', 'routes.js').to_s
 
   def sprockets_v3?
@@ -122,7 +122,7 @@ describe "after Rails initialization" do
   end
 end
 
-describe "JSRoutes thread safety" do
+describe "JSRoutes thread safety", :slow do
   before do
     begin
       Rails.application.initialize!

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"

data/spec/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../tsconfig.json",
+  "include": ["./**/*.spec.ts"]
+}

data/tsconfig.json

@@ -3,14 +3,10 @@
     "target": "es2019",
     "lib": ["es2020", "dom"],
     "module": "commonjs",
-    "outDir": "lib",
     "sourceMap": false,
     "declaration": true,
     "allowSyntheticDefaultImports": true,
-    "resolveJsonModule": true,
-    "typeRoots": ["node_modules/@types", "./@types"],
-
-    "strict": true,
+    "resolveJsonModule": false,
     "strictNullChecks": true,
     "noImplicitAny": true,
     "noImplicitThis": true,
@@ -22,11 +18,11 @@
     "forceConsistentCasingInFileNames": true,
     "emitDecoratorMetadata": true,
     "experimentalDecorators": true
+
   },
   "ts-node": {
     "files": true,
     "transpileOnly": false
   },
-  "include": ["./**/*.ts", "lib/**/*.json", "./**/*.tsx"],
-  "exclude": ["node_modules", "**/thorn", "**/support", "**/tmp"]
+  "include": ["lib/*.ts"]
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 2.0.8
+  version: 2.2.0
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-21 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -171,11 +171,17 @@ files:
 - lib/js-routes.rb
 - lib/js_routes.rb
 - lib/js_routes/engine.rb
+- lib/js_routes/generators/middleware.rb
+- lib/js_routes/generators/webpacker.rb
+- lib/js_routes/middleware.rb
 - lib/js_routes/version.rb
 - lib/routes.d.ts
 - lib/routes.js
 - lib/routes.ts
 - lib/tasks/js_routes.rake
+- lib/templates/erb.js
+- lib/templates/initializer.rb
+- lib/templates/routes.js.erb
 - package.json
 - spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/assets/javascripts/.gitkeep
@@ -183,13 +189,18 @@ files:
 - spec/js_routes/default_serializer_spec.rb
 - spec/js_routes/module_types/amd_spec.rb
 - spec/js_routes/module_types/cjs_spec.rb
+- spec/js_routes/module_types/dts/routes.spec.d.ts
+- 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
 - spec/js_routes/zzz_last_post_rails_init_spec.rb
 - spec/spec_helper.rb
 - spec/support/routes.rb
+- spec/tsconfig.json
 - tsconfig.json
 - yarn.lock
 homepage: http://github.com/railsware/js-routes