Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: added weather descriptions #911

Merged
merged 5 commits into from
Sep 27, 2024
Merged

chore: added weather descriptions #911

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e1a7757
chore: added weather descriptions
00thirdeye00 Sep 10, 2024
5a81638
refactor: locale to weather module
00thirdeye00 Sep 12, 2024
91e8726
test: parameterized test added
00thirdeye00 Sep 27, 2024
42ff861
test: weather module
00thirdeye00 Sep 27, 2024
1cc9f3e
Merge branch 'main' into swedish_weather_descriptions
00thirdeye00 Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions include/faker-cxx/weather.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,20 @@
#include <string_view>

#include "faker-cxx/export.h"
#include "faker-cxx/types/locale.h"

namespace faker::weather
{
/**
* @brief Generated a random weather description
*
* * @param locale The locale. Defaults to `Locale::en_US`.
*
* @return A random weather description
*
* @code
* faker::weather::weatherDescription(); // "Sunny"
* faker::weather::weatherDescription(Locale::en_GB); // "Sunny"
* @endcode
*/
FAKER_CXX_EXPORT std::string_view weatherDescription();
FAKER_CXX_EXPORT std::string_view weatherDescription(Locale locale = Locale::en_US);
}
40 changes: 38 additions & 2 deletions src/modules/weather.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,44 @@

namespace faker::weather
{
std::string_view weatherDescription()
namespace
{
return helper::randomElement(weatherDescriptions);
const auto& getWeatherDefinition(Locale locale)
{
switch (locale)
{
case Locale::sv_SE:
return svSEWeatherDescriptions;
case Locale::en_029:
case Locale::en_AU:
case Locale::en_BW:
case Locale::en_BZ:
case Locale::en_CA:
case Locale::en_cb:
case Locale::en_GB:
case Locale::en_GH:
case Locale::en_HK:
case Locale::en_IE:
case Locale::en_IN:
case Locale::en_JM:
case Locale::en_MT:
case Locale::en_MY:
case Locale::en_NZ:
case Locale::en_PH:
case Locale::en_SG:
case Locale::en_TT:
case Locale::en_US:
case Locale::en_ZA:
case Locale::en_ZW:
default:
return enUSWeatherDescriptions;
}
}
}
std::string_view weatherDescription(Locale locale)
{
const auto& weatherDefinition = getWeatherDefinition(locale);

return helper::randomElement(weatherDefinition);
}
}
2 changes: 1 addition & 1 deletion src/modules/weather_data.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

namespace faker::weather
{
const auto weatherDescriptions = std::to_array<std::string_view>({
const auto enUSWeatherDescriptions = std::to_array<std::string_view>({
"broken clouds",
"clear sky",
"cloudy",
Expand Down
42 changes: 40 additions & 2 deletions tests/modules/weather_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,60 @@

#include "gtest/gtest.h"

#include "faker-cxx/types/locale.h"
#include "faker-cxx/weather.h"
#include "weather_data.h"

using namespace ::testing;
using namespace faker::weather;

namespace
{
const auto& getWeatherDefinition(Locale locale)
{
switch (locale)
{
case Locale::sv_SE:
return svSEWeatherDescriptions;
case Locale::en_029:
case Locale::en_AU:
case Locale::en_BW:
case Locale::en_BZ:
case Locale::en_CA:
case Locale::en_cb:
case Locale::en_GB:
case Locale::en_GH:
case Locale::en_HK:
case Locale::en_IE:
case Locale::en_IN:
case Locale::en_JM:
case Locale::en_MT:
case Locale::en_MY:
case Locale::en_NZ:
case Locale::en_PH:
case Locale::en_SG:
case Locale::en_TT:
case Locale::en_US:
case Locale::en_ZA:
case Locale::en_ZW:
default:
return enUSWeatherDescriptions;
}
}
}

class WeatherTest : public Test
{
public:
};

TEST_F(WeatherTest, shouldGenerateWeatherDescription)
{
const std::string_view generatedWeatherDescription = weatherDescription();
const auto& weatherDefinition = getWeatherDefinition(Locale::en_US);
cieslarmichal marked this conversation as resolved.
Show resolved Hide resolved

const std::string_view generatedWeatherDescription = weatherDescription(Locale::en_US);

ASSERT_TRUE(std::ranges::any_of(weatherDescriptions,
ASSERT_TRUE(std::ranges::any_of(weatherDefinition,
[generatedWeatherDescription](const std::string_view& weatherDescription)
{ return weatherDescription == generatedWeatherDescription; }));
}
Loading