feat(/series/add): add support for letters for Scott numbers.

Fix #671

Author: php-coder

src/main/java/ru/mystamps/web/feature/series/AddSeriesForm.java

@@ -113,7 +113,9 @@ public class AddSeriesForm implements AddSeriesDto, HasImageOrImageUrl, Nullable
 	@Price
 	private BigDecimal michelPrice;
 
-	@CatalogNumbers
+	// @todo #671 /series/add: add integration test to check that Scott numbers may contain letters
+	// @todo #671 /series/add: add integration test for Scott numbers error message
+	@CatalogNumbers(allowLetters = true)
 	private String scottNumbers;
 
 	@Price

src/main/java/ru/mystamps/web/support/beanvalidation/CatalogNumbers.java

@@ -37,4 +37,6 @@
 	String message() default "{ru.mystamps.web.support.beanvalidation.CatalogNumbers.message}";
 	Class<?>[] groups() default {};
 	Class<? extends Payload>[] payload() default {};
+	
+	boolean allowLetters() default false;
 }

src/main/java/ru/mystamps/web/support/beanvalidation/CatalogNumbersValidator.java

@@ -29,18 +29,37 @@ public class CatalogNumbersValidator implements ConstraintValidator<CatalogNumbe
 	private static final Pattern CATALOG_NUMBERS =
 		Pattern.compile(ValidationRules.CATALOG_NUMBERS_REGEXP);
 
+	private static final Pattern CATALOG_NUMBERS_WITH_LETTERS =
+		Pattern.compile(ValidationRules.CATALOG_NUMBERS_AND_LETTERS_REGEXP);
+	
+	private boolean allowLetters;
+	
 	@Override
 	public void initialize(CatalogNumbers catalogNumbers) {
-		// Intentionally empty: nothing to initialize
+		allowLetters = catalogNumbers.allowLetters();
 	}
 
 	@Override
 	public boolean isValid(String catalogNumbers, ConstraintValidatorContext ctx) {
 		if (catalogNumbers == null) {
 			return true;
 		}
-
-		return CATALOG_NUMBERS.matcher(catalogNumbers).matches();
+		
+		if (!allowLetters) {
+			return CATALOG_NUMBERS.matcher(catalogNumbers).matches();
+		}
+		
+		boolean matches = CATALOG_NUMBERS_WITH_LETTERS.matcher(catalogNumbers).matches();
+		if (matches) {
+			return true;
+		}
+		
+		ConstraintViolationUtils.recreate(
+			ctx,
+			"{ru.mystamps.web.support.beanvalidation.CatalogNumbers.Alnum.message}"
+		);
+		
+		return false;
 	}
 
 }

src/main/java/ru/mystamps/web/support/beanvalidation/ConstraintViolationUtils.java

@@ -39,7 +39,7 @@ public static void recreate(
 	}
 
 	/**
-	 * Bind error {@code msgTemplate} to whole form.
+	 * Bind error {@code msgTemplate} to a currently validated object.
 	 */
 	public static void recreate(ConstraintValidatorContext ctx, String msgTemplate) {
 		ctx.disableDefaultConstraintViolation();

src/main/java/ru/mystamps/web/validation/ValidationRules.java

@@ -19,6 +19,8 @@
 
 import ru.mystamps.web.Db;
 
+// it complains on "PMD.LongVariable"
+@SuppressWarnings("PMD.AvoidDuplicateLiterals")
 public final class ValidationRules {
 
 	public static final int LOGIN_MIN_LENGTH = 2;
@@ -62,6 +64,8 @@ public final class ValidationRules {
 	public static final int MIN_RELEASE_YEAR     = 1840;
 	public static final int MAX_SERIES_COMMENT_LENGTH = Db.Series.COMMENT_LENGTH;
 	public static final String CATALOG_NUMBERS_REGEXP = "[1-9][0-9]{0,3}(,[1-9][0-9]{0,3})*";
+	@SuppressWarnings({ "PMD.LongVariable", "checkstyle:linelength" })
+	public static final String CATALOG_NUMBERS_AND_LETTERS_REGEXP = "[1-9][0-9]{0,3}[a-z]?(,[1-9][0-9]{0,3}[a-z]?)*";
 
 	public static final int PARTICIPANT_NAME_MIN_LENGTH = 3;
 	public static final int PARTICIPANT_NAME_MAX_LENGTH = Db.TransactionParticipant.NAME_LENGTH;

src/main/resources/ru/mystamps/i18n/ValidationMessages.properties

@@ -12,6 +12,7 @@ ru.mystamps.web.support.beanvalidation.Email.message = Invalid e-mail address
 ru.mystamps.web.support.beanvalidation.NotEmptyFilename.message = Value must not be empty
 ru.mystamps.web.support.beanvalidation.NotEmptyFile.message = File must not be empty
 ru.mystamps.web.support.beanvalidation.CatalogNumbers.message = Value must be comma delimited numbers
+ru.mystamps.web.support.beanvalidation.CatalogNumbers.Alnum.message = Value must be a list of numbers separated by comma. Any number may end with a latin letter in lower case
 ru.mystamps.web.support.beanvalidation.NotNullIfFirstField.message = Field '{second}' must not be empty
 ru.mystamps.web.support.beanvalidation.Price.message = Invalid value
 ru.mystamps.web.support.beanvalidation.ImageFile.message = Cannot detect file type. Must be image in JPEG or PNG format

src/main/resources/ru/mystamps/i18n/ValidationMessages_ru.properties

@@ -12,6 +12,7 @@ ru.mystamps.web.support.beanvalidation.Email.message = Неправильный
 ru.mystamps.web.support.beanvalidation.NotEmptyFilename.message = Поле обязательно для заполнения
 ru.mystamps.web.support.beanvalidation.NotEmptyFile.message = Файл не должен быть пустым
 ru.mystamps.web.support.beanvalidation.CatalogNumbers.message = Значение должно быть списком чисел через запятую
+ru.mystamps.web.support.beanvalidation.CatalogNumbers.Alnum.message = Значение должно быть списком чисел через запятую. Каждое число может оканчиваться латинской буквой в нижнем регистре
 ru.mystamps.web.support.beanvalidation.NotNullIfFirstField.message = Поле '{second}' обязательно для заполнения
 ru.mystamps.web.support.beanvalidation.Price.message = Некорректное значение
 ru.mystamps.web.support.beanvalidation.ImageFile.message = Не удалось определить тип файла. Должен быть изображением в формате JPEG или PNG

src/test/java/ru/mystamps/web/tests/cases/WhenUserAddSeries.java

@@ -181,7 +181,12 @@ public void quantityShouldNotBeGreaterThanLimit() {
 	}
 
 	@Test(groups = "invalid", dependsOnGroups = "std", dataProvider = "invalidCatalogNumbers")
-	public void catalogNumbersShouldRejectInvalidValues(String numbers, String msg) {
+	public void catalogNumbersShouldRejectInvalidValues(
+		String numbers,
+		String msg,
+		String alnumMsg
+	) {
+		
 		page.showCatalogNumbers();
 
 		page.fillMichelNumbers(numbers);
@@ -194,7 +199,7 @@ public void catalogNumbersShouldRejectInvalidValues(String numbers, String msg)
 		page.submit();
 
 		assertThat(page).field("michelNumbers").hasError(msg);
-		assertThat(page).field("scottNumbers").hasError(msg);
+		assertThat(page).field("scottNumbers").hasError(alnumMsg);
 		assertThat(page).field("yvertNumbers").hasError(msg);
 		assertThat(page).field("gibbonsNumbers").hasError(msg);
 		assertThat(page).field("solovyovNumbers").hasError(msg);
@@ -424,16 +429,19 @@ public Object[][] getInvalidCatalogNumbers() {
 		String expectedErrorMessage =
 			tr("ru.mystamps.web.support.beanvalidation.CatalogNumbers.message");
 
+		String expectedAlnumErrorMessage =
+			tr("ru.mystamps.web.support.beanvalidation.CatalogNumbers.Alnum.message");
+		
 		return new Object[][] {
-			{"t", expectedErrorMessage},
-			{"t,t", expectedErrorMessage},
-			{",1", expectedErrorMessage},
-			{"1,", expectedErrorMessage},
-			{"1,,2", expectedErrorMessage},
-			{"0", expectedErrorMessage},
-			{"05", expectedErrorMessage},
-			{"1,09", expectedErrorMessage},
-			{"10000", expectedErrorMessage}
+			{"t", expectedErrorMessage, expectedAlnumErrorMessage},
+			{"t,t", expectedErrorMessage, expectedAlnumErrorMessage},
+			{",1", expectedErrorMessage, expectedAlnumErrorMessage},
+			{"1,", expectedErrorMessage, expectedAlnumErrorMessage},
+			{"1,,2", expectedErrorMessage, expectedAlnumErrorMessage},
+			{"0", expectedErrorMessage, expectedAlnumErrorMessage},
+			{"05", expectedErrorMessage, expectedAlnumErrorMessage},
+			{"1,09", expectedErrorMessage, expectedAlnumErrorMessage},
+			{"10000", expectedErrorMessage, expectedAlnumErrorMessage}
 		};
 	}
 

src/test/robotframework/series/creation/validation-admin.robot

@@ -128,7 +128,7 @@ Invalid Catalog Numbers Should Be Rejected
 	Input Text                     id=gibbonsNumbers  ${catalogNumbers}
 	Submit Form                    id=add-series-form
 	Element Text Should Be         id=michelNumbers.errors  Value must be comma delimited numbers
-	Element Text Should Be         id=scottNumbers.errors  Value must be comma delimited numbers
+	Element Text Should Be         id=scottNumbers.errors    Value must be a list of numbers separated by comma. Any number may end with a latin letter in lower case
 	Element Text Should Be         id=yvertNumbers.errors  Value must be comma delimited numbers
 	Element Text Should Be         id=gibbonsNumbers.errors  Value must be comma delimited numbers