Trim string input in PropertyEditors where whitespace is irrelevant

Closes gh-28755
This commit is contained in:
Sam Brannen
2022-07-04 19:20:56 +02:00
parent 2bf5f7a6b3
commit 2c3243c93c
5 changed files with 37 additions and 13 deletions

View File

@@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2012 the original author or authors. * Copyright 2002-2022 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -29,6 +29,7 @@ import org.springframework.util.StringUtils;
* e.g. {@code UTF-8}, {@code ISO-8859-16}, etc. * e.g. {@code UTF-8}, {@code ISO-8859-16}, etc.
* *
* @author Arjen Poutsma * @author Arjen Poutsma
* @author Sam Brannen
* @since 2.5.4 * @since 2.5.4
* @see Charset * @see Charset
*/ */
@@ -37,7 +38,7 @@ public class CharsetEditor extends PropertyEditorSupport {
@Override @Override
public void setAsText(String text) throws IllegalArgumentException { public void setAsText(String text) throws IllegalArgumentException {
if (StringUtils.hasText(text)) { if (StringUtils.hasText(text)) {
setValue(Charset.forName(text)); setValue(Charset.forName(text.trim()));
} }
else { else {
setValue(null); setValue(null);

View File

@@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2012 the original author or authors. * Copyright 2002-2022 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -19,11 +19,14 @@ package org.springframework.beans.propertyeditors;
import java.beans.PropertyEditorSupport; import java.beans.PropertyEditorSupport;
import java.util.Currency; import java.util.Currency;
import org.springframework.util.StringUtils;
/** /**
* Editor for {@code java.util.Currency}, translating currency codes into Currency * Editor for {@code java.util.Currency}, translating currency codes into Currency
* objects. Exposes the currency code as text representation of a Currency object. * objects. Exposes the currency code as text representation of a Currency object.
* *
* @author Juergen Hoeller * @author Juergen Hoeller
* @author Sam Brannen
* @since 3.0 * @since 3.0
* @see java.util.Currency * @see java.util.Currency
*/ */
@@ -31,6 +34,9 @@ public class CurrencyEditor extends PropertyEditorSupport {
@Override @Override
public void setAsText(String text) throws IllegalArgumentException { public void setAsText(String text) throws IllegalArgumentException {
if (StringUtils.hasText(text)) {
text = text.trim();
}
setValue(Currency.getInstance(text)); setValue(Currency.getInstance(text));
} }

View File

@@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2013 the original author or authors. * Copyright 2002-2022 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -28,6 +28,7 @@ import org.springframework.util.StringUtils;
* *
* @author Juergen Hoeller * @author Juergen Hoeller
* @author Nicholas Williams * @author Nicholas Williams
* @author Sam Brannen
* @since 3.0 * @since 3.0
* @see java.util.TimeZone * @see java.util.TimeZone
* @see ZoneIdEditor * @see ZoneIdEditor
@@ -36,6 +37,9 @@ public class TimeZoneEditor extends PropertyEditorSupport {
@Override @Override
public void setAsText(String text) throws IllegalArgumentException { public void setAsText(String text) throws IllegalArgumentException {
if (StringUtils.hasText(text)) {
text = text.trim();
}
setValue(StringUtils.parseTimeZoneString(text)); setValue(StringUtils.parseTimeZoneString(text));
} }

View File

@@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2016 the original author or authors. * Copyright 2002-2022 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -19,11 +19,14 @@ package org.springframework.beans.propertyeditors;
import java.beans.PropertyEditorSupport; import java.beans.PropertyEditorSupport;
import java.time.ZoneId; import java.time.ZoneId;
import org.springframework.util.StringUtils;
/** /**
* Editor for {@code java.time.ZoneId}, translating zone ID Strings into {@code ZoneId} * Editor for {@code java.time.ZoneId}, translating zone ID Strings into {@code ZoneId}
* objects. Exposes the {@code TimeZone} ID as a text representation. * objects. Exposes the {@code TimeZone} ID as a text representation.
* *
* @author Nicholas Williams * @author Nicholas Williams
* @author Sam Brannen
* @since 4.0 * @since 4.0
* @see java.time.ZoneId * @see java.time.ZoneId
* @see TimeZoneEditor * @see TimeZoneEditor
@@ -32,6 +35,9 @@ public class ZoneIdEditor extends PropertyEditorSupport {
@Override @Override
public void setAsText(String text) throws IllegalArgumentException { public void setAsText(String text) throws IllegalArgumentException {
if (StringUtils.hasText(text)) {
text = text.trim();
}
setValue(ZoneId.of(text)); setValue(ZoneId.of(text));
} }

View File

@@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2019 the original author or authors. * Copyright 2002-2022 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -19,19 +19,26 @@ package org.springframework.beans.propertyeditors;
import java.time.ZoneId; import java.time.ZoneId;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThat;
/** /**
* @author Nicholas Williams * @author Nicholas Williams
* @author Sam Brannen
*/ */
public class ZoneIdEditorTests { class ZoneIdEditorTests {
private final ZoneIdEditor editor = new ZoneIdEditor(); private final ZoneIdEditor editor = new ZoneIdEditor();
@Test @ParameterizedTest(name = "[{index}] text = ''{0}''")
public void americaChicago() { @ValueSource(strings = {
editor.setAsText("America/Chicago"); "America/Chicago",
" America/Chicago ",
})
void americaChicago(String text) {
editor.setAsText(text);
ZoneId zoneId = (ZoneId) editor.getValue(); ZoneId zoneId = (ZoneId) editor.getValue();
assertThat(zoneId).as("The zone ID should not be null.").isNotNull(); assertThat(zoneId).as("The zone ID should not be null.").isNotNull();
@@ -41,7 +48,7 @@ public class ZoneIdEditorTests {
} }
@Test @Test
public void americaLosAngeles() { void americaLosAngeles() {
editor.setAsText("America/Los_Angeles"); editor.setAsText("America/Los_Angeles");
ZoneId zoneId = (ZoneId) editor.getValue(); ZoneId zoneId = (ZoneId) editor.getValue();
@@ -52,12 +59,12 @@ public class ZoneIdEditorTests {
} }
@Test @Test
public void getNullAsText() { void getNullAsText() {
assertThat(editor.getAsText()).as("The returned value is not correct.").isEqualTo(""); assertThat(editor.getAsText()).as("The returned value is not correct.").isEqualTo("");
} }
@Test @Test
public void getValueAsText() { void getValueAsText() {
editor.setValue(ZoneId.of("America/New_York")); editor.setValue(ZoneId.of("America/New_York"));
assertThat(editor.getAsText()).as("The text version is not correct.").isEqualTo("America/New_York"); assertThat(editor.getAsText()).as("The text version is not correct.").isEqualTo("America/New_York");
} }