User can specify a price that he/she paid for a series.

Fix #663

Author: php-coder

NEWS.txt

@@ -21,6 +21,7 @@
 - (functionality)  add support for specifying Solovyov catalog numbers
 - (functionality)  add support for specifying Zagorski catalog numbers
 - (functionality)  user may specify how many stamps from a series in his/her collection
+- (functionality)  user may specify a price that he/she paid for a series
 
 0.3
 - (functionality)  implemented possibility to user to add series to his collection

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

@@ -17,19 +17,24 @@
  */
 package ru.mystamps.web.controller.dto;
 
+import java.math.BigDecimal;
+
 import javax.validation.constraints.Min;
 import javax.validation.constraints.NotNull;
 
 import lombok.Getter;
 import lombok.Setter;
 
+import ru.mystamps.web.dao.dto.Currency;
 import ru.mystamps.web.service.dto.AddToCollectionDto;
 
 import static ru.mystamps.web.validation.ValidationRules.MIN_STAMPS_IN_SERIES;
 
 // @todo #477 Add to collection: integration test for invisible quantity for a series with 1 stamp
 // @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
 public class AddToCollectionForm implements AddToCollectionDto {
@@ -39,4 +44,9 @@ public class AddToCollectionForm implements AddToCollectionDto {
 	@Min(MIN_STAMPS_IN_SERIES)
 	private Integer numberOfStamps;
 
+	// @todo #663 /series/{id}(price): must be greater than zero
+	private BigDecimal price;
+	
+	// @todo #663 /series/{id}(currency): must be required when price is specified
+	private Currency currency;
 }

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

@@ -17,6 +17,8 @@
  */
 package ru.mystamps.web.dao.dto;
 
+import java.math.BigDecimal;
+
 import lombok.Getter;
 import lombok.Setter;
 
@@ -26,4 +28,6 @@ public class AddToCollectionDbDto {
 	private Integer ownerId;
 	private Integer seriesId;
 	private Integer numberOfStamps;
+	private BigDecimal price;
+	private String currency;
 }

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

@@ -171,6 +171,8 @@ public void addSeriesToUserCollection(AddToCollectionDbDto dto) {
 		params.put("user_id", dto.getOwnerId());
 		params.put("series_id", dto.getSeriesId());
 		params.put("number_of_stamps", dto.getNumberOfStamps());
+		params.put("price", dto.getPrice());
+		params.put("currency", dto.getCurrency());
 
 		int affected = jdbcTemplate.update(addSeriesToCollectionSql, params);
 

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

@@ -82,11 +82,24 @@ public void addToCollection(Integer userId, Integer seriesId, AddToCollectionDto
 		collectionDto.setSeriesId(seriesId);
 		collectionDto.setNumberOfStamps(dto.getNumberOfStamps());
 
+		if (dto.getPrice() != null) {
+			Validate.validState(
+				dto.getCurrency() != null,
+				"Currency must be non null when price is specified"
+			);
+			collectionDto.setPrice(dto.getPrice());
+			collectionDto.setCurrency(dto.getCurrency().toString());
+		}
+		
 		collectionDao.addSeriesToUserCollection(collectionDto);
 		collectionDao.markAsModified(userId, new Date());
 
-		// TODO: it would be good to include number of stamps in series vs in collection
-		log.info("Series #{} has been added to collection of user #{}", seriesId, userId);
+		log.info(
+			"Series #{} ({}) has been added to collection of user #{}",
+			seriesId,
+			formatSeriesInfo(collectionDto),
+			userId
+		);
 	}
 
 	@Override
@@ -145,4 +158,21 @@ public CollectionInfoDto findBySlug(String slug) {
 		return collectionDao.findCollectionInfoBySlug(slug);
 	}
 
+	private static String formatSeriesInfo(AddToCollectionDbDto collectionDto) {
+		StringBuilder sb = new StringBuilder();
+
+		// TODO: it would be good to include number of stamps in series vs in collection
+		sb.append("stamps=")
+			.append(collectionDto.getNumberOfStamps());
+
+		if (collectionDto.getPrice() != null) {
+			sb.append(", price=")
+				.append(collectionDto.getPrice())
+				.append(' ')
+				.append(collectionDto.getCurrency());
+		}
+
+		return sb.toString();
+	}
+	
 }

src/main/java/ru/mystamps/web/service/dto/AddToCollectionDto.java

@@ -17,6 +17,12 @@
  */
 package ru.mystamps.web.service.dto;
 
+import java.math.BigDecimal;
+
+import ru.mystamps.web.dao.dto.Currency;
+
 public interface AddToCollectionDto {
 	Integer getNumberOfStamps();
+	BigDecimal getPrice();
+	Currency getCurrency();
 }

src/main/resources/liquibase/version/0.4.xml

@@ -50,5 +50,6 @@
 	<include file="0.4/2018-02-09--add_seller_info_to_parsed_data.xml" relativeToChangelogFile="true" />
 	<include file="0.4/2018-03-11--series_remove_currency_fields.xml" relativeToChangelogFile="true" />
 	<include file="0.4/2018-06-09--add_number_of_stamps_to_collections_series.xml" relativeToChangelogFile="true" />
+	<include file="0.4/2018-06-15--add_price_to_collections_series.xml" relativeToChangelogFile="true" />
 
 </databaseChangeLog>

src/main/resources/liquibase/version/0.4/2018-06-15--add_price_to_collections_series.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog
+		xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+		http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.1.xsd">
+	
+	<changeSet id="add-price-and-currency-fields-to-collections_series" author="php-coder" context="scheme">
+		
+		<addColumn tableName="collections_series">
+			<column name="price" type="DECIMAL(19,2)" />
+			<column name="currency" type="CHAR(3)" />
+		</addColumn>
+		
+	</changeSet>
+	
+</databaseChangeLog>

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

@@ -136,6 +136,7 @@ t_yes = Yes
 t_no = No
 t_series_not_in_collection = Series isn't part of your collection
 t_i_have = I have
+t_i_bought_for = I bought for
 t_out_of_n_stamps = out of {0} stamps
 t_series_in_collection = Series is part of your collection
 t_add_to_collection = Add to collection

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

@@ -135,6 +135,7 @@ t_yes = Да
 t_no = Нет
 t_series_not_in_collection = Этой серии нет в вашей коллекции
 t_i_have = У меня есть
+t_i_bought_for = Я купил за
 t_out_of_n_stamps = из {0} марок
 t_series_in_collection = Эта серия есть в вашей коллекции
 t_add_to_collection = Добавить в коллекцию

src/main/resources/sql/collection_dao_queries.properties

@@ -55,10 +55,18 @@ SELECT COUNT(*) \
 
 collection.add_series_to_collection = \
 INSERT \
-  INTO collections_series(collection_id, series_id, number_of_stamps) \
+  INTO collections_series \
+     ( collection_id \
+     , series_id \
+     , number_of_stamps \
+     , price \
+     , currency \
+     ) \
 SELECT c.id AS collection_id \
       , :series_id AS series_id \
       , :number_of_stamps AS number_of_stamps \
+      , :price as price \
+      , :currency as currency \
   FROM collections c \
  WHERE c.user_id = :user_id
 

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

@@ -369,6 +369,35 @@
 												th:text="${error}"></span>
 										</p>
 										/*/-->
+										<p th:with="price_msg=#{t_price}">
+											<span th:text="#{t_i_bought_for}" th:remove="tag">I bought for</span>
+											<input id="paid-price"
+												type="text"
+												size="5"
+												placeholder="price"
+												th:placeholder="${#strings.unCapitalize(price_msg)}"
+												th:field="*{price}"
+												/>
+											<select id="paid-currency" th:field="*{currency}">
+												<option value=""></option>
+												<option value="USD">USD</option>
+												<option value="EUR">EUR</option>
+												<option value="RUB">RUB</option>
+												<option value="CZK">CZK</option>
+											</select>
+										</p>
+										<!--/*/
+										<p th:if="${#fields.hasErrors('price') or #fields.hasErrors('currency')}" th:classappend="has-error">
+											<span id="paid-price.errors"
+												class="help-block"
+												th:each="error : ${#fields.errors('price')}"
+												th:text="${error}"></span>
+											<span id="paid-currency.errors"
+												class="help-block"
+												th:each="error : ${#fields.errors('currency')}"
+												th:text="${error}"></span>
+										</p>
+										/*/-->
 										<p>
 											<input type="hidden" name="action" value="ADD" />
 											<input type="hidden" name="numberOfStamps" value="1" th:if="${series.quantity == 1}" />

src/test/groovy/ru/mystamps/web/service/CollectionServiceImplTest.groovy

@@ -30,6 +30,7 @@ import ru.mystamps.web.dao.CollectionDao
 import ru.mystamps.web.dao.dto.AddCollectionDbDto
 import ru.mystamps.web.dao.dto.AddToCollectionDbDto
 import ru.mystamps.web.dao.dto.CollectionInfoDto
+import ru.mystamps.web.dao.dto.Currency
 import ru.mystamps.web.tests.DateUtils
 import ru.mystamps.web.tests.Random
 import ru.mystamps.web.util.SlugUtils
@@ -147,15 +148,31 @@ class CollectionServiceImplTest extends Specification {
 			thrown IllegalArgumentException
 	}
 
+	def 'addToCollection() should throw exception when price is specified without currency'() {
+		given:
+			AddToCollectionForm dto = new AddToCollectionForm()
+			dto.setPrice(Random.price())
+			dto.setNumberOfStamps(Random.quantity())
+			dto.setCurrency(null)
+		when:
+			service.addToCollection(Random.userId(), Random.id(), dto)
+		then:
+			thrown IllegalStateException
+	}
+	
 	@SuppressWarnings(['ClosureAsLastMethodParameter', 'UnnecessaryReturnKeyword'])
 	def 'addToCollection() should add series to collection and mark it as modified'() {
 		given:
 			Integer expectedUserId = Random.userId()
 			Integer expectedSeriesId = Random.id()
 			Integer expectedNumberOfStamps = Random.quantity()
+			BigDecimal expectedPrice = Random.price()
+			Currency expectedCurrency = Random.currency()
 		and:
 			AddToCollectionForm form = new AddToCollectionForm()
 			form.setNumberOfStamps(expectedNumberOfStamps)
+			form.setPrice(expectedPrice)
+			form.setCurrency(expectedCurrency)
 		when:
 			service.addToCollection(expectedUserId, expectedSeriesId, form)
 		then: