Add support for ChronoUnit.WEEKS when using PeriodUnit

Fixes gh-22225
spring-projects · Jul 6, 2020 · 28128a9 · 28128a9
1 parent d1f0748
commit 28128a9
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 5 deletions.
diff --git a/...-boot-project/spring-boot/src/main/java/org/springframework/boot/convert/PeriodStyle.java b/...-boot-project/spring-boot/src/main/java/org/springframework/boot/convert/PeriodStyle.java
@@ -212,13 +212,18 @@ public static PeriodStyle detect(String value) {
 		throw new IllegalArgumentException("'" + value + "' is not a valid period");
 	}
 
-	enum Unit {
+	private enum Unit {
 
 		/**
 		 * Days, represented by suffix {@code d}.
 		 */
 		DAYS(ChronoUnit.DAYS, "d", Period::getDays, Period::ofDays),
 
+		/**
+		 * Weeks, represented by suffix {@code w}.
+		 */
+		WEEKS(ChronoUnit.WEEKS, "w", null, Period::ofWeeks),
+
 		/**
 		 * Months, represented by suffix {@code m}.
 		 */
@@ -253,15 +258,16 @@ private String print(Period value) {
 			return intValue(value) + this.suffix;
 		}
 
-		public boolean isZero(Period value) {
+		private boolean isZero(Period value) {
 			return intValue(value) == 0;
 		}
 
-		public int intValue(Period value) {
+		private int intValue(Period value) {
+			Assert.notNull(this.intValue, () -> "intValue cannot be extracted from " + this.name());
 			return this.intValue.apply(value);
 		}
 
-		public static Unit fromChronoUnit(ChronoUnit chronoUnit) {
+		private static Unit fromChronoUnit(ChronoUnit chronoUnit) {
 			if (chronoUnit == null) {
 				return Unit.DAYS;
 			}

diff --git a/...ing-boot/src/test/java/org/springframework/boot/convert/NumberToPeriodConverterTests.java b/...ing-boot/src/test/java/org/springframework/boot/convert/NumberToPeriodConverterTests.java
@@ -48,9 +48,14 @@ void convertWhenSimpleWithoutSuffixShouldReturnPeriod(ConversionService conversi
 
 	@ConversionServiceTest
 	void convertWhenSimpleWithoutSuffixButWithAnnotationShouldReturnPeriod(ConversionService conversionService) {
+		assertThat(convert(conversionService, 10, ChronoUnit.DAYS)).isEqualTo(Period.ofDays(10));
+		assertThat(convert(conversionService, -10, ChronoUnit.DAYS)).isEqualTo(Period.ofDays(-10));
+		assertThat(convert(conversionService, 10, ChronoUnit.WEEKS)).isEqualTo(Period.ofWeeks(10));
+		assertThat(convert(conversionService, -10, ChronoUnit.WEEKS)).isEqualTo(Period.ofWeeks(-10));
 		assertThat(convert(conversionService, 10, ChronoUnit.MONTHS)).isEqualTo(Period.ofMonths(10));
-		assertThat(convert(conversionService, +10, ChronoUnit.MONTHS)).isEqualTo(Period.ofMonths(10));
 		assertThat(convert(conversionService, -10, ChronoUnit.MONTHS)).isEqualTo(Period.ofMonths(-10));
+		assertThat(convert(conversionService, 10, ChronoUnit.YEARS)).isEqualTo(Period.ofYears(10));
+		assertThat(convert(conversionService, -10, ChronoUnit.YEARS)).isEqualTo(Period.ofYears(-10));
 	}
 
 	private Period convert(ConversionService conversionService, Integer source) {

diff --git a/...ing-boot/src/test/java/org/springframework/boot/convert/PeriodToStringConverterTests.java b/...ing-boot/src/test/java/org/springframework/boot/convert/PeriodToStringConverterTests.java
@@ -71,6 +71,13 @@ void convertWithFormatAndUnitWhenNonZeroShouldUseFormatAndIgnoreUnit(ConversionS
 		assertThat(converted).isEqualTo("1y3d");
 	}
 
+	@ConversionServiceTest
+	void convertWithWeekUnitShouldConvertToStringInDays(ConversionService conversionService) {
+		String converted = (String) conversionService.convert(Period.ofWeeks(53),
+				MockPeriodTypeDescriptor.get(null, PeriodStyle.SIMPLE), TypeDescriptor.valueOf(String.class));
+		assertThat(converted).isEqualTo("371d");
+	}
+
 	static Stream<? extends Arguments> conversionServices() throws Exception {
 		return ConversionServiceArguments.with(new PeriodToStringConverter());
 	}

diff --git a/...ing-boot/src/test/java/org/springframework/boot/convert/StringToPeriodConverterTests.java b/...ing-boot/src/test/java/org/springframework/boot/convert/StringToPeriodConverterTests.java
@@ -55,6 +55,14 @@ void convertWhenSimpleDaysShouldReturnPeriod(ConversionService conversionService
 		assertThat(convert(conversionService, "-10D")).isEqualTo(Period.ofDays(-10));
 	}
 
+	@ConversionServiceTest
+	void convertWhenSimpleWeeksShouldReturnPeriod(ConversionService conversionService) {
+		assertThat(convert(conversionService, "10w")).isEqualTo(Period.ofWeeks(10));
+		assertThat(convert(conversionService, "10W")).isEqualTo(Period.ofWeeks(10));
+		assertThat(convert(conversionService, "+10w")).isEqualTo(Period.ofWeeks(10));
+		assertThat(convert(conversionService, "-10W")).isEqualTo(Period.ofWeeks(-10));
+	}
+
 	@ConversionServiceTest
 	void convertWhenSimpleMonthsShouldReturnPeriod(ConversionService conversionService) {
 		assertThat(convert(conversionService, "10m")).isEqualTo(Period.ofMonths(10));
@@ -80,9 +88,18 @@ void convertWhenSimpleWithoutSuffixShouldReturnPeriod(ConversionService conversi
 
 	@ConversionServiceTest
 	void convertWhenSimpleWithoutSuffixButWithAnnotationShouldReturnPeriod(ConversionService conversionService) {
+		assertThat(convert(conversionService, "10", ChronoUnit.DAYS, null)).isEqualTo(Period.ofDays(10));
+		assertThat(convert(conversionService, "+10", ChronoUnit.DAYS, null)).isEqualTo(Period.ofDays(10));
+		assertThat(convert(conversionService, "-10", ChronoUnit.DAYS, null)).isEqualTo(Period.ofDays(-10));
+		assertThat(convert(conversionService, "10", ChronoUnit.WEEKS, null)).isEqualTo(Period.ofWeeks(10));
+		assertThat(convert(conversionService, "+10", ChronoUnit.WEEKS, null)).isEqualTo(Period.ofWeeks(10));
+		assertThat(convert(conversionService, "-10", ChronoUnit.WEEKS, null)).isEqualTo(Period.ofWeeks(-10));
 		assertThat(convert(conversionService, "10", ChronoUnit.MONTHS, null)).isEqualTo(Period.ofMonths(10));
 		assertThat(convert(conversionService, "+10", ChronoUnit.MONTHS, null)).isEqualTo(Period.ofMonths(10));
 		assertThat(convert(conversionService, "-10", ChronoUnit.MONTHS, null)).isEqualTo(Period.ofMonths(-10));
+		assertThat(convert(conversionService, "10", ChronoUnit.YEARS, null)).isEqualTo(Period.ofYears(10));
+		assertThat(convert(conversionService, "+10", ChronoUnit.YEARS, null)).isEqualTo(Period.ofYears(10));
+		assertThat(convert(conversionService, "-10", ChronoUnit.YEARS, null)).isEqualTo(Period.ofYears(-10));
 	}
 
 	private Period convert(ConversionService conversionService, String source) {