feat(geocoder): add support for geocoding without a geocoding API

Author: evansiroky

__tests__/util/__snapshots__/geocoder.js.snap

@@ -93,6 +93,34 @@ Object {
 }
 `;
 
+exports[`geocoder NoApiGeocoder should get location from geocode feature 1`] = `
+Object {
+  "lat": 45.516198,
+  "lon": -122.67324,
+  "name": "45.516198, -122.673240",
+}
+`;
+
+exports[`geocoder NoApiGeocoder should make autocomplete query 1`] = `
+Object {
+  "features": Array [],
+}
+`;
+
+exports[`geocoder NoApiGeocoder should make reverse query 1`] = `
+Object {
+  "lat": 45.5162,
+  "lon": -122.67324,
+  "name": "45.5162, -122.67324",
+}
+`;
+
+exports[`geocoder NoApiGeocoder should make search query 1`] = `
+Object {
+  "features": Array [],
+}
+`;
+
 exports[`geocoder PELIAS should get location from geocode feature 1`] = `
 Object {
   "lat": 45.516198,

__tests__/util/geocoder.js

@@ -9,12 +9,15 @@ function mockResponsePath (geocoder, file) {
 describe('geocoder', () => {
   const geocoders = [
     {
+      type: 'ARCGIS'
+    }, {
       apiKey: 'dummy-mapzen-key',
       baseUrl: 'https://ws-st.trimet.org/pelias/v1',
       type: 'PELIAS'
-    }, {
-      type: 'ARCGIS'
-    }
+    },
+    // this entry represents no geocoder configuration. In this case it is
+    // expected that the NoApiGeocoder will be used.
+    undefined
   ]
 
   // nocks for ARCGIS
@@ -54,8 +57,11 @@ describe('geocoder', () => {
     .replyWithFile(200, mockResponsePath('pelias', 'reverse-response.json'))
 
   geocoders.forEach(geocoder => {
+    const geocoderType = geocoder
+      ? geocoder.type
+      : 'NoApiGeocoder'
     // the describe is in quotes to bypass a lint rule
-    describe(`${geocoder.type}`, () => {
+    describe(`${geocoderType}`, () => {
       it('should make autocomplete query', async () => {
         const result = await getGeocoder(geocoder).autocomplete({ text: 'Mill Ends' })
         expect(result).toMatchSnapshot()
@@ -74,7 +80,7 @@ describe('geocoder', () => {
 
       it('should get location from geocode feature', async () => {
         let mockFeature
-        switch (geocoder.type) {
+        switch (geocoderType) {
           case 'ARCGIS':
             mockFeature = {
               magicKey: 'abcd',
@@ -95,6 +101,17 @@ describe('geocoder', () => {
               }
             }
             break
+          case 'NoApiGeocoder':
+            mockFeature = {
+              geometry: {
+                coordinates: [-122.673240, 45.516198],
+                type: 'Point'
+              },
+              properties: {
+                label: '45.516198, -122.673240'
+              }
+            }
+            break
           default:
             throw new Error(`no mock feature defined for geocoder type: ${geocoder.type}`)
         }

example-config.yml

@@ -37,6 +37,9 @@ map:
       url: http://tile.stamen.com/toner-lite/{z}/{x}/{y}.png
       attribution: 'Map tiles by <a href="http://stamen.com">Stamen Design</a>, under <a href="http://creativecommons.org/licenses/by/3.0">CC BY 3.0</a>. Data by <a href="http://openstreetmap.org">OpenStreetMap</a>, under <a href="http://www.openstreetmap.org/copyright">ODbL</a>.'
 
+# it is possible to leave out a geocoder config entirely. In that case only
+# GPS coordinates will be used when finding the origin/destination.
+
 # example config for a Pelias geocoder (https://pelias.io/)
 geocoder:
   apiKey: MAPZEN_KEY

lib/reducers/create-otp-reducer.js

@@ -51,12 +51,6 @@ const MAX_RECENT_STORAGE = 5
 
 // TODO: fire planTrip action if default query is complete/error-free
 
-// a list of required keys that must be present in the initial config of the
-// initial state
-const requiredConfigKeys = [
-  'geocoder.type'
-]
-
 /**
  * Validates the initial state of the store. This is intended to mainly catch
  * configuration issues since a manually edited config file is loaded into the
@@ -69,11 +63,6 @@ function validateInitalState (initialState) {
 
   const errors = []
 
-  // iterate through required keys to ensure integrity of config
-  requiredConfigKeys.forEach(k => {
-    if (!objectPath.has(config, k)) errors.push(new Error(`Config is missing required key: "${k}"`))
-  })
-
   // validate that the ArcGIS geocoder isn't used with a persistence strategy of
   // `localStorage`. ArcGIS requires the use of a paid account to store geocode
   // results.

lib/util/geocoder.js

@@ -40,7 +40,9 @@ class Geocoder {
    * done to obtain that detailed data.
    */
   getLocationFromGeocodedFeature (feature) {
-    return Promise.resolve(feature)
+    const location = lonlat.fromCoordinates(feature.geometry.coordinates)
+    location.name = feature.properties.label
+    return Promise.resolve(location)
   }
 
   /**
@@ -147,21 +149,71 @@ class ArcGISGeocoder extends Geocoder {
 }
 
 /**
- * Geocoder implementation for the Pelias geocoder.
- * See https://pelias.io
+ * An implementation that doesn't use an API for geocoding. Merely allows
+ * clicking on the map and finding GPS coordinates by typing them in.
  *
  * @extends Geocoder
  */
-class PeliasGeocoder extends Geocoder {
+class NoApiGeocoder extends Geocoder {
   /**
-   * Translate the given feature into an application-specific data format.
+   * Use coordinate string parser.
    */
-  getLocationFromGeocodedFeature (feature) {
-    const location = lonlat.fromCoordinates(feature.geometry.coordinates)
-    location.name = feature.properties.label
-    return Promise.resolve(location)
+  autocomplete (query) {
+    return this._parseCoordinateString(query.text)
   }
 
+  /**
+   * Always return the lat/lon.
+   */
+  reverse (query) {
+    let { lat, lon } = query.point
+    lat = this._roundGPSDecimal(lat)
+    lon = this._roundGPSDecimal(lon)
+    return Promise.resolve({ lat, lon, name: `${lat}, ${lon}` })
+  }
+
+  /**
+   * Use coordinate string parser.
+   */
+  search (query) {
+    return this._parseCoordinateString(query.text)
+  }
+
+  /**
+   * Attempt to parse the input as a GPS coordinate. If parseable, return a
+   * feature.
+   */
+  _parseCoordinateString (string) {
+    let feature
+    try {
+      feature = {
+        geometry: {
+          coordinates: lonlat.toCoordinates(lonlat.fromLatFirstString(string)),
+          type: 'Point'
+        },
+        properties: {
+          label: string
+        }
+      }
+    } catch (e) {
+      return Promise.resolve({ features: [] })
+    }
+    return Promise.resolve({ features: [feature] })
+  }
+
+  _roundGPSDecimal (number) {
+    const roundFactor = 100000
+    return Math.round(number * roundFactor) / roundFactor
+  }
+}
+
+/**
+ * Geocoder implementation for the Pelias geocoder.
+ * See https://pelias.io
+ *
+ * @extends Geocoder
+ */
+class PeliasGeocoder extends Geocoder {
   /**
    * Rewrite the response into an application-specific data format using the
    * first feature returned from the geocoder.
@@ -178,14 +230,18 @@ class PeliasGeocoder extends Geocoder {
 
 // Create a memoized getter to avoid recreating new geocoders each time.
 const getGeocoder = memoize(geocoderConfig => {
+  if (!geocoderConfig || !geocoderConfig.type) {
+    return new NoApiGeocoder()
+  }
   const {type} = geocoderConfig
   switch (type) {
     case 'ARCGIS':
       return new ArcGISGeocoder(arcgis, geocoderConfig)
     case 'PELIAS':
       return new PeliasGeocoder(pelias, geocoderConfig)
     default:
-      throw new Error(`Invalid geocoder type: ${type}`)
+      console.error(`Unkown geocoder type: "${type}". Using NoApiGeocoder.`)
+      return new NoApiGeocoder()
   }
 })
 

package.json

@@ -11,7 +11,7 @@
     "prepublish": "mastarm prepublish --config configurations/prepublish",
     "prestart": "yarn",
     "test": "yarn run lint && yarn run lint-docs && yarn run jest",
-    "start": "mastarm build --serve example.js"
+    "start": "mastarm build -e development --serve example.js"
   },
   "standard": {
     "parser": "babel-eslint"