Skip to content

Commit

Permalink
Polish 'Add Period converter support'
Browse files Browse the repository at this point in the history 
Polish period converter support, primarily by changing
`PeriodStyle` to parse and print periods that include
more than one unit.

See gh-21136
  • Loading branch information
@philwebb
philwebb committed May 6, 2020
1 parent dc4d71f commit 5ae623c
Show file tree
Hide file tree
Showing 6 changed files with 153 additions and 76 deletions.
20 changes: 20 additions & 0 deletions spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-features.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1450,6 +1450,26 @@ Doing so gives a transparent upgrade path while supporting a much richer format.



[[boot-features-external-config-conversion-period]]
===== Converting periods
In addition to durations, Spring Boot can also work with `java.time.Period` type.
The following formats can be used in application properties:

* An regular `int` representation (using days as the default unit unless a `@PeriodUnit` has been specified)
* The standard ISO-8601 format {java-api}/java/time/Period.html#parse-java.lang.CharSequence-[used by `java.time.Period`]
* A simpler format where the value and the unit pairs are coupled (e.g. `1y3d` means 1 year and 3 days)

The following units are supported with the simple format:

* `y` for years
* `m` for months
* `w` for weeks
* `d` for days

NOTE: The `java.time.Period` type never actually stores the number of weeks, it is simply a shortcut that means "`7 days`".



[[boot-features-external-config-conversion-datasize]]
===== Converting Data Sizes
Spring Framework has a `DataSize` value type that expresses a size in bytes.
Expand Down
26 changes: 13 additions & 13 deletions ...ramework/boot/configurationprocessor/fieldvalues/javac/JavaCompilerFieldValuesParser.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,19 @@ private static class FieldCollector implements TreeVisitor {
DURATION_SUFFIX = Collections.unmodifiableMap(values);
}

private static final String PERIOD_OF = "Period.of";

private static final Map<String, String> PERIOD_SUFFIX;

static {
Map<String, String> values = new HashMap<>();
values.put("Days", "d");
values.put("Weeks", "w");
values.put("Months", "m");
values.put("Years", "y");
PERIOD_SUFFIX = Collections.unmodifiableMap(values);
}

private static final String DATA_SIZE_OF = "DataSize.of";

private static final Map<String, String> DATA_SIZE_SUFFIX;
Expand All @@ -130,19 +143,6 @@ private static class FieldCollector implements TreeVisitor {
DATA_SIZE_SUFFIX = Collections.unmodifiableMap(values);
}

private static final String PERIOD_OF = "Period.of";

private static final Map<String, String> PERIOD_SUFFIX;

static {
Map<String, String> values = new HashMap<>();
values.put("Days", "d");
values.put("Weeks", "w");
values.put("Months", "m");
values.put("Years", "y");
PERIOD_SUFFIX = Collections.unmodifiableMap(values);
}

private final Map<String, Object> fieldValues = new HashMap<>();

private final Map<String, Object> staticFinals = new HashMap<>();
Expand Down
6 changes: 3 additions & 3 deletions ...ing-boot/src/main/java/org/springframework/boot/convert/ApplicationConversionService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,12 +110,12 @@ public static void configure(FormatterRegistry registry) {
public static void addApplicationConverters(ConverterRegistry registry) {
addDelimitedStringConverters(registry);
registry.addConverter(new StringToDurationConverter());
registry.addConverter(new StringToPeriodConverter());
registry.addConverter(new DurationToStringConverter());
registry.addConverter(new PeriodToStringConverter());
registry.addConverter(new NumberToDurationConverter());
registry.addConverter(new NumberToPeriodConverter());
registry.addConverter(new DurationToNumberConverter());
registry.addConverter(new StringToPeriodConverter());
registry.addConverter(new PeriodToStringConverter());
registry.addConverter(new NumberToPeriodConverter());
registry.addConverter(new StringToDataSizeConverter());
registry.addConverter(new NumberToDataSizeConverter());
registry.addConverter(new StringToFileConverter());
Expand Down
114 changes: 66 additions & 48 deletions ...-boot-project/spring-boot/src/main/java/org/springframework/boot/convert/PeriodStyle.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
import java.util.regex.Pattern;

import org.springframework.util.Assert;
import org.springframework.util.StringUtils;

/**
* A standard set of {@link Period} units.
Expand All @@ -38,33 +37,72 @@ public enum PeriodStyle {
/**
* Simple formatting, for example '1d'.
*/
SIMPLE("^([\\+\\-]?\\d+)([a-zA-Z]{0,2})$") {
SIMPLE("^" + "(?:([-+]?[0-9]+)Y)?" + "(?:([-+]?[0-9]+)M)?" + "(?:([-+]?[0-9]+)W)?" + "(?:([-+]?[0-9]+)D)?" + "$",
Pattern.CASE_INSENSITIVE) {

@Override
public Period parse(String value, ChronoUnit unit) {
try {
if (NUMERIC.matcher(value).matches()) {
return Unit.fromChronoUnit(unit).parse(value);
}
Matcher matcher = matcher(value);
Assert.state(matcher.matches(), "Does not match simple period pattern");
String suffix = matcher.group(2);
return (StringUtils.hasLength(suffix) ? Unit.fromSuffix(suffix) : Unit.fromChronoUnit(unit))
.parse(matcher.group(1));
Assert.isTrue(hasAtLeastOneGroupValue(matcher), "'" + value + "' is not a valid simple period");
int years = parseInt(matcher, 1);
int months = parseInt(matcher, 2);
int weeks = parseInt(matcher, 3);
int days = parseInt(matcher, 4);
return Period.of(years, months, Math.addExact(Math.multiplyExact(weeks, 7), days));
}
catch (Exception ex) {
throw new IllegalArgumentException("'" + value + "' is not a valid simple period", ex);
}
}

boolean hasAtLeastOneGroupValue(Matcher matcher) {
for (int i = 0; i < matcher.groupCount(); i++) {
if (matcher.group(i + 1) != null) {
return true;
}
}
return false;
}

private int parseInt(Matcher matcher, int group) {
String value = matcher.group(group);
return (value != null) ? Integer.parseInt(value) : 0;
}

@Override
protected boolean matches(String value) {
return NUMERIC.matcher(value).matches() || matcher(value).matches();
}

@Override
public String print(Period value, ChronoUnit unit) {
return Unit.fromChronoUnit(unit).print(value);
if (value.isZero()) {
return Unit.fromChronoUnit(unit).print(value);
}
StringBuilder result = new StringBuilder();
append(result, value, Unit.YEARS);
append(result, value, Unit.MONTHS);
append(result, value, Unit.DAYS);
return result.toString();
}

private void append(StringBuilder result, Period value, Unit unit) {
if (!unit.isZero(value)) {
result.append(unit.print(value));
}
}

},

/**
* ISO-8601 formatting.
*/
ISO8601("^[\\+\\-]?P.*$") {
ISO8601("^[\\+\\-]?P.*$", 0) {

@Override
public Period parse(String value, ChronoUnit unit) {
Expand All @@ -83,13 +121,15 @@ public String print(Period value, ChronoUnit unit) {

};

private static final Pattern NUMERIC = Pattern.compile("^[-+]?[0-9]+$");

private final Pattern pattern;

PeriodStyle(String pattern) {
this.pattern = Pattern.compile(pattern);
PeriodStyle(String pattern, int flags) {
this.pattern = Pattern.compile(pattern, flags);
}

protected final boolean matches(String value) {
protected boolean matches(String value) {
return this.pattern.matcher(value).matches();
}

Expand Down Expand Up @@ -175,69 +215,47 @@ enum Unit {
/**
* Days, represented by suffix {@code d}.
*/
DAYS(ChronoUnit.DAYS, "d", Period::getDays),
DAYS(ChronoUnit.DAYS, "d", Period::getDays, Period::ofDays),

/**
* Months, represented by suffix {@code m}.
*/
MONTHS(ChronoUnit.MONTHS, "m", Period::getMonths),
MONTHS(ChronoUnit.MONTHS, "m", Period::getMonths, Period::ofMonths),

/**
* Years, represented by suffix {@code y}.
*/
YEARS(ChronoUnit.YEARS, "y", Period::getYears);
YEARS(ChronoUnit.YEARS, "y", Period::getYears, Period::ofYears);

private final ChronoUnit chronoUnit;

private final String suffix;

private final Function<Period, Integer> intValue;

Unit(ChronoUnit chronoUnit, String suffix, Function<Period, Integer> intValue) {
private final Function<Integer, Period> factory;

Unit(ChronoUnit chronoUnit, String suffix, Function<Period, Integer> intValue,
Function<Integer, Period> factory) {
this.chronoUnit = chronoUnit;
this.suffix = suffix;
this.intValue = intValue;
this.factory = factory;
}

/**
* Return the {@link Unit} matching the specified {@code suffix}.
* @param suffix one of the standard suffixes
* @return the {@link Unit} matching the specified {@code suffix}
* @throws IllegalArgumentException if the suffix does not match the suffix of any
* of this enum's constants
*/
public static Unit fromSuffix(String suffix) {
for (Unit candidate : values()) {
if (candidate.suffix.equalsIgnoreCase(suffix)) {
return candidate;
}
}
throw new IllegalArgumentException("Unknown unit suffix '" + suffix + "'");
private Period parse(String value) {
return this.factory.apply(Integer.parseInt(value));
}

public Period parse(String value) {
int intValue = Integer.parseInt(value);

if (ChronoUnit.DAYS == this.chronoUnit) {
return Period.ofDays(intValue);
}
else if (ChronoUnit.WEEKS == this.chronoUnit) {
return Period.ofWeeks(intValue);
}
else if (ChronoUnit.MONTHS == this.chronoUnit) {
return Period.ofMonths(intValue);
}
else if (ChronoUnit.YEARS == this.chronoUnit) {
return Period.ofYears(intValue);
}
throw new IllegalArgumentException("Unknow unit '" + this.chronoUnit + "'");
private String print(Period value) {
return intValue(value) + this.suffix;
}

public String print(Period value) {
return longValue(value) + this.suffix;
public boolean isZero(Period value) {
return intValue(value) == 0;
}

public long longValue(Period value) {
public int intValue(Period value) {
return this.intValue.apply(value);
}

Expand All @@ -250,7 +268,7 @@ public static Unit fromChronoUnit(ChronoUnit chronoUnit) {
return candidate;
}
}
throw new IllegalArgumentException("Unknown unit " + chronoUnit);
throw new IllegalArgumentException("Unsupported unit " + chronoUnit);
}

}
Expand Down
38 changes: 31 additions & 7 deletions ...-project/spring-boot/src/test/java/org/springframework/boot/convert/PeriodStyleTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,14 @@ void detectAndParseWhenSimpleDaysShouldReturnPeriod() {
assertThat(PeriodStyle.detectAndParse("-10D")).isEqualTo(Period.ofDays(-10));
}

@Test
void detectAndParseWhenSimpleWeeksShouldReturnPeriod() {
assertThat(PeriodStyle.detectAndParse("10w")).isEqualTo(Period.ofWeeks(10));
assertThat(PeriodStyle.detectAndParse("10W")).isEqualTo(Period.ofWeeks(10));
assertThat(PeriodStyle.detectAndParse("+10w")).isEqualTo(Period.ofWeeks(10));
assertThat(PeriodStyle.detectAndParse("-10W")).isEqualTo(Period.ofWeeks(-10));
}

@Test
void detectAndParseWhenSimpleMonthsShouldReturnPeriod() {
assertThat(PeriodStyle.detectAndParse("10m")).isEqualTo(Period.ofMonths(10));
Expand Down Expand Up @@ -86,6 +94,16 @@ void detectAndParseWhenSimpleWithoutSuffixButWithChronoUnitShouldReturnPeriod()
assertThat(PeriodStyle.detectAndParse("-10", ChronoUnit.MONTHS)).isEqualTo(Period.ofMonths(-10));
}

@Test
void detectAndParseWhenComplexShouldReturnPeriod() {
assertThat(PeriodStyle.detectAndParse("1y2m")).isEqualTo(Period.of(1, 2, 0));
assertThat(PeriodStyle.detectAndParse("1y2m3d")).isEqualTo(Period.of(1, 2, 3));
assertThat(PeriodStyle.detectAndParse("2m3d")).isEqualTo(Period.of(0, 2, 3));
assertThat(PeriodStyle.detectAndParse("1y3d")).isEqualTo(Period.of(1, 0, 3));
assertThat(PeriodStyle.detectAndParse("-1y3d")).isEqualTo(Period.of(-1, 0, 3));
assertThat(PeriodStyle.detectAndParse("-1y-3d")).isEqualTo(Period.of(-1, 0, -3));
}

@Test
void detectAndParseWhenBadFormatShouldThrowException() {
assertThatIllegalArgumentException().isThrownBy(() -> PeriodStyle.detectAndParse("10foo"))
Expand Down Expand Up @@ -161,8 +179,8 @@ void parseSimpleWithUnitShouldUseUnitAsFallback() {

@Test
void parseSimpleWhenUnknownUnitShouldThrowException() {
assertThatIllegalArgumentException().isThrownBy(() -> PeriodStyle.SIMPLE.parse("10mb"))
.satisfies((ex) -> assertThat(ex.getCause().getMessage()).isEqualTo("Unknown unit suffix 'mb'"));
assertThatIllegalArgumentException().isThrownBy(() -> PeriodStyle.SIMPLE.parse("10x")).satisfies(
(ex) -> assertThat(ex.getCause().getMessage()).isEqualTo("Does not match simple period pattern"));
}

@Test
Expand All @@ -184,15 +202,21 @@ void printIso8601ShouldIgnoreUnit() {
}

@Test
void printSimpleWithoutUnitShouldPrintInDays() {
Period period = Period.ofMonths(1);
void printSimpleWhenZeroWithoutUnitShouldPrintInDays() {
Period period = Period.ofMonths(0);
assertThat(PeriodStyle.SIMPLE.print(period)).isEqualTo("0d");
}

@Test
void printSimpleWithUnitShouldPrintInUnit() {
Period period = Period.ofYears(1000);
assertThat(PeriodStyle.SIMPLE.print(period, ChronoUnit.YEARS)).isEqualTo("1000y");
void printSimpleWhenZeroWithUnitShouldPrintInUnit() {
Period period = Period.ofYears(0);
assertThat(PeriodStyle.SIMPLE.print(period, ChronoUnit.YEARS)).isEqualTo("0y");
}

@Test
void printSimpleWhenNonZeroShouldIgnoreUnit() {
Period period = Period.of(1, 2, 3);
assertThat(PeriodStyle.SIMPLE.print(period, ChronoUnit.YEARS)).isEqualTo("1y2m3d");
}

}
25 changes: 20 additions & 5 deletions ...ing-boot/src/test/java/org/springframework/boot/convert/PeriodToStringConverterTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,33 @@ void convertWithoutStyleShouldReturnIso8601(ConversionService conversionService)
}

@ConversionServiceTest
void convertWithFormatShouldUseFormatAndDays(ConversionService conversionService) {
String converted = (String) conversionService.convert(Period.ofMonths(1),
void convertWithFormatWhenZeroShouldUseFormatAndDays(ConversionService conversionService) {
String converted = (String) conversionService.convert(Period.ofMonths(0),
MockPeriodTypeDescriptor.get(null, PeriodStyle.SIMPLE), TypeDescriptor.valueOf(String.class));
assertThat(converted).isEqualTo("0d");
}

@ConversionServiceTest
void convertWithFormatAndUnitShouldUseFormatAndUnit(ConversionService conversionService) {
String converted = (String) conversionService.convert(Period.ofYears(1),
void convertWithFormatShouldUseFormat(ConversionService conversionService) {
String converted = (String) conversionService.convert(Period.of(1, 2, 3),
MockPeriodTypeDescriptor.get(null, PeriodStyle.SIMPLE), TypeDescriptor.valueOf(String.class));
assertThat(converted).isEqualTo("1y2m3d");
}

@ConversionServiceTest
void convertWithFormatAndUnitWhenZeroShouldUseFormatAndUnit(ConversionService conversionService) {
String converted = (String) conversionService.convert(Period.ofYears(0),
MockPeriodTypeDescriptor.get(ChronoUnit.YEARS, PeriodStyle.SIMPLE),
TypeDescriptor.valueOf(String.class));
assertThat(converted).isEqualTo("0y");
}

@ConversionServiceTest
void convertWithFormatAndUnitWhenNonZeroShouldUseFormatAndIgnoreUnit(ConversionService conversionService) {
String converted = (String) conversionService.convert(Period.of(1, 0, 3),
MockPeriodTypeDescriptor.get(ChronoUnit.YEARS, PeriodStyle.SIMPLE),
TypeDescriptor.valueOf(String.class));
assertThat(converted).isEqualTo("1y");
assertThat(converted).isEqualTo("1y3d");
}

static Stream<? extends Arguments> conversionServices() throws Exception {
Expand Down

0 comments on commit 5ae623c

Please sign in to comment.