Refactor direction engines and unify structure

[rails.git] / app / assets / javascripts / index / directions / fossgis_osrm.js

diff --git a/app/assets/javascripts/index/directions/fossgis_osrm.js b/app/assets/javascripts/index/directions/fossgis_osrm.js
index 3989ff2b6441c1f3e87c9725ce16b8f11a40cdb7..bb968f2da3c5594175d9fb72a2dc5299d4f2d87b 100644 (file)
--- a/app/assets/javascripts/index/directions/fossgis_osrm.js
+++ b/app/assets/javascripts/index/directions/fossgis_osrm.js
@@ -1,43 +1,39 @@
 // OSRM engine
 // Doesn't yet support hints
 
 // OSRM engine
 // Doesn't yet support hints
 

-function FOSSGISOSRMEngine(id, vehicleType) {
-  var cachedHints = [];
-
-  return {
-    id: id,
-    creditline: "<a href=\"https://routing.openstreetmap.de/about.html\" target=\"_blank\">OSRM (FOSSGIS)</a>",
-    draggable: true,
-
-    _transformSteps: function (input_steps, line) {
-      var INSTRUCTION_TEMPLATE = {
-        "continue": "javascripts.directions.instructions.continue",
-        "merge right": "javascripts.directions.instructions.merge_right",
-        "merge left": "javascripts.directions.instructions.merge_left",
-        "off ramp right": "javascripts.directions.instructions.offramp_right",
-        "off ramp left": "javascripts.directions.instructions.offramp_left",
-        "on ramp right": "javascripts.directions.instructions.onramp_right",
-        "on ramp left": "javascripts.directions.instructions.onramp_left",
-        "fork right": "javascripts.directions.instructions.fork_right",
-        "fork left": "javascripts.directions.instructions.fork_left",
-        "end of road right": "javascripts.directions.instructions.endofroad_right",
-        "end of road left": "javascripts.directions.instructions.endofroad_left",
-        "turn straight": "javascripts.directions.instructions.continue",
-        "turn slight right": "javascripts.directions.instructions.slight_right",
-        "turn right": "javascripts.directions.instructions.turn_right",
-        "turn sharp right": "javascripts.directions.instructions.sharp_right",
-        "turn uturn": "javascripts.directions.instructions.uturn",
-        "turn sharp left": "javascripts.directions.instructions.sharp_left",
-        "turn left": "javascripts.directions.instructions.turn_left",
-        "turn slight left": "javascripts.directions.instructions.slight_left",
-        "roundabout": "javascripts.directions.instructions.roundabout",
-        "rotary": "javascripts.directions.instructions.roundabout",
-        "exit roundabout": "javascripts.directions.instructions.exit_roundabout",
-        "exit rotary": "javascripts.directions.instructions.exit_roundabout",
-        "depart": "javascripts.directions.instructions.start",
-        "arrive": "javascripts.directions.instructions.destination"
+(function () {
+  function FOSSGISOSRMEngine(id, vehicleType) {
+    let cachedHints = [];
+
+    function _processDirections(route) {
+      const INSTRUCTION_TEMPLATE = {
+        "continue": "continue",
+        "merge right": "merge_right",
+        "merge left": "merge_left",
+        "off ramp right": "offramp_right",
+        "off ramp left": "offramp_left",
+        "on ramp right": "onramp_right",
+        "on ramp left": "onramp_left",
+        "fork right": "fork_right",
+        "fork left": "fork_left",
+        "end of road right": "endofroad_right",
+        "end of road left": "endofroad_left",
+        "turn straight": "continue",
+        "turn slight right": "slight_right",
+        "turn right": "turn_right",
+        "turn sharp right": "sharp_right",
+        "turn uturn": "uturn",
+        "turn sharp left": "sharp_left",
+        "turn left": "turn_left",
+        "turn slight left": "slight_left",
+        "roundabout": "roundabout",
+        "rotary": "roundabout",
+        "exit roundabout": "exit_roundabout",
+        "exit rotary": "exit_roundabout",
+        "depart": "start",
+        "arrive": "destination"

       };
       };

-      var ICON_MAP = {
+      const ICON_MAP = {

         "continue": 0,
         "merge right": 21,
         "merge left": 20,
         "continue": 0,
         "merge right": 21,
         "merge left": 20,


@@ -64,149 +60,137 @@ function FOSSGISOSRMEngine(id, vehicleType) {
         "depart": 8,
         "arrive": 14
       };
         "depart": 8,
         "arrive": 14
       };

-      var numToWord = function (num) {
+      function numToWord(num) {

         return ["first", "second", "third", "fourth", "fifth", "sixth", "seventh", "eighth", "ninth", "tenth"][num - 1];
         return ["first", "second", "third", "fourth", "fifth", "sixth", "seventh", "eighth", "ninth", "tenth"][num - 1];

-      };
-      var transformed_steps = input_steps.map(function (step, idx) {
-        var maneuver_id;
-
+      }
+      function getManeuverId(maneuver) {

         // special case handling
         // special case handling

-        switch (step.maneuver.type) {
+        switch (maneuver.type) {

           case "on ramp":
           case "off ramp":
           case "merge":
           case "end of road":
           case "fork":
           case "on ramp":
           case "off ramp":
           case "merge":
           case "end of road":
           case "fork":

-            maneuver_id = step.maneuver.type + " " + (step.maneuver.modifier.indexOf("left") >= 0 ? "left" : "right");
-            break;
+            return maneuver.type + " " + (maneuver.modifier.indexOf("left") >= 0 ? "left" : "right");

           case "depart":
           case "arrive":
           case "roundabout":
           case "rotary":
           case "exit roundabout":
           case "exit rotary":
           case "depart":
           case "arrive":
           case "roundabout":
           case "rotary":
           case "exit roundabout":
           case "exit rotary":

-            maneuver_id = step.maneuver.type;
-            break;
+            return maneuver.type;

           case "roundabout turn":
           case "turn":
           case "roundabout turn":
           case "turn":

-            maneuver_id = "turn " + step.maneuver.modifier;
-            break;
-          // for unknown types the fallback is turn
+            return "turn " + maneuver.modifier;
+            // for unknown types the fallback is turn

           default:
           default:

-            maneuver_id = "turn " + step.maneuver.modifier;
-            break;
-        }
-        var template = INSTRUCTION_TEMPLATE[maneuver_id];
-
-        // convert lat,lng pairs to LatLng objects
-        var step_geometry = L.PolylineUtil.decode(step.geometry, { precision: 5 }).map(function (a) { return L.latLng(a); });
-        // append step_geometry on line
-        Array.prototype.push.apply(line, step_geometry);
-
-        var instText = "<b>" + (idx + 1) + ".</b> ";
-        var destinations = "<b>" + step.destinations + "</b>";
-        var namedRoad = true;
-        var name;
-
-        if (step.name && step.ref) {
-          name = "<b>" + step.name + " (" + step.ref + ")</b>";
-        } else if (step.name) {
-          name = "<b>" + step.name + "</b>";
-        } else if (step.ref) {
-          name = "<b>" + step.ref + "</b>";
-        } else {
-          name = I18n.t("javascripts.directions.instructions.unnamed");
-          namedRoad = false;
+            return "turn " + maneuver.modifier;

         }
         }

+      }
+
+      const steps = route.legs.flatMap(
+        leg => leg.steps.map(function (step, idx) {
+          const maneuver_id = getManeuverId(step.maneuver);
+
+          const instrPrefix = "javascripts.directions.instructions.";
+          let template = instrPrefix + INSTRUCTION_TEMPLATE[maneuver_id];
+
+          const step_geometry = L.PolylineUtil.decode(step.geometry, { precision: 5 }).map(L.latLng);

 
 

-        if (step.maneuver.type.match(/^exit (rotary|roundabout)$/)) {
-          instText += I18n.t(template, { name: name });
-        } else if (step.maneuver.type.match(/^(rotary|roundabout)$/)) {
-          if (step.maneuver.exit) {
-            if (step.maneuver.exit <= 10) {
-              instText += I18n.t(template + "_with_exit_ordinal", { exit: I18n.t("javascripts.directions.instructions.exit_counts." + numToWord(step.maneuver.exit)), name: name });
+          let instText = "<b>" + (idx + 1) + ".</b> ";
+          const destinations = "<b>" + step.destinations + "</b>";
+          let namedRoad = true;
+          let name;
+
+          if (step.name && step.ref) {
+            name = "<b>" + step.name + " (" + step.ref + ")</b>";
+          } else if (step.name) {
+            name = "<b>" + step.name + "</b>";
+          } else if (step.ref) {
+            name = "<b>" + step.ref + "</b>";
+          } else {
+            name = I18n.t(instrPrefix + "unnamed");
+            namedRoad = false;
+          }
+
+          if (step.maneuver.type.match(/^exit (rotary|roundabout)$/)) {
+            instText += I18n.t(template, { name: name });
+          } else if (step.maneuver.type.match(/^(rotary|roundabout)$/)) {
+            if (step.maneuver.exit) {
+              if (step.maneuver.exit <= 10) {
+                instText += I18n.t(template + "_with_exit_ordinal", { exit: I18n.t(instrPrefix + "exit_counts." + numToWord(step.maneuver.exit)), name: name });
+              } else {
+                instText += I18n.t(template + "_with_exit", { exit: step.maneuver.exit, name: name });
+              }

             } else {
             } else {

-              instText += I18n.t(template + "_with_exit", { exit: step.maneuver.exit, name: name });
+              instText += I18n.t(template + "_without_exit", { name: name });

             }
             }

+          } else if (step.maneuver.type.match(/^(on ramp|off ramp)$/)) {
+            const params = {};
+            if (step.exits && step.maneuver.type.match(/^(off ramp)$/)) params.exit = step.exits;
+            if (step.destinations) params.directions = destinations;
+            if (namedRoad) params.directions = name;
+            if (Object.keys(params).length > 0) {
+              template = template + "_with_" + Object.keys(params).join("_");
+            }
+            instText += I18n.t(template, params);

           } else {
             instText += I18n.t(template + "_without_exit", { name: name });
           }
           } else {
             instText += I18n.t(template + "_without_exit", { name: name });
           }

-        } else if (step.maneuver.type.match(/^(on ramp|off ramp)$/)) {
-          var params = {};
-          if (step.exits && step.maneuver.type.match(/^(off ramp)$/)) params.exit = step.exits;
-          if (step.destinations) params.directions = destinations;
-          if (namedRoad) params.directions = name;
-          if (Object.keys(params).length > 0) {
-            template = template + "_with_" + Object.keys(params).join("_");
-          }
-          instText += I18n.t(template, params);
-        } else {
-          instText += I18n.t(template + "_without_exit", { name: name });
-        }
-        return [[step.maneuver.location[1], step.maneuver.location[0]], ICON_MAP[maneuver_id], instText, step.distance, step_geometry];
-      });
-
-      return transformed_steps;
-    },
-
-    getRoute: function (points, callback) {
-      var params = [
-        { name: "overview", value: "false" },
-        { name: "geometries", value: "polyline" },
-        { name: "steps", value: true }
-      ];
-
-
-      if (cachedHints.length === points.length) {
-        params.push({ name: "hints", value: cachedHints.join(";") });
-      } else {
-        // invalidate cache
-        cachedHints = [];
-      }
+          return [[step.maneuver.location[1], step.maneuver.location[0]], ICON_MAP[maneuver_id], instText, step.distance, step_geometry];
+        })
+      );
+
+      return {
+        line: steps.flatMap(step => step[4]),
+        steps,
+        distance: route.distance,
+        time: route.duration
+      };
+    }

 
 

-      var encoded_coords = points.map(function (p) {
-        return p.lng + "," + p.lat;
-      }).join(";");
+    return {
+      id: id,
+      creditline: "<a href=\"https://routing.openstreetmap.de/about.html\" target=\"_blank\">OSRM (FOSSGIS)</a>",
+      draggable: true,

 
 

-      var req_url = OSM.FOSSGIS_OSRM_URL + "routed-" + vehicleType + "/route/v1/driving/" + encoded_coords;
+      getRoute: function (points, callback) {
+        const data = [
+          { name: "overview", value: "false" },
+          { name: "geometries", value: "polyline" },
+          { name: "steps", value: true }
+        ];

 
 

-      var onResponse = function (data) {
-        if (data.code !== "Ok") {
-          return callback(true);
+        if (cachedHints.length === points.length) {
+          data.push({ name: "hints", value: cachedHints.join(";") });
+        } else {
+          // invalidate cache
+          cachedHints = [];

         }
 
         }
 

-        cachedHints = data.waypoints.map(function (wp) {
-          return wp.hint;
-        });
+        const req_path = "routed-" + vehicleType + "/route/v1/driving/" + points.map(p => p.lng + "," + p.lat).join(";");

 
 

-        var line = [];
-        var transformLeg = function (leg) {
-          return this._transformSteps(leg.steps, line);
-        };
-
-        var steps = [].concat.apply([], data.routes[0].legs.map(transformLeg.bind(this)));
+        return $.ajax({
+          url: OSM.FOSSGIS_OSRM_URL + req_path,
+          data,
+          dataType: "json",
+          success: function (response) {
+            if (response.code !== "Ok") {
+              return callback(true);
+            }

 
 

-        callback(false, {
-          line: line,
-          steps: steps,
-          distance: data.routes[0].distance,
-          time: data.routes[0].duration
+            cachedHints = response.waypoints.map(wp => wp.hint);
+            callback(false, _processDirections(response.routes[0]));
+          },
+          error: function () {
+            callback(true);
+          }

         });
         });

-      };
-
-      return $.ajax({
-        url: req_url,
-        data: params,
-        dataType: "json",
-        success: onResponse.bind(this),
-        error: function () {
-          callback(true);
-        }
-      });
-    }
-  };
-}
+      }
+    };
+  }

 
 

-OSM.Directions.addEngine(new FOSSGISOSRMEngine("fossgis_osrm_car", "car"), true);
-OSM.Directions.addEngine(new FOSSGISOSRMEngine("fossgis_osrm_bike", "bike"), true);
-OSM.Directions.addEngine(new FOSSGISOSRMEngine("fossgis_osrm_foot", "foot"), true);
+  OSM.Directions.addEngine(new FOSSGISOSRMEngine("fossgis_osrm_car", "car"), true);
+  OSM.Directions.addEngine(new FOSSGISOSRMEngine("fossgis_osrm_bike", "bike"), true);
+  OSM.Directions.addEngine(new FOSSGISOSRMEngine("fossgis_osrm_foot", "foot"), true);
+}());