Skip to content

Fix DurationFormatUtils.formatPeriod() calculation when pattern omits 'M' #1780

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

Open
Alwaysgaurav1 wants to merge 1 commit into
base: master
Choose a base branch
from
+34 −15
Open

Fix DurationFormatUtils.formatPeriod() calculation when pattern omits 'M' #1780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 7 additions & 15 deletions src/main/java/org/apache/commons/lang3/time/DurationFormatUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.Objects;
import java.util.TimeZone;
import java.util.stream.Stream;
Expand Down Expand Up @@ -580,24 +579,17 @@ public static String formatPeriod(final long startMillis, final long endMillis,
}
} else {
// there are no M's in the format string
if (!Token.containsTokenWithValue(tokens, y)) {
int target = end.get(Calendar.YEAR);
if (months < 0) {
// target is end-year -1
target -= 1;
if (Token.containsTokenWithValue(tokens, y)) {
if (months < 0 || months == 0 && days < 0) {
years -= 1;
}
while (start.get(Calendar.YEAR) != target) {
days += start.getActualMaximum(Calendar.DAY_OF_YEAR) - start.get(Calendar.DAY_OF_YEAR);
// Not sure I grok why this is needed, but the brutal tests show it is
if (start instanceof GregorianCalendar && start.get(Calendar.MONTH) == Calendar.FEBRUARY && start.get(Calendar.DAY_OF_MONTH) == 29) {
days += 1;
}
start.add(Calendar.YEAR, 1);
days += start.get(Calendar.DAY_OF_YEAR);
if (years > 0) {
start.add(Calendar.YEAR, (int) years);
}
} else {
years = 0;
}
while (start.get(Calendar.MONTH) != end.get(Calendar.MONTH)) {
while (start.get(Calendar.YEAR) != end.get(Calendar.YEAR) || start.get(Calendar.MONTH) != end.get(Calendar.MONTH)) {
days += start.getActualMaximum(Calendar.DAY_OF_MONTH);
start.add(Calendar.MONTH, 1);
}
Expand Down
27 changes: 27 additions & 0 deletions src/test/java/org/apache/commons/lang3/time/DurationFormatUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -790,4 +790,31 @@ void testUnmatchedOptionalTokens() {
assertIllegalArgumentException(() -> DurationFormatUtils.formatDuration(1, "[[s"));
assertIllegalArgumentException(() -> DurationFormatUtils.formatDuration(1, "[s]]"));
}

@Test
void testFormatPeriodWithoutMonths() {
final TimeZone timeZone = TimeZone.getTimeZone("UTC");
final Calendar start = Calendar.getInstance(timeZone);
start.set(2024, Calendar.DECEMBER, 15, 0, 0, 0);
start.set(Calendar.MILLISECOND, 0);

final Calendar end = Calendar.getInstance(timeZone);
end.set(2025, Calendar.JANUARY, 15, 0, 0, 0);
end.set(Calendar.MILLISECOND, 0);

// 31 days elapsed across year boundary
assertEquals("0 years 31 days", DurationFormatUtils.formatPeriod(start.getTimeInMillis(), end.getTimeInMillis(), "y' years 'd' days'", false, timeZone));
assertEquals("0y 31d", DurationFormatUtils.formatPeriod(start.getTimeInMillis(), end.getTimeInMillis(), "y'y 'd'd'", false, timeZone));

// 361 days elapsed (less than 1 full year)
start.set(2024, Calendar.JANUARY, 15, 0, 0, 0);
end.set(2025, Calendar.JANUARY, 10, 0, 0, 0);
assertEquals("0 years 361 days", DurationFormatUtils.formatPeriod(start.getTimeInMillis(), end.getTimeInMillis(), "y' years 'd' days'", false, timeZone));

// Leap year to non-leap year (Feb 29, 2024 to Feb 28, 2025 = 365 days)
start.set(2024, Calendar.FEBRUARY, 29, 0, 0, 0);
end.set(2025, Calendar.FEBRUARY, 28, 0, 0, 0);
assertEquals("0 years 365 days", DurationFormatUtils.formatPeriod(start.getTimeInMillis(), end.getTimeInMillis(), "y' years 'd' days'", false, timeZone));
}
}

Loading