TF
/
docuri
mirror of https://github.com/jo/docuri.git
1
0
Fork 0
Code Releases Wiki Activity

Merge pull request #18 from Useclark/no-global-state

Browse Source 
Remove global state, return rules directly
pull/20/head
Johannes Jörg Schmidt 10 years ago
parent 57a4fcfbd9 824d69fd08
commit 4bd7a135cd
9 changed files with 50 additions and 102 deletions
Show Stats Download Patch File Download Diff File

34
README.md
Unescape Escape View File

@ -72,46 +72,34 @@ function which parses
} }
``` ```
### `docuri.route(route, name)` ### `docuri.route(route)`
Create a single route. The `route` argument must be a routing string. The Create a single route. The `route` argument must be a routing string.
`name` argument will be the identifier for the resulting function:
`docuri[name]`. Routes added later may override previously declared routes.
```js ```js
// parses 'page/home' as { id: 'home' }: // parses 'page/home' as { id: 'home' }:
docuri.route('page/:id', 'page'); var page = docuri.route('page/:id');
``` ```
### `docuri.routes(map)` ### `route(strOrObj, [obj])`
Install a routes hash which maps DocURIs with parameters to functions:
```js
docuri.routes({
'movie/:id': 'movie',
'movie/:movie_id/:type/*path': 'movieAsset'
'movie/:movie_id/gallery-image/:id(/:version)': 'galleryImage',
});
```
### `docuri[name](strOrObj, [obj])`
The functions generated by DocURI can have a different behaviour, depending on The functions generated by DocURI can have a different behaviour, depending on
the type and number of the supplied arguments: the type and number of the supplied arguments:
* `name(str)`: parse DocURI string to object * `route(str)`: parse DocURI string to object
* `name(obj)`: generate DocURI string from object * `route(obj)`: generate DocURI string from object
* `name(str, obj)`: change DocURI string parts with values provided by object returning a string * `route(str, obj)`: change DocURI string parts with values provided by object returning a string
The function returns `false` if a string can not be parsed, enabling type The function returns `false` if a string can not be parsed, enabling type
checks. checks.
#### Example #### Example
```js ```js
docuri.movie('movie/blade-runner'); movie('movie/blade-runner');
// { id: 'blade-runner' } // { id: 'blade-runner' }
docuri.movieAsset('movie/blade-runner'); movieAsset('movie/blade-runner');
// false // false
docuri.galleryImage({ movie_id: 'blade-runner', id: 12 }); galleryImage({ movie_id: 'blade-runner', id: 12 });
// 'movie/blade-runner/gallery-image/12' // 'movie/blade-runner/gallery-image/12'
docuri.galleryImage('movie/blade-runner/gallery-image/12', { version: 'large' }); galleryImage('movie/blade-runner/gallery-image/12', { version: 'large' });
// 'movie/blade-runner/gallery-image/12/large' // 'movie/blade-runner/gallery-image/12/large'
``` ```

20
index.js
Unescape Escape View File

@ -9,8 +9,6 @@
var docuri = module.exports = exports = {}; var docuri = module.exports = exports = {};
var reservedNames = ['routes', 'route'];
// Cached regular expressions for matching named param parts and splatted parts // Cached regular expressions for matching named param parts and splatted parts
// of route strings. // of route strings.
// http://backbonejs.org/docs/backbone.html#section-158 // http://backbonejs.org/docs/backbone.html#section-158
@ -65,7 +63,7 @@ function extractParameters(route, fragment) {
} }
params = params.slice(1); params = params.slice(1);
return Object.keys(route.keys).reduce(function(memo, key, i) { return Object.keys(route.keys).reduce(function(memo, key, i) {
var param = params[i]; var param = params[i];
@ -103,22 +101,10 @@ function insertParameters(route, obj) {
} }
// Map routes docuri.route = function(route) {
docuri.routes = function(map) {
Object.keys(map).forEach(function(route) {
docuri.route(route, map[route]);
});
};
// Manually bind a single named route
docuri.route = function(route, name) {
if (reservedNames.indexOf(name) > -1) {
throw('Reserved name "' + name + '" cannot be used.');
}
route = routeToRegExp(route); route = routeToRegExp(route);
docuri[name] = function(source, target) { return function(source, target) {
source = source || {}; source = source || {};
if (target) { if (target) {

8
test/docuri-test.js
Unescape Escape View File

@ -2,11 +2,11 @@ var test = require('tap').test;
var docuri = require('..'); var docuri = require('..');
test('simple route', function(t) { test('simple route', function(t) {
docuri.route('page', 'page'); var page = docuri.route('page');
t.deepEqual(docuri.page('page'), {}, 'parsed page returns empty object'); t.deepEqual(page('page'), {}, 'parsed page returns empty object');
t.equal(docuri.page('image'), false, 'parsed image returns false'); t.equal(page('image'), false, 'parsed image returns false');
t.equal(docuri.page(), 'page', 'generate page url'); t.equal(page(), 'page', 'generate page url');
t.end(); t.end();
}); });

14
test/merge-test.js
Unescape Escape View File

@ -2,26 +2,26 @@ var test = require('tap').test;
var docuri = require('..'); var docuri = require('..');
test('named parameter', function(t) { test('named parameter', function(t) {
docuri.route('page/:id', 'page'); var page = docuri.route('page/:id');
t.equal(docuri.page('page/mypage', { id: 'otherpage' }), 'page/otherpage', 'merged page has "id" set to "otherpage"'); t.equal(page('page/mypage', { id: 'otherpage' }), 'page/otherpage', 'merged page has "id" set to "otherpage"');
t.end(); t.end();
}); });
test('optional parameter', function(t) { test('optional parameter', function(t) {
docuri.route('page(/:id)', 'page'); var page = docuri.route('page(/:id)');
t.deepEqual(docuri.page('page/mypage'), { id: 'mypage' }, 'parsed page has "id" set to "mypage"'); t.deepEqual(page('page/mypage'), { id: 'mypage' }, 'parsed page has "id" set to "mypage"');
t.equal(docuri.page('page/mypage', { id: 'otherpage' }), 'page/otherpage', 'merged page has "id" set to "otherpage"'); t.equal(page('page/mypage', { id: 'otherpage' }), 'page/otherpage', 'merged page has "id" set to "otherpage"');
t.end(); t.end();
}); });
test('two named parameters', function(t) { test('two named parameters', function(t) {
docuri.route('page/:page_id/content/:id', 'content'); var content = docuri.route('page/:page_id/content/:id');
t.equal(docuri.content('page/mypage/content/mycontent', { id: 'othercontent' }), 'page/mypage/content/othercontent', 'merged content has "id" set to "othercontent"'); t.equal(content('page/mypage/content/mycontent', { id: 'othercontent' }), 'page/mypage/content/othercontent', 'merged content has "id" set to "othercontent"');
t.end(); t.end();
}); });

18
test/named-parameter-test.js
Unescape Escape View File

@ -2,28 +2,28 @@ var test = require('tap').test;
var docuri = require('..'); var docuri = require('..');
test('named parameter', function(t) { test('named parameter', function(t) {
docuri.route('page/:id', 'page'); var page = docuri.route('page/:id');
t.deepEqual(docuri.page('page/mypage'), { id: 'mypage' }, 'parsed page has "id" set to "mypage"'); t.deepEqual(page('page/mypage'), { id: 'mypage' }, 'parsed page has "id" set to "mypage"');
t.equal(docuri.page({ id: 'mypage' }), 'page/mypage', 'stringified page results in "page/mypage"'); t.equal(page({ id: 'mypage' }), 'page/mypage', 'stringified page results in "page/mypage"');
t.end(); t.end();
}); });
test('two named parameters', function(t) { test('two named parameters', function(t) {
docuri.route('page/:page_id/content/:id', 'content'); var content = docuri.route('page/:page_id/content/:id');
t.deepEqual(docuri.content('page/mypage/content/mycontent'), { page_id: 'mypage', id: 'mycontent' }, 'parsed content has "page_id" set to "mypage" and "id" set to "mycontent"'); t.deepEqual(content('page/mypage/content/mycontent'), { page_id: 'mypage', id: 'mycontent' }, 'parsed content has "page_id" set to "mypage" and "id" set to "mycontent"');
t.equal(docuri.content({ page_id: 'mypage', id: 'mycontent' }), 'page/mypage/content/mycontent', 'stringified content results in "page/mypage/content/mycontent"'); t.equal(content({ page_id: 'mypage', id: 'mycontent' }), 'page/mypage/content/mycontent', 'stringified content results in "page/mypage/content/mycontent"');
t.end(); t.end();
}); });
test('named parameter followed by optional parameter', function(t) { test('named parameter followed by optional parameter', function(t) {
docuri.route('page/:id(/:optional)', 'page'); var page = docuri.route('page/:id(/:optional)');
t.deepEqual(docuri.page('page/mypage'), { id: 'mypage' }, 'parsed page has "id" set to "mypage"'); t.deepEqual(page('page/mypage'), { id: 'mypage' }, 'parsed page has "id" set to "mypage"');
t.equal(docuri.page({ id: 'mypage', optional: 'number' }), 'page/mypage/number', 'stringified page results in "page/mypage/number"'); t.equal(page({ id: 'mypage', optional: 'number' }), 'page/mypage/number', 'stringified page results in "page/mypage/number"');
t.end(); t.end();
}); });

20
test/optional-parameter-test.js
Unescape Escape View File

@ -2,23 +2,23 @@ var test = require('tap').test;
var docuri = require('..'); var docuri = require('..');
test('optional parameter', function(t) { test('optional parameter', function(t) {
docuri.route('page(/:id)', 'page'); var page = docuri.route('page(/:id)');
t.deepEqual(docuri.page('page'), {}, 'parsed page returns empty object'); t.deepEqual(page('page'), {}, 'parsed page returns empty object');
t.deepEqual(docuri.page('page/mypage'), { id: 'mypage' }, 'parsed page has "id" set to "mypage"'); t.deepEqual(page('page/mypage'), { id: 'mypage' }, 'parsed page has "id" set to "mypage"');
t.equal(docuri.page(), 'page', 'stringified empty page results in "page"'); t.equal(page(), 'page', 'stringified empty page results in "page"');
t.equal(docuri.page({ id: 'mypage' }), 'page/mypage', 'stringified page results in "page/mypage"'); t.equal(page({ id: 'mypage' }), 'page/mypage', 'stringified page results in "page/mypage"');
t.end(); t.end();
}); });
test('surrounded optional parameter', function(t) { test('surrounded optional parameter', function(t) {
docuri.route('page(/:id)/suffix', 'page'); var page = docuri.route('page(/:id)/suffix');
t.deepEqual(docuri.page('page/suffix'), {}, 'parsed page returns empty object'); t.deepEqual(page('page/suffix'), {}, 'parsed page returns empty object');
t.deepEqual(docuri.page('page/mypage/suffix'), { id: 'mypage' }, 'parsed page has "id" set to "mypage"'); t.deepEqual(page('page/mypage/suffix'), { id: 'mypage' }, 'parsed page has "id" set to "mypage"');
t.equal(docuri.page(), 'page/suffix', 'stringified empty page results in "page"'); t.equal(page(), 'page/suffix', 'stringified empty page results in "page"');
t.equal(docuri.page({ id: 'mypage' }), 'page/mypage/suffix', 'stringified page results in "page/mypage"'); t.equal(page({ id: 'mypage' }), 'page/mypage/suffix', 'stringified page results in "page/mypage"');
t.end(); t.end();
}); });

26
test/reserved-names-test.js
Unescape Escape View File

@ -1,26 +0,0 @@
var test = require('tap').test;
var docuri = require('..');
test('reserved name route', function(t) {
t.plan(1);
try {
docuri.route('page', 'route');
} catch(e) {
t.equal(e, 'Reserved name "route" cannot be used.', 'reserved name "route" should throw error');
}
t.end();
});
test('reserved name routes', function(t) {
t.plan(1);
try {
docuri.route('page', 'routes');
} catch(e) {
t.equal(e, 'Reserved name "routes" cannot be used.', 'reserved name "routes" should throw error');
}
t.end();
});

6
test/splat-and-named-parameter-test.js
Unescape Escape View File

@ -2,10 +2,10 @@ var test = require('tap').test;
var docuri = require('..'); var docuri = require('..');
test('splat and named parameter', function(t) { test('splat and named parameter', function(t) {
docuri.route('*splat/page/:named', 'page'); var page = docuri.route('*splat/page/:named');
t.deepEqual(docuri.page('splat/page/named'), { splat: [ 'splat' ], named: 'named' }, 'splat and named parameter parsed correctly'); t.deepEqual(page('splat/page/named'), { splat: [ 'splat' ], named: 'named' }, 'splat and named parameter parsed correctly');
t.equal(docuri.page({ splat: [ 'splat' ], named: 'named' }), 'splat/page/named', 'stringified result is in right order'); t.equal(page({ splat: [ 'splat' ], named: 'named' }), 'splat/page/named', 'stringified result is in right order');
t.end(); t.end();
}); });

6
test/splat-parameter-test.js
Unescape Escape View File

@ -2,10 +2,10 @@ var test = require('tap').test;
var docuri = require('..'); var docuri = require('..');
test('splat parameter', function(t) { test('splat parameter', function(t) {
docuri.route('page/*path', 'page'); var page = docuri.route('page/*path');
t.deepEqual(docuri.page('page/mypage/otherpage'), { path: ['mypage', 'otherpage'] }, 'parsed page has "parts" set to ["mypage","otherpage"]'); t.deepEqual(page('page/mypage/otherpage'), { path: ['mypage', 'otherpage'] }, 'parsed page has "parts" set to ["mypage","otherpage"]');
t.equal(docuri.page({ path: ['mypage', 'otherpage'] }), 'page/mypage/otherpage', 'stringified page results in "page/mypage/otherpage"'); t.equal(page({ path: ['mypage', 'otherpage'] }), 'page/mypage/otherpage', 'stringified page results in "page/mypage/otherpage"');
t.end(); t.end();
}); });

Write Preview
Loading…
Cancel
Save