js-routes 1.4.9 → 2.2.0

data/spec/js_routes/options_spec.rb

@@ -2,10 +2,18 @@ require 'spec_helper'
 
 describe JsRoutes, "options" do
 
+  let(:generated_js) do
+    JsRoutes.generate({
+      module_type: nil,
+      namespace: 'Routes',
+      **_options
+    })
+  end
+
   before(:each) do
     evaljs(_presetup) if _presetup
     with_warnings(_warnings) do
-      evaljs(JsRoutes.generate(_options))
+      evaljs(generated_js)
       App.routes.default_url_options = _options[:default_url_options] || {}
     end
   end
@@ -37,9 +45,10 @@ describe JsRoutes, "options" do
       let(:_presetup){ %q(var myCustomSerializer = 1) }
       let(:_options) { {:serializer => "myCustomSerializer"} }
 
-      it "should set configurable serializer" do
-        # expect to use default
-        expect(evaljs(%q(Routes.inboxes_path({a: 1})))).to eql("/inboxes?a=1")
+      it "should throw error" do
+      expect {
+        evaljs(%q(Routes.inboxes_path({a: 1})))
+      }.to raise_error(js_error_class)
       end
     end
 
@@ -86,6 +95,18 @@ describe JsRoutes, "options" do
       expect(evaljs("Routes.inboxes_path")).to be_nil
     end
 
+    context "with camel_case option" do
+      let(:_options) { {include: /^admin_/, camel_case: true} }
+
+      it "should exclude specified routes from file" do
+        expect(evaljs("Routes.adminUsersPath()")).not_to be_nil
+      end
+
+      it "should not exclude routes not under specified pattern" do
+        expect(evaljs("Routes.inboxesPath")).to be_nil
+      end
+    end
+
     context "for rails engine" do
       let(:_options) { {:include => /^blog_app_posts/} }
 
@@ -167,56 +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} }
-      it "should use this namespace for routing" do
-        evaljs("window.zz = #{JsRoutes.generate(namespace: nil)}")
-        expect(evaljs("window.Routes")).to be_nil
-        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
 
@@ -229,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
@@ -401,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
@@ -414,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
@@ -491,4 +493,13 @@ describe JsRoutes, "options" do
       expect(evaljs("Routes.posts_path()")).not_to be_nil
     end
   end
+
+  describe "documentation option" do
+    let(:_options) { {documentation: false} }
+
+    it "disables documentation generation" do
+      expect(generated_js).not_to include("@param")
+      expect(generated_js).not_to include("@returns")
+    end
+  end
 end

data/spec/js_routes/rails_routes_compatibility_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe JsRoutes, "compatibility with Rails"  do
 
   before(:each) do
-    evaljs(JsRoutes.generate({}))
+    evaljs(JsRoutes.generate({module_type: nil, namespace: 'Routes'}))
   end
 
   it "should generate collection routing" do
@@ -16,13 +16,16 @@ describe JsRoutes, "compatibility with Rails"  do
 
   it "should raise error if required argument is not passed", :aggregate_failures do
     expect { evaljs("Routes.thing_path()") }
-      .to raise_error(/Route parameter missing: id/)
+      .to raise_error(/Route missing required keys: id/)
     expect { evaljs("Routes.search_path()") }
-      .to raise_error(/Route parameter missing: q/)
+      .to raise_error(/Route missing required keys: q/)
     expect { evaljs("Routes.book_path()") }
-      .to raise_error(/Route parameter missing: title/)
+      .to raise_error(/Route missing required keys: section, title/)
     expect { evaljs("Routes.book_title_path()") }
-      .to raise_error(/Route parameter missing: title/)
+      .to raise_error(/Route missing required keys: title/)
+
+    expect( evaljs("try {Routes.thing_path()} catch (e) { e.name }") ).to eq('ParametersMissing')
+    expect( evaljs("try {Routes.thing_path()} catch (e) { e.keys }") ).to eq(['id'])
   end
 
   it "should produce error stacktraces including function names" do
@@ -70,7 +73,7 @@ describe JsRoutes, "compatibility with Rails"  do
     expect(evaljs("Routes.inbox_path(1, {expanded: true, anchor: 'hello'})")).to eq(test_routes.inbox_path(1, :expanded => true, :anchor => "hello"))
   end
 
-  it "should support required paramters given as options hash" do
+  it "should support required parameters given as options hash" do
     expect(evaljs("Routes.search_path({q: 'hello'})")).to eq(test_routes.search_path(:q => 'hello'))
   end
 
@@ -110,6 +113,7 @@ describe JsRoutes, "compatibility with Rails"  do
 
     it "doesn't apply defaults to path" do
       expect(evaljs("Routes.with_defaults_path()")).to eq(test_routes.with_defaults_path)
+      expect(evaljs("Routes.with_defaults_path({format: 'json'})")).to eq(test_routes.with_defaults_path(format: 'json'))
     end
   end
 
@@ -131,6 +135,11 @@ describe JsRoutes, "compatibility with Rails"  do
     it "should support single route mapping" do
       expect(evaljs("Routes.support_path({page: 3})")).to eq(test_routes.support_path(:page => 3))
     end
+
+    it 'works' do
+      expect(evaljs("Routes.planner_manage_path({locale: 'ua'})")).to eq(planner_routes.manage_path(locale: 'ua'))
+      expect(evaljs("Routes.planner_manage_path()")).to eq(planner_routes.manage_path)
+    end
   end
 
   it "shouldn't require the format" do
@@ -149,7 +158,7 @@ describe JsRoutes, "compatibility with Rails"  do
     expect(evaljs("Routes.root_path()")).to eq(test_routes.root_path)
   end
 
-  describe "get paramters" do
+  describe "get parameters" do
     it "should support simple get parameters" do
       expect(evaljs("Routes.inbox_path(1, {format: 'json', lang: 'ua', q: 'hello'})")).to eq(test_routes.inbox_path(1, :lang => "ua", :q => "hello", :format => "json"))
     end
@@ -158,6 +167,19 @@ describe JsRoutes, "compatibility with Rails"  do
       expect(evaljs("Routes.inbox_path(1, {hello: ['world', 'mars']})")).to eq(test_routes.inbox_path(1, :hello => [:world, :mars]))
     end
 
+    context "object without prototype" do
+      before(:each) do
+        evaljs("let params = Object.create(null); params.q = 'hello';")
+        evaljs("let inbox = Object.create(null); inbox.to_param = 1;")
+      end
+
+      it "should still work correctly" do
+        expect(evaljs("Routes.inbox_path(inbox, params)")).to eq(
+          test_routes.inbox_path(1, q: "hello")
+        )
+      end
+    end
+
     it "should support nested get parameters" do
       expect(evaljs("Routes.inbox_path(1, {format: 'json', env: 'test', search: { category_ids: [2,5], q: 'hello'}})")).to eq(
         test_routes.inbox_path(1, :env => 'test', :search => {:category_ids => [2,5], :q => "hello"}, :format => "json")
@@ -225,6 +247,15 @@ describe JsRoutes, "compatibility with Rails"  do
         expect(evaljs("Routes.things_path({ q: 'hello' })")).to eq(test_routes.things_path(q: 'hello'))
       end
 
+      it "treats false as absent optional part" do
+        pending("https://github.com/rails/rails/issues/42280")
+        expect(evaljs("Routes.things_path(false)")).to eq(test_routes.things_path(false))
+      end
+
+      it "treats false as absent optional part when default is specified" do
+        expect(evaljs("Routes.campaigns_path(false)")).to eq(test_routes.campaigns_path(false))
+      end
+
       it "should not require the optional parts as arguments" do
         expect(evaljs("Routes.thing_path(null, 5)")).to eq(test_routes.thing_path(nil, 5))
       end
@@ -235,7 +266,7 @@ describe JsRoutes, "compatibility with Rails"  do
 
       it "should raise error when passing non-full list of arguments and some query params" do
         expect { evaljs("Routes.thing_path(5, {q: 'hello'})") }
-          .to raise_error(/Route parameter missing: id/)
+          .to raise_error(/Route missing required keys: id/)
       end
 
       it "should treat null as non-given optional part" do
@@ -253,7 +284,7 @@ describe JsRoutes, "compatibility with Rails"  do
 
     context "and including them" do
       it "should fail when insufficient arguments are given" do
-        expect { evaljs("Routes.thing_deep_path(2)") }.to raise_error(/Route parameter missing: third_required/)
+        expect { evaljs("Routes.thing_deep_path(2)") }.to raise_error(/Route missing required keys: third_required/)
       end
 
       it "should include the optional parts" do
@@ -302,27 +333,22 @@ describe JsRoutes, "compatibility with Rails"  do
         evaljs("Routes.inbox_path()")
       }.to raise_error(js_error_class)
     end
+
     it "should throw Exception if required parameter is not defined" do
       expect {
         evaljs("Routes.inbox_path(null)")
       }.to raise_error(js_error_class)
     end
 
-    it "should throw Exceptions if when there is too many parameters" do
-      expect {
-        evaljs("Routes.inbox_path(1,2,3)")
-      }.to raise_error(js_error_class)
-    end
-
-    it "should throw Exceptions if when pass id with null" do
+    it "should throw Exception if required parameter is not defined" do
       expect {
-        evaljs("Routes.inbox_path({id: null})")
+        evaljs("Routes.inbox_path(undefined)")
       }.to raise_error(js_error_class)
     end
 
-    it "should throw Exceptions if when pass to_param with null" do
+    it "should throw Exceptions if when there is too many parameters" do
       expect {
-        evaljs("Routes.inbox_path({to_param: null})")
+        evaljs("Routes.inbox_path(1,2,3)")
       }.to raise_error(js_error_class)
     end
   end
@@ -341,8 +367,19 @@ describe JsRoutes, "compatibility with Rails"  do
     let(:klass) { Struct.new(:id, :to_param) }
     let(:inbox) { klass.new(1,"my") }
 
+    it "should throw Exceptions if when pass id with null" do
+      expect {
+        evaljs("Routes.inbox_path({id: null})")
+      }.to raise_error(js_error_class)
+    end
+
+    it "should throw Exceptions if when pass to_param with null" do
+      expect {
+        evaljs("Routes.inbox_path({to_param: null})")
+      }.to raise_error(js_error_class)
+    end
     it "should support 0 as a to_param option" do
-      expect(evaljs("Routes.inbox_path({to_param: 0})")).to eq(test_routes.inbox_path(0))
+      expect(evaljs("Routes.inbox_path({to_param: 0})")).to eq(test_routes.inbox_path(Struct.new(:to_param).new('0')))
     end
 
     it "should check for options special key" do
@@ -379,6 +416,14 @@ describe JsRoutes, "compatibility with Rails"  do
       )).to eq(test_routes.inbox_message_path(inbox, 2, :custom => true, :format => "json"))
     end
 
+    it "supports camel case property name" do
+      expect(evaljs("Routes.inbox_path({id: 1, toParam: 'my'})")).to eq(test_routes.inbox_path(inbox))
+    end
+
+    it "supports camel case method name" do
+      expect(evaljs("Routes.inbox_path({id: 1, toParam: function(){ return 'my';}})")).to eq(test_routes.inbox_path(inbox))
+    end
+
     context "when globbing" do
       it "should prefer to_param property over id property" do
         expect(evaljs("Routes.book_path({id: 1, to_param: 'my'}, 1)")).to eq(test_routes.book_path(inbox, 1))
@@ -398,6 +443,7 @@ describe JsRoutes, "compatibility with Rails"  do
         )).to eq(test_routes.book_path(inbox, 2, :custom => true, :format => "json"))
       end
     end
+
   end
 
   context "when specs" do
@@ -418,15 +464,13 @@ describe JsRoutes, "compatibility with Rails"  do
     end
   end
 
-  describe "required_params" do
+  describe "requiredParams" do
     it "should show inbox spec" do
-      expect(evaljs("Routes.inbox_path.required_params").to_a).to eq(["id"])
+      expect(evaljs("Routes.inbox_path.requiredParams()").to_a).to eq(["id"])
     end
 
     it "should show inbox message spec" do
-      expect(evaljs("Routes.inbox_message_path.required_params").to_a).to eq(["inbox_id", "id"])
+      expect(evaljs("Routes.inbox_message_path.requiredParams()").to_a).to eq(["inbox_id", "id"])
     end
   end
-
-
 end

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?
@@ -93,7 +93,7 @@ describe "after Rails initialization" do
               Rails.application.config.assets.initialize_on_precompile = true
             end
             it "should render some javascript" do
-              expect(evaluate(ctx, 'js-routes.js')).to match(/routes = /)
+              expect(evaluate(ctx, 'js-routes.js')).to match(/Utils\.define_module/)
             end
           end
           context "and not initialize on precompile" do
@@ -101,7 +101,7 @@ describe "after Rails initialization" do
               Rails.application.config.assets.initialize_on_precompile = false
             end
             it "should raise an exception if 3 version" do
-              expect(evaluate(ctx, 'js-routes.js')).to match(/routes = /)
+              expect(evaluate(ctx, 'js-routes.js')).to match(/Utils\.define_module/)
             end
           end
 
@@ -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

@@ -6,7 +6,14 @@ require 'rspec'
 require 'rails/all'
 require 'js-routes'
 require 'active_support/core_ext/hash/slice'
-require 'coffee-script'
+
+unless ENV['TRAVIS_CI']
+  code = system("yarn build")
+  unless code
+    exit(1)
+  end
+end
+
 
 if defined?(JRUBY_VERSION)
   require 'rhino'
@@ -32,8 +39,15 @@ def js_error_class
   end
 end
 
-def evaljs(string, force = false)
-  jscontext(force).eval(string)
+def evaljs(string, force: false, filename: 'context.js')
+  jscontext(force).eval(string, filename: filename)
+rescue MiniRacer::ParseError => e
+  message = e.message
+  _, _, line, _ = message.split(':')
+  code = line && string.split("\n")[line.to_i-1]
+  raise "#{message}. Code: #{code.strip}";
+rescue MiniRacer::RuntimeError => e
+  raise e
 end
 
 def test_routes
@@ -44,11 +58,21 @@ def blog_routes
   BlogEngine::Engine.routes.url_helpers
 end
 
+def planner_routes
+  Planner::Engine.routes.url_helpers
+end
+
 ActiveSupport::Inflector.inflections do |inflect|
   inflect.irregular "budgie", "budgies"
 end
 
 
+module Planner
+  class Engine < Rails::Engine
+    isolate_namespace Planner
+  end
+end
+
 module BlogEngine
   class Engine < Rails::Engine
     isolate_namespace BlogEngine
@@ -79,28 +103,21 @@ RSpec.configure do |config|
     c.syntax = :expect
   end
 
-  config.before(:all) do
-    # compile all js files begin
-    Dir["#{File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))}/**/*.coffee"].each do |coffee|
-      File.open(coffee.gsub(/\.coffee$/, ""), 'w') do |f|
-        f.write(CoffeeScript.compile(File.read(coffee)).lstrip)
-      end
-    end
-    # compile all js files end
+  config.before(:suite) do
     draw_routes
   end
 
   config.before :each do
-    evaljs("var window = this;", true)
+    log = proc do |*values|
+      puts values.map(&:inspect).join(", ")
+    end
 
     if defined?(JRUBY_VERSION)
-      jscontext[:log] = lambda do |context, value|
-        puts value.inspect
+      jscontext[:"console.log"] = lambda do |context, *values|
+        log(*values)
       end
     else
-      jscontext.attach("log", proc do |value|
-        puts value.inspect
-      end)
+      jscontext.attach("console.log", log)
     end
   end
 end

data/spec/support/routes.rb

@@ -1,11 +1,17 @@
 def draw_routes
+  Planner::Engine.routes.draw do
+    get "/manage" => 'foo#foo', as: :manage
+  end
 
   BlogEngine::Engine.routes.draw do
     root to: "application#index"
-    resources :posts
+    resources :posts, only: [:show, :index]
   end
   App.routes.draw do
 
+    mount Planner::Engine, at: "/(locale/:locale)", as: :planner
+
+    mount BlogEngine::Engine => "/blog", as: :blog_app
     get 'support(/page/:page)', to: BlogEngine::Engine, as: 'support'
 
     resources :inboxes, only: [:index, :show] do
@@ -14,6 +20,8 @@ def draw_routes
       end
     end
 
+    get "(/:space)/campaigns" => "foo#foo", as: :campaigns, defaults: {space: nil}
+
     root :to => "inboxes#index"
 
     namespace :admin do
@@ -41,8 +49,6 @@ def draw_routes
     get 'books/*section/:title' => 'books#show', :as => :book
     get 'books/:title/*section' => 'books#show', :as => :book_title
 
-    mount BlogEngine::Engine => "/blog", :as => :blog_app
-
     get '/no_format' => "foo#foo", :format => false, :as => :no_format
 
     get '/json_only' => "foo#foo", :format => true, :constraints => {:format => /json/}, :as => :json_only
@@ -56,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

@@ -0,0 +1,28 @@
+ {
+  "compilerOptions": {
+    "target": "es2019",
+    "lib": ["es2020", "dom"],
+    "module": "commonjs",
+    "sourceMap": false,
+    "declaration": true,
+    "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": false,
+    "strictNullChecks": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictBindCallApply": true,
+    "strictFunctionTypes": true,
+    "alwaysStrict": false,
+
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true
+
+  },
+  "ts-node": {
+    "files": true,
+    "transpileOnly": false
+  },
+  "include": ["lib/*.ts"]
+}