js-routes 0.8.1 → 0.8.2

data/Rakefile

@@ -38,12 +38,3 @@ end
 
 task :default => :spec
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "js-routes #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +1 @@
-0.8.1
+0.8.2

data/js-routes.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "js-routes"
-  s.version = "0.8.1"
+  s.version = "0.8.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
-  s.date = "2012-05-04"
+  s.date = "2012-06-23"
   s.description = "Generates javascript file that defines all Rails named routes as javascript helpers"
   s.email = "agresso@gmail.com"
   s.extra_rdoc_files = [

data/lib/js_routes.rb

@@ -108,7 +108,7 @@ class JsRoutes
 
   def js_routes
     Rails.application.reload_routes!
-    js_routes = Rails.application.routes.named_routes.routes.map do |_, route|
+    js_routes = Rails.application.routes.named_routes.routes.sort_by(&:to_s).map do |_, route|
       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)
@@ -137,10 +137,13 @@ class JsRoutes
   def build_js(route, parent_route)
     name = [parent_route.try(:name), route.name].compact
     parent_spec = parent_route.try(:path).try(:spec)
+    required_parts = route.required_parts.clone
+    optional_parts = route.optional_parts.clone
+    optional_parts.push(required_parts.delete :format) if required_parts.include?(:format)
     _ = <<-JS.strip!
   // #{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);
+  #{name.join('_')}_path: function(#{build_params(required_parts)}) {
+  return Utils.build_path(#{json(required_parts)}, #{json(optional_parts)}, #{json(serialize(route.path.spec, parent_spec))}, arguments);
   }
   JS
   end
@@ -149,8 +152,8 @@ class JsRoutes
     self.class.json(string)
   end
 
-  def build_params route
-    params = route.required_parts.map do |name|
+  def build_params required_parts
+    params = required_parts.map do |name|
       # prepending each parameter name with underscore
       # to prevent conflict with JS reserved words
       "_" + name.to_s

data/lib/js_routes/engine.rb

@@ -1,15 +1,13 @@
-if defined?(Rails) && Rails.version >= "3.1"
-  class JsRoutes
-    class Engine < Rails::Engine
-      JS_ROUTES_ASSET = 'js-routes'
+class JsRoutes
+  class Engine < Rails::Engine
+    JS_ROUTES_ASSET = 'js-routes'
 
-      initializer 'js-routes.dependent_on_routes', :after => "sprockets.environment" do
-        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
+    initializer 'js-routes.dependent_on_routes', :after => "sprockets.environment" do
+      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

data/lib/routes.js

@@ -15,7 +15,11 @@
   var Utils = {
 
     serialize: function(obj){
-      if (obj === null) {return '';}
+      if (!obj) {return '';}
+      if (window.jQuery) {
+        var result = window.jQuery.param(obj);
+        return !result ? "" : "?" + result
+      }
       var s = [];
       for (prop in obj){
         if (obj[prop]) {
@@ -36,7 +40,10 @@
     },
 
     clean_path: function(path) {
-      return path.replace(/\/+/g, "/").replace(/[\)\(]/g, "").replace(/\.$/m, '').replace(/\/$/m, '');
+      path = path.split("://");
+      last_index = path.length - 1;
+      path[last_index] = path[last_index].replace(/\/+/g, "/").replace(/\/$/m, '');
+      return path.join("://");
     },
 
     set_default_format: function(options) {
@@ -82,14 +89,14 @@
     },
 
     prepare_parameters: function(required_parameters, actual_parameters, options) {
-      var result = this.clone(options);
+      var result = this.clone(options) || {};
       for (var i=0; i < required_parameters.length; i++) {
         result[required_parameters[i]] = actual_parameters[i];
       }
       return result;
     },
 
-    build_path: function(required_parameters, route, args) {
+    build_path: function(required_parameters, optional_parts, route, args) {
       args = Array.prototype.slice.call(args);
       var opts = this.extract_options(required_parameters.length, args);
       if (args.length > required_parameters.length) {
@@ -97,7 +104,9 @@
       }
 
       parameters = this.prepare_parameters(required_parameters, args, opts);
-      this.set_default_format(parameters);
+      if (optional_parts.indexOf('format') != -1) {
+        this.set_default_format(parameters);
+      }
       var result = Utils.get_prefix();
       var anchor = Utils.extract_anchor(parameters);
 

data/spec/js_routes_spec.rb

@@ -69,6 +69,10 @@ describe JsRoutes do
       evaljs("Routes.blog_app_post_path(1)").should == blog_routes.post_path(1)
     end
 
+    it "shouldn't require the format" do
+      evaljs("Routes.json_only_path({format: 'json'})").should == routes.json_only_path(:format => 'json')
+    end
+
     context "routes globbing" do
       it "should be supported as parameters" do
         evaljs("Routes.book_path('thrillers', 1)").should == routes.book_path('thrillers', 1)
@@ -83,6 +87,33 @@ describe JsRoutes do
       end
     end
 
+    context "when jQuery is present" do
+      before do
+        evaljs("window.jQuery = {};")
+        jscontext[:parameterize] = lambda {|object| _value.to_param}
+        evaljs("window.jQuery.param = parameterize")
+      end
+
+      shared_examples_for "serialization" do
+        it "should support serialization of objects" do
+          evaljs("window.jQuery.param(#{_value.to_json})").should == _value.to_param
+          evaljs("Routes.inboxes_path(#{_value.to_json})").should == routes.inboxes_path(_value)
+        end
+      end
+      context "when parameters is a hash" do
+        let(:_value) do
+          {a: {b: 'c'}, q: [1,2]}
+        end
+        it_should_behave_like 'serialization'
+      end
+      context "when parameters is null" do
+        let(:_value) do
+          nil
+        end
+        it_should_behave_like 'serialization'
+      end
+    end
+
     context "using optional path fragments" do
       context "including not optional parts" do
         it "should include everything that is not optional" do
@@ -176,6 +207,15 @@ describe JsRoutes do
     end
 
   end
+
+  context "when prefix with http:// is specified" do
+    
+    let(:_options) { {:prefix => "http://localhost:3000" } }
+
+    it "should render routing with prefix" do
+      evaljs("Routes.inbox_path(1)").should == _options[:prefix] + routes.inbox_path(1)
+    end
+  end
   
   context "when prefix without trailing slash is specified" do
     
@@ -207,6 +247,13 @@ describe JsRoutes do
       evaljs("Routes.inbox_path(1, {format: null})").should == routes.inbox_path(1)
     end
 
+    it "shouldn't include the format when {:format => false} is specified" do
+      evaljs("Routes.no_format_path()").should == routes.no_format_path
+    end
+
+    it "shouldn't require the format" do
+      evaljs("Routes.json_only_path()").should == routes.json_only_path(:format => 'json')
+    end
   end
 
   describe "when namespace option is specified" do
@@ -282,6 +329,10 @@ describe JsRoutes do
     it "should have correct function signature with Ruby 1.8.7 and unordered hash" do
       should include("inbox_message_attachment_path: function(_inbox_id, _message_id, _id, options)")
     end
+
+    it "routes should be sorted in alphabetical order" do
+      subject.index("book_path").should <= subject.index("inboxes_path")
+    end
   end
 
   describe ".generate!" do

data/spec/spec_helper.rb

@@ -56,6 +56,10 @@ class App < Rails::Application
     match 'books/*section/:title' => 'books#show', :as => :book
 
     mount BlogEngine::Engine => "/blog", :as => :blog_app
+
+    get '/no_format' => "foo#foo", :format => false, :as => :no_format
+
+    get '/json_only' => "foo#foo", :format => true, :constraints => {:format => /json/}, :as => :json_only
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-04 00:00:00.000000000 Z
+date: 2012-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &16473680 !ruby/object:Gem::Requirement
+  requirement: &12169560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *16473680
+  version_requirements: *12169560
 - !ruby/object:Gem::Dependency
   name: therubyracer
-  requirement: &16471960 !ruby/object:Gem::Requirement
+  requirement: &12167600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16471960
+  version_requirements: *12167600
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &16469100 !ruby/object:Gem::Requirement
+  requirement: &12164260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *16469100
+  version_requirements: *12164260
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &16488880 !ruby/object:Gem::Requirement
+  requirement: &12177960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *16488880
+  version_requirements: *12177960
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &16486860 !ruby/object:Gem::Requirement
+  requirement: &12176940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *16486860
+  version_requirements: *12176940
 description: Generates javascript file that defines all Rails named routes as javascript
   helpers
 email: agresso@gmail.com
@@ -108,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 950059294616459731
+      hash: 379600740285990591
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: