js-routes 0.8.6 → 0.8.7

data/Readme.md

@@ -42,22 +42,30 @@ end
 
 Available options:
 
-* `default_format` - Format to append to urls. Default: blank
-* `exclude` - Array of regexps to exclude from js routes. Default: []
+* `default_url_options` - default parameters to be used to generate url
+  * Note that currently only optional parameters (like `:format`) can be defaulted.
+  * Example: {:format => "json"}
+  * Default: {}
+* `exclude` - Array of regexps to exclude from js routes. 
   * Note that regexp applied to **named route** not to *URL*
-* `include` - Array of regexps to include in js routes. Default: []
+  * Default: []
+* `include` - Array of regexps to include in js routes. 
   * Note that regexp applied to **named route** not to *URL*
-* `namespace` - global object used to access routes. Default: `Routes`
+  * Default: []
+* `namespace` - global object used to access routes. 
   * Supports nested namespace like `MyProject.routes`
-* `prefix` - String representing a url path to prepend to all paths. Default: blank
+  * Default: `Routes`
+* `prefix` - String representing a url path to prepend to all paths. 
   * Example: `http://yourdomain.com`. This will cause route helpers to generate full path only. 
+  * Default: blank
 
 
 You can generate routes files on the application side like this:
 
 ``` ruby
-JsRoutes.generate!("#{path}/app_routes.js", :namespace => "AppRoutes", :exclude => /^admin_/, :default_format => "json")
-JsRoutes.generate!("#{path}/adm_routes.js", :namespace => "AdmRoutes", :include => /^admin_/, :default_format => "json")
+JsRoutes.generate!("#{path}/app_routes.js", :namespace => "AppRoutes", :exclude => [/^admin_/, /^api_/])
+JsRoutes.generate!("#{path}/adm_routes.js", :namespace => "AdmRoutes", :include => /^admin_/)
+JsRoutes.generate!("#{path}/api_routes.js", :namespace => "ApiRoutes", :include => /^api_/, :default_url_options => {:format => "json"})
 ```
 
 In order to generate javascript to string and manipulate them yourself use:

data/VERSION

@@ -1 +1 @@
-0.8.6
+0.8.7

data/js-routes.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = "js-routes"
-  s.version = "0.8.6"
+  s.name = %q{js-routes}
+  s.version = "0.8.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
-  s.date = "2013-01-24"
-  s.description = "Generates javascript file that defines all Rails named routes as javascript helpers"
-  s.email = "agresso@gmail.com"
+  s.date = %q{2013-02-13}
+  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 = [
     "LICENSE.txt"
   ]
@@ -38,11 +38,11 @@ Gem::Specification.new do |s|
     "spec/js_routes/rails_routes_compatibility_spec.rb",
     "spec/spec_helper.rb"
   ]
-  s.homepage = "http://github.com/railsware/js-routes"
+  s.homepage = %q{http://github.com/railsware/js-routes}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
-  s.summary = "Brings Rails named routes to javascript"
+  s.rubygems_version = %q{1.6.0}
+  s.summary = %q{Brings Rails named routes to javascript}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/js_routes.rb

@@ -8,11 +8,11 @@ class JsRoutes
 
   DEFAULTS = {
     :namespace => "Routes",
-    :default_format => "",
     :exclude => [],
     :include => //,
     :file => DEFAULT_PATH,
-    :prefix => ""
+    :prefix => "",
+    :default_url_options => {}
   }
 
   # We encode node symbols as integer to reduce the routes.js file size
@@ -86,12 +86,21 @@ class JsRoutes
   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!("DEFAULT_URL_OPTIONS", json(@options[:default_url_options].merge(deprecated_default_format)))
     js.gsub!("PREFIX", @options[:prefix])
     js.gsub!("NODE_TYPES", json(NODE_TYPES))
     js.gsub!("ROUTES", js_routes)
   end
 
+  def deprecated_default_format
+    if @options.key?(:default_format) 
+      warn("default_format option is deprecated. Use default_url_options = {:format => <format>} instead")
+      {:format => @options[:default_format]} 
+    else
+      {}
+    end
+  end
+
   def generate!(file_name = nil)
     # Some libraries like Devise do not yet loaded their routes so we will wait
     # until initialization process finish

data/lib/routes.js

@@ -7,10 +7,10 @@
 
   var defaults = {
     prefix: 'PREFIX',
-    format: 'DEFAULT_FORMAT'
+    default_url_options: DEFAULT_URL_OPTIONS
   };
 
-  var NodeTypes = NODE_TYPES
+  var NodeTypes = NODE_TYPES;
   
   var Utils = {
 
@@ -46,8 +46,13 @@
       return path.join("://");
     },
 
-    set_default_format: function(options) {
-      if (!options.hasOwnProperty("format") && defaults.format) options.format = defaults.format;
+    set_default_url_options: function(optional_parts, options) {
+      for (var i=0;i < optional_parts.length; i++) {
+        var part = optional_parts[i];
+        if (!options.hasOwnProperty(part) && defaults.default_url_options.hasOwnProperty(part)) {
+          options[part] = defaults.default_url_options[part];
+        }
+      }
     },
 
     extract_anchor: function(options) {
@@ -66,11 +71,11 @@
 
     path_identifier: function(object) {
       if (object === 0) {
-	return '0';
+        return '0';
       }
 
       if (! object) { // null, undefined, false or ''
-	return '';
+        return '';
       }
 
       if (typeof(object) == "object") {
@@ -101,12 +106,6 @@
       return result;
     },
 
-    smartIndexOf: function(array, item){
-      if (Array.prototype.indexOf && array.indexOf === Array.prototype.indexOf) return array.indexOf(item);
-      for (var i = 0; i < array.length; i++) if (i in array && array[i] === item) return i;
-      return -1;
-    },
-
     build_path: function(required_parameters, optional_parts, route, args) {
       args = Array.prototype.slice.call(args);
       var opts = this.extract_options(required_parameters.length, args);
@@ -115,10 +114,7 @@
       }
 
       var parameters = this.prepare_parameters(required_parameters, args, opts);
-      // Array#indexOf is not supported by IE <= 8, so we use custom method
-      if (Utils.smartIndexOf(optional_parts, 'format') !== -1) {
-        this.set_default_format(parameters);
-      }
+      this.set_default_url_options(optional_parts, parameters);
       var result = Utils.get_prefix();
       var anchor = Utils.extract_anchor(parameters);
 
@@ -129,24 +125,26 @@
     /*
      * This function is JavaScript impelementation of the
      * Journey::Visitors::Formatter that builds route by given parameters
-     * and parsed route binary tree.
+     * from route binary tree.
      * Binary tree is serialized in the following way:
      * [node type, left node, right node ]
      *
-     *@param  {Boolean} optional  Marks the currently visited branch as optional. If set to `true`, this method will not throw when encountering a missing parameter (used in recursive calls).
+     * @param  {Boolean} optional  Marks the currently visited branch as optional. 
+     *   If set to `true`, this method will not throw when encountering 
+     *   a missing parameter (used in recursive calls).
      */
-    visit: function(route, options, optional) {
+    visit: function(route, parameters, optional) {
       var type = route[0];
       var left = route[1];
       var right = route[2];
       switch (type) {
         case NodeTypes.GROUP:
-          return this.visit(left, options, true)
+          return this.visit(left, parameters, true)
         case NodeTypes.STAR:
-          return this.visit(left, options, true)
+          return this.visit(left, parameters, true)
         case NodeTypes.CAT:
-          var leftPart = this.visit(left, options, optional),
-              rightPart = this.visit(right, options, optional);
+          var leftPart = this.visit(left, parameters, optional),
+              rightPart = this.visit(right, parameters, optional);
 
           if (optional && ! (leftPart && rightPart))
             return '';
@@ -159,10 +157,10 @@
         case NodeTypes.DOT:
           return left;
         case NodeTypes.SYMBOL:
-          var value = options[left];
+          var value = parameters[left];
 
           if (value || value === 0) {
-            delete options[left];
+            delete parameters[left];
             return this.path_identifier(value);
           }
 

data/spec/js_routes/options_spec.rb

@@ -4,11 +4,14 @@ describe JsRoutes, "options" do
   
   before(:each) do
     evaljs(_presetup)
-    evaljs(JsRoutes.generate(_options))
+    with_warnings(_warnings) do
+      evaljs(JsRoutes.generate(_options))
+    end
   end
 
   let(:_presetup) { "this;" }
   let(:_options) { {} }
+  let(:_warnings) { true }
 
   context "when exclude is specified" do
     
@@ -76,6 +79,7 @@ describe JsRoutes, "options" do
 
   context "when default_format is specified" do
     let(:_options) { {:default_format => "json"} }
+    let(:_warnings) { nil }
     
     it "should render routing with default_format" do
       evaljs("Routes.inbox_path(1)").should == routes.inbox_path(1, :format => "json")
@@ -131,4 +135,21 @@ describe JsRoutes, "options" do
       end
     end
   end
+
+  describe "default_url_options" do
+    context "with optional route parts" do
+      let(:_options) { {:default_url_options => {:optional_id => "12", :format => "json"}}}
+      it "should use this opions to fill optional parameters" do
+        evaljs("Routes.things_path()").should == routes.things_path(:optional_id => 12, :format => "json")
+      end
+    end
+
+    context "with required route parts" do
+      let(:_options) { {:default_url_options => {:inbox_id => "12"}} }
+      it "should use this opions to fill optional parameters" do
+        pending
+        evaljs("Routes.inbox_messages_path()").should == routes.inbox_messages_path(:inbox_id => 12)
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -92,6 +92,7 @@ RSpec.configure do |config|
     evaljs("var window = this;")
     jscontext[:cgi] = CGI
     evaljs("function encodeURIComponent(string) {return cgi.escape(string);}")
+    jscontext[:log] = lambda {|arg| puts arg.inspect}
   end
   config.before(:all) do
     draw_routes

metadata

@@ -1,104 +1,109 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: js-routes
-version: !ruby/object:Gem::Version
-  version: 0.8.6
+version: !ruby/object:Gem::Version 
+  hash: 49
   prerelease: 
+  segments: 
+  - 0
+  - 8
+  - 7
+  version: 0.8.7
 platform: ruby
-authors:
+authors: 
 - Bogdan Gusiev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-24 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
+
+date: 2013-02-13 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :runtime
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 3
+        - 2
+        version: "3.2"
+  version_requirements: *id001
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rails
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.2'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
+  prerelease: false
   name: therubyracer
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 2
+        - 10
+        - 0
         version: 2.10.0
-  type: :development
+  version_requirements: *id003
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.10.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.1.0
+  name: rspec
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
         version: 1.1.0
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.6.2
-  type: :development
+  version_requirements: *id004
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  name: bundler
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
         version: 1.6.2
-description: Generates javascript file that defines all Rails named routes as javascript
-  helpers
+  version_requirements: *id005
+  prerelease: false
+  name: jeweler
+  type: :development
+description: Generates javascript file that defines all Rails named routes as javascript helpers
 email: agresso@gmail.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE.txt
-files:
+files: 
 - .document
 - .rspec
 - .travis.yml
@@ -120,32 +125,39 @@ files:
 - spec/js_routes/post_rails_init_spec.rb
 - spec/js_routes/rails_routes_compatibility_spec.rb
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: http://github.com/railsware/js-routes
-licenses:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -2317376881540244004
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.6.0
 signing_key: 
 specification_version: 3
 summary: Brings Rails named routes to javascript
 test_files: []
+