js-routes 0.6.1 → 0.6.2

data/Readme.md

@@ -30,8 +30,10 @@ Available options:
   * Note that regexp applied to **named route** not to *URL*
 * `:namespace` - global object used to access routes. Default: `Routes`
   * Supports nested namespace like `MyProject.routes`
+* `:prefix` - String representing a url path to prepend to all paths
+  * `Should be specified via :prefix => "/myprefix"`
 
-Example options usage:
+This is how you can generate separated routes files for different parts of application:
 
 ``` ruby
 JsRoutes.generate!(:file => "#{path}/app_routes.js", :namespace => "AppRoutes", :exclude => /^admin_/, :default_format => "json")

data/VERSION

@@ -1 +1 @@
-0.6.1
+0.6.2

data/js-routes.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{js-routes}
-  s.version = "0.6.1"
+  s.version = "0.6.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
-  s.date = %q{2011-09-12}
+  s.date = %q{2011-09-21}
   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

@@ -1,88 +1,111 @@
-module JsRoutes
-  class << self
+class JsRoutes
 
+  #
+  # API
+  #
 
-    def generate(options = {})
-      js = File.read(File.dirname(__FILE__) + "/routes.js")
-      options[:namespace] ||= "Routes"
-      js.gsub!("NAMESPACE", options[:namespace])
-      js.gsub!("DEFAULT_FORMAT", options[:default_format].to_s)
-      js.gsub!("ROUTES", js_routes(options))
-    end
+  def self.generate(options = {})
+    self.new(options).generate
+  end
+
+  def self.generate!(options = {})
+    self.new(options).generate!
+  end
 
-    def generate!(options = {})
-      file = options[:file] || default_file
-      File.open(file, 'w') do |f|
-        f.write generate(options)
+  #
+  # Implementation
+  #
+
+  def initialize(options = {})
+    @options = default_options.merge(options)
+  end
+
+  def generate
+    js = File.read(File.dirname(__FILE__) + "/routes.js")
+    js.gsub!("NAMESPACE", @options[:namespace])
+    js.gsub!("DEFAULT_FORMAT", @options[:default_format].to_s)
+    js.gsub!("PREFIX", @options[:prefix])
+    js.gsub!("ROUTES", js_routes)
+  end
+
+  def generate!
+    # Some libraries like devise do yet load their routes so we will wait
+    # until initialization process finish
+    # https://github.com/railsware/js-routes/issues/7
+    Rails.configuration.after_initialize do
+      File.open(@options[:file], 'w') do |f|
+        f.write generate
       end
     end
+  end
 
-    #
-    # Implementation
-    #
-
-    protected
-    def js_routes(options = {})
-
-      options[:default_format] ||= ""
-      excludes = options[:exclude] || []
-      includes = options[:include] || //
-
-      Rails.application.reload_routes!
-      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
-      
-      "{\n" + js_routes.join(",\n") + "}\n"
-    end
+  protected
 
-    def any_match?(route, matchers)
-      matchers = Array(matchers)
-      matchers.any? {|regex| route.name =~ regex}
-    end
+  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
+      else
+        build_js(route)
+      end
+    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)
-      params = build_params route
-      _ = <<-JS.strip!
+  def build_js(route)
+    params = build_params route
+    _ = <<-JS.strip!
   // #{route.name} => #{route.path}
   #{route.name}_path: function(#{params.<<("options").join(", ")}) {
   return Utils.build_path(#{params.size}, #{path_parts(route).inspect}, arguments)
   }
-JS
-    end
+  JS
+  end
 
 
-    def build_params route
-      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
-    end
+  def build_params route
+    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
+  end
 
 
-    def path_parts route
-      route.path.gsub(/\(\.:format\)$/, "").split(/:[a-z\-_]+/)
-    end
+  def path_parts route
+    route.path.gsub(/\(\.:format\)$/, "").split(/:[a-z\-_]+/)
+  end
 
+  def default_options 
+    {
+      :namespace => "Routes",
+      :default_format => "",
+      :exclude => [],
+      :include => //,
+      :file => default_file,
+      :prefix => ""
+    }
+  end
 
-    def default_file
-      if Rails.version >= "3.1"
-        "#{Rails.root}/app/assets/javascripts/routes.js"
-      else
-        "#{Rails.root}/public/javascripts/routes.js"
-      end
+  def default_file
+    if Rails.version >= "3.1"
+      "#{Rails.root}/app/assets/javascripts/routes.js"
+    else
+      "#{Rails.root}/public/javascripts/routes.js"
     end
-
   end
+
 end

data/lib/routes.js

@@ -2,8 +2,6 @@
 
   var Utils = {
 
-    default_format: 'DEFAULT_FORMAT',
-
     serialize: function(obj){
       if (obj === null) {return '';}
       var s = [];
@@ -21,7 +19,7 @@
     },
 
     extract_format: function(options) {
-      var format =  options.hasOwnProperty("format") ? options.format : Utils.default_format;
+      var format =  options.hasOwnProperty("format") ? options.format : window.NAMESPACE.options.default_format;
       delete options.format;
       return format ? "." + format : "";
     },
@@ -47,7 +45,7 @@
 
     build_path: function(number_of_params, parts, args) {
       args = Array.prototype.slice.call(args);
-      result = "";
+      result = Utils.get_prefix();
       var opts = Utils.extract_options(number_of_params, args);
       for (var i=0; i < parts.length; i++) {
         value = args.shift();
@@ -71,10 +69,26 @@
 
     optional_part: function(part) {
       return part.match(/\(/);
+    },
+
+    get_prefix: function(){
+      var prefix = window.NAMESPACE.options.prefix;
+
+      if( prefix !== "" ){
+        prefix = prefix.match('\/$') ? prefix : ( prefix + '/');
+      }
+      
+      return prefix;
     }
 
   };
 
   window.NAMESPACE = ROUTES;
+  
+  window.NAMESPACE.options = {
+    prefix: 'PREFIX',
+    default_format: 'DEFAULT_FORMAT',
+  };
+
 
 })();

data/spec/js_routes_spec.rb

@@ -66,6 +66,36 @@ describe JsRoutes do
     end
   end
 
+  context "when prefix with trailing slash is specified" do
+    
+    let(:_options) { {:prefix => "/myprefix/" } }
+
+    it "should render routing with prefix" do
+        evaljs("Routes.inbox_path(1)").should == "/myprefix/inboxes/1"
+    end
+
+    it "should render routing with prefix set in JavaScript" do
+      evaljs("Routes.options.prefix = '/newprefix/'")
+      evaljs("Routes.inbox_path(1)").should == "/newprefix/inboxes/1"
+    end
+
+  end
+  
+  context "when prefix without trailing slash is specified" do
+    
+    let(:_options) { {:prefix => "/myprefix" } }
+
+    it "should render routing with prefix" do
+      evaljs("Routes.inbox_path(1)").should == "/myprefix/inboxes/1"
+    end
+    
+    it "should render routing with prefix set in JavaScript" do
+      evaljs("Routes.options.prefix = '/newprefix'")
+      evaljs("Routes.inbox_path(1)").should == "/newprefix/inboxes/1"
+    end
+
+  end
+
   context "when default_format is specified" do
     let(:_options) { {:default_format => "json"} }
     
@@ -73,7 +103,7 @@ describe JsRoutes do
       evaljs("Routes.inbox_path(1)").should == "/inboxes/1.json"
     end
 
-    it "should override default_format wehn spefified implicitly" do
+    it "should override default_format when spefified implicitly" do
       evaljs("Routes.inbox_path(1, {format: 'xml'})").should == "/inboxes/1.xml"
     end
 
@@ -138,23 +168,41 @@ describe JsRoutes do
   describe "generated js" do
     subject { JsRoutes.generate }
     it "should have correct function without arguments signature" do
-      subject.should include("inboxes_path: function(options)")
+      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)")
+      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)")
+      should include("inbox_message_attachment_path: function(_inbox_id, _message_id, _id, options)")
     end
   end
 
   describe ".generate!" do
+
     let(:name) {  "#{File.dirname(__FILE__)}/../routes.js" }
-    it "should generate routes file" do
+
+    before(:each) do
+      # prevent warning
+      Rails.configuration.active_support.deprecation = :log
+
       FileUtils.rm_f(name)
       JsRoutes.generate!({:file => name})
-      File.exists?(name).should be_true 
     end
+
+    it "should not generate file at once" do
+      File.exists?(name).should be_false
+    end
+
+    context "after Rails initialization" do
+      before(:each) do
+        Rails.application.initialize!
+      end
+      it "should generate routes file only after rails initialization" do
+        File.exists?(name).should be_true 
+      end
+    end
+
     after(:all) do
       FileUtils.rm_f(name)
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: js-routes
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: false
   segments: 
   - 0
   - 6
-  - 1
-  version: 0.6.1
+  - 2
+  version: 0.6.2
 platform: ruby
 authors: 
 - Bogdan Gusiev
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-12 00:00:00 +03:00
+date: 2011-09-21 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency