task: implement extraction of MNH/MVLH conditions for a series sale import and creation.

Part of #1326

Author: php-coder

src/main/frontend/src/components/SeriesSaleImportForm.js

@@ -81,6 +81,10 @@ class SeriesSaleImportForm extends React.Component {
 				document.getElementById('seller').value = data.sellerId;
 			}
 
+			if (data.condition) {
+				document.getElementById('condition').value = data.condition;
+			}
+			
 			this.setState({ isDisabled: false, url: '' });
 
 		}).catch(error => {

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

@@ -22,6 +22,7 @@
 import org.springframework.format.annotation.NumberFormat;
 import ru.mystamps.web.common.Currency;
 import ru.mystamps.web.feature.series.sale.AddSeriesSalesDto;
+import ru.mystamps.web.feature.series.sale.SeriesCondition;
 
 import javax.validation.constraints.NotNull;
 import java.math.BigDecimal;
@@ -64,4 +65,9 @@ public Integer getBuyerId() {
 		return null;
 	}
 
+	@Override
+	public SeriesCondition getCondition() {
+		return null;
+	}
+	
 }

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

@@ -36,4 +36,5 @@ public class RawParsedDataDto {
 	private final String currency;
 	private final String altPrice;
 	private final String altCurrency;
+	private final String condition;
 }

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

@@ -19,6 +19,7 @@
 
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
+import ru.mystamps.web.feature.series.sale.SeriesCondition;
 
 import java.math.BigDecimal;
 import java.util.List;
@@ -44,4 +45,5 @@ public class SeriesExtractedInfo {
 	private final String currency;
 	private final BigDecimal altPrice;
 	private final String altCurrency;
+	private final SeriesCondition condition;
 }

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

@@ -28,6 +28,7 @@
 import ru.mystamps.web.feature.country.CountryValidation;
 import ru.mystamps.web.feature.participant.ParticipantService;
 import ru.mystamps.web.feature.series.SeriesValidation;
+import ru.mystamps.web.feature.series.sale.SeriesCondition;
 
 import java.math.BigDecimal;
 import java.net.MalformedURLException;
@@ -116,6 +117,7 @@ public SeriesExtractedInfo extract(String pageUrl, RawParsedDataDto data) {
 		String currency = extractCurrency(data.getCurrency());
 		BigDecimal altPrice = extractPrice(data.getAltPrice());
 		String altCurrency = extractCurrency(data.getAltCurrency());
+		SeriesCondition condition = extractCondition(data.getCondition());
 
 		return new SeriesExtractedInfo(
 			categoryIds,
@@ -133,7 +135,8 @@ public SeriesExtractedInfo extract(String pageUrl, RawParsedDataDto data) {
 			price,
 			currency,
 			altPrice,
-			altCurrency
+			altCurrency,
+			condition
 		);
 	}
 
@@ -494,6 +497,33 @@ public SeriesExtractedInfo extract(String pageUrl, RawParsedDataDto data) {
 		return null;
 	}
 
+	// @todo #1326 SeriesInfoExtractorServiceImpl.extractCondition(): add unit tests
+	@SuppressWarnings({
+		"checkstyle:missingswitchdefault",
+		"PMD.TooFewBranchesForASwitchStatement",
+		"PMD.SwitchStmtsShouldHaveDefault"
+	})
+	/* default */ SeriesCondition extractCondition(String fragment) {
+		if (StringUtils.isBlank(fragment)) {
+			return null;
+		}
+		
+		String[] candidates = StringUtils.split(fragment, ' ');
+		for (String candidate : candidates) {
+			switch(candidate) {
+				case "MNH":
+				case "MVLH":
+					SeriesCondition condition = SeriesCondition.valueOf(candidate);
+					log.debug("Condition is {}", condition);
+					return condition;
+			}
+		}
+		
+		log.debug("Could not extract condition from a fragment");
+		
+		return null;
+	}
+	
 	private Integer extractSellerByNameAndUrl(String name, String url) {
 		log.debug("Determine seller by name '{}' and url '{}'", name, url);
 

src/main/java/ru/mystamps/web/feature/series/importing/event/DownloadingSucceededEventListener.java

@@ -98,7 +98,8 @@ public void onApplicationEvent(DownloadingSucceeded event) {
 			info.getPrice(),
 			info.getCurrency(),
 			info.getAltPrice(),
-			info.getAltCurrency()
+			info.getAltCurrency(),
+			info.getCondition()
 		);
 
 		SeriesExtractedInfo seriesInfo = extractorService.extract(event.getUrl(), data);

src/main/java/ru/mystamps/web/feature/series/importing/extractor/JsoupSiteParser.java

@@ -107,6 +107,7 @@ public SeriesInfo parse(String htmlPage) {
 		info.setCurrency(extractCurrency(body));
 		info.setAltPrice(extractAltPrice(body));
 		info.setAltCurrency(extractAltCurrency(body));
+		info.setCondition(extractCondition(body));
 
 		return info;
 	}
@@ -271,6 +272,17 @@ protected String extractAltCurrency(Element body) {
 		return currency;
 	}
 
+	// @todo #1326 JsoupSiteParser.extractCondition(): add unit tests
+	protected String extractCondition(Element body) {
+		String description = getTextOfTheFirstElement(body, shortDescriptionLocator);
+		if (description == null) {
+			return null;
+		}
+		
+		LOG.debug("Extracted condition: '{}'", description);
+		return description;
+	}
+	
 	private static Element getFirstElement(Element body, String locator) {
 		if (locator == null) {
 			return null;

src/main/java/ru/mystamps/web/feature/series/importing/extractor/SeriesInfo.java

@@ -43,6 +43,7 @@ public class SeriesInfo {
 	private String currency;
 	private String altPrice;
 	private String altCurrency;
+	private String condition;
 
 	/**
 	 * Check whether any info about a series is available.

src/main/java/ru/mystamps/web/feature/series/importing/sale/SeriesSaleExtractedInfo.java

@@ -19,6 +19,7 @@
 
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
+import ru.mystamps.web.feature.series.sale.SeriesCondition;
 
 import java.math.BigDecimal;
 
@@ -30,4 +31,5 @@ public class SeriesSaleExtractedInfo {
 	private final String currency;
 	private final BigDecimal altPrice;
 	private final String altCurrency;
+	private final SeriesCondition condition;
 }

src/main/java/ru/mystamps/web/feature/series/importing/sale/SeriesSalesImportServiceImpl.java

@@ -77,7 +77,8 @@ public SeriesSaleExtractedInfo downloadAndParse(String url) {
 			info.getPrice(),
 			info.getCurrency(),
 			info.getAltPrice(),
-			info.getAltCurrency()
+			info.getAltCurrency(),
+			info.getCondition()
 		);
 
 		// CheckStyle: ignore LineLength for next 1 line
@@ -89,7 +90,8 @@ public SeriesSaleExtractedInfo downloadAndParse(String url) {
 			seriesInfo.getPrice(),
 			seriesInfo.getCurrency(),
 			seriesInfo.getAltPrice(),
-			seriesInfo.getAltCurrency()
+			seriesInfo.getAltCurrency(),
+			seriesInfo.getCondition()
 		);
 	}
 

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

@@ -35,6 +35,7 @@ public class AddSeriesSalesDbDto {
 	private BigDecimal altPrice;
 	private String altCurrency;
 	private Integer buyerId;
+	private String condition;
 	private Date createdAt;
 	private Integer createdBy;
 }

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

@@ -32,4 +32,5 @@ public interface AddSeriesSalesDto {
 	BigDecimal getAltPrice();
 	Currency getAltCurrency();
 	Integer getBuyerId();
+	SeriesCondition getCondition();
 }

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

@@ -70,6 +70,9 @@ public class AddSeriesSalesForm implements AddSeriesSalesDto {
 
 	private Integer buyerId;
 
+	// @todo #1326 Series sale import: add integration test for series condition
+	private SeriesCondition condition;
+	
 	@GroupSequence({
 		Group.Level1.class,
 		Group.Level2.class,

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

@@ -45,6 +45,7 @@ public void add(AddSeriesSalesDbDto sale) {
 		params.put("alt_price", sale.getAltPrice());
 		params.put("alt_currency", sale.getAltCurrency());
 		params.put("buyer_id", sale.getBuyerId());
+		params.put("condition", sale.getCondition());
 		params.put("created_at", sale.getCreatedAt());
 		params.put("created_by", sale.getCreatedBy());
 

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

@@ -0,0 +1,25 @@
+/*
+ * Copyright (C) 2009-2020 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.feature.series.sale;
+
+public enum SeriesCondition {
+	MNH,
+	MVLH,
+	CANCELLED;
+}

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

@@ -54,6 +54,9 @@ public void add(AddSeriesSalesDto dto, Integer seriesId, Integer userId) {
 			sale.setAltCurrency(dto.getAltCurrency().toString());
 		}
 		sale.setBuyerId(dto.getBuyerId());
+		if (dto.getCondition() != null) {
+			sale.setCondition(dto.getCondition().toString());
+		}
 
 		Date now = new Date();
 		sale.setCreatedAt(now);

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.3.4";
+	public static final String RESOURCES_VERSION = "v0.4.3.5";
 
 	// 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

@@ -155,6 +155,8 @@ t_today = Today
 t_seller = Seller
 t_add_new_seller = Add a new seller
 t_price = Price
+t_condition = Condition
+t_cancelled = Cancelled
 t_alternative_price = Alternative price
 t_buyer = Buyer
 t_add_new_buyer = Add a new buyer

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

@@ -154,6 +154,8 @@ t_today = Сегодня
 t_seller = Продавец
 t_add_new_seller = Добавить нового продавца
 t_price = Цена
+t_condition = Состояние
+t_cancelled = Гашеная
 t_alternative_price = Альтернативная цена
 t_buyer = Покупатель
 t_add_new_buyer = Добавить нового покупателя

src/main/resources/sql/series_sales_dao_queries.properties

@@ -10,6 +10,7 @@ INSERT \
      , second_price \
      , second_currency \
      , buyer_id \
+     , condition \
      , created_at \
      , created_by \
      ) \
@@ -23,6 +24,7 @@ VALUES \
      , :alt_price \
      , :alt_currency \
      , :buyer_id \
+     , :condition \
      , :created_at \
      , :created_by \
      )

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

@@ -756,6 +756,23 @@ <h5 th:text="#{t_add_info_who_selling_series}">Add info about selling/buying thi
 											</div>
 										</div>
 
+										<div class="form-group form-group-sm" th:classappend="${#fields.hasErrors('condition') ? 'has-error' : ''}">
+											<label for="condition" class="control-label col-sm-3" th:text="#{t_condition}">
+												Condition
+											</label>
+											<div class="col-sm-3">
+												<select id="condition" class="form-control" th:field="*{condition}">
+													<option value=""></option>
+													<option value="MNH">MNH</option>
+													<option value="MVLH">MVLH</option>
+													<option value="CANCELLED" th:text="#{t_cancelled}">Сancelled</option>
+												</select>
+												<!--/*/
+												<span id="condition.errors" class="help-block" th:if="${#fields.hasErrors('condition')}" th:each="error : ${#fields.errors('condition')}" th:text="${error}"></span>
+												/*/-->
+											</div>
+										</div>
+										
 										<div class="form-group form-group-sm" th:classappend="${#fields.hasErrors('buyerId') ? 'has-error' : ''}">
 											<label for="buyer" class="control-label col-sm-3" th:text="#{t_buyer}">
 												Buyer

src/test/groovy/ru/mystamps/web/feature/series/sale/SeriesSalesServiceImplTest.groovy

@@ -17,9 +17,12 @@
  */
 package ru.mystamps.web.feature.series.sale
 
+import static io.qala.datagen.RandomShortApi.nullOr
+
 import org.slf4j.helpers.NOPLogger
 import ru.mystamps.web.common.Currency
 import ru.mystamps.web.tests.DateUtils
+import ru.mystamps.web.tests.Random
 import spock.lang.Specification
 import spock.lang.Unroll
 
@@ -108,6 +111,10 @@ class SeriesSalesServiceImplTest extends Specification {
 		Integer buyerId) {
 
 		given:
+			Integer expectedSeriesId = 777
+			Integer expectedUserId = 888
+			SeriesCondition expectedCondition = nullOr(Random.seriesCondition())
+		and:
 			// mandatory fields
 			form.setSellerId(444)
 			form.setPrice(new BigDecimal('100'))
@@ -118,9 +125,7 @@ class SeriesSalesServiceImplTest extends Specification {
 			form.setAltPrice(altPrice)
 			form.setAltCurrency(altCurrency)
 			form.setBuyerId(buyerId)
-		and:
-			Integer expectedSeriesId = 777
-			Integer expectedUserId = 888
+			form.setCondition(expectedCondition)
 		when:
 			service.add(form, expectedSeriesId, expectedUserId)
 		then:
@@ -133,6 +138,7 @@ class SeriesSalesServiceImplTest extends Specification {
 				assert dto?.altPrice    == form.altPrice
 				assert dto?.altCurrency == form.altCurrency?.toString()
 				assert dto?.buyerId     == form.buyerId
+				assert dto?.condition   == form.condition
 				assert dto?.createdBy   == expectedUserId
 				assert dto?.seriesId    == expectedSeriesId
 				assert DateUtils.roughlyEqual(dto?.createdAt, new Date())

src/test/java/ru/mystamps/web/service/TestObjects.java

@@ -273,7 +273,8 @@ public static RawParsedDataDto createRawParsedDataDto() {
 			Random.currency().toString(),
 			String.valueOf(Random.price()),
 			// FIXME: alternative currency shouldn't match with currency
-			Random.currency().toString()
+			Random.currency().toString(),
+			Random.seriesCondition().toString()
 		);
 	}
 
@@ -353,7 +354,8 @@ public static SeriesExtractedInfo createSeriesExtractedInfo() {
 			Random.currency().toString(),
 			Random.price(),
 			// FIXME: alternative currency shouldn't match with currency
-			Random.currency().toString()
+			Random.currency().toString(),
+			Random.seriesCondition()
 		);
 	}
 
@@ -374,6 +376,7 @@ public static SeriesExtractedInfo createEmptySeriesExtractedInfo() {
 			null,
 			null,
 			null,
+			null,
 			null
 		);
 	}