refactor weather data (cieslarmichal#612)

CMakeLists.txt

@@ -75,6 +75,7 @@ set(FAKER_SOURCES
     src/modules/videoGame/VideoGame.cpp
     src/modules/videoGame/VideoGameData.cpp
     src/modules/weather/Weather.cpp
+    src/modules/weather/WeatherData.cpp
     src/modules/word/Word.cpp
     src/common/FormatHelper.cpp
     src/common/LuhnCheck.cpp

include/faker-cxx/Weather.h

@@ -1,6 +1,6 @@
 #pragma once
 
-#include <string>
+#include <string_view>
 
 namespace faker
 {
@@ -99,13 +99,13 @@ class Weather
     /**
      * @brief Generated a random weather description
      *
-     * @return String A random weather description
+     * @return String_View A random weather description
      *
      * @code
      * Weather::description(); // "Sunny"
      * @endcode
      */
-    static std::string weatherDescription();
+    static std::string_view weatherDescription();
 
     /**
      * @brief Generated a random cloud cover percentage

src/modules/weather/Weather.cpp

@@ -1,10 +1,10 @@
 #include "faker-cxx/Weather.h"
 
-#include <string>
+#include <string_view>
 
-#include "data/WeatherDescription.h"
 #include "faker-cxx/Helper.h"
 #include "faker-cxx/Number.h"
+#include "WeatherData.h"
 
 namespace faker
 {
@@ -51,9 +51,9 @@ int Weather::humidity()
     return Number::integer(0, 100);
 }
 
-std::string Weather::weatherDescription()
+std::string_view Weather::weatherDescription()
 {
-    return Helper::arrayElement<std::string>(weatherDescriptions);
+    return Helper::arrayElement(weatherDescriptions);
 }
 
 int Weather::cloudCover()

src/modules/weather/data/WeatherDescription.h → src/modules/weather/WeatherData.cpp

@@ -1,16 +1,15 @@
-#pragma once
-
-#include <string>
-#include <vector>
+#include "WeatherData.h"
 
 namespace faker
 {
-const std::vector<std::string> weatherDescriptions = {
+
+const std::array<std::string_view, 16> weatherDescriptions = {
     "clear sky",     "few clouds",  "scattered clouds",
     "broken clouds", "shower rain", "rainy",
     "thunderstorm",  "snowy",       "misty",
     "smoky",         "haze",        "sunny",
     "cloudy",        "windy",       "dark",
     "foggy",
 };
+
 }

src/modules/weather/WeatherData.h

@@ -0,0 +1,11 @@
+#pragma once
+
+#include <array>
+#include <string_view>
+
+namespace faker
+{
+extern const std::array<std::string_view, 16> weatherDescriptions;
+
+}
+

tests/modules/weather/WeatherTest.cpp

@@ -1,11 +1,11 @@
 #include "faker-cxx/Weather.h"
 
 #include <algorithm>
-#include <string>
+#include <string_view>
 
 #include "gtest/gtest.h"
 
-#include "weather/data/WeatherDescription.h"
+#include "weather/WeatherData.h"
 
 using namespace ::testing;
 using namespace faker;
@@ -63,10 +63,10 @@ TEST_F(WeatherTest, shouldGenerateHumidity)
 
 TEST_F(WeatherTest, shouldGenerateWeatherDescription)
 {
-    std::string generatedWeatherDescription = Weather::weatherDescription();
+    const std::string_view generatedWeatherDescription = Weather::weatherDescription();
 
     ASSERT_TRUE(std::ranges::any_of(weatherDescriptions,
-                                    [generatedWeatherDescription](const std::string& weatherDescription)
+                                    [generatedWeatherDescription](const std::string_view& weatherDescription)
                                     { return weatherDescription == generatedWeatherDescription; }));
 }