js-routes 1.2.9 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33fffcaa3c5d7614a35673b8a53ea0f06030dbed
-  data.tar.gz: b8c5ffa5eb34114667b2d8e3f53dec2809816f2e
+  metadata.gz: 1b2b15773ea1f4c5fd8870ccda544a7386e28108
+  data.tar.gz: ffd6b967fd16e89a1d976098da3fa00109924319
 SHA512:
-  metadata.gz: 989c63812f7821d21fc94b0bd42f43e87be6a933a2f934733a8f30f3b575f566cb43619a3ca64b49e39ec1dc91ea633ab5337f5be133804aa995756e252cc27f
-  data.tar.gz: 880139c994a2f813b4e0c65d16f281626252462010a08f68e4ef234f3743cab1ae141041fb3cb60f4bdc04fe5d2803dbb22694cc08cf1604e5da692bc3f6e6ef
+  metadata.gz: 6e5b2c94c2c60924ab690669b61c95075e7bcc3ef576cd8284ee1a7d30aa63427a8826079eece47629cfe31bcafbde00ee63bae5b9f0d39f91a505ae4561c2f6
+  data.tar.gz: 69f1daf6f674da744d13dd6440af0a70399cfdfe3ecd29a3203c6ec9447e5367baaad19b998c85403c982cfbc6dc04e61f16a55ce796f493c47d69a43932265f

data/Readme.md

@@ -71,6 +71,10 @@ Available options:
   * Example: `jQuery.param` - use jQuery's serializer algorithm. You can attach serialize function from your favorite AJAX framework.
   * Example: `MyApp.custom_serialize` - use completely custom serializer of your application.
 
+* `special_options_key` - a special key that helps js-routes to destinguish serialized model from options hash
+  * This options is required because JS doesn't provide a difference between an object and a hash
+  * Default: `_options`
+
 ### Very Advanced Setup
 
 In case you need multiple route files for different parts of your application, you have to create the files manually.
@@ -168,6 +172,22 @@ Routes.users_path.required_params // => []
 Routes.user_path.required_params // => ['id']
 ```
 
+
+## Rails Compatibilities
+
+JsRoutes ties to be as close as possible to rails behaviour in all aspects of routing API.
+Please make and issue in case of any incomtibilities found outside of described below.
+
+### Object and Hash distinction issue
+
+Sometimes the destinction between JS Hash and Object can not be found by js-routes.
+In this case you would need to pass a special key to help:
+
+``` js
+Routes.company_project_path({company_id: 1, id: 2, _options: true}) // => "/companies/1/projects/2"
+```
+
+
 ## What about security?
 
 js-routes itself do not have security holes. It makes URLs

data/lib/js_routes.rb

@@ -20,7 +20,8 @@ class JsRoutes
     camel_case: false,
     default_url_options: {},
     compact: false,
-    serializer: nil
+    serializer: nil,
+    special_options_key: "_options",
   }
 
   NODE_TYPES = {
@@ -107,8 +108,9 @@ class JsRoutes
       "DEFAULT_URL_OPTIONS" => json(@options[:default_url_options].merge(deprecate_url_options)),
       "PREFIX"              => @options[:prefix] || Rails.application.config.relative_url_root || "",
       "NODE_TYPES"          => json(NODE_TYPES),
-      "SERIALIZER"          => @options[:serializer] || "null",
+      "SERIALIZER"          => @options[:serializer] || json(nil),
       "ROUTES"              => js_routes,
+      "SPECIAL_OPTIONS_KEY" => @options[:special_options_key].to_s
     }.inject(File.read(File.dirname(__FILE__) + "/routes.js")) do |js, (key, value)|
       js.gsub!(key, value)
     end

data/lib/js_routes/version.rb

@@ -1,3 +1,3 @@
 class JsRoutes
-  VERSION = "1.2.9"
+  VERSION = "1.3.0"
 end

data/lib/routes.js

@@ -4,7 +4,7 @@ Based on Rails routes of APP_CLASS
  */
 
 (function() {
-  var NodeTypes, ParameterMissing, ReservedOptions, Utils, createGlobalJsRoutesObject, defaults, root,
+  var NodeTypes, ParameterMissing, ReservedOptions, SpecialOptionsKey, Utils, createGlobalJsRoutesObject, defaults, root,
     hasProp = {}.hasOwnProperty,
     slice = [].slice;
 
@@ -23,6 +23,8 @@ Based on Rails routes of APP_CLASS
 
   NodeTypes = NODE_TYPES;
 
+  SpecialOptionsKey = "SPECIAL_OPTIONS_KEY";
+
   ReservedOptions = ['anchor', 'trailing_slash', 'host', 'port', 'protocol'];
 
   Utils = {
@@ -86,16 +88,18 @@ Based on Rails routes of APP_CLASS
       return path.join("://");
     },
     extract_options: function(number_of_params, args) {
-      var last_el;
+      var last_el, options;
       last_el = args[args.length - 1];
       if ((args.length > number_of_params && last_el === void 0) || ((last_el != null) && "object" === this.get_object_type(last_el) && !this.looks_like_serialized_model(last_el))) {
-        return args.pop() || {};
+        options = args.pop() || {};
+        delete options[SpecialOptionsKey];
+        return options;
       } else {
         return {};
       }
     },
     looks_like_serialized_model: function(object) {
-      return "id" in object || "to_param" in object;
+      return !object[SpecialOptionsKey] && ("id" in object || "to_param" in object);
     },
     path_identifier: function(object) {
       var property;

data/lib/routes.js.coffee

@@ -12,6 +12,7 @@ defaults =
   default_url_options: DEFAULT_URL_OPTIONS
 
 NodeTypes = NODE_TYPES
+SpecialOptionsKey = "SPECIAL_OPTIONS_KEY"
 
 ReservedOptions = [
   'anchor'
@@ -64,13 +65,14 @@ Utils =
   extract_options: (number_of_params, args) ->
     last_el = args[args.length - 1]
     if (args.length > number_of_params and last_el == undefined) or(last_el? and "object" is @get_object_type(last_el) and !@looks_like_serialized_model(last_el))
-      args.pop() || {}
+      options = args.pop() || {}
+      delete options[SpecialOptionsKey]
+      options
     else
       {}
 
   looks_like_serialized_model: (object) ->
-    # consider object a model if it have a path identifier properties like id and to_param
-    "id" of object or "to_param" of object
+    !object[SpecialOptionsKey] and ("id" of object or "to_param" of object)
 
 
   path_identifier: (object) ->

data/spec/js_routes/options_spec.rb

@@ -476,4 +476,14 @@ describe JsRoutes, "options" do
       end
     end
   end
+
+  describe "special_options_key" do
+    let(:_options) { { special_options_key: :__options__ } }
+    it "can be redefined" do
+      expect {
+        expect(evaljs("Routes.inbox_message_path({inbox_id: 1, id: 2, _options: true})")).to eq("")
+      }.to raise_error(js_error_class)
+      expect(evaljs("Routes.inbox_message_path({inbox_id: 1, id: 2, __options__: true})")).to eq(routes.inbox_message_path(inbox_id: 1, id: 2))
+    end
+  end
 end

data/spec/js_routes/rails_routes_compatibility_spec.rb

@@ -18,14 +18,6 @@ describe JsRoutes, "compatibility with Rails"  do
     expect(evaljs("Routes.inbox_path(0)")).to eq(routes.inbox_path(0))
   end
 
-  it "should support 0 as a to_param option" do
-    expect(evaljs("Routes.inbox_path({to_param: 0})")).to eq(routes.inbox_path(0))
-  end
-
-  it "should support 0 as an id option" do
-    expect(evaljs("Routes.inbox_path({id: 0})")).to eq(routes.inbox_path(0))
-  end
-
   it "should generate nested routing with one parameter" do
     expect(evaljs("Routes.inbox_messages_path(1)")).to eq(routes.inbox_messages_path(1))
   end
@@ -253,7 +245,27 @@ describe JsRoutes, "compatibility with Rails"  do
 
   context "when arguments are objects" do
 
-    let(:inbox) {Struct.new(:id, :to_param).new(1,"my")}
+    let(:klass) { Struct.new(:id, :to_param) }
+    let(:inbox) { klass.new(1,"my") }
+
+    it "should support 0 as a to_param option" do
+      expect(evaljs("Routes.inbox_path({to_param: 0})")).to eq(routes.inbox_path(0))
+    end
+
+    it "should check for options special key" do
+      expect(evaljs("Routes.inbox_path({id: 7, q: 'hello', _options: true})")).to eq(routes.inbox_path(id: 7, q: 'hello'))
+      expect {
+        evaljs("Routes.inbox_path({to_param: 7, _options: true})")
+      }.to raise_error(js_error_class)
+      expect(evaljs("Routes.inbox_message_path(5, {id: 7, q: 'hello', _options: true})")).to eq(routes.inbox_message_path(5, id: 7, q: 'hello'))
+    end
+
+    it "should check for options special key" do
+    end
+
+    it "should support 0 as an id option" do
+      expect(evaljs("Routes.inbox_path({id: 0})")).to eq(routes.inbox_path(0))
+    end
 
     it "should use id property of the object in path" do
       expect(evaljs("Routes.inbox_path({id: 1})")).to eq(routes.inbox_path(1))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 1.2.9
+  version: 1.3.0
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2016-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties