feat: show similar series on a page with series info.

Fix #967

Author: php-coder

NEWS.txt

@@ -25,6 +25,7 @@
 - (infrastructure) use WireMock in integration tests for mocking external services
 - (functionality)  suggest a possible country on a series creation page (contributed by John Shkarin)
 - (functionality)  suggest a possible category on a series creation page
+- (functionality)  show similar series on a page with series info
 
 0.3
 - (functionality)  implemented possibility to user to add series to his collection

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

@@ -57,6 +57,9 @@ public class JdbcSeriesDao implements SeriesDao {
 	@Value("${series.find_all_for_sitemap}")
 	private String findAllForSitemapSql;
 
+	@Value("${series.find_similar_series}")
+	private String findSimilarSeriesSql;
+	
 	@Value("${series.find_last_added}")
 	private String findLastAddedSeriesSql;
 
@@ -163,6 +166,15 @@ public List<SitemapInfoDto> findAllForSitemap() {
 		);
 	}
 
+	@Override
+	public List<SeriesLinkDto> findSimilarSeries(Integer seriesId, String lang) {
+		Map<String, Object> params = new HashMap<>();
+		params.put("id", seriesId);
+		params.put("lang", lang);
+		
+		return jdbcTemplate.query(findSimilarSeriesSql, params, RowMappers::forSeriesLinkDto);
+	}
+	
 	@Override
 	public List<SeriesLinkDto> findLastAdded(int quantity, String lang) {
 		Map<String, Object> params = new HashMap<>();

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

@@ -249,7 +249,7 @@ public String showInfo(
 			return null;
 		}
 
-		Map<String, ?> commonAttrs = prepareCommonAttrsForSeriesInfo(series, currentUserId);
+		Map<String, ?> commonAttrs = prepareCommonAttrsForSeriesInfo(series, currentUserId, lang);
 		model.addAllAttributes(commonAttrs);
 
 		addSeriesSalesFormToModel(model);
@@ -323,7 +323,8 @@ public String processImage(
 		model.addAttribute("maxQuantityOfImagesExceeded", maxQuantityOfImagesExceeded);
 
 		if (result.hasErrors() || maxQuantityOfImagesExceeded) {
-			Map<String, ?> commonAttrs = prepareCommonAttrsForSeriesInfo(series, currentUserId);
+			Map<String, ?> commonAttrs =
+				prepareCommonAttrsForSeriesInfo(series, currentUserId, lang);
 			model.addAllAttributes(commonAttrs);
 
 			addSeriesSalesFormToModel(model);
@@ -382,7 +383,7 @@ public String addToCollection(
 				return null;
 			}
 
-			Map<String, ?> commonAttrs = prepareCommonAttrsForSeriesInfo(series, userId);
+			Map<String, ?> commonAttrs = prepareCommonAttrsForSeriesInfo(series, userId, lang);
 			model.addAllAttributes(commonAttrs);
 
 			addSeriesSalesFormToModel(model);
@@ -456,7 +457,8 @@ public String processAskForm(
 		model.addAttribute("maxQuantityOfImagesExceeded", maxQuantityOfImagesExceeded);
 
 		if (result.hasErrors() || maxQuantityOfImagesExceeded) {
-			Map<String, ?> commonAttrs = prepareCommonAttrsForSeriesInfo(series, currentUserId);
+			Map<String, ?> commonAttrs =
+				prepareCommonAttrsForSeriesInfo(series, currentUserId, lang);
 			model.addAllAttributes(commonAttrs);
 
 			addSeriesSalesFormToModel(model);
@@ -587,13 +589,19 @@ public static void loadErrorsFromDownloadInterceptor(
 		request.removeAttribute(DownloadImageInterceptor.ERROR_CODE_ATTR_NAME);
 	}
 
-	// CheckStyle: ignore LineLength for next 1 line
-	private Map<String, ?> prepareCommonAttrsForSeriesInfo(SeriesDto series, Integer currentUserId) {
+	private Map<String, ?> prepareCommonAttrsForSeriesInfo(
+		SeriesDto series,
+		Integer currentUserId,
+		String lang) {
+		
 		Map<String, Object> model = new HashMap<>();
 		Integer seriesId = series.getId();
 
 		model.put("series", series);
 
+		List<SeriesLinkDto> similarSeries = seriesService.findSimilarSeries(seriesId, lang);
+		model.put("similarSeries", similarSeries);
+		
 		String michelNumbers   = CatalogUtils.toShortForm(series.getMichel().getNumbers());
 		String scottNumbers    = CatalogUtils.toShortForm(series.getScott().getNumbers());
 		String yvertNumbers    = CatalogUtils.toShortForm(series.getYvert().getNumbers());

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

@@ -26,6 +26,7 @@ public interface SeriesDao {
 	Integer add(AddSeriesDbDto series);
 	void markAsModified(Integer seriesId, Date updateAt, Integer updatedBy);
 	List<SitemapInfoDto> findAllForSitemap();
+	List<SeriesLinkDto> findSimilarSeries(Integer seriesId, String lang);
 	List<SeriesLinkDto> findLastAdded(int quantity, String lang);
 	SeriesFullInfoDto findByIdAsSeriesFullInfo(Integer seriesId, String lang);
 	List<SeriesInfoDto> findByIdsAsSeriesInfo(List<Integer> seriesIds, String lang);

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

@@ -44,6 +44,7 @@ public interface SeriesService {
 	List<SeriesInfoDto> findByCategorySlug(String slug, String lang);
 	List<SeriesInfoDto> findByCountrySlug(String slug, String lang);
 	List<SeriesLinkDto> findRecentlyAdded(int quantity, String lang);
+	List<SeriesLinkDto> findSimilarSeries(Integer seriesId, String lang);
 	List<SitemapInfoDto> findAllForSitemap();
 
 	List<PurchaseAndSaleDto> findPurchasesAndSales(Integer seriesId);

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

@@ -292,6 +292,15 @@ public List<SeriesLinkDto> findRecentlyAdded(int quantity, String lang) {
 		return seriesDao.findLastAdded(quantity, lang);
 	}
 
+	// @todo #967 SeriesServiceImpl.findSimilarSeries(): add unit tests
+	@Override
+	@Transactional(readOnly = true)
+	public List<SeriesLinkDto> findSimilarSeries(Integer seriesId, String lang) {
+		Validate.isTrue(seriesId != null, "Series id must be non null");
+		
+		return seriesDao.findSimilarSeries(seriesId, lang);
+	}
+	
 	@Override
 	@Transactional(readOnly = true)
 	public List<SitemapInfoDto> findAllForSitemap() {

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

@@ -163,6 +163,7 @@ t_sold_to = sold to
 t_sold_for = for
 t_not_chosen_masculine = Not chosen
 t_imported_from = Imported from
+t_similar_series = Similar series
 
 # category/add.html
 

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

@@ -162,6 +162,7 @@ t_sold_to = продал
 t_sold_for = за
 t_not_chosen_masculine = Не выбран
 t_imported_from = Импортировано с
+t_similar_series = Похожие серии
 
 # category/add.html
 

src/main/resources/sql/series_dao_queries.properties

@@ -51,6 +51,19 @@ series.find_all_for_sitemap = \
 SELECT s.id, s.updated_at \
   FROM series s
 
+series.find_similar_series = \
+   SELECT CASE WHEN ss.similar_series_id != :id THEN ss.similar_series_id ELSE ss.series_id END AS id \
+        , s.release_year \
+        , s.quantity \
+        , s.perforated \
+        , CASE WHEN 'ru' = :lang THEN COALESCE(count.name_ru, count.name) ELSE count.name END AS country_name \
+     FROM similar_series ss \
+     JOIN series s \
+       ON s.id = ss.series_id OR s.id = ss.similar_series_id \
+LEFT JOIN countries count \
+       ON count.id = s.country_id \
+    WHERE s.id = :id
+
 series.find_last_added = \
    SELECT s.id \
         , s.release_year \

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

@@ -338,13 +338,13 @@
 									</dl>
 								</div>
 							</div>
-							<!--/*-->
-							<div class="row">
+							<div class="row" th:if="${not #lists.isEmpty(similarSeries)}">
+								<!--/* @todo #967 Add integration tests for showing similar series */-->
 								<div class="col-sm-10 col-sm-offset-2">
 									<h5 class="text-center" th:text="#{t_similar_series}">
 										Similar series
 									</h5>
-									<ul>
+									<ul th:remove="all-but-first">
 										<li th:each="series : ${similarSeries}">
 											<a href="../series/info.html" th:href="@{${INFO_SERIES_PAGE}(id=${series.id})}">
 												<span th:remove="tag" th:if="${series.country != null}" th:text="|${series.country}, |">Italy, </span>
@@ -358,7 +358,6 @@ <h5 class="text-center" th:text="#{t_similar_series}">
 									</ul>
 								</div>
 							</div>
-							<!--*/-->
 						</div>
 
 						<div class="col-sm-4">