fix(validation): alternative price and currency must be both present or both left empty on a series sale form.

Fix #678

Author: php-coder

src/main/java/ru/mystamps/web/feature/series/importing/ImportSeriesSalesForm.java

@@ -54,11 +54,13 @@ public class ImportSeriesSalesForm implements AddSeriesSalesDto {
 	// They are no-op methods because we don't support all values during series import.
 	//
 
+	// For future: altPrice is required when altCurrency is specified
 	@Override
 	public BigDecimal getAltPrice() {
 		return null;
 	}
 
+	// For future: altCurrency is required when altPrice is specified
 	@Override
 	public Currency getAltCurrency() {
 		return null;

src/main/java/ru/mystamps/web/feature/series/sale/AddSeriesSalesForm.java

@@ -22,6 +22,7 @@
 import org.hibernate.validator.constraints.URL;
 import org.springframework.format.annotation.DateTimeFormat;
 import ru.mystamps.web.dao.dto.Currency;
+import ru.mystamps.web.support.beanvalidation.BothOrNoneRequired;
 import ru.mystamps.web.support.beanvalidation.FieldsMismatch;
 import ru.mystamps.web.support.beanvalidation.Group;
 import ru.mystamps.web.validation.ValidationRules;
@@ -34,6 +35,7 @@
 
 // @todo #503 Add integration test to ensure that seller and buyer are different
 // @todo #504 Add integration test to ensure that price and alternative price are different
+// @todo #678 Add integration tests for price and alternative price: both or none are required
 @Getter
 @Setter
 @FieldsMismatch.List({
@@ -44,6 +46,11 @@
 		first = "currency", second = "altCurrency", message = "{currencies.prices.match}"
 	)
 })
+@BothOrNoneRequired(
+	first = "altPrice",
+	second = "altCurrency",
+	message = "{altprice.altcurrency.both-required}"
+)
 public class AddSeriesSalesForm implements AddSeriesSalesDto {
 
 	@DateTimeFormat(pattern = "dd.MM.yyyy")

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

@@ -0,0 +1,41 @@
+/*
+ * Copyright (C) 2009-2019 Slava Semushin <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+package ru.mystamps.web.support.beanvalidation;
+
+import javax.validation.Constraint;
+import javax.validation.Payload;
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+@Target({ TYPE, ANNOTATION_TYPE })
+@Retention(RUNTIME)
+@Constraint(validatedBy = BothOrNoneRequiredValidator.class)
+@Documented
+public @interface BothOrNoneRequired {
+	String message() default "{ru.mystamps.web.support.beanvalidation.BothOrNoneRequired.message}";
+	Class<?>[] groups() default {};
+	Class<? extends Payload>[] payload() default {};
+	
+	String first();
+	String second();
+}

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

@@ -0,0 +1,77 @@
+/*
+ * Copyright (C) 2009-2019 Slava Semushin <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+package ru.mystamps.web.support.beanvalidation;
+
+import org.apache.commons.lang3.StringUtils;
+import org.springframework.beans.BeanWrapperImpl;
+import org.springframework.beans.PropertyAccessor;
+
+import javax.validation.ConstraintValidator;
+import javax.validation.ConstraintValidatorContext;
+import java.util.Objects;
+
+public class BothOrNoneRequiredValidator
+	implements ConstraintValidator<BothOrNoneRequired, Object> {
+	
+	private String firstFieldName;
+	private String secondFieldName;
+	
+	@Override
+	public void initialize(BothOrNoneRequired annotation) {
+		firstFieldName  = annotation.first();
+		secondFieldName = annotation.second();
+	}
+	
+	@Override
+	public boolean isValid(Object value, ConstraintValidatorContext ctx) {
+		
+		if (value == null) {
+			return true;
+		}
+		
+		PropertyAccessor bean = new BeanWrapperImpl(value);
+		
+		Object firstField  = bean.getPropertyValue(firstFieldName);
+		Object secondField = bean.getPropertyValue(secondFieldName);
+		
+		String firstFieldValue  = Objects.toString(firstField, null);
+		String secondFieldValue = Objects.toString(secondField, null);
+		
+		boolean firstIsEmpty  = StringUtils.isEmpty(firstFieldValue);
+		boolean secondIsEmpty = StringUtils.isEmpty(secondFieldValue);
+		
+		if (firstIsEmpty && secondIsEmpty) {
+			return true;
+		}
+		
+		if (!firstIsEmpty && !secondIsEmpty) {
+			return true;
+		}
+		
+		// bind error message to 2nd field
+		ConstraintViolationUtils.recreate(
+			ctx,
+			secondFieldName,
+			ctx.getDefaultConstraintMessageTemplate()
+		);
+		
+		return false;
+	}
+	
+}
+

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

@@ -5,6 +5,7 @@ javax.validation.constraints.Max.message = Value must be less than or equal to {
 org.hibernate.validator.constraints.NotEmpty.message = Value must not be empty
 org.hibernate.validator.constraints.URL.message = Value must be a valid URL
 
+ru.mystamps.web.support.beanvalidation.BothOrNoneRequired.message = {first} and {second} fields must be empty or non-empty, specifying only one of them makes no-sense
 ru.mystamps.web.support.beanvalidation.DenyValues.message = Invalid value
 ru.mystamps.web.support.beanvalidation.FieldsMismatch.message = Field '{second}' must mismatch '{first}'
 ru.mystamps.web.support.beanvalidation.FieldsMatch.message = Field '{second}' must match '{first}'
@@ -50,6 +51,7 @@ password.mismatch = Password mismatch
 password.login.match = Password and login must be different
 seller.buyer.match = Seller and buyer must be different
 currencies.prices.match = Price and alternative price must be in a different currencies
+altprice.altcurrency.both-required = Alternative price and currency must be specified or left empty, specifying only one of them makes no-sense
 
 name.invalid = Name must consist only letters, hyphen or spaces
 

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

@@ -5,6 +5,7 @@ javax.validation.constraints.Max.message = Значение должно быт
 org.hibernate.validator.constraints.NotEmpty.message = Поле обязательно для заполнения
 org.hibernate.validator.constraints.URL.message = Значение должно быть корректным URL
 
+ru.mystamps.web.support.beanvalidation.BothOrNoneRequired.message = Оба поля {first} и {second} должны быть заполнены либо пустыми. Указание только одного из них не имеет смысла
 ru.mystamps.web.support.beanvalidation.DenyValues.message = Неправильное значение
 ru.mystamps.web.support.beanvalidation.FieldsMismatch.message = Поле '{second}' не должно совпадать с '{first}'
 ru.mystamps.web.support.beanvalidation.FieldsMatch.message = Поле '{second}' должно совпадать с '{first}'
@@ -50,6 +51,7 @@ password.mismatch = Пароли не совпадают
 password.login.match = Пароль и логин не должны совпадать
 seller.buyer.match = Продавец и покупатель не должны совпадать
 currencies.prices.match = Цена и альтернативная цена должны быть в различных валютах
+altprice.altcurrency.both-required = Альтернативная цена и валюта должны быть указаны или оставлены пустыми, указание только одного поля не имеет смысла
 
 name.invalid = Имя может состоять только из букв, дефиса или пробелов