js-routes 0.3.1 → 0.4.0

data/Readme.md

@@ -26,12 +26,22 @@ Available options:
   * `#{Rails.root}/app/assets/javascripts/routes.js` for Rails >= 3.1
   * `#{Rails.root}/public/javascripts/routes.js` for Rails < 3.1
 * `:default_format` - Format to append to urls. Default: blank
-* `:exclude` - Array of regexps to exclude form js routes. Default: []
+* `:exclude` - Array of regexps to exclude from js routes. Default: []
+  * Note that regexp applied to **named route** not to *URL*
+* `: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`
 
-In order to generate routes to string and manipulate them yourself:
+Example options usage:
+
+``` ruby
+JsRoutes.generate!(:file => "#{path}/app_routes.js", :namespace => "AppRoutes", :exclude => /^admin_/, :default_format => "json")
+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`:
+Like:
 
 ``` ruby
 JsRoutes.generate(options)
@@ -43,8 +53,11 @@ This will create a nice javascript file with `Routes` object that has all the ra
 
 ``` js
 Routes.users_path() // => "/users"
+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"
+
 ```
 
 In order to make routes helpers available globally:

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/js-routes.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{js-routes}
-  s.version = "0.3.1"
+  s.version = "0.4.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-07}
+  s.date = %q{2011-08-18}
   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

@@ -25,64 +25,53 @@ module JsRoutes
     def js_routes(options = {})
 
       options[:default_format] ||= ""
-      exclude = Array(options[:exclude])
+      excludes = options[:exclude] || []
+      includes = options[:include] || //
 
       Rails.application.reload_routes!
-      Rails.application.routes.named_routes.routes.map do |_, route|
-        if exclude.find {|e| route.name =~ e}
+      js_routes = Rails.application.routes.named_routes.routes.map do |_, route|
+        if any_match?(route, excludes) || !any_match?(route, includes)
           nil
         else
           build_js(route, options)
         end
-      end.compact.join(",\n")
+      end.compact
+      
+      "{\n" + js_routes.join(",\n") + "}\n"
+    end
+
+    def any_match?(route, matchers)
+      matchers = Array(matchers)
+      matchers.any? {|regex| route.name =~ regex}
     end
 
     def build_js(route, options)
       _ = <<-JS.strip!
   // #{route.name} => #{route.path}
   #{route.name}_path: function(#{build_params route}) {
-    var opts = options || {};
-    var format = Utils.extract_format(opts);
-  #{build_default_params route};
-    return Utils.check_path('#{build_path route}' + format) + Utils.serialize(opts);
+  return Utils.build_path(#{path_parts(route).inspect}, arguments)
   }
 JS
     end
 
 
     def build_params route
-      route.conditions[:path_info].captures.map do |cap|
-        if cap.is_a?(Rack::Mount::GeneratableRegexp::DynamicSegment) && !(cap.name.to_s == "format")
-          cap.name.to_s.gsub(':', '')
+      route.conditions[:path_info].named_captures.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
 
-    def build_default_params route
-      route.conditions[:path_info].captures.map do |cap|
-        if cap.is_a?(Rack::Mount::GeneratableRegexp::DynamicSegment)
-          segg = cap.name.to_s.gsub(':', '')
-          "#{segg} = Utils.check_parameter(#{segg});"
-        end
-      end.join("\n")
-    end
-
-    def build_path route
-      s = route.path.gsub(/\(\.:format\)$/, ".")
-
-      route.conditions[:path_info].captures.each do |cap|
-        unless cap.name.to_s == "format"
-          if route.conditions[:path_info].required_params.include?(cap.name)
-            s.gsub!(/:#{cap.name.to_s}/){ "' + #{cap.name.to_s.gsub(':','')} + '" }
-          else
-            s.gsub!(/\((\.)?:#{cap.name.to_s}\)/){ "#{$1}' + #{cap.name.to_s.gsub(':','')} + '" }
-          end
-        end
-      end
-      s
 
+    def path_parts route
+      route.path.gsub(/\(\.:format\)$/, "").split(/:[a-z\-_]+/)
     end
 
+
     def default_file
       if Rails.version >= "3.1"
         "#{Rails.root}/app/assets/javascripts/routes.js"

data/lib/routes.js

@@ -5,37 +5,45 @@
     default_format: 'DEFAULT_FORMAT',
 
     serialize: function(obj){
-      if (obj == null) {return '';}
+      if (obj === null) {return '';}
       var s = [];
       for (prop in obj){
         s.push(prop + "=" + obj[prop]);
       }
-      if (s.length == 0) {
+      if (s.length === 0) {
         return '';
       }
       return "?" + s.join('&');
     },
 
-
-    check_parameter: function(param) {
-      if (param === undefined) {
-        param = '';
-      }
-      return param;
-    },
-
-    check_path: function(path) {
-      return path.replace(/\.$/m, '');
+    clean_path: function(path) {
+      return path.replace(/\.$/m, '').replace(/\/$/m, '');
     },
 
     extract_format: function(options) {
       var format =  options.hasOwnProperty("format") ? options.format : Utils.default_format;
       delete options.format;
-      return format || "";
+      return format ? "." + format : "";
+    },
+
+    extract_options: function(args) {
+      return typeof(args[args.length-1]) == "object" ?  args.pop() : {};
+    },
+
+    build_path: function(parts, args) {
+      args = Array.prototype.slice.call(args);
+      result = "";
+      var opts = Utils.extract_options(args);
+      for (var i=0; i < parts.length; i++) {
+        part = parts[i];
+        result += part;
+        result += args.shift() || "";
+      }
+      var format = Utils.extract_format(opts);
+      return Utils.clean_path(result + format) + Utils.serialize(opts);
     }
   };
 
-  window.NAMESPACE = {
-    ROUTES
-  };
+  window.NAMESPACE = ROUTES;
+
 })();

data/spec/js_routes_spec.rb

@@ -21,6 +21,10 @@ describe JsRoutes do
     evaljs("Routes.inbox_path(1)").should == "/inboxes/1"
   end
 
+  it "should generate nested routing with one parameter" do
+    evaljs("Routes.inbox_message_path(1)").should == "/inboxes/1/messages"
+  end
+
   it "should generate nested routing" do
     evaljs("Routes.inbox_message_path(1,2)").should == "/inboxes/1/messages/2"
   end
@@ -33,6 +37,13 @@ describe JsRoutes do
     evaljs("Routes.inbox_path(1, {format: 'json', q: 'hello', lang: 'ua'})").should == "/inboxes/1.json?q=hello&lang=ua"
   end
 
+  it "should support routes with reserved javascript words as parameters" do
+    #TODO: this doesn't actually test what it should test 
+    #because the parameter name is return_id
+    #need to find the real way to test
+    evaljs("Routes.return_path(1)").should == "/returns/1"
+  end
+
   context "when exclude is specified" do
     
     let(:_options) { {:exclude => /^admin_/} }
@@ -45,6 +56,18 @@ describe JsRoutes do
       evaljs("Routes.inboxes_path()").should_not be_nil
     end
   end
+  context "when include is specified" do
+    
+    let(:_options) { {:include => /^admin_/} }
+
+    it "should exclude specified routes from file" do
+      evaljs("Routes.admin_users_path()").should_not be_nil
+    end
+
+    it "should not exclude routes not under specified pattern" do
+      evaljs("Routes.inboxes_path").should be_nil
+    end
+  end
 
   context "when default_format is specified" do
     let(:_options) { {:default_format => "json"} }
@@ -80,6 +103,13 @@ describe JsRoutes do
     
   end
 
+  describe "generated js" do
+    subject { JsRoutes.generate }
+    it "should have correct function signature" do
+      subject.should include("inbox_message_path: function(_inbox_id, _id, options)")
+    end
+  end
+
   describe ".generate!" do
     let(:name) {  "#{File.dirname(__FILE__)}/../routes.js" }
     it "should generate routes file" do

data/spec/spec_helper.rb

@@ -21,6 +21,8 @@ class App < Rails::Application
     namespace :admin do
       resources :users
     end
+
+    resources :returns
   end
 end
 

metadata

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