Rephrase the OCI description for clarity

[rails.git] / app / assets / javascripts / router.js

diff --git a/app/assets/javascripts/router.js b/app/assets/javascripts/router.js
index 0c855d2d3f95b1f0c6c83aff2faee585cb856a0b..c397a44ec4de3eeeb0e338aceaeca557f3a6865c 100644 (file)
--- a/app/assets/javascripts/router.js
+++ b/app/assets/javascripts/router.js
@@ -8,7 +8,7 @@
 
   The router is initialized with a set of routes: a mapping of URL path templates
   to route controller objects. Path templates can contain placeholders
 
   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 four methods that are called at defined
   times during routing:
 
   Route controller objects can define four methods that are called at defined
   times during routing:


@@ -34,7 +34,7 @@
    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`:
 
    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.
 
    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.


@@ -42,39 +42,42 @@
    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
    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 optionalParam = /\((.*?)\)/g;

-  var namedParam    = /(\(\?)?:\w+/g;
-  var splatParam    = /\*\w+/g;
+  var namedParam = /(\(\?)?:\w+/g;
+  var splatParam = /\*\w+/g;

 
   function Route(path, controller) {
 
   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 = {};
 
 
     var route = {};
 

-    route.match = function(path) {
+    route.match = function (path) {

       return regexp.test(path);
     };
 
       return regexp.test(path);
     };
 

-    route.run = function(action, path) {
+    route.run = function (action, path) {

       var params = [];
 
       if (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;
         });
       }
 
           return (i > 0 && param) ? decodeURIComponent(param) : param;
         });
       }
 

+      params = params.concat(Array.prototype.slice.call(arguments, 2));
+

       return (controller[action] || $.noop).apply(controller, params);
     };
 
       return (controller[action] || $.noop).apply(controller, params);
     };
 


@@ -82,50 +85,54 @@ OSM.Router = function(map, rts) {
   }
 
   var routes = [];
   }
 
   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];
     }
   };
 
     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) {
 
   var router = {};
 
   if (window.history && window.history.pushState) {

-    $(window).on('popstate', function(e) {
+    $(window).on("popstate", function (e) {

       if (!e.originalEvent.state) return; // Is it a real popstate event or just a hash change?
       if (!e.originalEvent.state) return; // Is it a real popstate event or just a hash change?

-      var path = window.location.pathname + window.location.search;
+      var path = window.location.pathname + window.location.search,
+          route = routes.recognize(path);

       if (path === currentPath) return;
       if (path === currentPath) return;

-      currentRoute.run('unload');
+      currentRoute.run("unload", null, route === currentRoute);

       currentPath = path;
       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);
-      }
+      currentRoute = route;
+      currentRoute.run("popstate", currentPath);
+      map.setState(e.originalEvent.state, { animate: false });

     });
 
     router.route = function (url) {
     });
 
     router.route = function (url) {

-      var path = url.replace(/#.*/, ''),
-        route = routes.recognize(path);
+      var path = url.replace(/#.*/, ""),
+          route = routes.recognize(path);

       if (!route) return false;
       if (!route) return false;

-      window.history.pushState(OSM.parseHash(url) || {}, document.title, url);
-      currentRoute.run('unload');
+      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;
       currentPath = path;
       currentRoute = route;

-      currentRoute.run('pushstate', currentPath);
+      currentRoute.run("pushstate", currentPath);

       return true;
     };
 
       return true;
     };
 

-    router.stateChange = function(state) {
+    router.replace = function (url) {
+      window.history.replaceState(OSM.parseHash(url), document.title, url);
+    };
+
+    router.stateChange = function (state) {

       if (state.center) {
         window.history.replaceState(state, document.title, OSM.formatHash(state));
       } else {
       if (state.center) {
         window.history.replaceState(state, document.title, OSM.formatHash(state));
       } else {


@@ -133,48 +140,56 @@ OSM.Router = function(map, rts) {
       }
     };
   } else {
       }
     };
   } else {

-    router.route = function (url) {
+    router.route = router.replace = function (url) {

       window.location.assign(url);
     };
 
       window.location.assign(url);
     };
 

-    router.stateChange = function(state) {
+    router.stateChange = function (state) {

       if (state.center) window.location.replace(OSM.formatHash(state));
     };
   }
 
       if (state.center) window.location.replace(OSM.formatHash(state));
     };
   }
 

-  router.updateHash = function() {
+  router.updateHash = function () {

     var hash = OSM.formatHash(map);
     if (hash === currentHash) return;
     currentHash = hash;
     router.stateChange(OSM.parseHash(hash));
   };
 
     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);
     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.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 || {});
   };
 
     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;
 };
 
   return router;
 };