The router is initialized with a set of routes: a mapping of URL path templates
to route controller objects. Path templates can contain placeholders
- (`/browse/note/:id`) and optional segments (`/browse/:type/:id(/history)`).
+ (`/note/:id`) and optional segments (`/:type/:id(/history)`).
- Route controller objects can define three methods that are called at defined
+ Route controller objects can define four methods that are called at defined
times during routing:
* The `load` method is called by the router when a path which matches the
An instance of OSM.Router is assigned to `OSM.router`. To navigate to a new page
via pushState (with automatic full-page load fallback), call `OSM.router.route`:
- OSM.router.route('/browse/way/1234');
+ OSM.router.route('/way/1234');
If `route` is passed a path that matches one of the path templates, it performs
the appropriate actions and returns true. Otherwise it returns false.
OSM.Router also handles updating the hash portion of the URL containing transient
map state such as the position and zoom level. Some route controllers may wish to
temporarily suppress updating the hash (for example, to omit the hash on pages
- such as `/browse/way/1234` unless the map is moved). This can be done by calling
- `OSM.router.moveListenerOff` and `OSM.router.moveListenerOn`.
+ such as `/way/1234` unless the map is moved). This can be done by using
+ `OSM.router.withoutMoveListener` to run a block of code that may update
+ move the map without the hash changing.
*/
-OSM.Router = function(map, rts) {
- var escapeRegExp = /[\-{}\[\]+?.,\\\^$|#\s]/g;
+OSM.Router = function (map, rts) {
+ var escapeRegExp = /[-{}[\]+?.,\\^$|#\s]/g;
var optionalParam = /\((.*?)\)/g;
- var namedParam = /(\(\?)?:\w+/g;
- var splatParam = /\*\w+/g;
+ var namedParam = /(\(\?)?:\w+/g;
+ var splatParam = /\*\w+/g;
function Route(path, controller) {
- var regexp = new RegExp('^' +
- path.replace(escapeRegExp, '\\$&')
- .replace(optionalParam, '(?:$1)?')
- .replace(namedParam, function(match, optional){
- return optional ? match : '([^\/]+)';
+ var regexp = new RegExp("^" +
+ path.replace(escapeRegExp, "\\$&")
+ .replace(optionalParam, "(?:$1)?")
+ .replace(namedParam, function (match, optional) {
+ return optional ? match : "([^/]+)";
})
- .replace(splatParam, '(.*?)') + '(?:\\?.*)?$');
+ .replace(splatParam, "(.*?)") + "(?:\\?.*)?$");
var route = {};
- route.match = function(path) {
+ route.match = function (path) {
return regexp.test(path);
};
- route.run = function(action, path) {
+ route.run = function (action, path) {
var params = [];
if (path) {
- params = regexp.exec(path).map(function(param, i) {
+ params = regexp.exec(path).map(function (param, i) {
return (i > 0 && param) ? decodeURIComponent(param) : param;
});
}
+ params = params.concat(Array.prototype.slice.call(arguments, 2));
+
return (controller[action] || $.noop).apply(controller, params);
};
}
var routes = [];
- for (var r in rts)
- routes.push(Route(r, rts[r]));
+ for (var r in rts) {
+ routes.push(new Route(r, rts[r]));
+ }
- routes.recognize = function(path) {
+ routes.recognize = function (path) {
for (var i = 0; i < this.length; i++) {
if (this[i].match(path)) return this[i];
}
};
- var currentPath = window.location.pathname + window.location.search,
- currentRoute = routes.recognize(currentPath),
- currentHash = location.hash || OSM.formatHash(map);
+ var currentPath = window.location.pathname.replace(/(.)\/$/, "$1") + window.location.search,
+ currentRoute = routes.recognize(currentPath),
+ currentHash = location.hash || OSM.formatHash(map);
var router = {};
- if (window.history && window.history.pushState) {
- $(window).on('popstate', function(e) {
- if (!e.originalEvent.state) return; // Is it a real popstate event or just a hash change?
- var path = window.location.pathname + window.location.search;
- if (path === currentPath) return;
- currentRoute.run('unload');
- currentPath = path;
- currentRoute = routes.recognize(currentPath);
- currentRoute.run('popstate', currentPath);
- var state = e.originalEvent.state;
- if (state.center) {
- map.setView(state.center, state.zoom, {animate: false});
- map.updateLayers(state.layers);
- }
- });
-
- router.route = function (url) {
- var path = url.replace(/#.*/, ''),
+ $(window).on("popstate", function (e) {
+ if (!e.originalEvent.state) return; // Is it a real popstate event or just a hash change?
+ var path = window.location.pathname + window.location.search,
route = routes.recognize(path);
- if (!route) return false;
- window.history.pushState(OSM.parseHash(url) || {}, document.title, url);
- currentRoute.run('unload');
- currentPath = path;
- currentRoute = route;
- currentRoute.run('pushstate', currentPath);
- return true;
- };
+ if (path === currentPath) return;
+ currentRoute.run("unload", null, route === currentRoute);
+ currentPath = path;
+ currentRoute = route;
+ currentRoute.run("popstate", currentPath);
+ map.setState(e.originalEvent.state, { animate: false });
+ });
+
+ router.route = function (url) {
+ var path = url.replace(/#.*/, ""),
+ route = routes.recognize(path);
+ if (!route) return false;
+ currentRoute.run("unload", null, route === currentRoute);
+ var state = OSM.parseHash(url);
+ map.setState(state);
+ window.history.pushState(state, document.title, url);
+ currentPath = path;
+ currentRoute = route;
+ currentRoute.run("pushstate", currentPath);
+ return true;
+ };
- router.stateChange = function(state) {
- if (state.center) {
- window.history.replaceState(state, document.title, OSM.formatHash(state));
- } else {
- window.history.replaceState(state, document.title, window.location);
- }
- };
- } else {
- router.route = function (url) {
- window.location.assign(url);
- };
+ router.replace = function (url) {
+ window.history.replaceState(OSM.parseHash(url), document.title, url);
+ };
- router.stateChange = function(state) {
- if (state.center) window.location.replace(OSM.formatHash(state));
- };
- }
+ router.stateChange = function (state) {
+ if (state.center) {
+ window.history.replaceState(state, document.title, OSM.formatHash(state));
+ } else {
+ window.history.replaceState(state, document.title, window.location);
+ }
+ };
- router.updateHash = function() {
+ router.updateHash = function () {
var hash = OSM.formatHash(map);
if (hash === currentHash) return;
currentHash = hash;
router.stateChange(OSM.parseHash(hash));
};
- router.hashUpdated = function() {
+ router.hashUpdated = function () {
var hash = location.hash;
if (hash === currentHash) return;
currentHash = hash;
var state = OSM.parseHash(hash);
- if (!state) return;
- map.setView(state.center, state.zoom);
- map.updateLayers(state.layers);
+ map.setState(state);
router.stateChange(state, hash);
};
- router.moveListenerOn = function() {
- map.on('moveend', router.updateHash);
- };
+ router.withoutMoveListener = function (callback) {
+ function disableMoveListener() {
+ map.off("moveend", router.updateHash);
+ map.once("moveend", function () {
+ map.on("moveend", router.updateHash);
+ });
+ }
- router.moveListenerOff = function() {
- map.off('moveend', router.updateHash);
+ map.once("movestart", disableMoveListener);
+ callback();
+ map.off("movestart", disableMoveListener);
};
- router.load = function() {
- var loadState = currentRoute.run('load', currentPath);
+ router.load = function () {
+ var loadState = currentRoute.run("load", currentPath);
router.stateChange(loadState || {});
};
- map.on('moveend baselayerchange overlaylayerchange', router.updateHash);
- $(window).on('hashchange', router.hashUpdated);
+ router.setCurrentPath = function (path) {
+ currentPath = path;
+ currentRoute = routes.recognize(currentPath);
+ };
+
+ map.on("moveend baselayerchange overlaylayerchange", router.updateHash);
+ $(window).on("hashchange", router.hashUpdated);
return router;
};
projects / rails.git / blobdiff