js-routes 1.0.1 → 1.2.9

data/spec/js_routes/default_serializer_spec.rb

@@ -0,0 +1,13 @@
+describe JsRoutes, "#default_serializer" do
+  
+  before(:each) do
+    evaljs(JsRoutes.generate({}))
+  end
+
+  it "should provide this method" do
+    expect(evaljs("Routes.default_serializer({a: 1, b: [2,3], c: {d: 4, e: 5}, f: ''})")).to eq(
+      "a=1&b%5B%5D=2&b%5B%5D=3&c%5Bd%5D=4&c%5Be%5D=5&f="
+    )
+  end
+
+end

data/spec/js_routes/generated_javascript_spec.rb

@@ -9,6 +9,18 @@ describe JsRoutes do
 
   describe "generated js" do
     subject { JsRoutes.generate }
+
+    it "should set the default serializer when none is configured" do
+      is_expected.to match(%r(custom_serializer: null,\s+serialize: function\(object\) {\s+if \(\(this\.custom_serializer != null\) && this.get_object_type\(this\.custom_serializer\) === \"function\"\) {\s+return this\.custom_serializer\(object\);\s+} else {\s+return this\.default_serializer\(object\);\s+}\s+},))
+    end
+
+    it "should include a comment in the header" do
+      app_class = "App"
+
+      is_expected.to include("File generated by js-routes #{JsRoutes::VERSION}")
+      is_expected.to include("Based on Rails routes of #{app_class}")
+    end
+
     it "should call route function for each route" do
       is_expected.to include("inboxes_path: Utils.route(")
     end

data/spec/js_routes/options_spec.rb

@@ -13,6 +13,30 @@ describe JsRoutes, "options" do
   let(:_options) { {} }
   let(:_warnings) { true }
 
+  context "when serializer is specified" do
+    # define custom serializer
+    # this is a nonsense serializer, which always returns foo=bar
+    # for all inputs
+    let(:_presetup){ %q(function myCustomSerializer(object, prefix) { return "foo=bar"; }) }
+    let(:_options) { {:serializer => "myCustomSerializer"} }
+
+    it "should set configurable serializer" do
+      # expect the nonsense serializer above to have appened foo=bar
+      # to the end of the path
+      expect(evaljs(%q(Routes.inboxes_path()))).to eql("/inboxes?foo=bar")
+    end
+  end
+
+  context "when serializer is specified, but not function" 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")
+    end
+  end
+
   context "when exclude is specified" do
 
     let(:_options) { {:exclude => /^admin_/} }
@@ -114,15 +138,18 @@ describe JsRoutes, "options" do
       expect(evaljs("Routes.inbox_path(1, {format: null})")).to eq(routes.inbox_path(1))
     end
 
-    it "shouldn't include the format when {:format => false} is specified" do
-      expect(evaljs("Routes.no_format_path()")).to eq(routes.no_format_path)
-    end
 
     it "shouldn't require the format" do
+      pending if Rails.version < "4.0"
       expect(evaljs("Routes.json_only_path()")).to eq(routes.json_only_path(:format => 'json'))
     end
   end
 
+  it "shouldn't include the format when {:format => false} is specified" do
+    expect(evaljs("Routes.no_format_path()")).to eq(routes.no_format_path())
+    expect(evaljs("Routes.no_format_path({format: 'json'})")).to eq(routes.no_format_path(format: 'json'))
+  end
+
   describe "when namespace option is specified" do
     let(:_options) { {:namespace => "PHM"} }
     it "should use this namespace for routing" do
@@ -159,16 +186,24 @@ describe JsRoutes, "options" do
 
   describe "default_url_options" do
     context "with optional route parts" 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(routes.things_path(:optional_id => 12, :format => "json"))
+      context "provided" 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(routes.things_path(:optional_id => 12, :format => "json"))
+        end
+      end
+
+      context "not provided" do
+        let(:_options) { { :default_url_options => { :format => "json" } } }
+        it "breaks" do
+          expect(evaljs("Routes.foo_all_path()")).to eq(routes.foo_all_path(:format => "json"))
+        end
       end
     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
-        pending
         expect(evaljs("Routes.inbox_messages_path()")).to eq(routes.inbox_messages_path(:inbox_id => 12))
       end
     end
@@ -284,19 +319,13 @@ describe JsRoutes, "options" do
     end
 
     context "when configuring with default_url_options" do
-      context "when default host is not specified" do
-        it "raises an error" do
-          expect { JsRoutes.generate({ :url_links => true }) }.to raise_error RuntimeError
-        end
-      end
-
       context "when only host option is specified" do
         let(:_options) { { :url_links => true, :default_url_options => {:host => "example.com"} } }
-        
+
         it "uses the specified host, defaults protocol to http, defaults port to 80 (leaving it blank)" do
           expect(evaljs("Routes.inbox_url(1)")).to eq("http://example.com#{routes.inbox_path(1)}")
         end
-        
+
         it "does not override protocol when specified in route" do
           expect(evaljs("Routes.new_session_url()")).to eq("https://example.com#{routes.new_session_path}")
         end
@@ -316,7 +345,7 @@ describe JsRoutes, "options" do
         it "uses the specified protocol and host, defaults port to 80 (leaving it blank)" do
           expect(evaljs("Routes.inbox_url(1)")).to eq("ftp://example.com#{routes.inbox_path(1)}")
         end
-        
+
         it "does not override protocol when specified in route" do
           expect(evaljs("Routes.new_session_url()")).to eq("https://example.com#{routes.new_session_path}")
         end
@@ -340,11 +369,11 @@ describe JsRoutes, "options" do
         it "does not override protocol when specified in route" do
           expect(evaljs("Routes.new_session_url()")).to eq("https://example.com:3000#{routes.new_session_path}")
         end
-        
+
         it "does not override host, protocol, or port when host is specified in route" do
-          expect(evaljs("Routes.sso_url()")).to eq(routes.sso_url)
+          expect(evaljs("Routes.sso_url()")).to eq("http://sso.example.com:3000" + routes.sso_path)
         end
-        
+
         it "does not override port when specified in route" do
           expect(evaljs("Routes.portals_url()")).to eq("http://example.com:8080#{routes.portals_path}")
         end
@@ -380,6 +409,47 @@ describe JsRoutes, "options" do
         end
       end
     end
+
+    context 'when window.location is present' do
+      let(:current_protocol) { 'http:' } # window.location.protocol includes the colon character
+      let(:current_hostname) { 'current.example.com' }
+      let(:current_port){ '' } # an empty string means port 80
+      let(:current_host) do
+        host = "#{current_hostname}"
+        host += ":#{current_port}" unless current_port == ''
+        host
+      end
+
+      before do
+        jscontext.eval("window = {'location': {'protocol': '#{current_protocol}', 'hostname': '#{current_hostname}', 'port': '#{current_port}', 'host': '#{current_host}'}}")
+      end
+
+      context "without specifying a default host" do
+        let(:_options) { { :url_links => true } }
+
+        it "uses the current host" do
+          expect(evaljs("Routes.inbox_path")).not_to be_nil
+          expect(evaljs("Routes.inbox_url")).not_to be_nil
+          expect(evaljs("Routes.inbox_url(1)")).to eq("http://current.example.com#{routes.inbox_path(1)}")
+          expect(evaljs("Routes.inbox_url(1, { test_key: \"test_val\" })")).to eq("http://current.example.com#{routes.inbox_path(1, :test_key => "test_val")}")
+          expect(evaljs("Routes.new_session_url()")).to eq("https://current.example.com#{routes.new_session_path}")
+          expect(evaljs("Routes.sso_url()")).to eq("http://sso.example.com#{routes.sso_path}")
+
+        end
+
+        it "uses host option as an argument" do
+          expect(evaljs("Routes.portals_url({host: 'another.com'})")).to eq(routes.portals_url(host: 'another.com'))
+        end
+
+        it "uses port option as an argument" do
+          expect(evaljs("Routes.portals_url({host: 'localhost', port: 8080})")).to eq(routes.portals_url(host: 'localhost', port: 8080))
+        end
+
+        it "uses protocol option as an argument" do
+          expect(evaljs("Routes.portals_url({host: 'localhost', protocol: 'https'})")).to eq(routes.portals_url(protocol: 'https', host: 'localhost'))
+        end
+      end
+    end
   end
 
   describe "when the compact mode is enabled" do
@@ -397,7 +467,7 @@ describe JsRoutes, "options" do
             example.run
           end
         end
-        
+
         let(:_options) { { :compact => true, :url_links => "http://localhost" } }
         it "should not strip urls" do
           expect(evaljs("Routes.inbox(1)")).to eq(routes.inbox_path(1))

data/spec/js_routes/rails_routes_compatibility_spec.rb

@@ -54,11 +54,43 @@ describe JsRoutes, "compatibility with Rails"  do
     expect(evaljs("Routes.inbox_path(1, {expanded: true, anchor: 'hello'})")).to eq(routes.inbox_path(1, :expanded => true, :anchor => "hello"))
   end
 
+  it "should use irregular ActiveSupport pluralizations" do
+    expect(evaljs("Routes.budgies_path()")).to eq(routes.budgies_path)
+    expect(evaljs("Routes.budgie_path(1)")).to eq(routes.budgie_path(1))
+    expect(evaljs("Routes.budgy_path")).to eq(nil)
+    expect(evaljs("Routes.budgie_descendents_path(1)")).to eq(routes.budgie_descendents_path(1))
+  end
+
+  describe "when route has defaults" do
+    it "should support route default format" do
+      expect(evaljs("Routes.api_purchases_path()")).to eq(routes.api_purchases_path)
+    end
+
+    it 'should support route default subdomain' do
+      # root inside namespace is broken
+      # https://github.com/rails/rails/pull/23235
+      pending if Rails.version == '5.0.0'
+      expect(evaljs("Routes.backend_root_path()")).to eq(routes.backend_root_path)
+    end
+
+    it "should support default format override" do
+      expect(evaljs("Routes.api_purchases_path({format: 'xml'})")).to eq(routes.api_purchases_path(format: 'xml'))
+    end
+
+    it "doesn't apply defaults to path" do
+      expect(evaljs("Routes.with_defaults_path()")).to eq(routes.with_defaults_path)
+    end
+  end
+
   context "with rails engines" do
     it "should support simple route" do
       expect(evaljs("Routes.blog_app_posts_path()")).to eq(blog_routes.posts_path())
     end
 
+    it "should support root route" do
+      expect(evaljs("Routes.blog_app_path()")).to eq(routes.blog_app_path())
+    end
+
     it "should support route with parameters" do
       expect(evaljs("Routes.blog_app_post_path(1)")).to eq(blog_routes.post_path(1))
     end
@@ -74,6 +106,10 @@ describe JsRoutes, "compatibility with Rails"  do
     expect(evaljs("Routes.json_only_path({format: 'json'})")).to eq(routes.json_only_path(:format => 'json'))
   end
 
+  it "should serialize object with empty string value" do
+    expect(evaljs("Routes.inboxes_path({a: '', b: 1})")).to eq(routes.inboxes_path(:a => '', :b => 1))
+  end
+
   it "should support utf-8 route" do
     expect(evaljs("Routes.hello_path()")).to eq(routes.hello_path)
   end
@@ -141,48 +177,8 @@ describe JsRoutes, "compatibility with Rails"  do
       expect(evaljs("Routes.search_path({q: 'hello'})")).to eq(routes.search_path(:q => 'hello'))
     end
 
-    it "should ignore null parameters" do
-      pending
-      expect(evaljs("Routes.inboxes_path({hello: {world: null}})")).to eq(routes.inboxes_path(:hello => {world: nil}))
-    end
-  end
-
-  context "when jQuery is present" do
-    before do
-      evaljs("window.jQuery = {};")
-      jscontext[:parameterizeFunc] = lambda {|object| _value.to_param}
-      evaljs("window.jQuery.param = parameterizeFunc")
-    end
-
-    shared_examples_for "serialization" do
-      it "should support serialization of objects" do
-        expect(evaljs("window.jQuery.param(#{_value.to_json})")).to eq(_value.to_param)
-        expect(evaljs("Routes.inboxes_path(#{_value.to_json})")).to eq(routes.inboxes_path(_value))
-        expect(evaljs("Routes.inbox_path(1, #{_value.to_json})")).to eq(routes.inbox_path(1, _value))
-      end
-    end
-    context "when parameters is a hash" do
-      let(:_value) do
-        {:a => {:b => 'c'}, :q => [1,2]}
-      end
-      it_should_behave_like 'serialization'
-    end
-    context "when parameters is null" do
-      let(:_value) do
-        {:hello => {world: nil}}
-      end
-      it_should_behave_like 'serialization'
-    end
-    context "when parameters is null" do
-      let(:_value) do
-        nil
-      end
-
-      before do
-        pending("This test is invalid for nil/null and jruby #{JRUBY_VERSION}") if defined?(JRUBY_VERSION) && '1.7.13' == JRUBY_VERSION
-      end
-
-      it_should_behave_like 'serialization'
+    it "should support nested object null parameters" do
+      expect(evaljs("Routes.inboxes_path({hello: {world: null}})")).to eq(routes.inboxes_path(:hello => {:world => nil}))
     end
   end
 
@@ -204,17 +200,11 @@ describe JsRoutes, "compatibility with Rails"  do
         expect(evaljs("Routes.thing_path(null, 5)")).to eq(routes.thing_path(nil, 5))
       end
 
-      # Fail for rails 4.2. Reason: https://github.com/rails/rails/issues/12178
       it "should treat undefined as non-given optional part" do
-        # TODO: remove me after release of rails 4.2.1 (change Appraisals to "~> 4.2.1")
-        pending("This test is invalid for rails 4.2. Reason: https://github.com/rails/rails/issues/12178") if [4, 2, 0] == [Rails::VERSION::MAJOR, Rails::VERSION::MINOR, Rails::VERSION::TINY]
         expect(evaljs("Routes.thing_path(5, {optional_id: undefined})")).to eq(routes.thing_path(5, :optional_id => nil))
       end
 
-      # Fail for rails 4.2. Reason: https://github.com/rails/rails/issues/12178
       it "should treat null as non-given optional part" do
-        # TODO: remove me after release of rails 4.2.1 (change Appraisals to "~> 4.2.1")
-        pending("This test is invalid for rails 4.2. Reason: https://github.com/rails/rails/issues/12178") if [4, 2, 0] == [Rails::VERSION::MAJOR, Rails::VERSION::MINOR, Rails::VERSION::TINY]
         expect(evaljs("Routes.thing_path(5, {optional_id: null})")).to eq(routes.thing_path(5, :optional_id => nil))
       end
     end
@@ -224,6 +214,11 @@ describe JsRoutes, "compatibility with Rails"  do
         expect(evaljs("Routes.things_path({optional_id: 5})")).to eq(routes.things_path(:optional_id => 5))
       end
 
+      context "on nested optional parts" do
+        it "should include everything that is not optional" do
+          expect(evaljs("Routes.classic_path({controller: 'classic', action: 'edit'})")).to eq(routes.classic_path(controller: :classic, action: :edit))
+        end
+      end
     end
   end
 
@@ -321,7 +316,7 @@ describe JsRoutes, "compatibility with Rails"  do
     end
   end
 
-  context "when params" do
+  describe "required_params" do
     it "should show inbox spec" do
       expect(evaljs("Routes.inbox_path.required_params").to_a).to eq(["id"])
     end
@@ -330,4 +325,6 @@ describe JsRoutes, "compatibility with Rails"  do
       expect(evaljs("Routes.inbox_message_path.required_params").to_a).to eq(["inbox_id", "id"])
     end
   end
+
+
 end

data/spec/js_routes/zzz_last_post_rails_init_spec.rb

@@ -55,19 +55,13 @@ describe "after Rails initialization" do
       FileUtils.rm_f(TEST_ASSET_PATH)
     end
 
-    it "should have registered a preprocessor" do
-      pps = Rails.application.assets.preprocessors
-      js_pps = pps['application/javascript']
-      klass = sprockets_v3? ? 'LegacyProcProcessor' : 'Processor'
-      expect(js_pps.map(&:to_s)).to include("Sprockets::#{klass} (js-routes_dependent_on_routes)")
-    end
-
     context "the preprocessor" do
       before(:each) do
+        path = Rails.root.join('config','routes.rb').to_s
         if sprockets_v3?
-          expect_any_instance_of(Sprockets::Context).to receive(:depend_on).with(Rails.root.join('config','routes.rb').to_s)
+          expect_any_instance_of(Sprockets::Context).to receive(:depend_on).with(path)
         else
-          expect(ctx).to receive(:depend_on).with(Rails.root.join('config','routes.rb').to_s)
+          expect(ctx).to receive(:depend_on).with(path)
         end
       end
       let!(:ctx) do

data/spec/spec_helper.rb

@@ -5,7 +5,7 @@ $:.unshift(File.dirname(__FILE__))
 require 'rspec'
 require 'rails/all'
 require 'js-routes'
-require "active_support/core_ext/hash/slice"
+require 'active_support/core_ext/hash/slice'
 require 'coffee-script'
 # fix ends_with? error for rails 3.2
 require 'active_support/core_ext/string/starts_ends_with' if 3 == Rails::VERSION::MAJOR
@@ -14,7 +14,7 @@ if defined?(JRUBY_VERSION)
   require 'rhino'
   JS_LIB_CLASS = Rhino
 else
-  require "v8"
+  require 'v8'
   JS_LIB_CLASS = V8
 end
 
@@ -42,6 +42,10 @@ def blog_routes
   BlogEngine::Engine.routes.url_helpers
 end
 
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.irregular "budgie", "budgies"
+end
+
 
 module BlogEngine
   class Engine < Rails::Engine
@@ -66,59 +70,6 @@ class App < Rails::Application
   config.root = File.expand_path('../dummy', __FILE__)
 end
 
-def draw_routes
-
-  BlogEngine::Engine.routes.draw do
-    root to: "application#index"
-    resources :posts
-  end
-  App.routes.draw do
-
-    get 'support(/page/:page)', to: BlogEngine::Engine, as: 'support'
-
-    resources :inboxes do
-      resources :messages do
-        resources :attachments
-      end
-    end
-
-    root :to => "inboxes#index"
-
-    namespace :admin do
-      resources :users
-    end
-
-    scope "/returns/:return" do
-      resources :objects
-    end
-    resources :returns
-
-    scope "(/optional/:optional_id)" do
-      resources :things
-    end
-
-    get "/other_optional/(:optional_id)" => "foo#foo", :as => :foo
-
-    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
-
-    get '/привет' => "foo#foo", :as => :hello
-    get '(/o/:organization)/search/:q' => "foo#foo", as: :search
-
-    resources :sessions, :only => [:new, :create, :destroy], :protocol => 'https'
-
-    get '/' => 'sso#login', host: 'sso.example.com', as: :sso
-
-    resources :portals, :port => 8080
-  end
-
-end
 
 # prevent warning
 Rails.configuration.active_support.deprecation = :log
@@ -135,7 +86,9 @@ RSpec.configure do |config|
   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') {|f| f.write(CoffeeScript.compile(File.read(coffee))) }
+      File.open(coffee.gsub(/\.coffee$/, ""), 'w') do |f|
+        f.write(CoffeeScript.compile(File.read(coffee)).lstrip)
+      end
     end
     # compile all js files end
     draw_routes
@@ -143,6 +96,27 @@ RSpec.configure do |config|
 
   config.before :each do
     evaljs("var window = this;", true)
-    jscontext[:log] = lambda {|context, value| puts value.inspect}
+
+    def inspectify(value)
+      case value
+      when V8::Array
+        value.map do |v|
+          inspectify(v)
+        end
+      when V8::Object
+        require 'byebug'; byebug
+        value.to_h.map do |k,v|
+          [k, inspectify(v)]
+        end.to_h
+      when String, nil, Fixnum, FalseClass, TrueClass
+        value
+      else
+        raise "wtf #{value.class}?"
+      end
+
+    end
+    jscontext[:log] = lambda do |context, value|
+      puts inspectify(value).to_json
+    end
   end
 end

data/spec/support/routes.rb

@@ -0,0 +1,71 @@
+def draw_routes
+
+  BlogEngine::Engine.routes.draw do
+    root to: "application#index"
+    resources :posts
+  end
+  App.routes.draw do
+
+    get 'support(/page/:page)', to: BlogEngine::Engine, as: 'support'
+
+    resources :inboxes do
+      resources :messages do
+        resources :attachments
+      end
+    end
+
+    root :to => "inboxes#index"
+
+    namespace :admin do
+      resources :users
+    end
+
+    scope "/returns/:return" do
+      resources :objects
+    end
+    resources :returns
+
+    scope "(/optional/:optional_id)" do
+      resources :things
+    end
+
+    get "/:controller(/:action(/:id))" => "classic#classic", :as => :classic
+
+    get "/other_optional/(:optional_id)" => "foo#foo", :as => :foo
+    get '/other_optional(/*optional_id)' => 'foo#foo', :as => :foo_all
+
+    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
+
+    get '/привет' => "foo#foo", :as => :hello
+    get '(/o/:organization)/search/:q' => "foo#foo", as: :search
+
+    resources :sessions, :only => [:new, :create, :destroy], :protocol => 'https'
+
+    get '/' => 'sso#login', host: 'sso.example.com', as: :sso
+
+    resources :portals, :port => 8080
+
+    get '/with_defaults' => 'foo#foo', defaults: { bar: 'tested', format: :json }, format: :true
+
+    namespace :api, format: true, defaults: {format: 'json'} do
+      get "/purchases" => "purchases#index"
+    end
+
+    resources :budgies do
+      get "descendents"
+    end
+
+    namespace :backend, path: '', constraints: {subdomain: 'backend'} do
+      root to: 'backend#index'
+    end
+
+  end
+
+end