h3 3.6.0 → 3.7.2

data/lib/h3/regions.rb

@@ -141,6 +141,7 @@ module H3
       linked_geo_polygon = LinkedGeoPolygon.new
       Bindings::Private.h3_set_to_linked_geo(h3_set, h3_indexes.size, linked_geo_polygon)
 
+      # The algorithm in h3 currently only handles 1 polygon
       extract_linked_geo_polygon(linked_geo_polygon).first
     ensure
       Bindings::Private.destroy_linked_polygon(linked_geo_polygon)
@@ -154,6 +155,8 @@ module H3
       geo_polygons = [linked_geo_polygon]
 
       until linked_geo_polygon[:next].null?
+        # Until the h3 algorithm is updated to handle multiple polygons,
+        # this block will never run.
         geo_polygons << linked_geo_polygon[:next]
         linked_geo_polygon = linked_geo_polygon[:next]
       end

data/lib/h3/traversal.rb

@@ -32,12 +32,6 @@ module H3
     # @return [Integer] Distance between indexes.
     attach_function :distance, :h3Distance, %i[h3_index h3_index], :k_distance
 
-    # @deprecated Please use {#distance} instead.
-    def h3_distance(origin, destination)
-      distance(origin, destination)
-    end
-    deprecate :h3_distance, :distance, 2020, 1
-
     # @!method line_size(origin, destination)
     #
     # Derive the number of hexagons present in a line between two H3 indexes.
@@ -57,12 +51,6 @@ module H3
     # @return [Integer] Number of hexagons found between indexes.
     attach_function :line_size, :h3LineSize, %i[h3_index h3_index], :int
 
-    # @deprecated Please use {#line_size} instead.
-    def h3_line_size(origin, destination)
-      line_size(origin, destination)
-    end
-    deprecate :h3_line_size, :line_size, 2020, 1
-
     # Derives H3 indexes within k distance of the origin H3 index.
     #
     # Similar to {k_ring}, except that an error is raised when one of the indexes
@@ -317,12 +305,6 @@ module H3
       hexagons.read
     end
 
-    # @deprecated Please use {#line} instead.
-    def h3_line(origin, destination)
-      line(origin, destination)
-    end
-    deprecate :h3_line, :line, 2020, 1
-
     private
 
     def k_rings_for_hex_range(indexes, k)

data/lib/h3/unidirectional_edges.rb

@@ -17,16 +17,7 @@ module H3
     #   true
     #
     # @return [Boolean] True if indexes are neighbors
-    attach_function :neighbors, :h3IndexesAreNeighbors, %i[h3_index h3_index], :bool
-    alias_method :neighbors?, :neighbors
-    undef_method :neighbors
-
-    # @deprecated Please use {#neighbors?} instead.
-    def h3_indexes_neighbors?(origin, destination)
-      neighbors?(origin, destination)
-    end
-
-    deprecate :h3_indexes_neighbors?, :neighbors?, 2020, 1
+    attach_predicate_function :neighbors?, :h3IndexesAreNeighbors, %i[h3_index h3_index], :bool
 
     # @!method unidirectional_edge_valid?(h3_index)
     #
@@ -39,19 +30,10 @@ module H3
     #   true
     #
     # @return [Boolean] True if H3 index is a valid unidirectional edge
-    attach_function :unidirectional_edge_valid,
-                    :h3UnidirectionalEdgeIsValid,
-                    %i[h3_index],
-                    :bool
-    alias_method :unidirectional_edge_valid?, :unidirectional_edge_valid
-    undef_method :unidirectional_edge_valid
-
-    # @deprecated Please use {#unidirectional_edge_valid?} instead.
-    def h3_unidirectional_edge_valid?(h3_index)
-      unidirectional_edge_valid?(h3_index)
-    end
-
-    deprecate :h3_unidirectional_edge_valid?, :unidirectional_edge_valid?, 2020, 1
+    attach_predicate_function :unidirectional_edge_valid?,
+                              :h3UnidirectionalEdgeIsValid,
+                              %i[h3_index],
+                              :bool
 
     # @!method unidirectional_edge(origin, destination)
     #
@@ -70,13 +52,6 @@ module H3
                     %i[h3_index h3_index],
                     :h3_index
 
-    # @deprecated Please use {#unidirectional_edge} instead.
-    def h3_unidirectional_edge(origin, destination)
-      unidirectional_edge(origin, destination)
-    end
-
-    deprecate :h3_unidirectional_edge, :unidirectional_edge, 2020, 1
-
     # @!method destination_from_unidirectional_edge(edge)
     #
     # Derive destination H3 index from edge.
@@ -129,16 +104,6 @@ module H3
       out.read
     end
 
-    # @deprecated Please use {#origin_and_destination_from_unidirectional_edge} instead.
-    def h3_indexes_from_unidirectional_edge(edge)
-      origin_and_destination_from_unidirectional_edge(edge)
-    end
-
-    deprecate :h3_indexes_from_unidirectional_edge,
-              :origin_and_destination_from_unidirectional_edge,
-              2020,
-              1
-
     # Derive unidirectional edges for a H3 index.
     #
     # @param [Integer] origin H3 index
@@ -158,16 +123,6 @@ module H3
       out.read
     end
 
-    # @deprecated Please use {#unidirectional_edges_from_hexagon} instead.
-    def h3_unidirectional_edges_from_hexagon(origin)
-      unidirectional_edges_from_hexagon(origin)
-    end
-
-    deprecate :h3_unidirectional_edges_from_hexagon,
-              :unidirectional_edges_from_hexagon,
-              2020,
-              1
-
     # Derive coordinates for edge boundary.
     #
     # @param [Integer] edge H3 edge index
@@ -188,15 +143,5 @@ module H3
         [rads_to_degs(d[:lat]), rads_to_degs(d[:lon])]
       end
     end
-
-    # @deprecated Please use {#unidirectional_edge_boundary} instead.
-    def h3_unidirectional_edge_boundary(edge)
-      unidirectional_edge_boundary(edge)
-    end
-
-    deprecate :h3_unidirectional_edge_boundary,
-              :unidirectional_edge_boundary,
-              2020,
-              1
   end
 end

data/lib/h3/version.rb

@@ -1,3 +1,3 @@
 module H3
-  VERSION = "3.6.0".freeze
+  VERSION = "3.7.2".freeze
 end

data/spec/geo_json_spec.rb

@@ -60,6 +60,14 @@ RSpec.describe H3 do
         expect { geo_json_to_coordinates }.to raise_error(ArgumentError)
       end
     end
+
+    context "when given JSON with the wrong structure" do
+      let(:input) { { blah: "blah" }.to_json }
+
+      it "raises an error" do
+        expect { geo_json_to_coordinates }.to raise_error(ArgumentError)
+      end
+    end
   end
 
   describe ".coordinates_to_geo_json" do

data/spec/miscellaneous_spec.rb

@@ -109,4 +109,121 @@ RSpec.describe H3 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/spec_helper.rb

@@ -1,5 +1,5 @@
-require "coveralls"
-Coveralls.wear!
+# require "coveralls"
+# Coveralls.wear!
 
 begin
   require "h3"

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: h3
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.2
 platform: ruby
 authors:
 - Lachlan Laycock
 - Sean Handley
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-14 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -53,20 +53,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +95,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: 
+description:
 email: l.laycock@stuart.com
 executables: []
 extensions:
@@ -117,11 +103,12 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/workflows/ruby_ci.yml"
 - ".gitignore"
 - ".gitmodules"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -133,9 +120,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
@@ -144,13 +134,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
@@ -171,8 +168,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
@@ -196,6 +193,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
@@ -210,6 +208,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
@@ -224,12 +223,15 @@ 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
@@ -241,6 +243,7 @@ files:
 - 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
@@ -248,11 +251,14 @@ files:
 - 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
@@ -269,6 +275,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
@@ -284,6 +291,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
@@ -364,14 +372,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
@@ -390,7 +398,8 @@ 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/base.rb
@@ -411,7 +420,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
@@ -426,24 +435,23 @@ homepage: https://github.com/StuartApp/h3_ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: C Bindings for Uber's H3 library
 test_files: []