feat: add locales to color module (#926)

* feat: add locales to color module * fix: fix build issues
cieslarmichal · Sep 30, 2024 · 738ce3e · 738ce3e
1 parent 388e098
commit 738ce3e
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,7 @@ All notable changes to this project will be documented in this file
 
 * added locale to `book` module
 * added locale to `weather` module
+* added locale to `color` module
 
 ## v3.0.0 (28.08.2024)
 

diff --git a/include/faker-cxx/color.h b/include/faker-cxx/color.h
@@ -4,20 +4,23 @@
 #include <string_view>
 
 #include "faker-cxx/export.h"
+#include "faker-cxx/types/locale.h"
 #include "types/hex.h"
 
 namespace faker::color
 {
 /**
  * @brief Returns a random color.
  *
+ * @param locale The locale. Defaults to `Locale::en_US`.
+ *
  * @returns Human readable color name.
  *
  * @code
  * faker::color::name() // "Blue"
  * @endcode
  */
-FAKER_CXX_EXPORT std::string_view name();
+FAKER_CXX_EXPORT std::string_view name(Locale locale = Locale::en_US);
 
 /**
  * @brief Returns an RGB color.

diff --git a/src/modules/color.cpp b/src/modules/color.cpp
@@ -1,5 +1,6 @@
 #include "faker-cxx/color.h"
 
+#include <span>
 #include <string>
 #include <string_view>
 
@@ -8,11 +9,28 @@
 #include "faker-cxx/helper.h"
 #include "faker-cxx/number.h"
 #include "faker-cxx/types/hex.h"
+#include "faker-cxx/types/locale.h"
 
 namespace faker::color
 {
-std::string_view name()
+namespace
 {
+std::span<const std::string_view> getColors(Locale locale)
+{
+    switch (locale)
+    {
+    case Locale::pl_PL:
+        return polishColors;
+    default:
+        return englishColors;
+    }
+}
+}
+
+std::string_view name(Locale locale)
+{
+    const auto& colors = getColors(locale);
+
     return helper::randomElement(colors);
 }
 

diff --git a/src/modules/color_data.h b/src/modules/color_data.h
@@ -5,11 +5,18 @@
 
 namespace faker::color
 {
-const auto colors = std::to_array<std::string_view>({
+const auto englishColors = std::to_array<std::string_view>({
     "azure",    "black",  "blue",     "cyan",      "fuchsia", "gold",   "green",      "grey",
     "indigo",   "ivory",  "lavender", "lime",      "magenta", "maroon", "mint green", "olive",
     "orange",   "orchid", "pink",     "plum",      "purple",  "red",    "salmon",     "silver",
     "sky blue", "tan",    "teal",     "turquoise", "violet",  "white",  "yellow",
 });
 
+const auto polishColors = std::to_array<std::string_view>({
+    "błękitny",     "czarny",        "niebieski", "cyjan",     "fuksja",    "złoty",      "zielony",   "szary",
+    "indygo",       "kość słoniowa", "lawendowy", "limonkowy", "magenta",   "kasztanowy", "miętowy",   "oliwkowy",
+    "pomarańczowy", "orchidea",      "różowy",    "śliwkowy",  "purpurowy", "czerwony",   "łososiowy", "srebrny",
+    "błękit nieba", "jasnobrązowy",  "morski",    "turkusowy", "fioletowy", "biały",      "żółty",
+});
+
 }
diff --git a/tests/modules/color_test.cpp b/tests/modules/color_test.cpp
@@ -1,7 +1,7 @@
 #include <algorithm>
 #include <charconv>
+#include <span>
 #include <string>
-#include <string_view>
 
 #include "gtest/gtest.h"
 
@@ -13,21 +13,44 @@
 
 using namespace ::testing;
 using namespace faker;
-using namespace color;
+using namespace faker::color;
 
-class ColorTest : public Test
+std::span<const std::string_view> getColors(Locale locale)
+{
+    switch (locale)
+    {
+    case Locale::pl_PL:
+        return polishColors;
+    default:
+        return englishColors;
+    }
+}
+
+class ColorNameTest : public TestWithParam<Locale>
 {
 public:
 };
 
-TEST_F(ColorTest, shouldGenerateColorName)
+TEST_P(ColorNameTest, shouldGenerateColorName)
 {
-    const auto generatedColorName = name();
+    const auto locale = GetParam();
+
+    const auto generatedColorName = name(locale);
+
+    const auto exceptedColors = getColors(locale);
 
-    ASSERT_TRUE(std::ranges::any_of(colors, [generatedColorName](const std::string_view& colorName)
+    ASSERT_TRUE(std::ranges::any_of(exceptedColors, [generatedColorName](const std::string_view& colorName)
                                     { return colorName == generatedColorName; }));
 }
 
+INSTANTIATE_TEST_SUITE_P(TestColorNameByLocale, ColorNameTest, ValuesIn(locales),
+                         [](const TestParamInfo<Locale>& paramInfo) { return toString(paramInfo.param); });
+
+class ColorTest : public Test
+{
+public:
+};
+
 TEST_F(ColorTest, shouldGenerateRgbColorWithoutAlpha)
 {
     const auto generatedRgbColor = rgb();