Merge pull request #43 from NotWoods/version-2

2.0.0 update! Changes convert behavior.

package.json

@@ -1,7 +1,7 @@
 {
     "name": "spherical-geometry-js",
-    "version": "1.4.0",
-    "description": "This library provides classes and functions for the computation of geometric data on the surface of the Earth. Code ported from the Google Maps Javascript API v3 and tubalmartin/spherical-geometry-php",
+    "version": "2.0.0",
+    "description": "This library provides classes and functions for the computation of geometric data on the surface of the Earth. Code ported from the Google Maps Javascript API v3",
     "license": "MIT",
     "author": "Tiger Oakes <[email protected]> (https://tigeroakes.com)",
     "repository": "NotWoods/spherical-geometry-js",

src/latlng.js

@@ -1,13 +1,5 @@
-const LAT = Symbol('Latitude');
-const LNG = Symbol('Longitude');
-
-/**
- * Shorthand for Object#hasOwnProperty
- * @param {object} obj
- * @param {string | symbol} prop
- * @returns {boolean}
- */
-const has = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop);
+const LAT = 'latitude';
+const LNG = 'longitude';
 
 /**
  * Converts an object into a LatLng. Tries a few different methods:
@@ -27,28 +19,32 @@ const has = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop);
  * 7. If it has x and y properties, try using y as latitude and x and
  *    longitude.
  * @param {any} like
- * @param {function} [Class=LatLng]
  * @returns {LatLng}
  */
-export function convert(like, Class = LatLng) {
+export function convert(like) {
     if (like instanceof LatLng) {
-        return new Class(like[LAT], like[LNG]);
-    } else if (has(like, 'lat') && has(like, 'lng')) {
+        return new LatLng(like[LAT], like[LNG]);
+    } else if ('lat' in like && 'lng' in like) {
         if (typeof like.lat == 'function' && typeof like.lng == 'function') {
-            return new Class(like.lat(), like.lng());
+            return new LatLng(like.lat(), like.lng());
         } else {
-            return new Class(parseFloat(like.lat), parseFloat(like.lng));
+            return new LatLng(parseFloat(like.lat), parseFloat(like.lng));
         }
-    } else if (has(like, 'lat') && has(like, 'long')) {
-        return new Class(parseFloat(like.lat), parseFloat(like.long));
-    } else if (has(like, 'lat') && has(like, 'lon')) {
-        return new Class(parseFloat(like.lat), parseFloat(like.lon));
-    } else if (has(like, 'latitude') && has(like, 'longitude')) {
-        return new Class(parseFloat(like.latitude), parseFloat(like.longitude));
+    } else if ('lat' in like && 'long' in like) {
+        return new LatLng(parseFloat(like.lat), parseFloat(like.long));
+    } else if ('lat' in like && 'lon' in like) {
+        return new LatLng(parseFloat(like.lat), parseFloat(like.lon));
+    } else if ('latitude' in like && 'longitude' in like) {
+        return new LatLng(
+            parseFloat(like.latitude),
+            parseFloat(like.longitude)
+        );
     } else if (typeof like[0] === 'number' && typeof like[1] === 'number') {
-        return new Class(like[1], like[0]);
-    } else if (has(like, 'x') && has(like, 'y')) {
-        return new Class(parseFloat(like.y), parseFloat(like.x));
+        return new LatLng(like[1], like[0]);
+    } else if ('x' in like && 'y' in like) {
+        return new LatLng(parseFloat(like.y), parseFloat(like.x));
+    } else {
+        throw new TypeError(`Cannot convert ${like} to LatLng`);
     }
 }
 
@@ -130,14 +126,6 @@ export default class LatLng {
     get y() {
         return this[LAT];
     }
-    /** @type {number} alias for lat */
-    get latitude() {
-        return this[LAT];
-    }
-    /** @type {number} alias for lng */
-    get longitude() {
-        return this[LNG];
-    }
     /** @type {number} alias for lng */
     get 0() {
         return this[LNG];

test/LatLng.test.js

@@ -134,10 +134,30 @@ describe('covertLatLng', () => {
     });
 
     it('should convert Javascript Coordinates from Geolocation API', () => {
-        const coords = {
-            latitude: places.newyork.lat(),
-            longitude: places.newyork.lng(),
-        };
+        class Coordinates {
+            /**
+             *
+             * @param {number} latitude
+             * @param {number} longitude
+             */
+            constructor(latitude, longitude) {
+                this._la = latitude;
+                this._lo = longitude;
+            }
+
+            get latitude() {
+                return this._la;
+            }
+
+            get longitude() {
+                return this._lo;
+            }
+        }
+
+        const coords = new Coordinates(
+            places.newyork.lat(),
+            places.newyork.lng()
+        );
         expect(convertLatLng(coords)).toEqual(places.newyork);
     });
 
@@ -162,4 +182,13 @@ describe('covertLatLng', () => {
         };
         expect(convertLatLng(place)).toEqual(places.newyork);
     });
+
+    it('should not convert other objects', () => {
+        /** @type {any} */
+        const notPlace = {
+            foo: 10,
+            bar: 12,
+        };
+        expect(() => convertLatLng(notPlace)).toThrow(TypeError);
+    });
 });