Get test coverage to 100% (#66)

* Rename regions spec.

* Add comment to inform why these lines won't ever
get executed currently.

* Cover missing case for geo json.

* Remove deprecated methods.

Author: seanhandley

lib/h3/hierarchy.rb

@@ -19,12 +19,6 @@ module Hierarchy
     # @return [Integer] H3 index of parent hexagon.
     attach_function :parent, :h3ToParent, [:h3_index, Resolution], :h3_index
 
-    # @deprecated Please use {#parent} instead.
-    def h3_to_parent(h3_index, resolution)
-      parent(h3_index, resolution)
-    end
-    deprecate :h3_to_parent, :parent, 2020, 1
-
     # @!method max_children(h3_index, child_resolution)
     #
     # Derive maximum number of child hexagons possible at given resolution.
@@ -54,12 +48,6 @@ def h3_to_parent(h3_index, resolution)
     # @return [Integer] H3 index of center child hexagon.
     attach_function :center_child, :h3ToCenterChild, [:h3_index, Resolution], :h3_index
 
-    # @deprecated Please use {#max_children} instead.
-    def max_h3_to_children_size(h3_index, resolution)
-      max_children(h3_index, resolution)
-    end
-    deprecate :max_h3_to_children_size, :max_children, 2020, 1
-
     # Derive child hexagons contained within the hexagon at the given H3 index.
     #
     # @param [Integer] h3_index A valid H3 index.
@@ -80,12 +68,6 @@ def children(h3_index, child_resolution)
       out.read
     end
 
-    # @deprecated Please use {#children} instead.
-    def h3_to_children(h3_index, resolution)
-      children(h3_index, resolution)
-    end
-    deprecate :h3_to_children, :children, 2020, 1
-
     # Find the maximum uncompacted size of the given set of H3 indexes.
     #
     # @param [Array<Integer>] compacted_set An array of valid H3 indexes.

lib/h3/indexing.rb

@@ -35,12 +35,6 @@ def from_geo_coordinates(coords, resolution)
       Bindings::Private.geo_to_h3(coords, resolution)
     end
 
-    # @deprecated Please use {#from_geo_coordinates} instead.
-    def geo_to_h3(coords, resolution)
-      from_geo_coordinates(coords, resolution)
-    end
-    deprecate :geo_to_h3, :from_geo_coordinates, 2020, 1
-
     # Derive coordinates for a given H3 index.
     #
     # The coordinates map to the centre of the hexagon at the given index.
@@ -58,12 +52,6 @@ def to_geo_coordinates(h3_index)
       [rads_to_degs(coords[:lat]), rads_to_degs(coords[:lon])]
     end
 
-    # @deprecated Please use {#to_geo_coordinates} instead.
-    def h3_to_geo(h3_index)
-      to_geo_coordinates(h3_index)
-    end
-    deprecate :h3_to_geo, :to_geo_coordinates, 2020, 1
-
     # Derive the geographical boundary as coordinates for a given H3 index.
     #
     # This will be a set of 6 coordinate pairs matching the vertexes of the
@@ -89,11 +77,5 @@ def to_boundary(h3_index)
         [rads_to_degs(d[:lat]), rads_to_degs(d[:lon])]
       end
     end
-
-    # @deprecated Please use {#to_boundary} instead.
-    def h3_to_geo_boundary(h3_index)
-      to_boundary(h3_index)
-    end
-    deprecate :h3_to_geo_boundary, :to_boundary, 2020, 1
   end
 end

lib/h3/inspection.rb

@@ -21,12 +21,6 @@ module Inspection
     # @return [Integer] Resolution of H3 index
     attach_function :resolution, :h3GetResolution, %i[h3_index], Resolution
 
-    # @deprecated Please use {#resolution} instead.
-    def h3_resolution(h3_index)
-      resolution(h3_index)
-    end
-    deprecate :h3_resolution, :resolution, 2020, 1
-
     # @!method base_cell(h3_index)
     #
     # Derives the base cell number of the given H3 index
@@ -40,12 +34,6 @@ def h3_resolution(h3_index)
     # @return [Integer] Base cell number
     attach_function :base_cell, :h3GetBaseCell, %i[h3_index], :int
 
-    # @deprecated Please use {#base_cell} instead.
-    def h3_base_cell(h3_index)
-      base_cell(h3_index)
-    end
-    deprecate :h3_base_cell, :base_cell, 2020, 1
-
     # @!method from_string(h3_string)
     #
     # Derives the H3 index for a given hexadecimal string representation.
@@ -59,12 +47,6 @@ def h3_base_cell(h3_index)
     # @return [Integer] H3 index
     attach_function :from_string, :stringToH3, %i[string], :h3_index
 
-    # @deprecated Please use {#from_string} instead.
-    def string_to_h3(string)
-      from_string(string)
-    end
-    deprecate :string_to_h3, :from_string, 2020, 1
-
     # @!method pentagon?(h3_index)
     #
     # Determine whether the given H3 index is a pentagon.
@@ -78,12 +60,6 @@ def string_to_h3(string)
     # @return [Boolean] True if the H3 index is a pentagon.
     attach_predicate_function :pentagon?, :h3IsPentagon, %i[h3_index], :bool
 
-    # @deprecated Please use {#pentagon?} instead.
-    def h3_pentagon?(h3_index)
-      pentagon?(h3_index)
-    end
-    deprecate :h3_pentagon?, :pentagon?, 2020, 1
-
     # @!method class_3_resolution?(h3_index)
     #
     # Determine whether the given H3 index has a resolution with
@@ -98,12 +74,6 @@ def h3_pentagon?(h3_index)
     # @return [Boolean] True if the H3 index has a class III resolution.
     attach_predicate_function :class_3_resolution?, :h3IsResClassIII, %i[h3_index], :bool
 
-    # @deprecated Please use {#class_3_resolution?} instead.
-    def h3_res_class_3?(h3_index)
-      class_3_resolution?(h3_index)
-    end
-    deprecate :h3_res_class_3?, :class_3_resolution?, 2020, 1
-
     # @!method valid?(h3_index)
     #
     # Determine whether the given H3 index is valid.
@@ -117,12 +87,6 @@ def h3_res_class_3?(h3_index)
     # @return [Boolean] True if the H3 index is valid.
     attach_predicate_function :valid?, :h3IsValid, %i[h3_index], :bool
 
-    # @deprecated Please use {#valid?} instead.
-    def h3_valid?(h3_index)
-      valid?(h3_index)
-    end
-    deprecate :h3_valid?, :valid?, 2020, 1
-
     # Derives the hexadecimal string representation for a given H3 index.
     #
     # @param [Integer] h3_index A valid H3 index.
@@ -138,12 +102,6 @@ def to_string(h3_index)
       h3_str.read_string
     end
 
-    # @deprecated Please use {#to_string} instead.
-    def h3_to_string(h3_index)
-      to_string(h3_index)
-    end
-    deprecate :h3_to_string, :to_strings, 2020, 1
-
     # @!method max_face_count(h3_index)
     #
     # Returns the maximum number of icosahedron faces the given H3 index may intersect.
@@ -173,11 +131,5 @@ def faces(h3_index)
       # The C function returns a sparse array whose holes are represented by -1.
       out.read_array_of_int(max_faces).reject(&:negative?).sort
     end
-
-    # @deprecated Please use {#faces} instead.
-    def h3_faces(h3_index)
-      faces(h3_index)
-    end
-    deprecate :h3_faces, :faces, 2020, 1
   end
 end

lib/h3/miscellaneous.rb

@@ -83,12 +83,6 @@ module Miscellaneous
     # @return [Integer] Number of unique hexagons
     attach_function :hexagon_count, :numHexagons, [Resolution], :ulong_long
 
-    # @deprecated Please use {#hexagon_count} instead.
-    def num_hexagons(resolution)
-      hexagon_count(resolution)
-    end
-    deprecate :num_hexagons, :hexagon_count, 2020, 1
-
     # @!method rads_to_degs(rads)
     #
     # Convert a number expressed in radians to its equivalent in degrees.
@@ -125,12 +119,6 @@ def num_hexagons(resolution)
     # @return [Integer] The number of pentagons per resolution.
     attach_function :pentagon_count, :pentagonIndexCount, [], :int
 
-    # @deprecated Please use {#base_cell_count} instead.
-    def res_0_index_count
-      base_cell_count
-    end
-    deprecate :res_0_index_count, :base_cell_count, 2020, 1
-
     # Returns all resolution 0 hexagons (base cells).
     #
     # @example Return all base cells.
@@ -156,11 +144,5 @@ def pentagons(resolution)
       Bindings::Private.get_pentagon_indexes(resolution, out)
       out.read
     end
-
-    # @deprecated Please use {#base_cells} instead.
-    def res_0_indexes
-      base_cells
-    end
-    deprecate :res_0_indexes, :base_cells, 2020, 1
   end
 end

lib/h3/regions.rb

@@ -141,6 +141,7 @@ def h3_set_to_linked_geo(h3_indexes)
       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 @@ def extract_linked_geo_polygon(linked_geo_polygon)
       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

lib/h3/traversal.rb

@@ -32,12 +32,6 @@ module Traversal
     # @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 @@ def h3_distance(origin, destination)
     # @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 @@ def line(origin, destination)
       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)

lib/h3/unidirectional_edges.rb

@@ -19,13 +19,6 @@ module UnidirectionalEdges
     # @return [Boolean] True if indexes are neighbors
     attach_predicate_function :neighbors?, :h3IndexesAreNeighbors, %i[h3_index h3_index], :bool
 
-    # @deprecated Please use {#neighbors?} instead.
-    def h3_indexes_neighbors?(origin, destination)
-      neighbors?(origin, destination)
-    end
-
-    deprecate :h3_indexes_neighbors?, :neighbors?, 2020, 1
-
     # @!method unidirectional_edge_valid?(h3_index)
     #
     # Determine whether the given H3 index represents an edge.
@@ -42,13 +35,6 @@ def h3_indexes_neighbors?(origin, destination)
                               %i[h3_index],
                               :bool
 
-    # @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
-
     # @!method unidirectional_edge(origin, destination)
     #
     # Derives the H3 index of the edge from the given H3 indexes.
@@ -66,13 +52,6 @@ def h3_unidirectional_edge_valid?(h3_index)
                     %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.
@@ -125,16 +104,6 @@ def origin_and_destination_from_unidirectional_edge(edge)
       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
@@ -154,16 +123,6 @@ def unidirectional_edges_from_hexagon(origin)
       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
@@ -184,15 +143,5 @@ def unidirectional_edge_boundary(edge)
         [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

spec/geo_json_spec.rb

@@ -60,6 +60,14 @@
         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