Merge pull request #141 from isaacbrodsky/dev-v4-rc4

Upgrade to v4.0.0-rc4

Primary change here is renaming distance to greatCircleDistance. Did not change anything about version numbers as the previous release candidate upgrade was not released.

Author: nrabinowitz

CHANGELOG.md

@@ -6,6 +6,7 @@ All notable changes to this project will be documented in this file. This librar
 ### Added
 - Added vertex mode functions (#138)
 ### Breaking Changes
+- Updated the core library to `v4.0.0-rc4`. (#141)
 - Updated the core library to `v4.0.0-rc2`. This update renames the majority of the H3 functions. You can see a [list of changed function names](https://h3geo.org/docs/next/library/migration-3.x/functions) in the core library documentation. For the most part, upgrading to v4 for Javascript consumers should be a straightforward search & replace between the old names and the new. (#139)
 - Added more cases in which JS errors may be thrown. In H3 v3, many functions would fail silently with invalid input, returning `null` or similar signal values. In H3 v4, we will throw descriptive errors for most instances of bad input. (#139)
 

H3_VERSION

@@ -1 +1 @@
-4.0.0-rc2
+4.0.0-rc4

README.md

@@ -8,7 +8,7 @@
 [![Coverage Status](https://coveralls.io/repos/github/uber/h3-js/badge.svg?branch=master)](https://coveralls.io/github/uber/h3-js?branch=master)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
 [![npm version](https://badge.fury.io/js/h3-js.svg)](https://badge.fury.io/js/h3-js)
-[![H3 Version](https://img.shields.io/static/v1?label=h3%20api&message=v4.0.0-rc2&color=blue)](https://github.com/uber/h3/releases/tag/v4.0.0-rc2)
+[![H3 Version](https://img.shields.io/static/v1?label=h3%20api&message=v4.0.0-rc4&color=blue)](https://github.com/uber/h3/releases/tag/v4.0.0-rc4)
 
 The `h3-js` library provides a pure-JavaScript version of the [H3 Core Library](https://github.com/uber/h3), a hexagon-based geographic grid system. It can be used either in Node >= 6 or in the browser. The core library is transpiled from C using [emscripten](http://kripken.github.io/emscripten-site), offering full parity with the C API and highly efficient operations.
 
@@ -130,7 +130,7 @@ const coordinates = h3.cellsToMultiPolygon(hexagons, true);
     * [.gridPathCells(origin, destination)](#module_h3.gridPathCells) ⇒ <code>Array.&lt;H3Index&gt;</code>
     * [.cellToLocalIj(origin, destination)](#module_h3.cellToLocalIj) ⇒ <code>CoordIJ</code>
     * [.localIjToCell(origin, coords)](#module_h3.localIjToCell) ⇒ <code>H3Index</code>
-    * [.distance(latLng1, latLng2, unit)](#module_h3.distance) ⇒ <code>number</code>
+    * [.greatCircleDistance(latLng1, latLng2, unit)](#module_h3.greatCircleDistance) ⇒ <code>number</code>
     * [.cellArea(h3Index, unit)](#module_h3.cellArea) ⇒ <code>number</code>
     * [.exactEdgeLength(edge, unit)](#module_h3.exactEdgeLength) ⇒ <code>number</code>
     * [.getHexagonAreaAvg(res, unit)](#module_h3.getHexagonAreaAvg) ⇒ <code>number</code>
@@ -703,9 +703,9 @@ to be compatible across different versions of H3.
 
 * * *
 
-<a name="module_h3.distance"></a>
+<a name="module_h3.greatCircleDistance"></a>
 
-### h3.distance(latLng1, latLng2, unit) ⇒ <code>number</code>
+### h3.greatCircleDistance(latLng1, latLng2, unit) ⇒ <code>number</code>
 Great circle distance between two geo points. This is not specific to H3,
 but is implemented in the library and provided here as a convenience.
 

doc-files/README.tmpl.md

@@ -8,7 +8,7 @@
 [![Coverage Status](https://coveralls.io/repos/github/uber/h3-js/badge.svg?branch=master)](https://coveralls.io/github/uber/h3-js?branch=master)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
 [![npm version](https://badge.fury.io/js/h3-js.svg)](https://badge.fury.io/js/h3-js)
-[![H3 Version](https://img.shields.io/static/v1?label=h3%20api&message=v4.0.0-rc2&color=blue)](https://github.com/uber/h3/releases/tag/v4.0.0-rc2)
+[![H3 Version](https://img.shields.io/static/v1?label=h3%20api&message=v4.0.0-rc4&color=blue)](https://github.com/uber/h3/releases/tag/v4.0.0-rc4)
 
 The `h3-js` library provides a pure-JavaScript version of the [H3 Core Library](https://github.com/uber/h3), a hexagon-based geographic grid system. It can be used either in Node >= 6 or in the browser. The core library is transpiled from C using [emscripten](http://kripken.github.io/emscripten-site), offering full parity with the C API and highly efficient operations.
 

lib/bindings.js

@@ -81,9 +81,9 @@ export default [
     ['getHexagonAreaAvgKm2', H3_ERROR, [RESOLUTION, POINTER]],
     ['getHexagonEdgeLengthAvgM', H3_ERROR, [RESOLUTION, POINTER]],
     ['getHexagonEdgeLengthAvgKm', H3_ERROR, [RESOLUTION, POINTER]],
-    ['distanceM', NUMBER, [POINTER, POINTER]],
-    ['distanceKm', NUMBER, [POINTER, POINTER]],
-    ['distanceRads', NUMBER, [POINTER, POINTER]],
+    ['greatCircleDistanceM', NUMBER, [POINTER, POINTER]],
+    ['greatCircleDistanceKm', NUMBER, [POINTER, POINTER]],
+    ['greatCircleDistanceRads', NUMBER, [POINTER, POINTER]],
     ['cellAreaM2', H3_ERROR, [H3_LOWER, H3_UPPER, POINTER]],
     ['cellAreaKm2', H3_ERROR, [H3_LOWER, H3_UPPER, POINTER]],
     ['cellAreaRads2', H3_ERROR, [H3_LOWER, H3_UPPER, POINTER]],

lib/h3core.js

@@ -1300,19 +1300,19 @@ export function localIjToCell(origin, coords) {
  * @return {number}           Great circle distance
  * @throws {Error}            If the unit is invalid
  */
-export function distance(latLng1, latLng2, unit) {
+export function greatCircleDistance(latLng1, latLng2, unit) {
     const coord1 = storeLatLng(latLng1[0], latLng1[1]);
     const coord2 = storeLatLng(latLng2[0], latLng2[1]);
     let result;
     switch (unit) {
         case UNITS.m:
-            result = H3.distanceM(coord1, coord2);
+            result = H3.greatCircleDistanceM(coord1, coord2);
             break;
         case UNITS.km:
-            result = H3.distanceKm(coord1, coord2);
+            result = H3.greatCircleDistanceKm(coord1, coord2);
             break;
         case UNITS.rads:
-            result = H3.distanceRads(coord1, coord2);
+            result = H3.greatCircleDistanceRads(coord1, coord2);
             break;
         default:
             result = null;

out/binding-functions

@@ -8,7 +8,7 @@ polygonToCells
 cellsToMultiPolygon
 degsToRads
 radsToDegs
-distance
+greatCircleDistance
 getHexagonAreaAvg
 cellArea
 getHexagonEdgeLengthAvg

out/libh3.js

@@ -1867,47 +1867,47 @@ test('exactEdgeLength - bad units', assert => {
     assert.end();
 });
 
-test('distance', assert => {
+test('greatCircleDistance', assert => {
     assert.ok(
-        almostEqual(h3.distance([-10, 0], [10, 0], h3.UNITS.rads), h3.degsToRads(20)),
+        almostEqual(h3.greatCircleDistance([-10, 0], [10, 0], h3.UNITS.rads), h3.degsToRads(20)),
         'Got expected angular distance for latitude along the equator'
     );
     assert.ok(
-        almostEqual(h3.distance([0, -10], [0, 10], h3.UNITS.rads), h3.degsToRads(20)),
+        almostEqual(h3.greatCircleDistance([0, -10], [0, 10], h3.UNITS.rads), h3.degsToRads(20)),
         'Got expected angular distance for latitude along a meridian'
     );
     assert.equal(
-        h3.distance([23, 23], [23, 23], h3.UNITS.rads),
+        h3.greatCircleDistance([23, 23], [23, 23], h3.UNITS.rads),
         0,
         'Got expected angular distance for same point'
     );
     // Just rough tests for the other units
-    const distKm = h3.distance([0, 0], [39, -122], h3.UNITS.km);
+    const distKm = h3.greatCircleDistance([0, 0], [39, -122], h3.UNITS.km);
     assert.ok(distKm > 12e3 && distKm < 13e3, 'has some reasonable distance in Km');
-    const distM = h3.distance([0, 0], [39, -122], h3.UNITS.m);
+    const distM = h3.greatCircleDistance([0, 0], [39, -122], h3.UNITS.m);
     assert.ok(distM > 12e6 && distM < 13e6, 'has some reasonable distance in m');
 
     assert.end();
 });
 
-test('distance - bad units', assert => {
+test('greatCircleDistance - bad units', assert => {
     assert.throws(
-        () => h3.distance([0, 0], [0, 0]),
+        () => h3.greatCircleDistance([0, 0], [0, 0]),
         {code: E_UNKNOWN_UNIT},
         'throws on missing unit'
     );
     assert.throws(
-        () => h3.distance([0, 0], [0, 0], 'foo'),
+        () => h3.greatCircleDistance([0, 0], [0, 0], 'foo'),
         {code: E_UNKNOWN_UNIT},
         'throws on unknown unit'
     );
     assert.throws(
-        () => h3.distance([0, 0], [0, 0], 42),
+        () => h3.greatCircleDistance([0, 0], [0, 0], 42),
         {code: E_UNKNOWN_UNIT},
         'throws on unknown unit'
     );
     assert.throws(
-        () => h3.distance([0, 0], [0, 0], h3.UNITS.m2),
+        () => h3.greatCircleDistance([0, 0], [0, 0], h3.UNITS.m2),
         {code: E_UNKNOWN_UNIT},
         'throws on invalid unit'
     );

test/h3core.spec.js

@@ -25,12 +25,7 @@ const BINDING_FUNCTIONS = fs
     .split(/\s+/);
 
 // Exclude methods that don't make sense for the JS bindings
-const EXCLUDE_METHODS = [
-    'h3ToString',
-    'stringToH3',
-    // TODO: Unnecessary when https://github.com/uber/h3/pull/622 is released
-    'distance'
-];
+const EXCLUDE_METHODS = ['h3ToString', 'stringToH3'];
 
 test('implementsBindingFunctions', assert => {
     BINDING_FUNCTIONS.forEach(fn => {