Merge pull request #22 from websdk/resource-metadata

Add metadata to resources, and the ability to find them by path

Author: mstade

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@websdk/nap",
-  "version": "0.10.7",
+  "version": "0.11.0",
   "description": "Organizing applications into resources",
   "main": "lib/nap.js",
   "devDependencies": {

src/nap.js

@@ -172,33 +172,42 @@ function newWeb(){
     , routes = rhumb.create()
     , middleware = []
 
-  web.resource = function(name, ptn, handler){
-    if(arguments.length == 1) return resources[name]
-
-    if(arguments.length == 2) {
+  web.resource = function(name, ptn, handler, metadata) {
+    if (arguments.length == 1) {
+      return resources[name]
+    } else if (arguments.length == 2) {
+      handler = ptn
+      ptn = name
+    } else if (arguments.length == 3 && typeof handler !== 'function') {
+      metadata = handler
       handler = ptn
       ptn = name
     }
 
+    metadata || (metadata = {})
+
     handler = wrap(handler, middleware)
 
     resources[name] = {
       name : name
     , ptn : ptn
     , handler : handler
+    , metadata : metadata
     }
 
     routes.add(ptn, function(params){
       return {
         fn : handler
       , params : params
+      , metadata: metadata
       }
     })
     return web
   }
 
+  web.find = find
+
   web.req = function(path, cb){
-    
     var req = isStr(path) ? {uri: path} : path
       , cb = cb || noop
 
@@ -208,7 +217,7 @@ function newWeb(){
     req.headers || (req.headers = {})
     req.headers.accept || (req.headers.accept = "application/x.nap.view")
 
-    var match = routes.match(req.uri) || { fn : wrap(notFound, middleware) }
+    var match = find(req.uri) || { fn: wrap(notFound, middleware) }
     req.params = match.params
     match.fn.call(null, req, cb)
     return web
@@ -238,6 +247,10 @@ function newWeb(){
   }
 
   return web
+
+  function find(path) {
+    return routes.match(path)
+  }
 }
 
 module.exports = nap

test/web.test.js

@@ -85,6 +85,39 @@ test('Web resource handlers should invoke a response callback if given', functio
   })
 })
 
+test('Web should return handler, params, and metadata when finding a resource by path', function(t) {
+  t.plan(12)
+  var web  = nap.web()
+    , fn_a = function() {}
+    , fn_b = function() {}
+    , fn_c = function() {}
+    , fn_d = function() {}
+
+  web.resource('/no/metadata/no/params', fn_a)
+  var a = web.find('/no/metadata/no/params')
+  t.equal(a.fn, fn_a)
+  t.deepEqual(a.params, {})
+  t.deepEqual(a.metadata, {})
+
+  web.resource('/with/metadata/no/params', fn_b, { foo: 'bar' })
+  var b = web.find('/with/metadata/no/params')
+  t.equal(b.fn, fn_b)
+  t.deepEqual(b.params, {})
+  t.deepEqual(b.metadata, { foo: 'bar' })
+
+  web.resource('/{with}/metadata/and/{params}', fn_c, { baz: 'wibble' })
+  var c = web.find('/some/metadata/and/fun')
+  t.equal(c.fn, fn_c)
+  t.deepEqual(c.params, { with: 'some', params: 'fun' })
+  t.deepEqual(c.metadata, { baz: 'wibble' })
+
+  web.resource('named', '/also/{with}/metadata/and/{params}', fn_d, { boo: 'moo' })
+  var d = web.find('/also/some/metadata/and/fun')
+  t.equal(d.fn, fn_d)
+  t.deepEqual(d.params, { with: 'some', params: 'fun' })
+  t.deepEqual(d.metadata, { boo: 'moo' })
+})
+
 test("Web should respond with a 404 if no resource is found", function(t) {
   t.plan(1)
   var web = nap.web()