js-routes 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8070be8c5b23bf6559f75032ac0512e19ab5cd1
-  data.tar.gz: 2264e1657fcc5601ecd1eaa57fa71a2854b8e6e3
+  metadata.gz: 5b720670fa76910ce7f6648985f595280bb07c16
+  data.tar.gz: 6ea110ece8ff7cf6e5fc1fe6635819f62c15464e
 SHA512:
-  metadata.gz: 59dab9d9c8c9bbadf9f5611ecc59b573db0443c7cff3691c17d52806da3586ecb1d0716b8d71ddd912d4f3e195b4f000d19338cc3a994ce0675e65fb7b781e0b
-  data.tar.gz: 67059a57046c2430ee4b4ae1a8aa6657e0172db5fca0214067fb8130016b09424d51a291dc9c38990050515d8102d1f3713a76e7f558dc1e9502bc9b4abbacea
+  metadata.gz: 37d1e5fa18e348092b4f56525eb6c61626b8b4820e46bffc2b16f28466a181f3a233499c8cc9004db4dc5dee551c3dd1998efc8ed3515b43a9ee1e551e477c0b
+  data.tar.gz: fce1d09de9f6b5772a9b9b0a6f2a4759722f72f7a45e7032a9bcb7341f7987807624bff591d5115edfebcd1b04403aac258f4a46daa6f496f49f34dbddd94341

data/gemfiles/rails42.gemfile

@@ -4,5 +4,6 @@ source "http://rubygems.org"
 
 gem "railties", "~> 4.2.1"
 gem "sprockets", "< 3"
+gem "nokogiri", "< 1.7"
 
 gemspec :path => "../"

data/gemfiles/rails42_sprockets3.gemfile

@@ -4,5 +4,6 @@ source "http://rubygems.org"
 
 gem "railties", "~> 4.2.1"
 gem "sprockets", "~> 3.0"
+gem "nokogiri", "< 1.7"
 
 gemspec :path => "../"

data/js-routes.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
     s.add_development_dependency(%q<therubyrhino>, [">= 2.0.4"])
   else
     s.add_development_dependency(%q<byebug>)
+    s.add_development_dependency(%q<pry-byebug>)
     s.add_development_dependency(%q<therubyracer>, [">= 0.12.1"])
   end
 end

data/lib/js_routes.rb

@@ -110,9 +110,10 @@ class JsRoutes
       "NODE_TYPES"          => json(NODE_TYPES),
       "SERIALIZER"          => @options[:serializer] || json(nil),
       "ROUTES"              => js_routes,
-      "SPECIAL_OPTIONS_KEY" => @options[:special_options_key].to_s
+      "SPECIAL_OPTIONS_KEY" => @options[:special_options_key].to_s,
+      "DEPRECATED_BEHAVIOR" => Rails.version < "4",
     }.inject(File.read(File.dirname(__FILE__) + "/routes.js")) do |js, (key, value)|
-      js.gsub!(key, value)
+      js.gsub!(key, value.to_s)
     end
   end
 
@@ -216,13 +217,19 @@ class JsRoutes
   end
 
   def route_js_arguments(route, parent_spec)
-    required_parts = route.required_parts.clone
-    optional_parts = route.parts - required_parts
-    default_parts = route.defaults.select do |part, _|
-      FILTERED_DEFAULT_PARTS.exclude?(part) && URL_OPTIONS.include?(part) || required_parts.include?(part)
+    required_parts = route.required_parts
+    parts_table = route.parts.each_with_object({}) do |part, hash|
+      hash[part] = required_parts.include?(part)
+    end
+    default_options = route.defaults.select do |part, _|
+      FILTERED_DEFAULT_PARTS.exclude?(part) && URL_OPTIONS.include?(part) || parts_table[part]
     end
     [
-      required_parts, optional_parts, serialize(route.path.spec, parent_spec), default_parts
+      # JS objects don't preserve the order of properties which is crucial,
+      # so array is a better choice.
+      parts_table.to_a,
+      default_options,
+      serialize(route.path.spec, parent_spec)
     ].map do |argument|
       json(argument)
     end.join(", ")

data/lib/js_routes/version.rb

@@ -1,3 +1,3 @@
 class JsRoutes
-  VERSION = "1.3.2"
+  VERSION = "1.3.3"
 end

data/lib/routes.js

@@ -4,7 +4,7 @@ Based on Rails routes of APP_CLASS
  */
 
 (function() {
-  var NodeTypes, ParameterMissing, ReservedOptions, SpecialOptionsKey, Utils, createGlobalJsRoutesObject, defaults, root,
+  var DeprecatedBehavior, NodeTypes, ParameterMissing, ReservedOptions, SpecialOptionsKey, Utils, createGlobalJsRoutesObject, defaults, root,
     hasProp = {}.hasOwnProperty,
     slice = [].slice;
 
@@ -25,6 +25,8 @@ Based on Rails routes of APP_CLASS
 
   SpecialOptionsKey = "SPECIAL_OPTIONS_KEY";
 
+  DeprecatedBehavior = DEPRECATED_BEHAVIOR;
+
   ReservedOptions = ['anchor', 'trailing_slash', 'host', 'port', 'protocol'];
 
   Utils = {
@@ -170,13 +172,22 @@ Based on Rails routes of APP_CLASS
         });
       }
     },
-    normalize_options: function(default_parts, required_parameters, optional_parts, actual_parameters) {
-      var i, j, key, len, options, result, url_parameters, value;
-      options = this.extract_options(required_parameters.length, actual_parameters);
-      if (actual_parameters.length > required_parameters.length) {
+    normalize_options: function(parts, required_parts, default_options, actual_parameters) {
+      var i, j, key, len, options, part, parts_options, result, route_parts, url_parameters, use_all_parts, value;
+      options = this.extract_options(parts.length, actual_parameters);
+      if (actual_parameters.length > parts.length) {
         throw new Error("Too many parameters provided for path");
       }
-      options = this.merge(defaults.default_url_options, default_parts, options);
+      use_all_parts = DeprecatedBehavior || actual_parameters.length > required_parts.length;
+      parts_options = {};
+      for (key in options) {
+        if (!hasProp.call(options, key)) continue;
+        use_all_parts = true;
+        if (this.indexOf(parts, key) >= 0) {
+          parts_options[key] = value;
+        }
+      }
+      options = this.merge(defaults.default_url_options, default_options, options);
       result = {};
       url_parameters = {};
       result['url_parameters'] = url_parameters;
@@ -189,18 +200,23 @@ Based on Rails routes of APP_CLASS
           url_parameters[key] = value;
         }
       }
-      for (i = j = 0, len = required_parameters.length; j < len; i = ++j) {
-        value = required_parameters[i];
+      route_parts = use_all_parts ? parts : required_parts;
+      i = 0;
+      for (j = 0, len = route_parts.length; j < len; j++) {
+        part = route_parts[j];
         if (i < actual_parameters.length) {
-          url_parameters[value] = actual_parameters[i];
+          if (!parts_options.hasOwnProperty(part)) {
+            url_parameters[part] = actual_parameters[i];
+            ++i;
+          }
         }
       }
       return result;
     },
-    build_route: function(required_parameters, optional_parts, route, default_parts, full_url, args) {
+    build_route: function(parts, required_parts, default_options, route, full_url, args) {
       var options, parameters, result, url, url_params;
       args = Array.prototype.slice.call(args);
-      options = this.normalize_options(default_parts, required_parameters, optional_parts, args);
+      options = this.normalize_options(parts, required_parts, default_options, args);
       parameters = options['url_parameters'];
       result = "" + (this.get_prefix()) + (this.visit(route, parameters));
       url = Utils.clean_path(result);
@@ -313,10 +329,19 @@ Based on Rails routes of APP_CLASS
       }
       return prefix;
     },
-    route: function(required_parts, optional_parts, route_spec, default_parts, full_url) {
-      var path_fn;
+    route: function(parts_table, default_options, route_spec, full_url) {
+      var j, len, part, parts, path_fn, ref, required, required_parts;
+      required_parts = [];
+      parts = [];
+      for (j = 0, len = parts_table.length; j < len; j++) {
+        ref = parts_table[j], part = ref[0], required = ref[1];
+        parts.push(part);
+        if (required) {
+          required_parts.push(part);
+        }
+      }
       path_fn = function() {
-        return Utils.build_route(required_parts, optional_parts, route_spec, default_parts, full_url, arguments);
+        return Utils.build_route(parts, required_parts, default_options, route_spec, full_url, arguments);
       };
       path_fn.required_params = required_parts;
       path_fn.toString = function() {

data/lib/routes.js.coffee

@@ -13,6 +13,7 @@ defaults =
 
 NodeTypes = NODE_TYPES
 SpecialOptionsKey = "SPECIAL_OPTIONS_KEY"
+DeprecatedBehavior = DEPRECATED_BEHAVIOR
 
 ReservedOptions = [
   'anchor'
@@ -104,11 +105,21 @@ Utils =
     if xs?.length > 0
       tap {}, (m) -> m[k] = v for k, v of x for x in xs
 
-  normalize_options: (default_parts, required_parameters, optional_parts, actual_parameters) ->
-    options = @extract_options(required_parameters.length, actual_parameters)
-    if actual_parameters.length > required_parameters.length
+  normalize_options: (parts, required_parts, default_options, actual_parameters) ->
+    options = @extract_options(parts.length, actual_parameters)
+
+    if actual_parameters.length > parts.length
       throw new Error("Too many parameters provided for path")
-    options = @merge(defaults.default_url_options, default_parts, options)
+
+    use_all_parts = DeprecatedBehavior or actual_parameters.length > required_parts.length
+    parts_options = {}
+
+    for own key of options
+      use_all_parts = true
+      if @indexOf(parts, key) >= 0
+        parts_options[key] = value
+
+    options = @merge(defaults.default_url_options, default_options, options)
     result = {}
     url_parameters = {}
     result['url_parameters'] = url_parameters
@@ -118,14 +129,19 @@ Utils =
       else
         url_parameters[key] = value
 
-    for value, i in required_parameters when i < actual_parameters.length
-      url_parameters[value] = actual_parameters[i]
+    route_parts = if use_all_parts then parts else required_parts
+    i = 0
+    for part in route_parts when i < actual_parameters.length
+      unless parts_options.hasOwnProperty(part)
+        url_parameters[part] = actual_parameters[i]
+        ++i
+
     result
 
-  build_route: (required_parameters, optional_parts, route, default_parts, full_url, args) ->
+  build_route: (parts, required_parts, default_options, route, full_url, args) ->
     args = Array::slice.call(args)
 
-    options = @normalize_options(default_parts, required_parameters, optional_parts, args)
+    options = @normalize_options(parts, required_parts, default_options, args)
     parameters = options['url_parameters']
 
     # path
@@ -239,9 +255,15 @@ Utils =
   #
   # route function: create route path function and add spec to it
   #
-  route: (required_parts, optional_parts, route_spec, default_parts, full_url) ->
+  route: (parts_table, default_options, route_spec, full_url) ->
+    required_parts = []
+    parts = []
+    for [part, required] in parts_table
+      parts.push(part)
+      required_parts.push(part) if required
+
     path_fn = -> Utils.build_route(
-      required_parts, optional_parts, route_spec, default_parts, full_url, arguments
+      parts, required_parts, default_options, route_spec, full_url, arguments
     )
     path_fn.required_params = required_parts
     path_fn.toString = -> Utils.build_path_spec(route_spec)

data/spec/js_routes/generated_javascript_spec.rb

@@ -25,13 +25,13 @@ describe JsRoutes do
       is_expected.to include("inboxes_path: Utils.route(")
     end
     it "should have correct function without arguments signature" do
-      is_expected.to include("inboxes_path: Utils.route([]")
+      is_expected.to include("inboxes_path: Utils.route([[\"format\",false]]")
     end
     it "should have correct function with arguments signature" do
-      is_expected.to include("inbox_message_path: Utils.route([\"inbox_id\",\"id\"]")
+      is_expected.to include("inbox_message_path: Utils.route([[\"inbox_id\",true],[\"id\",true],[\"format\",false]]")
     end
     it "should have correct function signature with unordered hash" do
-      is_expected.to include("inbox_message_attachment_path: Utils.route([\"inbox_id\",\"message_id\",\"id\"]")
+      is_expected.to include("inbox_message_attachment_path: Utils.route([[\"inbox_id\",true],[\"message_id\",true],[\"id\",true],[\"format\",false]]")
     end
 
     it "should have correct function comment with options argument" do
@@ -77,7 +77,7 @@ describe JsRoutes do
   describe "compiled javascript asset" do
     subject { ERB.new(File.read("app/assets/javascripts/js-routes.js.erb")).result(binding) }
     it "should have js routes code" do
-      is_expected.to include("inbox_message_path: Utils.route([\"inbox_id\",\"id\"]")
+      is_expected.to include("inbox_message_path: Utils.route([[\"inbox_id\",true],[\"id\",true],[\"format\",false]]")
     end
   end
 end

data/spec/js_routes/rails_routes_compatibility_spec.rb

@@ -14,6 +14,17 @@ describe JsRoutes, "compatibility with Rails"  do
     expect(evaljs("Routes.inbox_path(1)")).to eq(routes.inbox_path(1))
   end
 
+  it "should raise error if required argument is not passed" do
+    expect { evaljs("Routes.thing_path()") }
+      .to raise_error('Route parameter missing: id')
+    expect { evaljs("Routes.search_path()") }
+      .to raise_error('Route parameter missing: q')
+    expect { evaljs("Routes.book_path()") }
+      .to raise_error('Route parameter missing: title')
+    expect { evaljs("Routes.book_title_path()") }
+      .to raise_error('Route parameter missing: title')
+  end
+
   it "should support 0 as a member parameter" do
     expect(evaljs("Routes.inbox_path(0)")).to eq(routes.inbox_path(0))
   end
@@ -59,9 +70,6 @@ describe JsRoutes, "compatibility with Rails"  do
     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' && Rails.version <= "5.0.1"
       expect(evaljs("Routes.backend_root_path()")).to eq(routes.backend_root_path)
     end
 
@@ -69,6 +77,10 @@ describe JsRoutes, "compatibility with Rails"  do
       expect(evaljs("Routes.api_purchases_path({format: 'xml'})")).to eq(routes.api_purchases_path(format: 'xml'))
     end
 
+    it "should support default format override by passing it in args" do
+      expect(evaljs("Routes.api_purchases_path('xml')")).to eq(routes.api_purchases_path('xml'))
+    end
+
     it "doesn't apply defaults to path" do
       expect(evaljs("Routes.with_defaults_path()")).to eq(routes.with_defaults_path)
     end
@@ -184,11 +196,10 @@ describe JsRoutes, "compatibility with Rails"  do
     context "but not including them" do
       it "should not include the optional parts" do
         expect(evaljs("Routes.things_path()")).to eq(routes.things_path)
+        expect(evaljs("Routes.things_path({ q: 'hello' })")).to eq(routes.things_path(q: 'hello'))
       end
 
       it "should not require the optional parts as arguments" do
-        #TODO: fix this inconsistence
-        pending
         expect(evaljs("Routes.thing_path(null, 5)")).to eq(routes.thing_path(nil, 5))
       end
 
@@ -196,14 +207,60 @@ describe JsRoutes, "compatibility with Rails"  do
         expect(evaljs("Routes.thing_path(5, {optional_id: undefined})")).to eq(routes.thing_path(5, :optional_id => nil))
       end
 
+      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')
+      end
+
       it "should treat null as non-given optional part" do
         expect(evaljs("Routes.thing_path(5, {optional_id: null})")).to eq(routes.thing_path(5, :optional_id => nil))
       end
+
+      it "should work when passing required params in options" do
+        expect(evaljs("Routes.thing_deep_path({second_required: 1, third_required: 2})")).to eq(routes.thing_deep_path(second_required: 1, third_required: 2))
+      end
+
+      it "should skip leading and trailing optional parts" do
+        skip if Rails.version < '4'
+        expect(evaljs("Routes.thing_deep_path(1, 2)")).to eq(routes.thing_deep_path(1, 2))
+      end
     end
 
     context "and including them" do
+      if Rails.version < '4'
+        it "should fail when insufficient arguments are given" do
+          expect { evaljs("Routes.thing_deep_path(1)")}
+            .to raise_error('Route parameter missing: second_required')
+          expect { evaljs("Routes.thing_deep_path(1,2)")}
+            .to raise_error('Route parameter missing: third_required')
+        end
+      end
+
       it "should include the optional parts" do
         expect(evaljs("Routes.things_path({optional_id: 5})")).to eq(routes.things_path(:optional_id => 5))
+        expect(evaljs("Routes.things_path(5)")).to eq(routes.things_path(5))
+        expect(evaljs("Routes.thing_deep_path(1, { third_required: 3, second_required: 2 })")).to eq(routes.thing_deep_path(1, third_required: 3, second_required: 2))
+        expect(evaljs("Routes.thing_deep_path(1, { third_required: 3, second_required: 2, forth_optional: 4 })")).to eq(routes.thing_deep_path(1, third_required: 3, second_required: 2, forth_optional: 4))
+        expect(evaljs("Routes.thing_deep_path(2, { third_required: 3, first_optional: 1 })")).to eq(routes.thing_deep_path(2, third_required: 3, first_optional: 1))
+        expect(evaljs("Routes.thing_deep_path(3, { first_optional: 1, second_required: 2 })")).to eq(routes.thing_deep_path(3, first_optional: 1, second_required: 2))
+        expect(evaljs("Routes.thing_deep_path(3, { first_optional: 1, second_required: 2, forth_optional: 4 })")).to eq(routes.thing_deep_path(3, first_optional: 1, second_required: 2, forth_optional: 4))
+        expect(evaljs("Routes.thing_deep_path(4, { first_optional: 1, second_required: 2, third_required: 3 })")).to eq(routes.thing_deep_path(4, first_optional: 1, second_required: 2, third_required: 3))
+        expect(evaljs("Routes.thing_deep_path(1, 2, { third_required: 3 })")).to eq(routes.thing_deep_path(1, 2, third_required: 3))
+        expect(evaljs("Routes.thing_deep_path(1,2, {third_required: 3, q: 'bogdan'})")).to eq(routes.thing_deep_path(1,2, {third_required: 3, q: 'bogdan'}))
+        expect(evaljs("Routes.thing_deep_path(1, 2, { forth_optional: 4, third_required: 3 })")).to eq(routes.thing_deep_path(1, 2, forth_optional: 4, third_required: 3))
+        expect(evaljs("Routes.thing_deep_path(1, 3, { second_required: 2 })")).to eq(routes.thing_deep_path(1, 3, second_required: 2))
+        expect(evaljs("Routes.thing_deep_path(1, 4, { second_required: 2, third_required: 3 })")).to eq(routes.thing_deep_path(1, 4, second_required: 2, third_required: 3))
+        expect(evaljs("Routes.thing_deep_path(2, 3, { first_optional: 1 })")).to eq(routes.thing_deep_path(2, 3, first_optional: 1))
+        expect(evaljs("Routes.thing_deep_path(2, 3, { first_optional: 1, forth_optional: 4 })")).to eq(routes.thing_deep_path(2, 3, first_optional: 1, forth_optional: 4))
+        expect(evaljs("Routes.thing_deep_path(2, 4, { first_optional: 1, third_required: 3 })")).to eq(routes.thing_deep_path(2, 4, first_optional: 1, third_required: 3))
+        expect(evaljs("Routes.thing_deep_path(3, 4, { first_optional: 1, second_required: 2 })")).to eq(routes.thing_deep_path(3, 4, first_optional: 1, second_required: 2))
+        expect(evaljs("Routes.thing_deep_path(1, 2, 3)")).to eq(routes.thing_deep_path(1, 2, 3))
+        expect(evaljs("Routes.thing_deep_path(1, 2, 3, { forth_optional: 4 })")).to eq(routes.thing_deep_path(1, 2, 3, forth_optional: 4))
+        expect(evaljs("Routes.thing_deep_path(1, 2, 4, { third_required: 3 })")).to eq(routes.thing_deep_path(1, 2, 4, third_required: 3))
+        expect(evaljs("Routes.thing_deep_path(1, 3, 4, { second_required: 2 })")).to eq(routes.thing_deep_path(1, 3, 4, second_required: 2))
+        expect(evaljs("Routes.thing_deep_path(2, 3, 4, { first_optional: 1 })")).to eq(routes.thing_deep_path(2, 3, 4, first_optional: 1))
+        expect(evaljs("Routes.thing_deep_path(1, 2, 3, 4)")).to eq(routes.thing_deep_path(1, 2, 3, 4))
+
       end
 
       context "on nested optional parts" do
@@ -232,7 +289,7 @@ describe JsRoutes, "compatibility with Rails"  do
 
     it "should throw Exceptions if when there is too many parameters" do
       expect {
-        evaljs("Routes.inbox_path(1,2)")
+        evaljs("Routes.inbox_path(1,2,3)")
       }.to raise_error(js_error_class)
     end
 

data/spec/spec_helper.rb

@@ -104,7 +104,6 @@ RSpec.configure do |config|
           inspectify(v)
         end
       when V8::Object
-        require 'byebug'; byebug
         value.to_h.map do |k,v|
           [k, inspectify(v)]
         end.to_h

data/spec/support/routes.rb

@@ -29,6 +29,9 @@ def draw_routes
       resources :things
     end
 
+    get "(/sep1/:first_optional)/sep2/:second_required/sep3/:third_required(/:forth_optional)",
+      as: :thing_deep, controller: :things, action: :show
+
     if Rails.version < "5.0.0"
       get "/:controller(/:action(/:id))" => "classic#classic", :as => :classic
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2017-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: therubyracer
   requirement: !ruby/object:Gem::Requirement
@@ -188,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Brings Rails named routes to javascript