h3 3.5.0 → 3.7.1

data/spec/miscellaneous_spec.rb

@@ -1,11 +1,11 @@
 RSpec.describe H3 do
   include_context "constants"
 
-  describe ".num_hexagons" do
+  describe ".hexagon_count" do
     let(:resolution) { 2 }
     let(:result) { 5882 }
 
-    subject(:num_hexagons) { H3.num_hexagons(resolution) }
+    subject(:hexagon_count) { H3.hexagon_count(resolution) }
 
     it { is_expected.to eq(result) }
 
@@ -14,7 +14,7 @@ RSpec.describe H3 do
       let(:result) { false }
 
       it "returns the expected result" do
-        expect { num_hexagons }.to raise_error(ArgumentError)
+        expect { hexagon_count }.to raise_error(ArgumentError)
       end
     end
   end
@@ -73,12 +73,157 @@ RSpec.describe H3 do
     it { is_expected.to eq(result) }
   end
 
-  describe ".res_0_indexes" do
+  describe ".base_cells" do
     let(:count) { 122 }
-    subject(:res_0_indexes) { H3.res_0_indexes }
+    subject(:base_cells) { H3.base_cells }
 
     it "has 122 base cells" do
-      expect(res_0_indexes.count).to eq(count)
+      expect(base_cells.count).to eq(count)
+    end
+  end
+
+  describe ".pentagon_count" do
+    let(:count) { 12 }
+    subject(:pentagon_count) { H3.pentagon_count }
+
+    it "has 12 pentagons per resolution" do
+      expect(pentagon_count).to eq(count)
+    end
+  end
+
+  describe ".pentagons" do
+    let(:resolution) { 4 }
+    let(:expected) do
+      [
+        594615896891195391, 594967740612083711,
+        595319584332972031, 595812165542215679,
+        596199193635192831, 596515852983992319,
+        596691774844436479, 597008434193235967,
+        597395462286213119, 597888043495456767,
+        598239887216345087, 598591730937233407
+      ]
+    end
+    subject(:pentagons) { H3.pentagons(resolution) }
+
+    it "returns pentagons at the given resolution" do
+      expect(pentagons).to eq(expected)
+    end
+  end
+
+  describe ".cell_area_rads2" do
+    let(:cell) { "8928308280fffff".to_i(16) }
+    let(:expected) { 2.6952182709835757e-09 }
+    subject(:cell_area_rads2) { H3.cell_area_rads2(cell) }
+
+    it "returns cell area in rads2" do
+      expect(cell_area_rads2).to be_within(0.0001).of(expected)
+    end
+  end
+
+  describe ".cell_area_km2" do
+    let(:cell) { "8928308280fffff".to_i(16) }
+    let(:expected) { 0.10939818864648902 }
+    subject(:cell_area_km2) { H3.cell_area_km2(cell) }
+
+    it "returns cell area in km2" do
+      expect(cell_area_km2).to be_within(0.0001).of(expected)
+    end
+  end
+
+  describe ".cell_area_m2" do
+    let(:cell) { "8928308280fffff".to_i(16) }
+    let(:expected) { 109398.18864648901 }
+    subject(:cell_area_m2) { H3.cell_area_m2(cell) }
+
+    it "returns cell area in m2" do
+      expect(cell_area_m2).to be_within(0.0001).of(expected)
+    end
+  end
+
+  describe ".exact_edge_length_rads" do
+    let(:cell) { "11928308280fffff".to_i(16) }
+    let(:expected) { 3.287684056071637e-05 }
+    subject(:exact_edge_length_rads) { H3.exact_edge_length_rads(cell) }
+
+    it "returns edge length in rads" do
+      expect(exact_edge_length_rads).to be_within(0.0001).of(expected)
+    end
+  end
+
+  describe ".exact_edge_length_km" do
+    let(:cell) { "11928308280fffff".to_i(16) }
+    let(:expected) { 0.20945858729823577 }
+    subject(:exact_edge_length_km) { H3.exact_edge_length_km(cell) }
+
+    it "returns edge length in km" do
+      expect(exact_edge_length_km).to be_within(0.0001).of(expected)
+    end
+  end
+
+  describe ".exact_edge_length_m" do
+    let(:cell) { "11928308280fffff".to_i(16) }
+    let(:expected) { 209.45858729823578 }
+    subject(:exact_edge_length_m) { H3.exact_edge_length_m(cell) }
+
+    it "returns edge length in m" do
+      expect(exact_edge_length_m).to be_within(0.0001).of(expected)
+    end
+  end
+
+  describe ".point_distance_rads" do
+    let(:a) { [41.3964809, 2.160444] }
+    let(:b) { [41.3870609, 2.164917] }
+    let(:expected) { 0.00017453024784008713 }
+    subject(:point_distance_rads) { H3.point_distance_rads(a, b) }
+
+    it "returns distance between points in rads" do
+      expect(point_distance_rads).to be_within(0.0001).of(expected)
+    end
+
+    context "when the coordinates are invalid" do
+      let(:a) { [91, -18] }
+
+      it "raises an argument error" do
+        expect { point_distance_rads }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe ".point_distance_km" do
+    let(:a) { [41.3964809, 2.160444] }
+    let(:b) { [41.3870609, 2.164917] }
+    let(:expected) { 1.1119334622766763 }
+    subject(:point_distance_km) { H3.point_distance_km(a, b) }
+
+    it "returns distance between points in km" do
+      expect(point_distance_km).to be_within(0.0001).of(expected)
+    end
+
+    context "when the coordinates are invalid" do
+      let(:a) { [89, -181] }
+
+      it "raises an argument error" do
+        expect { point_distance_km }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe ".point_distance_m" do
+    let(:a) { [41.3964809, 2.160444] }
+    let(:b) { [41.3870609, 2.164917] }
+    let(:expected) { 1111.9334622766764 }
+    subject(:point_distance_m) { H3.point_distance_m(a, b) }
+
+    it "returns distance between points in m" do
+      expect(point_distance_m).to be_within(0.0001).of(expected)
+    end
+
+    context "when the coordinates are invalid" do
+      let(:a) { "boom" }
+
+      it "raises an argument error" do
+        expect { point_distance_m }.to raise_error(ArgumentError)
+      end
     end
   end
 end

data/spec/{region_spec.rb → regions_spec.rb}

@@ -42,7 +42,7 @@ RSpec.describe H3 do
       File.read(File.join(File.dirname(__FILE__), "support/fixtures/banbury.json"))
     end
     let(:resolution) { 9 }
-    let(:expected_count) { 33_391 }
+    let(:expected_count) { 47_018 }
 
     subject(:max_polyfill_size) { H3.max_polyfill_size(geojson, resolution) }
 

data/spec/traversal_spec.rb

@@ -331,27 +331,27 @@ RSpec.describe H3 do
     end
   end
 
-  describe ".h3_distance" do
+  describe ".distance" do
     let(:origin) { "89283082993ffff".to_i(16) }
     let(:destination) { "89283082827ffff".to_i(16) }
     let(:result) { 5 }
 
-    subject(:h3_distance) { H3.h3_distance(origin, destination) }
+    subject(:distance) { H3.distance(origin, destination) }
 
     it { is_expected.to eq(result) }
   end
 
-  describe ".h3_line_size" do
+  describe ".line_size" do
     let(:origin) { "89283082993ffff".to_i(16) }
     let(:destination) { "89283082827ffff".to_i(16) }
     let(:result) { 6 }
 
-    subject(:h3_line_size) { H3.h3_line_size(origin, destination) }
+    subject(:h3_line_size) { H3.line_size(origin, destination) }
 
     it { is_expected.to eq(result) }
   end
 
-  describe ".h3_line" do
+  describe ".line" do
     let(:origin) { "89283082993ffff".to_i(16) }
     let(:destination) { "89283082827ffff".to_i(16) }
     let(:result) do
@@ -361,7 +361,7 @@ RSpec.describe H3 do
       ].map { |i| i.to_i(16) }
     end
 
-    subject(:h3_line) { H3.h3_line(origin, destination) }
+    subject(:line) { H3.line(origin, destination) }
 
     it { is_expected.to eq(result) }
   end

data/spec/unidirectional_edges_spec.rb

@@ -1,12 +1,12 @@
 RSpec.describe H3 do
   include_context "constants"
 
-  describe ".h3_indexes_neighbors?" do
+  describe ".neighbors?" do
     let(:origin) { "8928308280fffff".to_i(16) }
     let(:destination) { "8928308280bffff".to_i(16) }
     let(:result) { true }
 
-    subject(:h3_indexes_neighbors?) { H3.h3_indexes_neighbors?(origin, destination) }
+    subject(:neighbors?) { H3.neighbors?(origin, destination) }
 
     it { is_expected.to eq(result) }
 
@@ -18,21 +18,21 @@ RSpec.describe H3 do
     end
   end
 
-  describe ".h3_unidirectional_edge" do
+  describe ".unidirectional_edge" do
     let(:origin) { "8928308280fffff".to_i(16) }
     let(:destination) { "8928308280bffff".to_i(16) }
     let(:result) { "16928308280fffff".to_i(16) }
 
-    subject(:h3_unidirectional_edge) { H3.h3_unidirectional_edge(origin, destination) }
+    subject(:unidirectional_edge) { H3.unidirectional_edge(origin, destination) }
 
     it { is_expected.to eq(result) }
   end
 
-  describe ".h3_unidirectional_edge_valid?" do
+  describe ".unidirectional_edge_valid?" do
     let(:edge) { "11928308280fffff".to_i(16) }
     let(:result) { true }
 
-    subject(:h3_unidirectional_edge_valid?) { H3.h3_unidirectional_edge_valid?(edge) }
+    subject(:h3_unidirectional_edge_valid?) { H3.unidirectional_edge_valid?(edge) }
 
     it { is_expected.to eq(result) }
 
@@ -62,24 +62,24 @@ RSpec.describe H3 do
     it { is_expected.to eq(result) }
   end
 
-  describe ".h3_indexes_from_unidirectional_edge" do
+  describe ".origin_and_destination_from_unidirectional_edge" do
     let(:h3_index) { "11928308280fffff".to_i(16) }
     let(:expected_indexes) do
       %w(8928308280fffff 8928308283bffff).map { |i| i.to_i(16) }
     end
 
-    subject(:h3_indexes_from_unidirectional_edge) do
-      H3.h3_indexes_from_unidirectional_edge(h3_index)
+    subject(:origin_and_destination_from_unidirectional_edge) do
+      H3.origin_and_destination_from_unidirectional_edge(h3_index)
     end
 
     it "has two expected h3 indexes" do
-      expect(h3_indexes_from_unidirectional_edge).to eq(expected_indexes)
+      expect(origin_and_destination_from_unidirectional_edge).to eq(expected_indexes)
     end
   end
 
-  describe ".h3_unidirectional_edges_from_hexagon" do
-    subject(:h3_unidirectional_edges_from_hexagon) do
-      H3.h3_unidirectional_edges_from_hexagon(h3_index)
+  describe ".unidirectional_edges_from_hexagon" do
+    subject(:unidirectional_edges_from_hexagon) do
+      H3.unidirectional_edges_from_hexagon(h3_index)
     end
 
     context "when index is a hexagon" do
@@ -87,7 +87,7 @@ RSpec.describe H3 do
       let(:count) { 6 }
 
       it "has six expected edges" do
-        expect(h3_unidirectional_edges_from_hexagon.count).to eq(count)
+        expect(unidirectional_edges_from_hexagon.count).to eq(count)
       end
     end
 
@@ -96,21 +96,21 @@ RSpec.describe H3 do
       let(:count) { 5 }
 
       it "has five expected edges" do
-        expect(h3_unidirectional_edges_from_hexagon.count).to eq(count)
+        expect(unidirectional_edges_from_hexagon.count).to eq(count)
       end
     end
   end
 
-  describe ".h3_unidirectional_edge_boundary" do
+  describe ".unidirectional_edge_boundary" do
     let(:edge) { "11928308280fffff".to_i(16) }
     let(:expected) do
       [[37.77820687262237, -122.41971895414808], [37.77652420699321, -122.42079024541876]]
     end
 
-    subject(:h3_unidirectional_edge_boundary) { H3.h3_unidirectional_edge_boundary(edge) }
+    subject(:unidirectional_edge_boundary) { H3.unidirectional_edge_boundary(edge) }
 
     it "matches expected coordinates" do
-      h3_unidirectional_edge_boundary.zip(expected) do |(lat, lon), (exp_lat, exp_lon)|
+      unidirectional_edge_boundary.zip(expected) do |(lat, lon), (exp_lat, exp_lon)|
         expect(lat).to be_within(0.000001).of(exp_lat)
         expect(lon).to be_within(0.000001).of(exp_lon)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: h3
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.7.1
 platform: ruby
 authors:
 - Lachlan Laycock
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-25 00:00:00.000000000 Z
+date: 2020-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -39,6 +39,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -119,9 +133,12 @@ files:
 - ext/h3/extconf.rb
 - ext/h3/src/.clang-format
 - ext/h3/src/.clang-tidy
+- ext/h3/src/.github/workflows/test-linux.yml
+- ext/h3/src/.github/workflows/test-macos.yml
+- ext/h3/src/.github/workflows/test-website.yml
+- ext/h3/src/.github/workflows/test-windows.yml
 - ext/h3/src/.gitignore
 - ext/h3/src/.travis.yml
-- ext/h3/src/.ycm_extra_conf.py
 - ext/h3/src/CHANGELOG.md
 - ext/h3/src/CMakeLists.txt
 - ext/h3/src/CONTRIBUTING.md
@@ -130,13 +147,20 @@ files:
 - ext/h3/src/README.md
 - ext/h3/src/RELEASE.md
 - ext/h3/src/VERSION
-- ext/h3/src/appveyor.yml
 - ext/h3/src/cmake/Config.cmake.in
 - ext/h3/src/cmake/TestWrapValgrind.cmake
 - ext/h3/src/cmake/toolchain.cmake
 - ext/h3/src/dev-docs/Doxyfile.in
+- ext/h3/src/dev-docs/RFCs/rfc-template.md
+- ext/h3/src/dev-docs/RFCs/v4.0.0/error-handling-rfc.md
+- ext/h3/src/dev-docs/RFCs/v4.0.0/names_for_concepts_types_functions.md
+- ext/h3/src/dev-docs/RFCs/v4.0.0/overrideable-allocators-rfc.md
+- ext/h3/src/dev-docs/RFCs/v4.0.0/polyfill-modes-rfc.md
+- ext/h3/src/dev-docs/RFCs/v4.0.0/vertex-mode-rfc.md
 - ext/h3/src/dev-docs/build_windows.md
 - ext/h3/src/dev-docs/creating_bindings.md
+- ext/h3/src/dev-docs/custom_alloc.md
+- ext/h3/src/docs/README.md
 - ext/h3/src/docs/api/hierarchy.md
 - ext/h3/src/docs/api/indexing.md
 - ext/h3/src/docs/api/inspection.md
@@ -157,8 +181,8 @@ files:
 - ext/h3/src/docs/core-library/overview.md
 - ext/h3/src/docs/core-library/restable.md
 - ext/h3/src/docs/core-library/usage.md
-- ext/h3/src/docs/overview/mainpage.md
-- ext/h3/src/docs/overview/usecases.md
+- ext/h3/src/docs/table-of-contents.json
+- ext/h3/src/docs/usecases.md
 - ext/h3/src/examples/CMakeLists.txt
 - ext/h3/src/examples/compact.c
 - ext/h3/src/examples/distance.c
@@ -182,6 +206,7 @@ files:
 - ext/h3/src/src/apps/benchmarks/benchmarkH3Api.c
 - ext/h3/src/src/apps/benchmarks/benchmarkH3Line.c
 - ext/h3/src/src/apps/benchmarks/benchmarkH3SetToLinkedGeo.c
+- ext/h3/src/src/apps/benchmarks/benchmarkH3UniEdge.c
 - ext/h3/src/src/apps/benchmarks/benchmarkKRing.c
 - ext/h3/src/src/apps/benchmarks/benchmarkPolyfill.c
 - ext/h3/src/src/apps/benchmarks/benchmarkPolygon.c
@@ -196,6 +221,7 @@ files:
 - ext/h3/src/src/apps/miscapps/generateBaseCellNeighbors.c
 - ext/h3/src/src/apps/miscapps/generateFaceCenterPoint.c
 - ext/h3/src/src/apps/miscapps/generateNumHexagons.c
+- ext/h3/src/src/apps/miscapps/generatePentagonDirectionFaces.c
 - ext/h3/src/src/apps/miscapps/h3ToGeoBoundaryHier.c
 - ext/h3/src/src/apps/miscapps/h3ToGeoHier.c
 - ext/h3/src/src/apps/miscapps/h3ToHier.c
@@ -210,30 +236,42 @@ files:
 - ext/h3/src/src/apps/testapps/testGeoCoord.c
 - ext/h3/src/src/apps/testapps/testGeoToH3.c
 - ext/h3/src/src/apps/testapps/testH3Api.c
+- ext/h3/src/src/apps/testapps/testH3CellArea.c
+- ext/h3/src/src/apps/testapps/testH3CellAreaExhaustive.c
 - ext/h3/src/src/apps/testapps/testH3Distance.c
+- ext/h3/src/src/apps/testapps/testH3DistanceExhaustive.c
 - ext/h3/src/src/apps/testapps/testH3GetFaces.c
 - ext/h3/src/src/apps/testapps/testH3Index.c
 - ext/h3/src/src/apps/testapps/testH3Line.c
+- ext/h3/src/src/apps/testapps/testH3LineExhaustive.c
+- ext/h3/src/src/apps/testapps/testH3Memory.c
 - ext/h3/src/src/apps/testapps/testH3NeighborRotations.c
 - ext/h3/src/src/apps/testapps/testH3SetToLinkedGeo.c
 - ext/h3/src/src/apps/testapps/testH3SetToVertexGraph.c
+- ext/h3/src/src/apps/testapps/testH3ToCenterChild.c
 - ext/h3/src/src/apps/testapps/testH3ToChildren.c
 - ext/h3/src/src/apps/testapps/testH3ToGeo.c
 - ext/h3/src/src/apps/testapps/testH3ToGeoBoundary.c
 - ext/h3/src/src/apps/testapps/testH3ToLocalIj.c
+- ext/h3/src/src/apps/testapps/testH3ToLocalIjExhaustive.c
 - ext/h3/src/src/apps/testapps/testH3ToParent.c
 - ext/h3/src/src/apps/testapps/testH3UniEdge.c
+- ext/h3/src/src/apps/testapps/testH3UniEdgeExhaustive.c
 - ext/h3/src/src/apps/testapps/testHexRanges.c
 - ext/h3/src/src/apps/testapps/testHexRing.c
 - ext/h3/src/src/apps/testapps/testKRing.c
 - ext/h3/src/src/apps/testapps/testLinkedGeo.c
 - ext/h3/src/src/apps/testapps/testMaxH3ToChildrenSize.c
+- ext/h3/src/src/apps/testapps/testPentagonIndexes.c
 - ext/h3/src/src/apps/testapps/testPolyfill.c
+- ext/h3/src/src/apps/testapps/testPolyfillReported.c
 - ext/h3/src/src/apps/testapps/testPolygon.c
 - ext/h3/src/src/apps/testapps/testVec2d.c
 - ext/h3/src/src/apps/testapps/testVec3d.c
+- ext/h3/src/src/apps/testapps/testVertex.c
 - ext/h3/src/src/apps/testapps/testVertexGraph.c
 - ext/h3/src/src/h3lib/include/algos.h
+- ext/h3/src/src/h3lib/include/alloc.h
 - ext/h3/src/src/h3lib/include/baseCells.h
 - ext/h3/src/src/h3lib/include/bbox.h
 - ext/h3/src/src/h3lib/include/constants.h
@@ -250,6 +288,7 @@ files:
 - ext/h3/src/src/h3lib/include/polygonAlgos.h
 - ext/h3/src/src/h3lib/include/vec2d.h
 - ext/h3/src/src/h3lib/include/vec3d.h
+- ext/h3/src/src/h3lib/include/vertex.h
 - ext/h3/src/src/h3lib/include/vertexGraph.h
 - ext/h3/src/src/h3lib/lib/algos.c
 - ext/h3/src/src/h3lib/lib/baseCells.c
@@ -265,6 +304,7 @@ files:
 - ext/h3/src/src/h3lib/lib/polygon.c
 - ext/h3/src/src/h3lib/lib/vec2d.c
 - ext/h3/src/src/h3lib/lib/vec3d.c
+- ext/h3/src/src/h3lib/lib/vertex.c
 - ext/h3/src/src/h3lib/lib/vertexGraph.c
 - ext/h3/src/tests/inputfiles/bc05r08cells.txt
 - ext/h3/src/tests/inputfiles/bc05r08centers.txt
@@ -345,14 +385,14 @@ files:
 - ext/h3/src/tests/inputfiles/res03cells.txt
 - ext/h3/src/tests/inputfiles/res03ic.txt
 - ext/h3/src/tests/inputfiles/res04ic.txt
+- ext/h3/src/website/.eslintignore
+- ext/h3/src/website/.gitignore
+- ext/h3/src/website/.nvmrc
 - ext/h3/src/website/README.md
-- ext/h3/src/website/html.config.js
+- ext/h3/src/website/gatsby-config.js
 - ext/h3/src/website/package.json
 - ext/h3/src/website/scripts/build-to-gh-pages.sh
-- ext/h3/src/website/src/config.js
-- ext/h3/src/website/src/mdRoutes.js
-- ext/h3/src/website/src/styles/_variables.scss
-- ext/h3/src/website/src/styles/index.scss
+- ext/h3/src/website/src/.gitkeep
 - ext/h3/src/website/static/favicon.ico
 - ext/h3/src/website/static/images/ca_compact_6_901.png
 - ext/h3/src/website/static/images/ca_uncompact_6_10633.png
@@ -371,10 +411,10 @@ files:
 - ext/h3/src/website/static/images/substrate3.png
 - ext/h3/src/website/static/images/triEdge.png
 - ext/h3/src/website/static/images/uber-logo.png
-- ext/h3/src/website/static/index.html
+- ext/h3/src/website/templates/documentation.jsx
+- ext/h3/src/website/yarn.lock
 - h3.gemspec
 - lib/h3.rb
-- lib/h3/bindings.rb
 - lib/h3/bindings/base.rb
 - lib/h3/bindings/private.rb
 - lib/h3/bindings/structs.rb
@@ -393,7 +433,7 @@ files:
 - spec/indexing_spec.rb
 - spec/inspection_spec.rb
 - spec/miscellaneous_spec.rb
-- spec/region_spec.rb
+- spec/regions_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures/australia.json
 - spec/support/fixtures/banbury.json
@@ -424,7 +464,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
 summary: C Bindings for Uber's H3 library