js-routes 0.4.0 → 0.6.0

data/Readme.md

@@ -13,11 +13,9 @@ gem "js-routes"
 Your application initializer, like `config/initializers/jsroutes.rb`:
 
 ``` ruby
-JsRoutes.generate!(
-    :file => "#{Rails.root}app/assets/javascripts/routes.js",
-    :default_format => "json",
-    :exclude => [/^admin_/, /paypal/, /^api_/]
-)
+JsRoutes.generate!({
+ #options
+})
 ```
 
 Available options:
@@ -31,7 +29,7 @@ Available options:
 * `:include` - Array of regexps to include in js routes. Default: []
   * Note that regexp applied to **named route** not to *URL*
 * `:namespace` - global object used to access routes. Default: `Routes`
-  * Possible variants: `MyProject.routes`, `MyProjectRoutes`
+  * Supports nested namespace like `MyProject.routes`
 
 Example options usage:
 
@@ -40,16 +38,16 @@ JsRoutes.generate!(:file => "#{path}/app_routes.js", :namespace => "AppRoutes",
 JsRoutes.generate!(:file => "#{path}/adm_routes.js", :namespace => "AdmRoutes", :include => /^admin_/, :default_format => "json")
 ```
 
-In order to generate routes to string and manipulate them yourself use `JsRoutes.generate`:
+In order to generate routes to string and manipulate them yourself use:
 Like:
 
 ``` ruby
-JsRoutes.generate(options)
+routes_js = JsRoutes.generate(options)
 ```
 
 ### Usage
 
-This will create a nice javascript file with `Routes` object that has all the rails routes available:
+Configuration above will create a nice javascript file with `Routes` object that has all the rails routes available:
 
 ``` js
 Routes.users_path() // => "/users"
@@ -57,13 +55,30 @@ Routes.user_path(1) // => "/users/1"
 Routes.user_path(1, {format: 'json'}) // => "/users/1.json"
 Routes.new_user_project_path(1, {format: 'json'}) // => "/users/1/projects/new.json"
 Routes.user_project_path(1,2, {q: 'hello', custom: true}) // => "/users/1/projects/2?q=hello&custom=true"
+```
+
+Using serialized object as route function arguments:
 
+``` js
+var google = {id: 1, name: "Google"};
+Routes.company_path(google) // => "/companies/1"
+var google = {id: 1, name: "Google", to_param: "google"};
+Routes.company_path(google) // => "/companies/google"
 ```
 
 In order to make routes helpers available globally:
 
 ``` js
-$.extend(window, Routes)
+jQuery.extend(window, Routes)
 ```
 
+### Alternative
+
+There are some alternatives available. Advantages of this one are:
+
+* Rails3 support
+* Rich options set
+* Support Rails `#to_param` convention for seo optimized paths
+* Well tested
+
 #### Have fun 

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.6.0

data/js-routes.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{js-routes}
-  s.version = "0.4.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
-  s.date = %q{2011-08-18}
+  s.date = %q{2011-08-22}
   s.description = %q{Generates javascript file that defines all Rails named routes as javascript helpers}
   s.email = %q{agresso@gmail.com}
   s.extra_rdoc_files = [

data/lib/js_routes.rb

@@ -46,24 +46,28 @@ module JsRoutes
     end
 
     def build_js(route, options)
+      params = build_params route
       _ = <<-JS.strip!
   // #{route.name} => #{route.path}
-  #{route.name}_path: function(#{build_params route}) {
-  return Utils.build_path(#{path_parts(route).inspect}, arguments)
+  #{route.name}_path: function(#{params.<<("options").join(", ")}) {
+  return Utils.build_path(#{params.size}, #{path_parts(route).inspect}, arguments)
   }
 JS
     end
 
 
     def build_params route
-      route.conditions[:path_info].named_captures.map do |cap|
+      route.conditions[:path_info].named_captures.to_a.sort do |cap1, cap2|
+        # Hash is not ordered in Ruby 1.8.7
+        cap1.last.first <=> cap2.last.first
+      end.map do |cap|
         name = cap.first
         if !(name.to_s == "format")
           # prepending each parameter name with underscore
           # to prevent conflict with JS reserved words
           "_" + name.to_s.gsub(/^:/, '')
         end
-      end.compact.<<("options").join(', ')
+      end.compact
     end
 
 

data/lib/routes.js

@@ -26,18 +26,33 @@
       return format ? "." + format : "";
     },
 
-    extract_options: function(args) {
-      return typeof(args[args.length-1]) == "object" ?  args.pop() : {};
+    extract_options: function(number_of_params, args) {
+      if (args.length >= number_of_params) {
+        return typeof(args[args.length-1]) == "object" ?  args.pop() : {};
+      } else {
+        return {};
+      }
+    },
+
+    path_identifier: function(object) {
+      if (!object) {
+        return "";
+      }
+      if (typeof(object) == "object") {
+        return (object.to_param || object.id).toString();
+      } else {
+        return object.toString();
+      }
     },
 
-    build_path: function(parts, args) {
+    build_path: function(number_of_params, parts, args) {
       args = Array.prototype.slice.call(args);
       result = "";
-      var opts = Utils.extract_options(args);
+      var opts = Utils.extract_options(number_of_params, args);
       for (var i=0; i < parts.length; i++) {
         part = parts[i];
         result += part;
-        result += args.shift() || "";
+        result += Utils.path_identifier(args.shift());
       }
       var format = Utils.extract_format(opts);
       return Utils.clean_path(result + format) + Utils.serialize(opts);

data/spec/js_routes_spec.rb

@@ -103,11 +103,31 @@ describe JsRoutes do
     
   end
 
+  context "when arguments are objects" do
+    it "should use id property of the object" do
+      evaljs("Routes.inbox_path({id: 1})").should == "/inboxes/1"
+    end
+
+    it "should use prefer to_param property over id property" do
+      evaljs("Routes.inbox_path({id: 1, to_param: 'my'})").should == "/inboxes/my"
+    end
+
+    it "should support still support options argument" do
+      evaljs("Routes.inbox_message_path({id:1, to_param: 'my'}, {id:2}, {custom: true, format: 'json'})").should == "/inboxes/my/messages/2.json?custom=true"
+    end
+  end
+
   describe "generated js" do
     subject { JsRoutes.generate }
-    it "should have correct function signature" do
+    it "should have correct function without arguments signature" do
+      subject.should include("inboxes_path: function(options)")
+    end
+    it "should have correct function with arguments signature" do
       subject.should include("inbox_message_path: function(_inbox_id, _id, options)")
     end
+    it "should have correct function signature with Ruby 1.8.7 and unordered hash" do
+      subject.should include("inbox_message_attachment_path: function(_inbox_id, _message_id, _id, options)")
+    end
   end
 
   describe ".generate!" do

data/spec/spec_helper.rb

@@ -15,7 +15,9 @@ end
 class App < Rails::Application
   self.routes.draw do 
     resources :inboxes do
-      resources :messages
+      resources :messages do
+        resources :attachments
+      end
     end
 
     namespace :admin do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: js-routes
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 6
   - 0
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Bogdan Gusiev
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-18 00:00:00 +03:00
+date: 2011-08-22 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency