improve: allow to specify multiple ids or range of ids when adding similar series.

Fix #1448

Author: php-coder

src/main/frontend/src/components/SimilarSeriesForm.js

@@ -10,7 +10,7 @@ class SimilarSeriesForm extends React.PureComponent {
 		super(props);
 		this.state = {
 			seriesId: props.seriesId,
-			similarSeriesId: '',
+			similarSeriesIds: [],
 			isDisabled: false,
 			hasServerError: false,
 			validationErrors: []
@@ -22,26 +22,30 @@ class SimilarSeriesForm extends React.PureComponent {
 	handleChange(event) {
 		event.preventDefault();
 		this.setState({
-			similarSeriesId: event.target.value
+			similarSeriesIds: event.target.value
 		});
 	}
 
 	handleSubmit(event) {
 		event.preventDefault();
 
+		const similarSeriesIds = CatalogUtils.expandNumbers(this.state.similarSeriesIds)
+			.split(',')
+			.map(number => parseInt(number, 10))
+			.filter(number => !isNaN(number));
+		
 		this.setState({
+			similarSeriesIds: similarSeriesIds,
 			isDisabled: true,
 			hasServerError: false,
 			validationErrors: []
 		});
 
-		const similarSeriesId = parseInt(this.state.similarSeriesId, 10) || this.state.similarSeriesId;
-		
 		axios.post(
 			this.props.url,
 			{
 				'seriesId': this.state.seriesId,
-				'similarSeriesId': similarSeriesId
+				'similarSeriesIds': similarSeriesIds
 			},
 			{
 				headers: {
@@ -59,8 +63,8 @@ class SimilarSeriesForm extends React.PureComponent {
 				if (data.fieldErrors.seriesId) {
 					fieldErrors.push(...data.fieldErrors.seriesId);
 				}
-				if (data.fieldErrors.similarSeriesId) {
-					fieldErrors.push(...data.fieldErrors.similarSeriesId);
+				if (data.fieldErrors.similarSeriesIds) {
+					fieldErrors.push(...data.fieldErrors.similarSeriesIds);
 				}
 				this.setState({ isDisabled: false, validationErrors: fieldErrors });
 				return;
@@ -81,7 +85,7 @@ class SimilarSeriesForm extends React.PureComponent {
 				l10n={this.props.l10n}
 				handleChange={this.handleChange}
 				handleSubmit={this.handleSubmit}
-				similarSeriesId={this.state.similarSeriesId}
+				similarSeriesIds={this.state.similarSeriesIds}
 				isDisabled={this.state.isDisabled}
 				hasServerError={this.state.hasServerError}
 				validationErrors={this.state.validationErrors}
@@ -92,7 +96,7 @@ class SimilarSeriesForm extends React.PureComponent {
 
 class SimilarSeriesFormView extends React.PureComponent {
 	render() {
-		const {similarSeriesId, hasServerError, isDisabled, validationErrors, handleChange, handleSubmit} = this.props;
+		const {similarSeriesIds, hasServerError, isDisabled, validationErrors, handleChange, handleSubmit} = this.props;
 		const hasValidationErrors = validationErrors.length > 0;
 
 		return (
@@ -112,8 +116,8 @@ class SimilarSeriesFormView extends React.PureComponent {
 								type="text"
 								className="form-control"
 								required="required"
-								placeholder={ this.props.l10n['t_similar_series_id'] || 'Similar series ID' }
-								value={ similarSeriesId }
+								placeholder={ this.props.l10n['t_similar_series_ids'] || 'Similar series ID(s)' }
+								value={ similarSeriesIds }
 								onChange={ handleChange }
 								disabled={ isDisabled } />
 						</div>

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

@@ -20,7 +20,10 @@
 import lombok.Getter;
 import lombok.Setter;
 
+import javax.validation.constraints.NotEmpty;
 import javax.validation.constraints.NotNull;
+import java.util.Collections;
+import java.util.Set;
 
 // @todo #1280 AddSimilarSeriesForm: series and similar series must be different
 @Getter
@@ -33,6 +36,34 @@ public class AddSimilarSeriesForm implements AddSimilarSeriesDto {
 
 	// @todo #1280 AddSimilarSeriesForm: add integration test for mandatory similarSeriesId
 	// @todo #1280 AddSimilarSeriesForm: similarSeriesId must exist
-	@NotNull
+	// @todo #1448 AddSimilarSeriesForm.similarSeriesId: remove deprecated member
+	// NOTE: similarSeriesId is deprecated and exist only for backward compatibility
 	private Integer similarSeriesId;
+	
+	private Set<Integer> similarSeriesIds;
+	
+	@NotNull
+	public Integer getSimilarSeriesId() {
+		if (similarSeriesId != null) {
+			return similarSeriesId;
+		}
+		
+		if (similarSeriesIds != null && !similarSeriesIds.isEmpty()) {
+			return similarSeriesIds.iterator().next();
+		}
+		
+		return null;
+	}
+	
+	// @todo #1448 AddSimilarSeriesForm: add integration test that similarSeriesIds isn't empty
+	@NotEmpty
+	public Set<Integer> getSimilarSeriesIds() {
+		// respect the old interface to not break compatibility
+		if (similarSeriesId != null) {
+			return Collections.singleton(similarSeriesId);
+		}
+		
+		return similarSeriesIds;
+	}
+	
 }

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

@@ -626,9 +626,9 @@ public ResponseEntity<Void> markSimilarSeries(
 
 		} catch (RuntimeException ex) { // NOPMD: AvoidCatchingGenericException; try to catch-all
 			LOG.error(
-				"Couldn't mark series #{} similar to #{}: {}",
+				"Couldn't mark series #{} similar to {}: {}",
 				form.getSeriesId(),
-				form.getSimilarSeriesId(),
+				form.getSimilarSeriesIds(),
 				ex.getMessage()
 			);
 			return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);

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

@@ -428,12 +428,14 @@ public void markAsSimilar(AddSimilarSeriesForm dto) {
 		Integer seriesId = dto.getSeriesId();
 		Validate.isTrue(seriesId != null, "Series id must be non null");
 
-		Integer similarSeriesId = dto.getSimilarSeriesId();
-		Validate.isTrue(similarSeriesId != null, "Similar series id must be non null");
-		
-		seriesDao.markAsSimilar(seriesId, similarSeriesId);
-		
-		log.info("Series #{} has been marked as similar to #{}", seriesId, similarSeriesId);
+		Set<Integer> similarSeriesIds = dto.getSimilarSeriesIds();
+		Validate.isTrue(similarSeriesIds != null, "Similar series ids must be non null");
+
+		// @todo #1448 SeriesServiceImpl.markAsSimilar(): mark multiple series at once in DAO
+		for (Integer similarSeriesId : similarSeriesIds) {
+			seriesDao.markAsSimilar(seriesId, similarSeriesId);
+			log.info("Series #{} has been marked as similar to #{}", seriesId, similarSeriesId);
+		}
 	}
 
 	private List<SeriesInfoDto> findByCatalogNumber(

src/main/java/ru/mystamps/web/feature/site/ResourceUrl.java

@@ -32,7 +32,7 @@ public final class ResourceUrl {
 	public static final String STATIC_RESOURCES_URL = "https://stamps.filezz.ru";
 
 	// MUST be updated when any of our resources were modified
-	public static final String RESOURCES_VERSION = "v0.4.4.0";
+	public static final String RESOURCES_VERSION = "v0.4.4.1";
 
 	// CheckStyle: ignore LineLength for next 15 lines
 	private static final String CATALOG_UTILS_JS      = "/public/js/" + RESOURCES_VERSION + "/CatalogUtils.min.js";

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

@@ -169,7 +169,7 @@ t_sold_for = for
 t_not_chosen_masculine = Not chosen
 t_imported_from = Imported from
 t_similar_series = Similar series
-t_similar_series_id = Similar series ID
+t_similar_series_ids = Similar series ID(s)
 t_mark_as_similar = Mark as similar
 t_could_not_import_info = Could not import information from this page
 

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

@@ -168,7 +168,7 @@ t_sold_for = за
 t_not_chosen_masculine = Не выбран
 t_imported_from = Импортировано с
 t_similar_series = Похожие серии
-t_similar_series_id = ID серии
+t_similar_series_ids = ID серии(й)
 t_mark_as_similar = Отметить как похожую
 t_could_not_import_info = Не удалось импортировать информацию с этой страницы
 

src/main/webapp/WEB-INF/views/series/info.html

@@ -1140,6 +1140,7 @@ <h5 th:text="#{t_add_info_who_selling_series}">Add info about selling/buying thi
 		<!--/*/
 		<th:block sec:authorize="hasAuthority('MARK_SIMILAR_SERIES')">
 		/*/-->
+		<script src="../../../../javascript/CatalogUtils.js" th:src="${CATALOG_UTILS_JS}"></script>
 		<script src="../../../../../../target/classes/js/components/SimilarSeriesForm.js" th:src="${SIMILAR_SERIES_FORM_JS}"></script>
 		<script th:inline="javascript">
 			/*[+
@@ -1151,7 +1152,7 @@ <h5 th:text="#{t_add_info_who_selling_series}">Add info about selling/buying thi
 				'l10n': {
 					't_server_error':      [[ #{t_server_error} ]],
 					't_mark_as_similar':   [[ #{t_mark_as_similar} ]],
-					't_similar_series_id': [[ #{t_similar_series_id} ]],
+					't_similar_series_ids': [[ #{t_similar_series_ids} ]],
 				}
 			};
 			+]*/