js-routes 0.8.7 → 0.8.8

data/.gitignore

@@ -0,0 +1,52 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+log
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+.rvmrc
+
+Gemfile.lock

data/.travis.yml

@@ -1,10 +1,16 @@
+language: ruby
 rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - ruby-head
 notifications:
-  email: 
+  email:
     - agresso@gmail.com
 branches:
   only:
     - master
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -1,10 +1,4 @@
 source "http://rubygems.org"
 
-gem "rails", ">= 3.2"
-
-group :development do
-  gem "therubyracer"
-  gem "rspec", "~> 2.10.0"
-  gem "bundler", "~> 1.1.0"
-  gem "jeweler", "~> 1.6.2"
-end
+# Specify your gem's dependencies in js-routes.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,3 @@
+guard 'coffeescript', :output => 'lib', :all_on_start => true do
+  watch(%r{^lib/(.+\.coffee)$})
+end

data/Rakefile

@@ -9,23 +9,10 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  gem.name = "js-routes"
-  gem.homepage = "http://github.com/railsware/js-routes"
-  gem.license = "MIT"
-  gem.summary = %Q{Brings Rails named routes to javascript}
-  gem.description = %Q{Generates javascript file that defines all Rails named routes as javascript helpers}
-  gem.email = "agresso@gmail.com"
-  gem.authors = ["Bogdan Gusiev"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
+require 'bundler/gem_tasks'
 require 'rspec/core'
 require 'rspec/core/rake_task'
+
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern =  FileList['spec/**/*_spec.rb'].sort_by do|n|
     # we need to run post_rails_init_spec as the latest

data/Readme.md

@@ -1,4 +1,5 @@
 # JsRoutes
+[![Build Status](https://travis-ci.org/railsware/js-routes.png)](https://travis-ci.org/railsware/js-routes)
 
 Generates javascript file that defines all Rails named routes as javascript helpers
 
@@ -26,9 +27,9 @@ Also in order to flush asset pipeline cache sometimes you might need to run:
 rake tmp:cache:clear
 ```
 
-This cache is not flushed on server restart in development environment. 
+This cache is not flushed on server restart in development environment.
 
-**Important:** If routes.js file is not updated after some configuration change you need to run this command again.
+**Important:** If routes.js file is not updated after some configuration change you need to run this rake task again.
 
 ### Advanced Setup
 
@@ -46,19 +47,20 @@ Available options:
   * Note that currently only optional parameters (like `:format`) can be defaulted.
   * Example: {:format => "json"}
   * Default: {}
-* `exclude` - Array of regexps to exclude from js routes. 
+* `exclude` - Array of regexps to exclude from js routes.
   * Note that regexp applied to **named route** not to *URL*
   * Default: []
-* `include` - Array of regexps to include in js routes. 
+* `include` - Array of regexps to include in js routes.
   * Note that regexp applied to **named route** not to *URL*
   * Default: []
-* `namespace` - global object used to access routes. 
+* `namespace` - global object used to access routes.
   * Supports nested namespace like `MyProject.routes`
   * 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. 
+* `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
-
+* `camel_case` (version >= 0.8.8) - Generate camel case route names.
+  * Default: false
 
 You can generate routes files on the application side like this:
 
@@ -105,7 +107,7 @@ jQuery.extend(window, Routes)
 
 ## What about security?
 
-js-routes itself do not have security holes. It makes URLs 
+js-routes itself do not have security holes. It makes URLs
 without access protection more reachable by potential attacker.
 In order to prevent this use `:exclude` option for sensitive urls like `/admin_/`
 
@@ -119,7 +121,7 @@ Spork.trap_method(JsRoutes, :generate!)
 
 ## Advantages over alternatives
 
-There are some alternatives available. Most of them has only basic feature and don't reach the level of quality I accept. 
+There are some alternatives available. Most of them has only basic feature and don't reach the level of quality I accept.
 Advantages of this one are:
 
 * Rails3 support
@@ -129,4 +131,4 @@ Advantages of this one are:
 
 #### Thanks to [Contributors](https://github.com/railsware/js-routes/contributors)
 
-#### Have fun 
+#### Have fun

data/js-routes.gemspec

@@ -1,11 +1,11 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'js_routes/version'
 
 Gem::Specification.new do |s|
   s.name = %q{js-routes}
-  s.version = "0.8.7"
+  s.version = JsRoutes::VERSION
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
@@ -15,57 +15,19 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = [
     "LICENSE.txt"
   ]
-  s.files = [
-    ".document",
-    ".rspec",
-    ".travis.yml",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "Rakefile",
-    "Readme.md",
-    "VERSION",
-    "app/assets/javascripts/js-routes.js.erb",
-    "js-routes.gemspec",
-    "lib/js-routes.rb",
-    "lib/js_routes.rb",
-    "lib/js_routes/engine.rb",
-    "lib/routes.js",
-    "lib/tasks/js_routes.rake",
-    "spec/js_routes/generated_javascript_spec.rb",
-    "spec/js_routes/options_spec.rb",
-    "spec/js_routes/post_rails_init_spec.rb",
-    "spec/js_routes/rails_routes_compatibility_spec.rb",
-    "spec/spec_helper.rb"
-  ]
+  s.files = `git ls-files`.split("\n")
   s.homepage = %q{http://github.com/railsware/js-routes}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   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
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rails>, [">= 3.2"])
-      s.add_development_dependency(%q<therubyracer>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.10.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
-    else
-      s.add_dependency(%q<rails>, [">= 3.2"])
-      s.add_dependency(%q<therubyracer>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 2.10.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
-    end
-  else
-    s.add_dependency(%q<rails>, [">= 3.2"])
-    s.add_dependency(%q<therubyracer>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 2.10.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
-  end
+  s.add_runtime_dependency(%q<rails>, [">= 3.2"])
+  s.add_development_dependency(%q<therubyracer>, [">= 0"])
+  s.add_development_dependency(%q<rspec>, ["~> 2.10.0"])
+  s.add_development_dependency(%q<bundler>, [">= 1.1.0"])
+  s.add_development_dependency(%q<guard>, [">= 0"])
+  s.add_development_dependency(%q<rb-fsevent>, [">= 0"])
+  s.add_development_dependency(%q<guard-coffeescript>, [">= 0"])
 end
 

data/lib/js_routes.rb

@@ -1,3 +1,4 @@
+require 'js_routes/version'
 class JsRoutes
 
   #
@@ -12,6 +13,7 @@ class JsRoutes
     :include => //,
     :file => DEFAULT_PATH,
     :prefix => "",
+    :camel_case => false,
     :default_url_options => {}
   }
 
@@ -93,9 +95,9 @@ class JsRoutes
   end
 
   def deprecated_default_format
-    if @options.key?(:default_format) 
+    if @options.key?(:default_format)
       warn("default_format option is deprecated. Use default_url_options = {:format => <format>} instead")
-      {:format => @options[:default_format]} 
+      {:format => @options[:default_format]}
     else
       {}
     end
@@ -149,9 +151,11 @@ class JsRoutes
     required_parts = route.required_parts.clone
     optional_parts = route.optional_parts.clone
     optional_parts.push(required_parts.delete :format) if required_parts.include?(:format)
+    route_name = "#{name.join('_')}_path"
+    route_name = route_name.camelize(:lower) if true == @options[:camel_case]
     _ = <<-JS.strip!
   // #{name.join('.')} => #{parent_spec}#{route.path.spec}
-  #{name.join('_')}_path: function(#{build_params(required_parts)}) {
+  #{route_name}: function(#{build_params(required_parts)}) {
   return Utils.build_path(#{json(required_parts)}, #{json(optional_parts)}, #{json(serialize(route.path.spec, parent_spec))}, arguments);
   }
   JS

data/lib/js_routes/version.rb

@@ -0,0 +1,3 @@
+class JsRoutes
+  VERSION = "0.8.8"
+end

data/lib/routes.js

@@ -1,205 +1,208 @@
-(function(){
+(function() {
+  var NodeTypes, ParameterMissing, Utils, defaults,
+    __hasProp = {}.hasOwnProperty;
 
-  function ParameterMissing(message) {
-   this.message = message;
-  }
-  ParameterMissing.prototype = new Error(); 
+  ParameterMissing = function(message) {
+    this.message = message;
+  };
+
+  ParameterMissing.prototype = new Error();
 
-  var defaults = {
-    prefix: 'PREFIX',
+  defaults = {
+    prefix: "PREFIX",
     default_url_options: DEFAULT_URL_OPTIONS
   };
 
-  var NodeTypes = NODE_TYPES;
-  
-  var Utils = {
+  NodeTypes = NODE_TYPES;
+
+  Utils = {
+    serialize: function(obj) {
+      var i, key, prop, result, s, val, _i, _len;
 
-    serialize: function(obj){
-      if (!obj) {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]) {
-          if (obj[prop] instanceof Array) {
-            for (var i=0; i < obj[prop].length; i++) {
-              key = prop + encodeURIComponent("[]");
-              s.push(key + "=" + encodeURIComponent(obj[prop][i].toString()));
+        result = window.jQuery.param(obj);
+        return (!result ? "" : "?" + result);
+      }
+      s = [];
+      for (key in obj) {
+        if (!__hasProp.call(obj, key)) continue;
+        prop = obj[key];
+        if (prop != null) {
+          if (prop instanceof Array) {
+            for (i = _i = 0, _len = prop.length; _i < _len; i = ++_i) {
+              val = prop[i];
+              s.push("" + key + (encodeURIComponent("[]")) + "=" + (encodeURIComponent(val.toString())));
             }
           } else {
-            s.push(prop + "=" + encodeURIComponent(obj[prop].toString()));
+            s.push("" + key + "=" + (encodeURIComponent(prop.toString())));
           }
         }
       }
-      if (s.length === 0) {
-        return '';
+      if (!s.length) {
+        return "";
       }
-      return "?" + s.join('&');
+      return "?" + (s.join("&"));
     },
-
     clean_path: function(path) {
+      var last_index;
+
       path = path.split("://");
-      var last_index = path.length - 1;
-      path[last_index] = path[last_index].replace(/\/+/g, "/").replace(/\/$/m, '');
+      last_index = path.length - 1;
+      path[last_index] = path[last_index].replace(/\/+/g, "/").replace(/\/$/m, "");
       return path.join("://");
     },
-
     set_default_url_options: function(optional_parts, options) {
-      for (var i=0;i < optional_parts.length; i++) {
-        var part = optional_parts[i];
+      var i, part, _i, _len, _results;
+
+      _results = [];
+      for (i = _i = 0, _len = optional_parts.length; _i < _len; i = ++_i) {
+        part = optional_parts[i];
         if (!options.hasOwnProperty(part) && defaults.default_url_options.hasOwnProperty(part)) {
-          options[part] = defaults.default_url_options[part];
+          _results.push(options[part] = defaults.default_url_options[part]);
+        } else {
+          _results.push(void 0);
         }
       }
+      return _results;
     },
-
     extract_anchor: function(options) {
-      var anchor = options.hasOwnProperty("anchor") ? options.anchor : null;
-      delete options.anchor;
-      return anchor ? "#" + anchor : "";
-    },
+      var anchor;
 
-    extract_options: function(number_of_params, args) {
-      if (args.length > number_of_params) {
-        return typeof(args[args.length-1]) == "object" ?  args.pop() : {};
-      } else {
-        return {};
+      anchor = "";
+      if (options.hasOwnProperty("anchor")) {
+        anchor = "#" + options.anchor;
+        options.anchor = null;
       }
+      return anchor;
     },
+    extract_options: function(number_of_params, args) {
+      var ret_value;
 
+      ret_value = {};
+      if (args.length > number_of_params && typeof args[args.length - 1] === "object") {
+        ret_value = args.pop();
+      }
+      return ret_value;
+    },
     path_identifier: function(object) {
+      var property;
+
       if (object === 0) {
-        return '0';
+        return "0";
       }
-
-      if (! object) { // null, undefined, false or ''
-        return '';
+      if (!object) {
+        return "";
       }
-
-      if (typeof(object) == "object") {
-        var property = object.to_param || object.id || object;
-        if (typeof(property) == "function") {
-          property = property.call(object)
+      property = object;
+      if (typeof object === "object") {
+        property = object.to_param || object.id || object;
+        if (typeof property === "function") {
+          property = property.call(object);
         }
-        return property.toString();
-      } else {
-        return object.toString();
       }
+      return property.toString();
     },
+    clone: function(obj) {
+      var attr, copy, key;
 
-    clone: function (obj) {
-      if (null == obj || "object" != typeof obj) return obj;
-      var copy = obj.constructor();
-      for (var attr in obj) {
-        if (obj.hasOwnProperty(attr)) copy[attr] = obj[attr];
+      if (null === obj || "object" !== typeof obj) {
+        return obj;
+      }
+      copy = obj.constructor();
+      for (key in obj) {
+        if (!__hasProp.call(obj, key)) continue;
+        attr = obj[key];
+        copy[key] = attr;
       }
       return copy;
     },
-
     prepare_parameters: function(required_parameters, actual_parameters, options) {
-      var result = this.clone(options) || {};
-      for (var i=0; i < required_parameters.length; i++) {
-        result[required_parameters[i]] = actual_parameters[i];
+      var i, result, val, _i, _len;
+
+      result = this.clone(options) || {};
+      for (i = _i = 0, _len = required_parameters.length; _i < _len; i = ++_i) {
+        val = required_parameters[i];
+        result[val] = actual_parameters[i];
       }
       return result;
     },
-
     build_path: function(required_parameters, optional_parts, route, args) {
+      var opts, parameters, result;
+
       args = Array.prototype.slice.call(args);
-      var opts = this.extract_options(required_parameters.length, args);
+      opts = this.extract_options(required_parameters.length, args);
       if (args.length > required_parameters.length) {
         throw new Error("Too many parameters provided for path");
       }
-
-      var parameters = this.prepare_parameters(required_parameters, args, opts);
+      parameters = this.prepare_parameters(required_parameters, args, opts);
       this.set_default_url_options(optional_parts, parameters);
-      var result = Utils.get_prefix();
-      var anchor = Utils.extract_anchor(parameters);
-
-      result += this.visit(route, parameters)
-      return Utils.clean_path(result + anchor) + Utils.serialize(parameters);
+      result = "" + (Utils.get_prefix()) + (this.visit(route, parameters));
+      return Utils.clean_path("" + result + (Utils.extract_anchor(parameters))) + Utils.serialize(parameters);
     },
-
-    /*
-     * This function is JavaScript impelementation of the
-     * Journey::Visitors::Formatter that builds route by given parameters
-     * 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).
-     */
     visit: function(route, parameters, optional) {
-      var type = route[0];
-      var left = route[1];
-      var right = route[2];
+      var left, left_part, right, right_part, type, value;
+
+      type = route[0], left = route[1], right = route[2];
       switch (type) {
         case NodeTypes.GROUP:
-          return this.visit(left, parameters, true)
         case NodeTypes.STAR:
-          return this.visit(left, parameters, true)
-        case NodeTypes.CAT:
-          var leftPart = this.visit(left, parameters, optional),
-              rightPart = this.visit(right, parameters, optional);
-
-          if (optional && ! (leftPart && rightPart))
-            return '';
-
-          return leftPart + rightPart;
+          return this.visit(left, parameters, true);
         case NodeTypes.LITERAL:
-          return left;
         case NodeTypes.SLASH:
-          return left;
         case NodeTypes.DOT:
           return left;
+        case NodeTypes.CAT:
+          left_part = this.visit(left, parameters, optional);
+          right_part = this.visit(right, parameters, optional);
+          if (optional && !(left_part && right_part)) {
+            return "";
+          }
+          return "" + left_part + right_part;
         case NodeTypes.SYMBOL:
-          var value = parameters[left];
-
-          if (value || value === 0) {
-            delete parameters[left];
+          value = parameters[left];
+          if (value != null) {
+            parameters[left] = null;
             return this.path_identifier(value);
           }
-
           if (optional) {
-            return '';  // missing parameter
+            return "";
           } else {
             throw new ParameterMissing("Route parameter missing: " + left);
           }
-        /*
-         * I don't know what is this node type
-         * Please send your PR if you do
-         */
-        //case NodeTypes.OR:
+          break;
         default:
           throw new Error("Unknown Rails node type");
       }
     },
+    get_prefix: function() {
+      var prefix;
 
-    get_prefix: function(){
-      var prefix = defaults.prefix;
-
-      if( prefix !== "" ){
-        prefix = prefix.match('\/$') ? prefix : ( prefix + '/');
+      prefix = defaults.prefix;
+      if (prefix !== "") {
+        prefix = (prefix.match("/$") ? prefix : "" + prefix + "/");
       }
-      
       return prefix;
     },
+    namespace: function(root, namespaceString) {
+      var current, parts;
 
-    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('.'));
-        }
+      parts = (namespaceString ? namespaceString.split(".") : []);
+      if (!parts.length) {
+        return;
+      }
+      current = parts.shift();
+      root[current] = root[current] || {};
+      return Utils.namespace(root[current], parts.join("."));
     }
   };
 
-  Utils.namespace(window, 'NAMESPACE');
+  Utils.namespace(window, "NAMESPACE");
+
   window.NAMESPACE = ROUTES;
+
   window.NAMESPACE.options = defaults;
-})();
+
+}).call(this);