backbone_named_routes.js

/*!
 * Backbone Named Routes 0.1.7
 * http://github.com/drtangible/backbone-named-routes
 */

(function(){

  var PATTERNS = {};

  var addRoute = function(name, route, options) {
    options = options || {};

    _.defaults(options, {
      includeRoot: false
    });

    // Create key to store path patterns for this route name.
    PATTERNS[name] = PATTERNS[name] || {};

    // Store the route pattern for the combination of this route name and the
    // number of path params defined in the pattern.
    var numberOfParams = route.match(/\:\w+/g) ? route.match(/\:\w+/g).length : 0;
    PATTERNS[name][numberOfParams] = route;

    // Create the named route helper method for this route name.
    Backbone.NamedRoutes[name + 'Path'] = function() {
      var args = Array.prototype.slice.call(arguments);
      var hasQueryParams = _(args[args.length-1]).isObject();
      var numberOfParams = hasQueryParams ? arguments.length - 1 : arguments.length;
      var routePattern = PATTERNS[name][numberOfParams];
      var queryParams = hasQueryParams ? args.pop() : null;

      if (options.includeRoot) routePattern = prependRoot(routePattern);

      return pathFor(routePattern, args, queryParams);
    };
  };

  var prependRoot = function(route) {
    var history = Backbone.history;
    if (!history || !history.options || history.options.root == "/") return route;

    routeWithRoot = history.options.root + '/' + route;
    return routeWithRoot.replace("//", "/");
  };

  var pathFor = function(pathPattern, urlParams, queryParams) {
    var path = pathPattern;
    if (path.charAt(0) !== "/") path = "/" + path;

    for(var i = 0; i < urlParams.length; i++) {
      var param = urlParams[i];
      path = path.replace(/\:\w+/, param);
    }

    var filteredQueryParams = filterObject(queryParams);

    if (filteredQueryParams && !_.isEmpty(filteredQueryParams)) {
      path += "?" + $.param(filteredQueryParams);
    }
    return path;
  };

  // Filters out `undefined` and `null` values
  var filterObject = function(object) {
    var filteredObject = {}, key;

    for(key in object) {
      if (has(object, key)) {
        if (object[key] != null) {
          filteredObject[key] = object[key];
        }
      }
    }

    return filteredObject;
  };

  // cache reference to `Object.prototype.hasOwnProperty`
  var hasOwnProperty = Object.prototype.hasOwnProperty;

  var has = function(object, key) {
    return hasOwnProperty.call(object, key);
  };

  var initNamedRoutes = resetNamedRoutes = function() {
    PATTERNS = {};

    Backbone.NamedRoutes =
    Backbone.View.prototype.helper =
    Backbone.Model.prototype.helper =
    Backbone.Router.prototype.helper =
    Backbone.Collection.prototype.helper = {
      VERSION: '0.1.7',
      addRoute: addRoute,
      resetNamedRoutes: resetNamedRoutes
    };
  };

  initNamedRoutes();

}).call(this);