helpers.js | |
|---|---|
| CamelCase +var camelize = function(str,capitalize){ + var ret = str.replace( /[^a-zA-Z][a-zA-Z]/g, function(str){ + return str[1].toUpperCase(); + }); + if (capitalize) return ret.replace(/^./,function(str){ + return str.toUpperCase(); + }); + return ret; +} | |
| snake_case | exports.snakeize = function(str){
+ return str.replace( /[A-Z]|\d+/g, function(str){
+ return '_'+str.toLowerCase();
+ }).replace(/^[^a-zA-Z0-9]|[^a-zA-Z0-9]$/,'');
+} |
| deep object mixer | exports.mixin = function(){
+ var args = Array.prototype.slice.call(arguments)
+
+ for ( i=1; i < args.length; i++ ) {
+
+ for ( var prop in args[i] ) {
+ if ( exports.kindof(args[i][prop]) == 'object' ) { |
| deep copy | args[0][prop] = mixin( {}, args[i][prop] )
+ } else { |
| shallow copy | args[0][prop] = args[i][prop]
+ }
+ }
+ }
+ return args[0]
+} |
| escapes a string on its way in to a regex pattern | exports.regExpEscape = (function() {
+ var specials = [ '/', '.', '*', '+', '?', '|', '(', ')', '[', ']', '{', '}', '\\' ]
+ sRE = new RegExp('(\\' + specials.join('|\\') + ')', 'g')
+ return function (text) { return text.replace(sRE, '\\$1') }
+})();
+
+exports.kindof = function(o) {
+ if (typeof(o) != "object") return typeof(o)
+ if (o === null) return "null"
+ if (o.constructor == (new Array).constructor) return "array"
+ if (o.constructor == (new Date).constructor) return "date"
+ if (o.constructor == (new RegExp).constructor) return "regex"
+ return "object"
+}
+
+ |
index.js | |
|---|---|
exports.Router = require('./lib/router').Router;
+
+ |
key.js | |
|---|---|
new Key( name, optional )+ +those variable thingies + + | var Key = function( name, optional ) {
+
+ var self = this
+
+ self.name = name
+ self.optional = (optional===true) ? true : false
+ self.regex = /[\w\-]+/ // default url-friendly regex |
| special defaults for controllers & actions, which will always be function-name-safe | if (self.name == 'controller' || self.name == 'action') {
+ self.regex = /[a-zA-Z_][\w\-]*/
+ } |
key.regexString()+ +makes a regex string of the key - used by key.test() + +returns a string of this keys regex | this.regexString = function() {
+ var ret = String(self.regex).replace(/^\//, '').replace(/\/[gis]?$/, '')
+ if (self.optional) {
+ return '(' + ret + ')?'
+ }
+ return '(' + ret + ')'
+ }; |
key.test( string )+ +validates a string using the key's regex pattern + +returns true/false if the string matches | this.test = function( string ) {
+ return new RegExp('^'+self.regexString()+'$').test(string)
+ }; |
key.url( string )+ +returns a string for buulding the url +if it matches the key conditions | this.url = function( string ) {
+ if (self.test(string)) {
+ /*
+ -- no longer needed
+ snake_caseify the controller, if there is one
+ if (self.name == 'controller') return snakeize(string)
+ */
+ return string
+ }
+ return false // doesn't match, let it go
+ };
+ |
key.where( conditions )+ +adds conditions that the key must match + +returns the key... because it can? | this.where = function( conditions ) {
+
+ var condition = conditions[self.name]
+
+ if (condition instanceof RegExp) self.regex = condition // e.g. /\d+/
+
+ if (condition instanceof String) self.regex = new RegExp(condition) // e.g. "/\d+/" |
| an array of allowed values, e.g. ['stop','play','pause'] | if (condition instanceof Array) self.regex = new RegExp('/'+condition.join('|')+'/')
+
+ return self
+ }
+
+ return self // just in case we forgot the new operator
+};
+
+exports.Key = Key
+
+ |
route.js | |
|---|---|
var Key = require('./key').Key,
+ regExpEscape = require('./helpers').regExpEscape,
+ mixin = require('./helpers').mixin,
+ kindof = require('./helpers').kindof | |
new Route( path [, method] )+ +turns strings into magical ponies that come when you call them + +Pretty familiar to anyone who's used Merb/Rails - called by Router.match() | var Route = function( path, method ) {
+
+ var self = this, |
| !x! regexen crossing !x! +matches keys | KEY = /:([a-zA-Z_][\w\-]*)/, |
| optional group (the part in parens) | OGRP = /\(([^)]+)\)/, |
| breaks a string into atomic parts: ogrps, keys, then everything else | PARTS = /\([^)]+\)|:[a-zA-Z_][\w\-]*|[\w\-_\\\/\.]+/g |
| is this a nested, optional url segment like (.:format) | self.optional = false |
| uppercase the method name | if (typeof(method) == 'string') self.method = method.toUpperCase() |
| base properties | self.params = {}
+ self.parts = []
+ self.route_name = null
+ self.path = path
+ /*self.regex = null // for caching of test() regex MAYBE*/ |
route.regexString()+ +returns a composite regex string of all route parts | this.regexString = function() {
+ var ret = '' |
| a route regex is a composite of its parts' regexe(s|n) | for (var i in self.parts) {
+ var part = self.parts[i]
+ if (part instanceof Key) {
+ ret += part.regexString()
+ } else if (part instanceof Route) {
+ ret += part.regexString()
+ } else { // string
+ ret += regExpEscape(part)
+ }
+ }
+ return '('+ret+')'+(self.optional ? '?' : '')
+ }; |
route.test( string )+ +builds & tests on a full regex of the entire path + +returns true/false depending on whether the url matches | this.test = function( string ) {
+ /*
+ TODO cache this if it makes sense, code below:
+ if(self.regex == null) self.regex = RegExp('^' + self.regexString() + '(\\\?.*)?$')
+ return self.regex.test(string)
+ */
+ return RegExp('^' + self.regexString() + '(\\\?.*)?$').test(string)
+ }; |
route.to( endpoint [, extra_params ] )+ +defines the endpoint & mixes in optional params + +returns the route for chaining | this.to = function( endpoint, extra_params ) {
+
+ if ( !extra_params && typeof endpoint != 'string' ) {
+ extra_params = endpoint
+ endpoint = undefined
+ }
+
+ /*
+ TODO: make endpoint optional, since you can have the
+ controller & action in the URL utself,
+ even though that's a terrible idea...
+ */
+
+ if ( endpoint ){
+ endpoint = endpoint.split('.')
+ if( kindof(endpoint) == 'array' && endpoint.length != 2 ) throw 'syntax should be in the form: controller.action'
+ this.params.controller = endpoint[0]
+ this.params.action = endpoint[1]
+ }
+
+ extra_params = kindof(extra_params) == 'object' ? extra_params : {}
+ mixin(self.params, extra_params)
+
+ return this // chainable
+ }; |
route.name( name )+ +just sets the route name - NAMED ROUTES ARE NOT CURRENTLY USED + +returns: the route for chaining | this.name = function( name ) {
+ self.route_name = name
+ return self // chainable
+ }; |
route.where( conditions )+ +sets conditions that each url variable must match for the URL to be valid + +returns: the route for chaining | this.where = function( conditions ) {
+
+ var self = this
+
+ if ( kindof(conditions) != 'object' ) throw 'conditions must be an object'
+
+ for (var i in self.parts) {
+ if (self.parts[i] instanceof Key || self.parts[i] instanceof Route) { |
| recursively apply all conditions to sub-parts | self.parts[i].where(conditions)
+ }
+ }
+
+ return self // chainable
+ };
+ |
route.stringify( params )+ +builds a string url for this Route from a params object + +returns: [ "url", [leftover params] ] + +this is meant to be called & modified by router.url() | this.stringify = function( params ) {
+ var url = [] // urls start life as an array to enble a second pass
+
+ for (var i in self.parts) {
+ var part = self.parts[i]
+ if (part instanceof Key) {
+ if (typeof(params[part.name]) != 'undefined' &&
+ part.regex.test(params[part.name])) { |
| there's a param named this && the param matches the key's regex | url.push(part.url(params[part.name])); // push it onto the stack
+ delete params[part.name] // and remove from list of params
+ } else if (self.optional) { |
| (sub)route doesn't match, move on | return false
+ }
+ } else if (part instanceof Route) { |
| sub-routes must be handled in the next pass +to avoid leftover param duplication | url.push(part)
+ } else { // string
+ url.push(part)
+ }
+ }
+ |
| second pass, resolve optional parts | for (var i in url) {
+ if (url[i] instanceof Route) {
+ url[i] = url[i].stringify(params) // recursion is your friend |
| it resolved to a url fragment! | if (url[i]) { |
| replace leftover params hash with the new, smaller leftover params hash | params = url[i][1] |
| leave only the string for joining | url[i] = url[i][0]
+ } else {
+ delete url[i] // get rid of these shits
+ }
+ }
+ }
+
+ for (var i in self.params) { |
| remove from leftovers, they're implied in the to() portion of the route | delete params[i]
+ }
+
+ return [ url.join(''), params ]
+ };
+ |
route.keysAndRoutes()+ +just the parts that aren't strings. basically + +returns an array of Key and Route objects | this.keysAndRoutes = function() {
+ var knr = []
+ for (var i in self.parts) {
+ if (self.parts[i] instanceof Key || self.parts[i] instanceof Route) {
+ knr.push(self.parts[i])
+ }
+ }
+ return knr
+ }; |
route.keys()+ +just the parts that are Keys + +returns an array of aforementioned Keys | this.keys = function() {
+ var keys = []
+ for (var i in self.parts) {
+ if (self.parts[i] instanceof Key) {
+ keys.push(self.parts[i])
+ }
+ }
+ return keys;
+ }; |
route.parse( url, method )+ +parses a URL into a params object + +returns: a params hash || false (if the route doesn't match) + +this is meant to be called by Router.first() && Router.all() | this.parse = function( urlParam, method ) {
+ |
| parse the URL with the regex & step along with the parts, +assigning the vals from the url to the names of the keys as we go (potentially stoopid) | |
| let's chop off the QS to make life easier | var url = require('url').parse(urlParam)
+ var path = url.pathname
+ var params = {method:method}
+
+ for (var key in self.params) { params[key] = self.params[key] } |
| if the method doesn't match, gtfo immediately | if (typeof self.method != 'undefined' && self.method != params.method) return false
+
+ /* TODO: implement substring checks for possible performance boost */ |
| if the route doesn't match the regex, gtfo | if (!self.test(path)) {
+ return false
+ } |
| parse the URL with the regex | var parts = new RegExp('^' + self.regexString() + '$').exec(path)
+ var j = 2; // index of the parts array, starts at 2 to bypass the entire match string & the entire match
+
+ var keysAndRoutes = self.keysAndRoutes()
+
+ for (var i in keysAndRoutes) {
+ if (keysAndRoutes[i] instanceof Key) {
+ if (keysAndRoutes[i].test(parts[j])) {
+ params[keysAndRoutes[i].name] = parts[j]
+ }
+ } else if (keysAndRoutes[i] instanceof Route) {
+ if (keysAndRoutes[i].test(parts[j])) { |
| parse the subroute | var subparams = keysAndRoutes[i].parse(parts[j], method)
+ mixin(params, subparams) |
| advance the parts pointer by the number of submatches | j+= parts[j].match(keysAndRoutes[i].regexString()).length-2 || 0
+ } else {
+ j++;
+ }
+ }
+ j++;
+ }
+
+ return params
+ }; |
| path parsing | while (part = PARTS.exec(path)) {
+ self.parts.push(part)
+ }
+ |
| have to do this in two passes due to RegExp execution limits | for (var i in self.parts) {
+ if (OGRP.test(self.parts[i])) { // optional group
+ self.parts[i] = new Route(OGRP.exec(self.parts[i])[1], true)
+ self.parts[i].optional = true
+
+ } else if(KEY.test(self.parts[i])) { // key
+ var keyname = KEY.exec(self.parts[i])[1]
+ self.parts[i] = new Key(keyname)
+ } else { // string
+ self.parts[i] = String(self.parts[i])
+ }
+ }
+
+ return self
+
+}; // Route
+
+
+exports.Route = Route
+
+ |
router.js | |
|---|---|
var Route = require('./route').Route,
+ snakeize = require('./helpers').snakeize | |
new Router()+ +Simple router for Node -- setting up routes looks like this: + +Pretty familiar to anyone who's used Merb/Rails | var Router = function() {
+
+ var METHODS = /^(GET|POST|PUT|DELETE)$/i,
+ self = this
+
+ this.routes = []
+ |
router.match( path [, method] )+ +path is mandatory (duh) +method is optional, routes without a method will apply in all cases + +returns the route (for chaining) | this.match = function( path, method ) {
+
+ if ( typeof path != 'string' ) throw 'path must be a string'
+
+ if ( typeof method != 'undefined' && !METHODS.test(method)) throw 'method must be one of: get, post, put, delete'
+
+ var route = new Route(path, method)
+ self.routes.push(route)
+
+ return route
+ }; |
convenience methods | |
router.get( path )+ +equivalent to + + | this.get = function( path ){
+ return this.match(path, 'GET')
+ } |
router.put( path )+ +equivalent to + + | this.put = function( path ){
+ return this.match(path, 'PUT')
+ } |
router.post( path )+ +equivalent to + + | this.post = function( path ){
+ return this.match(path, 'POST')
+ } |
router.delete( path )+ +equivalent to + + | this.delete = function( path ){
+ return this.match(path, 'DELETE')
+ } |
router.resource( controller )+ +generates standard resource routes for a controller name + +returns an array of routes (for now, this may change) | this.resource = function( controller ) {
+ var controller_slug = snakeize(controller)
+ return [
+ self.get('/'+controller_slug+'(.:format)', 'GET').to(controller+'.index'),
+ self.get('/'+controller_slug+'/add(.:format)', 'GET').to(controller+'.add'),
+ self.get('/'+controller_slug+'/:id(.:format)', 'GET').to(controller+'.show'),
+ self.get('/'+controller_slug+'/:id/edit(.:format)', 'GET').to(controller+'.edit'),
+ self.post('/'+controller_slug+'(.:format)', 'POST').to(controller+'.create'),
+ self.put('/'+controller_slug+'/:id(.:format)', 'PUT').to(controller+'.update'),
+ self.delete('/'+controller_slug+'/:id(.:format)', 'DELETE').to(controller+'.destroy')
+ ];
+ };
+
+ |
router.first( path, method, callback )+ +find the first route that match the path & method + +find & return a params hash from the first route that matches. If there's no match, this will return false + +If the options callback function is provided, it will be fired like so: + + | this.first = function( path, method, cb ) {
+ var params = false
+
+ for (var i in self.routes) {
+ |
| attempt the parse | params = self.routes[i].parse(path, method)
+ if (params) { |
| fire the callback if given | if (typeof cb == 'function') cb(false, params) |
| may as well return this | return params
+ }
+
+ }
+ if (typeof cb == 'function') cb('No matching routes found')
+ return false
+ };
+ |
router.all( path [, method] )+ +find & return a params hash from ALL routes that match + +if there ares no matches, returns an empty array | this.all = function( path, method ) {
+ var ret = [],
+ params = false
+
+ for (var i in self.routes) {
+ params = self.routes[i].parse(path, method) // TODO: use call or apply (I forget which) to make 'method' optional
+ if (params) ret.push(params)
+ }
+ return ret;
+ };
+ |
router.url( params[, add_querystring=false] )+ +generates a URL from a params hash + +returns false if there are no suitable routes | this.url = function( params, add_querystring ) {
+ var url = false
+ |
| iterate through the existing routes until a suitable match is found | for (var i in self.routes) { |
| do the controller & acton match? | if (typeof(self.routes[i].params.controller) != 'undefined' &&
+ self.routes[i].params.controller != params.controller) {
+ continue
+ }
+ if (typeof(self.routes[i].params.action) != 'undefined' &&
+ self.routes[i].params.action != params.action) {
+ continue
+ }
+ url = self.routes[i].stringify(params);
+ if (url) {
+ break;
+ }
+ }
+
+ if (!url) return false // no love? return false
+
+ var qs = require('querystring').stringify(url[1]) // build the possibly empty query string
+
+ if (add_querystring && qs.length > 0) return url[0] + '?' + qs // if there is a query string...
+
+ return url[0] // just return the url
+ }; |
router.defer( testfn() )+ +test should be a function that examines non-standard URLs + +path and method will be passed in - expects a params hash back OR false on a non-match + +returns: DeferredRoute (for... reference? I dunno.) + +THIS IS CURRENTLY COMPLETELY UNTESTED. IT MIGHT NOT EVEN WORK. SERIOUSLY. | this.defer = function( fn ) {
+ if ( typeof(fn) != 'function' ) throw 'Router.defer requires a function as the only argument'
+
+ var route = new Route('deferred')
+ route.parse = fn // add the custom parser
+ delete route.test // = function(){return false};
+ delete route.stringify //= function(){ throw 'Deferred routes are NOT generatable'};
+ self.routes.push(route)
+ return route
+ }
+
+}; // Router
+
+exports.Router = Router
+
+ |