js-routes 0.8.0 → 0.8.1

data/Gemfile

@@ -5,7 +5,6 @@ gem "rails", ">= 3.2"
 group :development do
   gem "therubyracer"
   gem "rspec", "~> 2.7.0"
-  gem "bundler", "~> 1.0.0"
+  gem "bundler", "~> 1.1.0"
   gem "jeweler", "~> 1.6.2"
-  gem "rcov", ">= 0"
 end

data/Gemfile.lock

@@ -72,7 +72,6 @@ GEM
       rdoc (~> 3.4)
       thor (~> 0.14.6)
     rake (0.9.2)
-    rcov (0.9.9)
     rdoc (3.12)
       json (~> 1.4)
     rspec (2.7.0)
@@ -87,7 +86,7 @@ GEM
       hike (~> 1.2)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    therubyracer (0.9.9)
+    therubyracer (0.9.10)
       libv8 (~> 3.3.10)
     thor (0.14.6)
     tilt (1.3.3)
@@ -100,9 +99,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
+  bundler (~> 1.1.0)
   jeweler (~> 1.6.2)
   rails (>= 3.2)
-  rcov
   rspec (~> 2.7.0)
   therubyracer

data/Readme.md

@@ -25,7 +25,7 @@ Require js routes file in `application.js` or other bundle
 ``` ruby
 JsRoutes.setup do |config|
   config.option = value
-})
+end
 ```
 
 Available options:

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.8.1

data/js-routes.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "js-routes"
-  s.version = "0.8.0"
+  s.version = "0.8.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
-  s.date = "2012-03-02"
+  s.date = "2012-05-04"
   s.description = "Generates javascript file that defines all Rails named routes as javascript helpers"
   s.email = "agresso@gmail.com"
   s.extra_rdoc_files = [
@@ -39,7 +39,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/railsware/js-routes"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.11"
   s.summary = "Brings Rails named routes to javascript"
 
   if s.respond_to? :specification_version then
@@ -49,24 +49,21 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<rails>, [">= 3.2"])
       s.add_development_dependency(%q<therubyracer>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.7.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<rails>, [">= 3.2"])
       s.add_dependency(%q<therubyracer>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.7.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
-      s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
     s.add_dependency(%q<rails>, [">= 3.2"])
     s.add_dependency(%q<therubyracer>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.7.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
-    s.add_dependency(%q<rcov>, [">= 0"])
   end
 end
 

data/lib/js_routes.rb

@@ -52,7 +52,7 @@ class JsRoutes
       new(opts).generate
     end
 
-    def generate!(file_name, opts = {})
+    def generate!(file_name=nil, opts = {})
       if file_name.is_a?(Hash)
         opts = file_name
         file_name = opts[:file]
@@ -64,7 +64,7 @@ class JsRoutes
     # full environment will be available during asset compilation.
     # This is required to ensure routes are loaded.
     def assert_usable_configuration!
-      unless Rails.application.config.assets.initialize_on_precompile 
+      unless Rails.application.config.assets.initialize_on_precompile
         raise("Cannot precompile js-routes unless environment is initialized. Please set config.assets.initialize_on_precompile to true.")
       end
       true
@@ -92,11 +92,12 @@ class JsRoutes
     js.gsub!("ROUTES", js_routes)
   end
 
-  def generate!(file_name)
+  def generate!(file_name = nil)
     # Some libraries like Devise do not yet loaded their routes so we will wait
     # until initialization process finish
     # https://github.com/railsware/js-routes/issues/7
     Rails.configuration.after_initialize do
+      file_name ||= self.class.options['file']
       File.open(Rails.root.join(file_name || DEFAULT_PATH), 'w') do |f|
         f.write generate
       end
@@ -108,26 +109,38 @@ class JsRoutes
   def js_routes
     Rails.application.reload_routes!
     js_routes = Rails.application.routes.named_routes.routes.map do |_, route|
-      if any_match?(route, @options[:exclude]) || !any_match?(route, @options[:include])
-        nil
+      if route.app.respond_to?(:superclass) && route.app.superclass == Rails::Engine
+        route.app.routes.named_routes.map do |_, engine_route|
+          build_route_if_match(engine_route, route)
+        end
       else
-        build_js(route)
+        build_route_if_match(route)
       end
-    end.compact
+    end.flatten.compact
 
     "{\n" + js_routes.join(",\n") + "}\n"
   end
 
-  def any_match?(route, matchers)
+  def build_route_if_match(route, parent_route=nil)
+    if any_match?(route, parent_route, @options[:exclude]) || !any_match?(route, parent_route, @options[:include])
+       nil
+     else
+       build_js(route, parent_route)
+     end
+  end
+
+  def any_match?(route, parent_route, matchers)
     matchers = Array(matchers)
-    matchers.any? {|regex| route.name =~ regex}
+    matchers.any? {|regex| [parent_route.try(:name), route.name].compact.join('') =~ regex}
   end
 
-  def build_js(route)
+  def build_js(route, parent_route)
+    name = [parent_route.try(:name), route.name].compact
+    parent_spec = parent_route.try(:path).try(:spec)
     _ = <<-JS.strip!
-  // #{route.name} => #{route.path.spec}
-  #{route.name}_path: function(#{build_params(route)}) {
-  return Utils.build_path(#{json(route.required_parts)}, #{json(serialize(route.path.spec))}, arguments)
+  // #{name.join('.')} => #{parent_spec}#{route.path.spec}
+  #{name.join('_')}_path: function(#{build_params(route)}) {
+  return Utils.build_path(#{json(route.required_parts)}, #{json(serialize(route.path.spec, parent_spec))}, arguments);
   }
   JS
   end
@@ -149,12 +162,24 @@ class JsRoutes
   # We do not use Hash for human readable serialization
   # And preffer Array serialization because it is shorter.
   # Routes.js file will be smaller.
-  def serialize(spec)
+  def serialize(spec, parent_spec=nil)
     return nil unless spec
     return spec.tr(':', '') if spec.is_a?(String)
-    [      
+    result = serialize_spec(spec, parent_spec)
+    if parent_spec && result[1].is_a?(String)
+      result = [
+        NODE_TYPES[:CAT],
+        serialize_spec(parent_spec),
+        result
+      ]
+    end
+    result
+  end
+
+  def serialize_spec(spec, parent_spec=nil)
+    [
       NODE_TYPES[spec.type],
-      serialize(spec.left),
+      serialize(spec.left, parent_spec),
       spec.respond_to?(:right) && serialize(spec.right)
     ]
   end

data/lib/js_routes/engine.rb

@@ -1,13 +1,15 @@
-if defined?(Rails)
+if defined?(Rails) && Rails.version >= "3.1"
   class JsRoutes
     class Engine < Rails::Engine
       JS_ROUTES_ASSET = 'js-routes'
 
       initializer 'js-routes.dependent_on_routes', :after => "sprockets.environment" do
-        routes = Rails.root.join('config','routes.rb')
-        Rails.application.assets.register_preprocessor 'application/javascript', :'js-routes_dependent_on_routes' do |ctx,data|
-          ctx.depend_on(routes) if ctx.logical_path == JS_ROUTES_ASSET
-          data
+        if Rails.application.assets.respond_to?(:register_preprocessor)
+          routes = Rails.root.join('config','routes.rb')
+          Rails.application.assets.register_preprocessor 'application/javascript', :'js-routes_dependent_on_routes' do |ctx,data|
+            ctx.depend_on(routes) if ctx.logical_path == JS_ROUTES_ASSET
+            data
+          end
         end
       end
     end

data/lib/routes.js

@@ -62,7 +62,11 @@
         return "";
       }
       if (typeof(object) == "object") {
-        return ((typeof(object.to_param) == "function" && object.to_param()) || object.to_param || object.id || object).toString();
+        var property = object.to_param || object.id || object;
+        if (typeof(property) == "function") {
+          property = property.call(object)
+        }
+        return property.toString();
       } else {
         return object.toString();
       }
@@ -114,15 +118,9 @@
       var right = route[2];
       switch (type) {
         case NodeTypes.GROUP:
-          try {
-            return this.visit(left, options);
-          } catch(e) {
-            if (e instanceof ParameterMissing) {
-              return "";
-            } else {
-              throw e;
-            }
-          }
+          return this.visit_group(left, options)
+        case NodeTypes.STAR:
+          return this.visit_group(left, options)
         case NodeTypes.CAT:
           return this.visit(left, options) + this.visit(right, options);
         case NodeTypes.SYMBOL:
@@ -134,11 +132,10 @@
             throw new ParameterMissing("Route parameter missing: " + left);
           }
         /*
-         * I don't know what are these node types
+         * I don't know what is this node type
          * Please send your PR if you do
          */
         //case NodeTypes.OR:
-        //case NodeTypes.STAR:
         case NodeTypes.LITERAL:
           return left;
         case NodeTypes.SLASH:
@@ -151,6 +148,18 @@
       
     },
 
+    visit_group: function(left, options) {
+      try {
+        return this.visit(left, options);
+      } catch(e) {
+        if (e instanceof ParameterMissing) {
+          return "";
+        } else {
+          throw e;
+        }
+      }
+    },
+
     get_prefix: function(){
       var prefix = defaults.prefix;
 
@@ -159,10 +168,19 @@
       }
       
       return prefix;
-    }
+    },
 
+    namespace: function (root, namespaceString) {
+        var parts = namespaceString ? namespaceString.split('.') : [];
+        if (parts.length > 0) {
+            current = parts.shift();
+            root[current] = root[current] || {};
+            Utils.namespace(root[current], parts.join('.'));
+        }
+    }
   };
 
+  Utils.namespace(window, 'NAMESPACE');
   window.NAMESPACE = ROUTES;
   window.NAMESPACE.options = defaults;
 })();

data/spec/js_routes_spec.rb

@@ -13,8 +13,9 @@ describe JsRoutes do
   let(:_options) { {} }
 
   let(:routes) { App.routes.url_helpers }
+  let(:blog_routes) { BlogEngine::Engine.routes.url_helpers }
 
-  describe "compatibility with Rails routes" do
+  describe "compatibility with Rails" do
 
     it "should generate collection routing" do
       evaljs("Routes.inboxes_path()").should == routes.inboxes_path()
@@ -59,6 +60,61 @@ describe JsRoutes do
     it "should support url anchor given as parameter" do
       evaljs("Routes.inbox_path(1, {anchor: 'hello'})").should == routes.inbox_path(1, :anchor => "hello")
     end
+    
+    it "should support engine routes" do
+      evaljs("Routes.blog_app_posts_path()").should == blog_routes.posts_path()
+    end
+    
+    it "should support engine routes with parameter" do
+      evaljs("Routes.blog_app_post_path(1)").should == blog_routes.post_path(1)
+    end
+
+    context "routes globbing" do
+      it "should be supported as parameters" do
+        evaljs("Routes.book_path('thrillers', 1)").should == routes.book_path('thrillers', 1)
+      end
+
+      xit "should support routes globbing as hash" do
+        evaljs("Routes.book_path(1, {section: 'thrillers'})").should == routes.book_path(1, :section => 'thrillers')
+      end
+
+      xit "should bee support routes globbing as hash" do
+        evaljs("Routes.book_path(1)").should == routes.book_path(1)
+      end
+    end
+
+    context "using optional path fragments" do
+      context "including not optional parts" do
+        it "should include everything that is not optional" do
+          evaljs("Routes.foo_path()").should == routes.foo_path
+        end
+      end
+
+      context "but not including them" do
+        it "should not include the optional parts" do
+          evaljs("Routes.things_path()").should == routes.things_path
+        end
+
+        xit "should not require the optional parts as arguments" do
+          #TODO: fix this inconsistence
+          evaljs("Routes.thing_path(null, 5)").should == routes.thing_path(nil, 5)
+        end
+
+        it "should treat undefined as non-given optional part" do
+          evaljs("Routes.thing_path(5, {optional_id: undefined})").should == routes.thing_path(5, :optional_id => nil)
+        end
+
+        it "should treat null as non-given optional part" do
+          evaljs("Routes.thing_path(5, {optional_id: null})").should == routes.thing_path(5, :optional_id => nil)
+        end
+      end
+
+      context "and including them" do
+        it "should include the optional parts" do
+          evaljs("Routes.things_path({optional_id: 5})").should == routes.things_path(:optional_id => 5)
+        end
+      end
+    end
   end
 
   context "when wrong parameters given" do
@@ -153,19 +209,37 @@ describe JsRoutes do
 
   end
 
-  context "when namspace option is specified" do
+  describe "when namespace option is specified" do
     let(:_options) { {:namespace => "PHM"} }
-    it "should use this name space for routing" do
+    it "should use this namespace for routing" do
       evaljs("window.Routes").should be_nil
       evaljs("PHM.inbox_path").should_not be_nil
     end
-    
   end
-  context "when nested namspace option is specified" do
-    let(:_presetup) { "window.PHM = {}" }
-    let(:_options) { {:namespace => "PHM.Routes"} }
-    it "should use this name space for routing" do
-      evaljs("PHM.Routes.inbox_path").should_not be_nil
+
+  describe "when nested namespace option is specified" do 
+    context "and defined on client" do
+      let(:_presetup) { "window.PHM = {}" }
+      let(:_options) { {:namespace => "PHM.Routes"} }
+      it "should use this namespace for routing" do
+        evaljs("PHM.Routes.inbox_path").should_not be_nil
+      end
+    end
+
+    context "but undefined on client" do
+      let(:_options) { {:namespace => "PHM.Routes"} }
+      it "should initialize namespace" do
+        evaljs("window.PHM.Routes.inbox_path").should_not be_nil
+      end 
+    end
+
+    context "and some parts are defined" do
+      let(:_presetup) { "window.PHM = { Utils: {} };" }
+      let(:_options) { {:namespace => "PHM.Routes"} }
+      it "should not overwrite existing parts" do
+        evaljs("window.PHM.Utils").should_not be_nil
+        evaljs("window.PHM.Routes.inbox_path").should_not be_nil
+      end
     end
   end
 
@@ -185,6 +259,10 @@ describe JsRoutes do
       evaljs("Routes.inbox_path({id: 1, to_param: function(){ return 'my';}})").should == routes.inbox_path(inbox)
     end
 
+    it "should call id if it is a function" do
+      evaljs("Routes.inbox_path({id: function() { return 1;}})").should == routes.inbox_path(1)
+    end
+
     it "should support options argument" do
       evaljs(
         "Routes.inbox_message_path({id:1, to_param: 'my'}, {id:2}, {custom: true, format: 'json'})"
@@ -192,37 +270,6 @@ describe JsRoutes do
     end
   end
 
-  context "using optional path fragments" do
-  	context "including not optional parts" do
-  		it "should include everything that is not optional" do
-      	evaljs("Routes.foo_path()").should == routes.foo_path
-  		end
-  	end
-
-    context "but not including them" do
-      it "should not include the optional parts" do
-        evaljs("Routes.things_path()").should == routes.things_path
-      end
-
-      it "should not require the optional parts as arguments" do
-        evaljs("Routes.thing_path(5)").should == routes.thing_path(nil, 5)
-      end
-
-      it "should treat undefined as non-given optional part" do
-        evaljs("Routes.thing_path(5, {optional_id: undefined})").should == routes.thing_path(5, :optional_id => nil)
-      end
-
-      it "should treat null as non-given optional part" do
-        evaljs("Routes.thing_path(5, {optional_id: null})").should == routes.thing_path(5, :optional_id => nil)
-      end
-    end
-
-    context "and including them" do
-      it "should include the optional parts" do
-        evaljs("Routes.things_path({optional_id: 5})").should == routes.things_path(:optional_id => 5)
-      end
-    end
-  end
 
   describe "generated js" do
     subject { JsRoutes.generate }

data/spec/spec_helper.rb

@@ -16,7 +16,15 @@ def evaljs(string)
 end
 
 
+module BlogEngine
+  class Engine < Rails::Engine
+    isolate_namespace BlogEngine
+  end
 
+  Engine.routes.draw do
+    resources :posts
+  end
+end
 
 
 class App < Rails::Application
@@ -44,6 +52,10 @@ class App < Rails::Application
     end
     
     match "/other_optional/(:optional_id)" => "foo#foo", :as => :foo
+
+    match 'books/*section/:title' => 'books#show', :as => :book
+
+    mount BlogEngine::Engine => "/blog", :as => :blog_app
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-02 00:00:00.000000000 Z
+date: 2012-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &85230710 !ruby/object:Gem::Requirement
+  requirement: &16473680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *85230710
+  version_requirements: *16473680
 - !ruby/object:Gem::Dependency
   name: therubyracer
-  requirement: &85229560 !ruby/object:Gem::Requirement
+  requirement: &16471960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *85229560
+  version_requirements: *16471960
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &85245130 !ruby/object:Gem::Requirement
+  requirement: &16469100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,21 +43,21 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *85245130
+  version_requirements: *16469100
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &85244440 !ruby/object:Gem::Requirement
+  requirement: &16488880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *85244440
+  version_requirements: *16488880
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &85243690 !ruby/object:Gem::Requirement
+  requirement: &16486860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,18 +65,7 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *85243690
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &85242750 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *85242750
+  version_requirements: *16486860
 description: Generates javascript file that defines all Rails named routes as javascript
   helpers
 email: agresso@gmail.com
@@ -119,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -314330307
+      hash: 950059294616459731
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -128,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Brings Rails named routes to javascript