Validate :type for building_number and coordinate

Author: muzhawir

lib/neo_faker/address.ex

@@ -47,12 +47,14 @@ defmodule NeoFaker.Address do
     Validator.validate_range!(range)
 
     type = Options.get(opts, :type, :string)
+
+    Validator.validate_building_number_type!(type)
+
     number = Number.between(range.first, range.last)
 
     case type do
       :string -> Formatter.format_number(number, :string)
       :integer -> number
-      _ -> Formatter.format_number(number, :string)
     end
   end
 
@@ -142,6 +144,7 @@ defmodule NeoFaker.Address do
     type = Options.get(opts, :type, :full)
 
     Validator.validate_precision!(precision)
+    Validator.validate_coordinate_type!(type)
 
     latitude = Generator.latitude(precision)
     longitude = Generator.longitude(precision)
@@ -150,7 +153,6 @@ defmodule NeoFaker.Address do
       :latitude -> latitude
       :longitude -> longitude
       :full -> {latitude, longitude}
-      _ -> {latitude, longitude}
     end
   end
 end

lib/neo_faker/address/validator.ex

@@ -1,6 +1,37 @@
 defmodule NeoFaker.Address.Validator do
   @moduledoc false
 
+  @building_number_types [:string, :integer]
+  @coordinate_types [:full, :latitude, :longitude]
+
+  @doc """
+  Validates the `:type` option for `building_number/2`.
+
+  Raises `ArgumentError` if the type is not one of `#{inspect([:string, :integer])}`.
+  """
+  @spec validate_building_number_type!(atom()) :: :ok
+  def validate_building_number_type!(type) when type in @building_number_types, do: :ok
+
+  def validate_building_number_type!(other) do
+    raise ArgumentError,
+          "invalid :type for building_number/2. " <>
+            "Expected one of #{inspect(@building_number_types)}, got: #{inspect(other)}"
+  end
+
+  @doc """
+  Validates the `:type` option for `coordinate/1`.
+
+  Raises `ArgumentError` if the type is not one of `#{inspect([:full, :latitude, :longitude])}`.
+  """
+  @spec validate_coordinate_type!(atom()) :: :ok
+  def validate_coordinate_type!(type) when type in @coordinate_types, do: :ok
+
+  def validate_coordinate_type!(other) do
+    raise ArgumentError,
+          "invalid :type for coordinate/1. " <>
+            "Expected one of #{inspect(@coordinate_types)}, got: #{inspect(other)}"
+  end
+
   @doc """
   Validates that the given value is a `Range` with `first <= last`.
 

test/neo_faker/address_test.exs

@@ -11,6 +11,10 @@ defmodule NeoFaker.AddressTest do
   end
 
   describe "building_number/2" do
+    test "returns a string by default" do
+      assert is_binary(Address.building_number())
+    end
+
     test "returns a random integer building number" do
       assert is_integer(Address.building_number(1..100, type: :integer))
     end
@@ -22,6 +26,18 @@ defmodule NeoFaker.AddressTest do
     test "returns a random integer building number within the specified range" do
       assert Address.building_number(1..100, type: :integer) in 1..100
     end
+
+    test "raises ArgumentError for an unknown :type" do
+      assert_raise ArgumentError, ~r/invalid :type for building_number\/2/, fn ->
+        Address.building_number(1..100, type: :float)
+      end
+    end
+
+    test "raises ArgumentError for a non-atom :type" do
+      assert_raise ArgumentError, ~r/invalid :type for building_number\/2/, fn ->
+        Address.building_number(1..100, type: "string")
+      end
+    end
   end
 
   describe "city/1" do
@@ -53,6 +69,10 @@ defmodule NeoFaker.AddressTest do
   end
 
   describe "coordinate/1" do
+    test "returns a {latitude, longitude} tuple by default" do
+      assert {_lat, _lng} = Address.coordinate()
+    end
+
     test "returns a random coordinate as a tuple of floats" do
       {latitude, longitude} = Address.coordinate()
 
@@ -69,5 +89,17 @@ defmodule NeoFaker.AddressTest do
     test "returns only a random longitude as a float" do
       assert is_float(Address.coordinate(type: :longitude))
     end
+
+    test "raises ArgumentError for an unknown :type" do
+      assert_raise ArgumentError, ~r/invalid :type for coordinate\/1/, fn ->
+        Address.coordinate(type: :altitude)
+      end
+    end
+
+    test "raises ArgumentError for a non-atom :type" do
+      assert_raise ArgumentError, ~r/invalid :type for coordinate\/1/, fn ->
+        Address.coordinate(type: "full")
+      end
+    end
   end
 end