/collection/{slug}/estimation: add a page with prices of the series in a collection.

Fix #884

Author: php-coder

src/main/java/ru/mystamps/web/Url.java

@@ -67,7 +67,8 @@ public final class Url {
 	public static final String GET_COUNTRIES_PAGE    = "/countries";
 	public static final String INFO_COUNTRY_PAGE     = "/country/{slug}";
 
-	public static final String INFO_COLLECTION_PAGE  = "/collection/{slug}";
+	public static final String INFO_COLLECTION_PAGE       = "/collection/{slug}";
+	public static final String ESTIMATION_COLLECTION_PAGE = "/collection/{slug}/estimation";
 
 	public static final String GET_IMAGE_PAGE         = "/image/{id}";
 	public static final String GET_IMAGE_PREVIEW_PAGE = "/image/preview/{id}";
@@ -145,6 +146,7 @@ public static Map<String, String> asMap(boolean production) {
 		map.put("AUTHENTICATION_PAGE", AUTHENTICATION_PAGE);
 		map.put("BOOTSTRAP_LANGUAGE", BOOTSTRAP_LANGUAGE);
 		map.put("DAILY_STATISTICS", DAILY_STATISTICS);
+		map.put("ESTIMATION_COLLECTION_PAGE", ESTIMATION_COLLECTION_PAGE);
 		map.put("GET_CATEGORIES_PAGE", GET_CATEGORIES_PAGE);
 		map.put("GET_COUNTRIES_PAGE", GET_COUNTRIES_PAGE);
 		map.put("INFO_CATEGORY_PAGE", INFO_CATEGORY_PAGE);

src/main/java/ru/mystamps/web/controller/CollectionController.java

@@ -37,6 +37,7 @@
 import ru.mystamps.web.Url;
 import ru.mystamps.web.dao.dto.CollectionInfoDto;
 import ru.mystamps.web.dao.dto.SeriesInCollectionDto;
+import ru.mystamps.web.dao.dto.SeriesInCollectionWithPriceDto;
 import ru.mystamps.web.service.CategoryService;
 import ru.mystamps.web.service.CollectionService;
 import ru.mystamps.web.service.CountryService;
@@ -53,6 +54,7 @@ public class CollectionController {
 	private final SeriesService seriesService;
 	private final MessageSource messageSource;
 
+	// @todo #884 /collection/{slug}: add a link to collection estimation page
 	@GetMapping(Url.INFO_COLLECTION_PAGE)
 	public String showInfoBySlug(
 		@PathVariable("slug") String slug,
@@ -101,6 +103,38 @@ public String showInfoBySlug(
 
 		return "collection/info";
 	}
+	
+	// @todo #884 Add integration tests for collection estimation page
+	@GetMapping(Url.ESTIMATION_COLLECTION_PAGE)
+	public String showPrices(
+		@PathVariable("slug") String slug,
+		Model model,
+		Locale userLocale,
+		HttpServletResponse response)
+		throws IOException {
+		
+		if (slug == null) {
+			response.sendError(HttpServletResponse.SC_NOT_FOUND);
+			return null;
+		}
+		
+		// TODO: we need only ownerName, without id and slug
+		CollectionInfoDto collection = collectionService.findBySlug(slug);
+		if (collection == null) {
+			response.sendError(HttpServletResponse.SC_NOT_FOUND);
+			return null;
+		}
+		
+		String owner = collection.getOwnerName();
+		model.addAttribute("ownerName", owner);
+		
+		String lang = LocaleUtils.getLanguageOrNull(userLocale);
+		List<SeriesInCollectionWithPriceDto> seriesOfCollection =
+			collectionService.findSeriesWithPricesBySlug(slug, lang);
+		model.addAttribute("seriesOfCollection", seriesOfCollection);
+		
+		return "collection/estimation";
+	}
 
 	@GetMapping(Url.INFO_COLLECTION_BY_ID_PAGE)
 	public View showInfoById(

src/main/java/ru/mystamps/web/controller/dto/AddToCollectionForm.java

@@ -35,7 +35,6 @@
 // @todo #477 Add to collection: series quantity should be specified by default
 // @todo #477 Add to collection: add integration test for custom number of stamps
 // @todo #663 Add to collection: add integration test for specifying a price
-// @todo #663 Add a page with a list of series, their prices and total cost
 @Getter
 @Setter
 @MaxNumberOfStamps

src/main/java/ru/mystamps/web/dao/CollectionDao.java

@@ -24,9 +24,11 @@
 import ru.mystamps.web.dao.dto.AddToCollectionDbDto;
 import ru.mystamps.web.dao.dto.CollectionInfoDto;
 import ru.mystamps.web.dao.dto.LinkEntityDto;
+import ru.mystamps.web.dao.dto.SeriesInCollectionWithPriceDto;
 
 public interface CollectionDao {
 	List<LinkEntityDto> findLastCreated(int quantity);
+	List<SeriesInCollectionWithPriceDto> findSeriesWithPricesBySlug(String slug, String lang);
 	long countCollectionsOfUsers();
 	long countUpdatedSince(Date date);
 	Integer add(AddCollectionDbDto collection);

src/main/java/ru/mystamps/web/dao/dto/SeriesInCollectionWithPriceDto.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright (C) 2009-2018 Slava Semushin <slava.semushin@gmail.com>
+ *
+ * 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.dao.dto;
+
+import java.math.BigDecimal;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@Getter
+@RequiredArgsConstructor
+public class SeriesInCollectionWithPriceDto {
+	private final Integer id;
+	private final Integer releaseYear;
+	private final Integer quantity;
+	private final Integer numberOfStamps;
+	private final Boolean perforated;
+	private final String countryName;
+	private final BigDecimal price;
+	private final Currency currency;
+}

src/main/java/ru/mystamps/web/dao/impl/JdbcCollectionDao.java

@@ -42,6 +42,7 @@
 import ru.mystamps.web.dao.dto.AddToCollectionDbDto;
 import ru.mystamps.web.dao.dto.CollectionInfoDto;
 import ru.mystamps.web.dao.dto.LinkEntityDto;
+import ru.mystamps.web.dao.dto.SeriesInCollectionWithPriceDto;
 
 @RequiredArgsConstructor
 @SuppressWarnings("PMD.AvoidDuplicateLiterals")
@@ -53,6 +54,9 @@ public class JdbcCollectionDao implements CollectionDao {
 	@Value("${collection.find_last_created}")
 	private String findLastCreatedCollectionsSql;
 
+	@Value("${collection.find_series_with_prices_by_slug}")
+	private String findSeriesWithPricesBySlugSql;
+	
 	@Value("${collection.count_collections_of_users}")
 	private String countCollectionsOfUsersSql;
 
@@ -86,6 +90,22 @@ public List<LinkEntityDto> findLastCreated(int quantity) {
 		);
 	}
 
+	@Override
+	public List<SeriesInCollectionWithPriceDto> findSeriesWithPricesBySlug(
+		String slug,
+		String lang) {
+		
+		Map<String, Object> params = new HashMap<>();
+		params.put("slug", slug);
+		params.put("lang", lang);
+		
+		return jdbcTemplate.query(
+			findSeriesWithPricesBySlugSql,
+			params,
+			RowMappers::forSeriesInCollectionWithPriceDto
+		);
+	}
+	
 	@Override
 	public long countCollectionsOfUsers() {
 		return jdbcTemplate.queryForObject(

src/main/java/ru/mystamps/web/dao/impl/RowMappers.java

@@ -109,6 +109,32 @@ public static SeriesInCollectionDto forSeriesInCollectionDto(ResultSet rs, int u
 		);
 	}
 
+	public static SeriesInCollectionWithPriceDto forSeriesInCollectionWithPriceDto(
+		ResultSet rs,
+		int unused)
+		throws SQLException {
+
+		Integer id             = rs.getInt("id");
+		Integer releaseYear    = JdbcUtils.getInteger(rs, "release_year");
+		Integer quantity       = rs.getInt("quantity");
+		Boolean perforated     = rs.getBoolean("perforated");
+		Integer numberOfStamps = rs.getInt("number_of_stamps");
+		String country         = rs.getString("country_name");
+		BigDecimal price       = rs.getBigDecimal("price");
+		Currency currency      = JdbcUtils.getCurrency(rs, "currency");
+		
+		return new SeriesInCollectionWithPriceDto(
+			id,
+			releaseYear,
+			quantity,
+			numberOfStamps,
+			perforated,
+			country,
+			price,
+			currency
+		);
+	}
+	
 	/**
 	 * @author Sergey Chechenev
 	 */

src/main/java/ru/mystamps/web/service/CollectionService.java

@@ -22,6 +22,7 @@
 
 import ru.mystamps.web.dao.dto.CollectionInfoDto;
 import ru.mystamps.web.dao.dto.LinkEntityDto;
+import ru.mystamps.web.dao.dto.SeriesInCollectionWithPriceDto;
 import ru.mystamps.web.service.dto.AddToCollectionDto;
 
 public interface CollectionService {
@@ -32,5 +33,6 @@ public interface CollectionService {
 	long countCollectionsOfUsers();
 	long countUpdatedSince(Date date);
 	List<LinkEntityDto> findRecentlyCreated(int quantity);
+	List<SeriesInCollectionWithPriceDto> findSeriesWithPricesBySlug(String slug, String lang);
 	CollectionInfoDto findBySlug(String slug);
 }

src/main/java/ru/mystamps/web/service/CollectionServiceImpl.java

@@ -36,6 +36,7 @@
 import ru.mystamps.web.dao.dto.AddToCollectionDbDto;
 import ru.mystamps.web.dao.dto.CollectionInfoDto;
 import ru.mystamps.web.dao.dto.LinkEntityDto;
+import ru.mystamps.web.dao.dto.SeriesInCollectionWithPriceDto;
 import ru.mystamps.web.service.dto.AddToCollectionDto;
 import ru.mystamps.web.support.spring.security.HasAuthority;
 import ru.mystamps.web.util.SlugUtils;
@@ -150,6 +151,20 @@ public List<LinkEntityDto> findRecentlyCreated(int quantity) {
 		return collectionDao.findLastCreated(quantity);
 	}
 
+	// @todo #884 CollectionService.findSeriesWithPricesBySlug(): add unit tests
+	// @todo #884 CollectionService.findSeriesWithPricesBySlug(): restrict access by only an owner
+	@Override
+	@Transactional(readOnly = true)
+	@PreAuthorize(HasAuthority.ADD_SERIES_PRICE)
+	public List<SeriesInCollectionWithPriceDto> findSeriesWithPricesBySlug(
+		String slug,
+		String lang) {
+		
+		Validate.isTrue(slug != null, "Collection slug must be non null");
+		
+		return collectionDao.findSeriesWithPricesBySlug(slug, lang);
+	}
+	
 	@Override
 	@Transactional(readOnly = true)
 	public CollectionInfoDto findBySlug(String slug) {

src/main/java/ru/mystamps/web/support/spring/security/HasAuthority.java

@@ -21,6 +21,7 @@
 public final class HasAuthority {
 	// Constants sorted in an ascending order.
 	public static final String ADD_PARTICIPANT = "hasAuthority('" + StringAuthority.ADD_PARTICIPANT + "')";
+	public static final String ADD_SERIES_PRICE = "hasAuthority('" + StringAuthority.ADD_SERIES_PRICE + "')";
 	public static final String ADD_SERIES_SALES = "hasAuthority('" + StringAuthority.ADD_SERIES_SALES + "')";
 	public static final String CREATE_CATEGORY = "hasAuthority('" + StringAuthority.CREATE_CATEGORY + "')";
 	public static final String CREATE_COUNTRY = "hasAuthority('" + StringAuthority.CREATE_COUNTRY + "')";

src/main/java/ru/mystamps/web/support/spring/security/SecurityConfig.java

@@ -89,6 +89,8 @@ protected void configure(HttpSecurity http) throws Exception {
 				.mvcMatchers(Url.SITE_EVENTS_PAGE).hasAuthority(StringAuthority.VIEW_SITE_EVENTS)
 				.mvcMatchers(Url.SUGGEST_SERIES_COUNTRY).hasAuthority(StringAuthority.CREATE_SERIES)
 				.mvcMatchers(Url.DAILY_STATISTICS).hasAuthority(StringAuthority.VIEW_DAILY_STATS)
+				// @todo #884 /collection/{slug}/estimation: only owner should have access to estimation page
+				.mvcMatchers(Url.ESTIMATION_COLLECTION_PAGE).hasAnyAuthority(StringAuthority.ADD_SERIES_PRICE)
 				.regexMatchers(HttpMethod.POST, "/series/[0-9]+")
 					.hasAnyAuthority(
 						StringAuthority.UPDATE_COLLECTION,

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

@@ -192,6 +192,11 @@ t_stamps_by_categories = Stamps by categories
 t_stamps_by_countries = Stamps by countries
 t_unspecified = Unspecified
 
+# collection/estimation.html
+t_series = Series
+t_you_paid = You paid
+t_total = Total
+
 # participant/add.html
 t_group = Group
 

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

@@ -191,6 +191,11 @@ t_stamps_by_categories = Марки по категориям
 t_stamps_by_countries = Марки по странам
 t_unspecified = Не указана
 
+# collection/estimation.html
+t_series = Серия
+t_you_paid = Вы заплатили
+t_total = Всего
+
 # participant/add.html
 t_group = Группа
 

src/main/resources/sql/collection_dao_queries.properties

@@ -10,6 +10,24 @@ collection.find_last_created = \
 ORDER BY c.id DESC \
    LIMIT :quantity
 
+collection.find_series_with_prices_by_slug = \
+   SELECT s.id \
+        , s.release_year \
+        , s.quantity \
+        , s.perforated \
+        , cs.number_of_stamps \
+        , cs.price \
+        , cs.currency \
+        , CASE WHEN 'ru' = :lang THEN COALESCE(count.name_ru, count.name) ELSE count.name END AS country_name \
+     FROM collections c \
+     JOIN collections_series cs \
+       ON cs.collection_id = c.id \
+     JOIN series s \
+       ON s.id = cs.series_id \
+LEFT JOIN countries count \
+       ON count.id = s.country_id \
+    WHERE c.slug = :slug
+
 collection.count_collections_of_users = \
    SELECT COUNT(DISTINCT c.id) \
      FROM collections c \