0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update utils::format_timespan() documentation and tests

Browse source 
CC #6036
This commit is contained in:
Iris Morelle 2021-09-17 07:39:23 -03:00
parent c159cf9131
commit bab195f14b
No known key found for this signature in database
GPG key ID: E312033F4023A753
2 changed files with 51 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
src/formula/string_utils.hpp
View file

@ -78,10 +78,24 @@ std::string format_conjunct_list(const t_string& empty, const std::vector<t_stri
std::string format_disjunct_list(const t_string& empty, const std::vector<t_string>& elems);
/**
* Formats a timespan into human-readable text.
* @param time The timespan in seconds.
* @return A string such as "6 days, 12 hours, 4 minutes, 13 seconds". Years,
* months and weeks are also considered.
* Formats a timespan into human-readable text for player authentication functions.
*
* This is intentionally not a very thorough representation of time intervals.
* See <https://github.com/wesnoth/wesnoth/issues/6036> for more information.
*
* @param time The timespan in seconds.
* @param detailed Whether to display more specific values such as "3 months, 2 days,
* 30 minutes, and 1 second". If not specified or set to @a false, the
* return value will ONLY include most significant time unit (e.g. "3
* months").
* @return A human-readable timespan description.
*
* @note The implementation is not very precise because not all months in the Gregorian
* calendar have 30 days. Furthermore, it doesn't take into account leap years or
* leap seconds. If you need to account for those, you are better off importing
* a new library and providing it with more specific information about the start and
* end times of the interval; otherwise your next best option is to hire a fortune
* teller to manually service your requests every time instead of this function.
*/
std::string format_timespan(std::time_t time, bool detailed = false);
}

73
src/tests/test_formula_timespan.cpp
View file

@ -82,72 +82,65 @@ inline std::string gen_as_str(const time_detailed& params)
return utils::format_conjunct_list("expired", bits);
}
inline void test_format_timespan(const time_detailed& tcase, const std::string& detailed, const std::string& fuzzy="")
{
BOOST_CHECK_EQUAL(detailed, utils::format_timespan(gen_as_time_t(tcase), true));
if(!fuzzy.empty()) {
BOOST_REQUIRE_NE(detailed, fuzzy); // ensure test case params are not borked
BOOST_CHECK_EQUAL(fuzzy, utils::format_timespan(gen_as_time_t(tcase)));
BOOST_CHECK_NE(utils::format_timespan(gen_as_time_t(tcase)), utils::format_timespan(gen_as_time_t(tcase), true));
}
}
}
BOOST_AUTO_TEST_CASE( test_formula_timespan )
{
time_detailed t;
test_format_timespan({ 1, 0, 0, 0, 0, 0, 0 }, "1 second");
t = time_detailed{ 1, 0, 0, 0, 0, 0, 0 };
BOOST_CHECK_EQUAL("1 second", utils::format_timespan(gen_as_time_t(t)));
test_format_timespan({ 2, 0, 0, 0, 0, 0, 0 }, "2 seconds");
t = time_detailed{ 2, 0, 0, 0, 0, 0, 0 };
BOOST_CHECK_EQUAL("2 seconds", utils::format_timespan(gen_as_time_t(t)));
test_format_timespan({ 0, 1, 0, 0, 0, 0, 0 }, "1 minute");
t = time_detailed{ 0, 1, 0, 0, 0, 0, 0 };
BOOST_CHECK_EQUAL("1 minute", utils::format_timespan(gen_as_time_t(t)));
test_format_timespan({ 0, 2, 0, 0, 0, 0, 0 }, "2 minutes");
t = time_detailed{ 0, 2, 0, 0, 0, 0, 0 };
BOOST_CHECK_EQUAL("2 minutes", utils::format_timespan(gen_as_time_t(t)));
test_format_timespan({ 0, 0, 1, 0, 0, 0, 0 }, "1 hour");
t = time_detailed{ 0, 0, 1, 0, 0, 0, 0 };
BOOST_CHECK_EQUAL("1 hour", utils::format_timespan(gen_as_time_t(t)));
test_format_timespan({ 0, 0, 2, 0, 0, 0, 0 }, "2 hours");
t = time_detailed{ 0, 0, 2, 0, 0, 0, 0 };
BOOST_CHECK_EQUAL("2 hours", utils::format_timespan(gen_as_time_t(t)));
test_format_timespan({ 0, 0, 0, 1, 0, 0, 0 }, "1 day");
t = time_detailed{ 0, 0, 0, 1, 0, 0, 0 };
BOOST_CHECK_EQUAL("1 day", utils::format_timespan(gen_as_time_t(t)));
test_format_timespan({ 0, 0, 0, 2, 0, 0, 0 }, "2 days");
t = time_detailed{ 0, 0, 0, 2, 0, 0, 0 };
BOOST_CHECK_EQUAL("2 days", utils::format_timespan(gen_as_time_t(t)));
test_format_timespan({ 0, 0, 0, 0, 1, 0, 0 }, "1 week");
t = time_detailed{ 0, 0, 0, 0, 1, 0, 0 };
BOOST_CHECK_EQUAL("1 week", utils::format_timespan(gen_as_time_t(t)));
test_format_timespan({ 0, 0, 0, 0, 2, 0, 0 }, "2 weeks");
t = time_detailed{ 0, 0, 0, 0, 2, 0, 0 };
BOOST_CHECK_EQUAL("2 weeks", utils::format_timespan(gen_as_time_t(t)));
test_format_timespan({ 0, 0, 0, 0, 0, 1, 0 }, "1 month");
t = time_detailed{ 0, 0, 0, 0, 0, 1, 0 };
BOOST_CHECK_EQUAL("1 month", utils::format_timespan(gen_as_time_t(t)));
test_format_timespan({ 0, 0, 0, 0, 0, 2, 0 }, "2 months");
t = time_detailed{ 0, 0, 0, 0, 0, 2, 0 };
BOOST_CHECK_EQUAL("2 months", utils::format_timespan(gen_as_time_t(t)));
test_format_timespan({ 0, 0, 0, 0, 0, 0, 1 }, "1 year");
t = time_detailed{ 0, 0, 0, 0, 0, 0, 1 };
BOOST_CHECK_EQUAL("1 year", utils::format_timespan(gen_as_time_t(t)));
test_format_timespan({ 0, 0, 0, 0, 0, 0, 2 }, "2 years");
t = time_detailed{ 0, 0, 0, 0, 0, 0, 2 };
BOOST_CHECK_EQUAL("2 years", utils::format_timespan(gen_as_time_t(t)));
t = time_detailed{ 12, 1, 23, 3, 2, 5, 2 };
BOOST_CHECK_EQUAL(gen_as_str(t), utils::format_timespan(gen_as_time_t(t)));
auto t = time_detailed{ 12, 1, 23, 3, 2, 5, 2 };
test_format_timespan(t, gen_as_str(t), "2 years");
t = time_detailed{ 0, 0, 0, 0, 0, 0, 0 };
BOOST_CHECK_EQUAL(utils::format_timespan(gen_as_time_t(t)), utils::format_timespan(0));
BOOST_CHECK_EQUAL(utils::format_timespan(gen_as_time_t(t), true), utils::format_timespan(0));
BOOST_CHECK_EQUAL(utils::format_timespan(gen_as_time_t(t)), utils::format_timespan(-10000));
BOOST_CHECK_EQUAL(utils::format_timespan(gen_as_time_t(t), true), utils::format_timespan(-10000));
t = time_detailed{ 4, 0, 49, 0, 0, 0, 0 };
BOOST_CHECK_EQUAL("2 days, 1 hour, and 4 seconds", utils::format_timespan(gen_as_time_t(t)));
test_format_timespan({ 4, 0, 49, 0, 0, 0, 0 }, "2 days, 1 hour, and 4 seconds", "2 days");
t = time_detailed{ 0, 40, 0, 11, 1, 0, 4 };
BOOST_CHECK_EQUAL("4 years, 2 weeks, 4 days, and 40 minutes", utils::format_timespan(gen_as_time_t(t)));
test_format_timespan({ 0, 40, 0, 11, 1, 0, 4 }, "4 years, 2 weeks, 4 days, and 40 minutes", "4 years");
t = time_detailed{ 0, 0, 1, 0, 0, 3, 4 };
BOOST_CHECK_EQUAL("4 years, 3 months, and 1 hour", utils::format_timespan(gen_as_time_t(t)));
test_format_timespan({ 0, 0, 1, 0, 0, 3, 4 }, "4 years, 3 months, and 1 hour", "4 years");
t = time_detailed{ 10, 0, 0, 0, 0, 2, 0 };
BOOST_CHECK_EQUAL("2 months and 10 seconds", utils::format_timespan(gen_as_time_t(t)));
test_format_timespan({ 10, 0, 0, 0, 0, 2, 0 }, "2 months and 10 seconds", "2 months");
}
BOOST_AUTO_TEST_SUITE_END()