js-routes 0.2.0 → 0.3.0

data/Readme.md

@@ -14,11 +14,29 @@ Your application initializer, like `config/initializers/jsroutes.rb`:
 
 ``` ruby
 JsRoutes.generate!(
-    :file => "#{Rails.root}app/assets/javascripts/routes.js",  # This is default
-    :default_format => "json"                         # Default is blank
+    :file => "#{Rails.root}app/assets/javascripts/routes.js",
+    :default_format => "json",
+    :exclude => [/^admin_/, /paypal/, /^api_/]
 )
 ```
 
+Available options:
+
+* `:file` - the file to generate the routes. Default: 
+  * `#{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: []
+  * 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:
+
+``` ruby
+JsRoutes.generate(options)
+```
+
 ### Usage
 
 This will create a nice javascript file with `Routes` object that has all the rails routes available:
@@ -26,7 +44,7 @@ This will create a nice javascript file with `Routes` object that has all the ra
 ``` js
 Routes.users_path() // => "/users"
 Routes.user_path(1, {format: 'json'}) // => "/users/1.json"
-Routes.urer_project_path(1,2, {q: 'hello', custom: true}) // => "/users/1/projects/2?q=hello&custom=true"
+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.2.0
+0.3.0

data/{jsroutes.gemspec → js-routes.gemspec}

@@ -4,8 +4,8 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{jsroutes}
-  s.version = "0.2.0"
+  s.name = %q{js-routes}
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
     "Rakefile",
     "Readme.md",
     "VERSION",
-    "jsroutes.gemspec",
+    "js-routes.gemspec",
     "lib/js_routes.rb",
     "lib/jsroutes.rb",
     "lib/routes.js",
@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
     "spec/js_routes_spec.rb",
     "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/bogdan/jsroutes}
+  s.homepage = %q{http://github.com/railsware/js-routes}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
@@ -43,14 +43,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rails>, [">= 0"])
+      s.add_runtime_dependency(%q<rails>, [">= 3.0"])
       s.add_development_dependency(%q<therubyracer>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
-      s.add_dependency(%q<rails>, [">= 0"])
+      s.add_dependency(%q<rails>, [">= 3.0"])
       s.add_dependency(%q<therubyracer>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
@@ -58,7 +58,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rails>, [">= 0"])
+    s.add_dependency(%q<rails>, [">= 3.0"])
     s.add_dependency(%q<therubyracer>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.3.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])

data/lib/js_routes.rb

@@ -4,7 +4,9 @@ module JsRoutes
 
     def generate(options = {})
       js = File.read(File.dirname(__FILE__) + "/routes.js")
-      js.gsub!("IDENTITY", js_routes(options))
+      options[:namespace] ||= "Routes"
+      js.gsub!("NAMESPACE", options[:namespace])
+      js.gsub!("ROUTES", js_routes(options))
     end
 
     def generate!(options = {})
@@ -22,10 +24,20 @@ module JsRoutes
     def js_routes(options = {})
 
       options[:default_format] ||= ""
+      exclude = Array(options[:exclude])
 
       Rails.application.reload_routes!
       Rails.application.routes.named_routes.routes.map do |name, route|
-        <<-JS
+        if exclude.find {|e| name.to_s =~ e}
+          ""
+        else
+          build_js(name, route, options)
+        end
+      end.join("\n")
+    end
+
+    def build_js(name, route, options)
+      _ = <<-JS
   // #{route.name} => #{route.path}
   #{name.to_s}_path: function(#{build_params route}) {
     var opts = options || {};
@@ -35,7 +47,6 @@ module JsRoutes
     return Routes.check_path('#{build_path route}' + format) + Routes.serialize(opts);
   },
 JS
-      end.join("\n")
     end
 
 

data/lib/routes.js

@@ -1,29 +1,34 @@
-var Routes = {
+(function(){
 
-  IDENTITY
+  var Routes = {
 
-  serialize: function(obj){
-    if (obj == null) {return '';}
-    var s = [];
-    for (prop in obj){
-      s.push(prop + "=" + obj[prop]);
-    }
-    if (s.length == 0) {
-      return '';
-    }
-    return "?" + s.join('&');
-  },
+    ROUTES
+
+    serialize: function(obj){
+      if (obj == null) {return '';}
+      var s = [];
+      for (prop in obj){
+        s.push(prop + "=" + obj[prop]);
+      }
+      if (s.length == 0) {
+        return '';
+      }
+      return "?" + s.join('&');
+    },
 
 
-  check_parameter: function(param) {
-    if (param === undefined) {
-      param = '';
+    check_parameter: function(param) {
+      if (param === undefined) {
+        param = '';
+      }
+      return param;
+    },
+
+    check_path: function(path) {
+      return path.replace(/\.$/m, '');
     }
-    return param;
-  },
-  
-  check_path: function(path) {
-    return path.replace(/\.$/m, '');
-  }
-
-}
+
+  };
+
+  window.NAMESPACE = Routes;
+})();

data/spec/js_routes_spec.rb

@@ -5,45 +5,64 @@ require "fileutils"
 
 describe JsRoutes do
   before(:each) do
+    Rails.application.stub!(:reload_routes!).and_return(true)
+    evaljs("var window = {};")
     evaljs(JsRoutes.generate(_options))
   end
 
   let(:_options) { {} }
 
   it "should generate collection routing" do
-    evaljs("Routes.inboxes_path()").should == "/inboxes"
+    evaljs("window.Routes.inboxes_path()").should == "/inboxes"
   end
 
   it "should generate member routing" do
-    evaljs("Routes.inbox_path(1)").should == "/inboxes/1"
+    evaljs("window.Routes.inbox_path(1)").should == "/inboxes/1"
   end
 
   it "should generate nested routing" do
-    evaljs("Routes.inbox_message_path(1,2)").should == "/inboxes/1/messages/2"
+    evaljs("window.Routes.inbox_message_path(1,2)").should == "/inboxes/1/messages/2"
   end
 
   it "should generate routing with format" do
-    evaljs("Routes.inbox_path(1, {format: 'json'})").should == "/inboxes/1.json"
+    evaljs("window.Routes.inbox_path(1, {format: 'json'})").should == "/inboxes/1.json"
   end
 
   it "should support get parameters" do
-    evaljs("Routes.inbox_path(1, {format: 'json', q: 'hello', lang: 'ua'})").should == "/inboxes/1.json?q=hello&lang=ua"
+    evaljs("window.Routes.inbox_path(1, {format: 'json', q: 'hello', lang: 'ua'})").should == "/inboxes/1.json?q=hello&lang=ua"
   end
 
+  context "when exclude is specified" do
+    
+    let(:_options) { {:exclude => /^admin_/} }
+
+    it "should exclude specified routes from file" do
+      evaljs("window.Routes.admin_users_path").should be_nil
+    end
+  end
 
   context "when default_format is specified" do
     let(:_options) { {:default_format => "json"} }
     
     it "should render routing with default_format" do
-      evaljs("Routes.inbox_path(1)").should == "/inboxes/1.json"
+      evaljs("window.Routes.inbox_path(1)").should == "/inboxes/1.json"
     end
 
     it "should override default_format implicitly" do
-      evaljs("Routes.inbox_path(1, {format: 'xml'})").should == "/inboxes/1.xml"
+      evaljs("window.Routes.inbox_path(1, {format: 'xml'})").should == "/inboxes/1.xml"
     end
 
   end
 
+  context "when namspace option is specified" do
+    let(:_options) { {:namespace => "PHM"} }
+    it "should use this name space for routing" do
+      evaljs("window.Routes").should be_nil
+      evaljs("window.PHM.inbox_path").should_not be_nil
+    end
+    
+  end
+
   describe ".generate!" do
     let(:name) {  "#{File.dirname(__FILE__)}/../routes.js" }
     it "should generate routes file" do

data/spec/spec_helper.rb

@@ -11,16 +11,20 @@ def evaljs(string)
   @context.eval(string)
 end
 
+
 class App < Rails::Application
   self.routes.draw do 
     resources :inboxes do
       resources :messages
     end
+
+    namespace :admin do
+      resources :users
+    end
   end
 end
 
 
-
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: js-routes
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Bogdan Gusiev
@@ -126,7 +126,7 @@ files:
 - Rakefile
 - Readme.md
 - VERSION
-- jsroutes.gemspec
+- js-routes.gemspec
 - lib/js_routes.rb
 - lib/jsroutes.rb
 - lib/routes.js