feat: added ordinalDirection generation function

include/faker-cxx/location.h

@@ -199,6 +199,21 @@ FAKER_CXX_EXPORT std::tuple<std::string, std::string> nearbyGPSCoordinate(
  */
 FAKER_CXX_EXPORT std::string_view direction();
 
+/**
+ * @brief Generates a random direction from ordinal directions.
+ * 
+ * @param abbreviated If `true` this will return abbreviated directions (NW, SE, etc). Otherwise this 
+ * will return the long name. By default, this is set to `false`.
+ * 
+ * @returns Ordinal direction.
+ * 
+ * @code
+ * faker::location::ordinalDirection() // "Southeast"
+ * faker::location::ordinalDirection(true) // "NW"
+ * @endcode
+ */
+FAKER_CXX_EXPORT std::string_view ordinalDirection(bool abbreviated = false);
+
 /**
  * @brief Generates a random time zone.
  *

src/modules/location.cpp

@@ -241,6 +241,12 @@ std::string_view direction()
     return helper::randomElement(directions);
 }
 
+std::string_view ordinalDirection(bool abbreviated)
+{
+    return abbreviated ? helper::randomElement(ordinalDirections).second :
+                         helper::randomElement(ordinalDirections).first;
+}
+
 std::string_view timeZone()
 {
     return helper::randomElement(timeZones);

src/modules/location_data.h

@@ -788,6 +788,13 @@ const auto directions = std::to_array<std::string_view>({
     "West",
 });
 
+constexpr auto ordinalDirections = std::to_array<std::pair<std::string_view, std::string_view>>({
+    {"Northeast", "NE"},
+    {"Northwest", "NW"},
+    {"Southeast", "SE"},
+    {"Southwest", "SW"}
+});
+
 const auto timeZones = std::to_array<std::string_view>({
     // clang-format off
     "Africa/Abidjan",

tests/modules/location_test.cpp

@@ -622,6 +622,22 @@ TEST_F(LocationTest, shouldGenerateDirection)
                                     { return direction == generatedDirection; }));
 }
 
+TEST_F(LocationTest, shouldGenerateOrdinalDirection)
+{
+    const auto generatedOrdinalDirection = ordinalDirection();
+    const auto generatedOrdinalDirectionAbbreviated = ordinalDirection(true);
+
+    ASSERT_TRUE(std::ranges::any_of(
+        ordinalDirections,
+        [generatedOrdinalDirection](const std::pair<std::string_view, std::string_view>& ordinalDirection)
+        { return ordinalDirection.first == generatedOrdinalDirection; }));
+
+    ASSERT_TRUE(std::ranges::any_of(
+        ordinalDirections,
+        [generatedOrdinalDirectionAbbreviated](const std::pair<std::string_view, std::string_view>& ordinalDirection)
+        { return ordinalDirection.second == generatedOrdinalDirectionAbbreviated; }));
+}
+
 TEST_F(LocationTest, shouldGenerateTimeZone)
 {
     const auto generatedTimeZone = timeZone();