Add support for specifying Zagorski catalog numbers.

Fix #769

Author: php-coder

NEWS.txt

@@ -18,6 +18,7 @@
 - (functionality)  add capability to specify image URL (as alternative to providing a file)
 - (functionality)  admin can import a series from an external site
 - (integration)    migrate from coveralls.io to codecov.io service for code coverage
+- (functionality)  add support for specifying Zagorski catalog numbers
 
 0.3
 - (functionality)  implemented possibility to user to add series to his collection

src/main/java/ru/mystamps/web/config/DaoConfig.java

@@ -135,7 +135,16 @@ public StampsCatalogDao getYvertCatalogDao() {
 			env.getRequiredProperty("series_yvert.add"),
 			env.getRequiredProperty("series_yvert.find_by_series_id")
 		);
-		
+	}
+	
+	@Bean
+	public StampsCatalogDao getZagorskiCatalogDao() {
+		return new JdbcStampsCatalogDao(
+			jdbcTemplate,
+			env.getRequiredProperty("zagorski.create"),
+			env.getRequiredProperty("series_zagorski.add"),
+			env.getRequiredProperty("series_zagorski.find_by_series_id")
+		);
 	}
 
 }

src/main/java/ru/mystamps/web/config/ServicesConfig.java

@@ -158,7 +158,8 @@ public SeriesService getSeriesService() {
 			getMichelCatalogService(),
 			getScottCatalogService(),
 			getYvertCatalogService(),
-			getGibbonsCatalogService()
+			getGibbonsCatalogService(),
+			getZagorskiCatalogService()
 		);
 	}
 
@@ -245,6 +246,15 @@ public StampsCatalogService getGibbonsCatalogService() {
 		);
 	}
 
+	@Bean
+	public StampsCatalogService getZagorskiCatalogService() {
+		return new StampsCatalogServiceImpl(
+			LoggerFactory.getLogger(StampsCatalogServiceImpl.class),
+			"Zagorski",
+			daoConfig.getZagorskiCatalogDao()
+		);
+	}
+	
 	@Bean
 	public TransactionParticipantService getTransactionParticipantService() {
 		return new TransactionParticipantServiceImpl(

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

@@ -120,6 +120,7 @@ protected void initSeriesFormBinder(WebDataBinder binder) {
 		binder.registerCustomEditor(String.class, "scottNumbers", editor);
 		binder.registerCustomEditor(String.class, "yvertNumbers", editor);
 		binder.registerCustomEditor(String.class, "gibbonsNumbers", editor);
+		binder.registerCustomEditor(String.class, "zagorskiNumbers", editor);
 		binder.registerCustomEditor(String.class, "comment", new StringTrimmerEditor(true));
 	}
 
@@ -455,6 +456,7 @@ public String searchSeriesByCatalog(
 			return "redirect:" + Url.INDEX_PAGE;
 		}
 
+		// @todo #769 Support search by Zagorski number
 		String lang = LocaleUtils.getLanguageOrNull(userLocale);
 		List<SeriesInfoDto> series;
 		switch (catalogName) {
@@ -544,14 +546,16 @@ protected static void loadErrorsFromDownloadInterceptor(
 
 		model.put("series", series);
 
-		String michelNumbers  = CatalogUtils.toShortForm(series.getMichel().getNumbers());
-		String scottNumbers   = CatalogUtils.toShortForm(series.getScott().getNumbers());
-		String yvertNumbers   = CatalogUtils.toShortForm(series.getYvert().getNumbers());
-		String gibbonsNumbers = CatalogUtils.toShortForm(series.getGibbons().getNumbers());
+		String michelNumbers   = CatalogUtils.toShortForm(series.getMichel().getNumbers());
+		String scottNumbers    = CatalogUtils.toShortForm(series.getScott().getNumbers());
+		String yvertNumbers    = CatalogUtils.toShortForm(series.getYvert().getNumbers());
+		String gibbonsNumbers  = CatalogUtils.toShortForm(series.getGibbons().getNumbers());
+		String zagorskiNumbers = CatalogUtils.toShortForm(series.getZagorski().getNumbers());
 		model.put("michelNumbers", michelNumbers);
 		model.put("scottNumbers", scottNumbers);
 		model.put("yvertNumbers", yvertNumbers);
 		model.put("gibbonsNumbers", gibbonsNumbers);
+		model.put("zagorskiNumbers", zagorskiNumbers);
 
 		boolean isSeriesInCollection =
 			collectionService.isSeriesInCollection(currentUserId, series.getId());

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

@@ -130,6 +130,14 @@ public class AddSeriesForm implements AddSeriesDto, HasImageOrImageUrl, Nullable
 
 	@Price
 	private BigDecimal gibbonsPrice;
+
+	// @todo #769 /series/add: validate that Zagorski numbers are specified only for stamps
+	//  from USSR/Russia
+	@CatalogNumbers
+	private String zagorskiNumbers;
+
+	@Price
+	private BigDecimal zagorskiPrice;
 
 	@Size(max = MAX_SERIES_COMMENT_LENGTH, message = "{value.too-long}")
 	private String comment;

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

@@ -144,6 +144,16 @@ public BigDecimal getGibbonsPrice() {
 		return null;
 	}
 
+	@Override
+	public String getZagorskiNumbers() {
+		return null;
+	}
+	
+	@Override
+	public BigDecimal getZagorskiPrice() {
+		return null;
+	}
+	
 	@Override
 	public String getComment() {
 		return null;

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

@@ -47,6 +47,8 @@ public class AddSeriesDbDto {
 	private BigDecimal gibbonsPrice;
 	private String gibbonsCurrency;
 
+	private BigDecimal zagorskiPrice;
+	
 	private Integer releaseDay;
 	private Integer releaseMonth;
 	private Integer releaseYear;

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

@@ -48,4 +48,6 @@ public class SeriesFullInfoDto {
 
 	private final BigDecimal gibbonsPrice;
 	private final String gibbonsCurrency;
+	
+	private final BigDecimal zagorskiPrice;
 }

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

@@ -134,6 +134,7 @@ public Integer add(AddSeriesDbDto series) {
 		params.put("yvert_currency", series.getYvertCurrency());
 		params.put("gibbons_price", series.getGibbonsPrice());
 		params.put("gibbons_currency", series.getGibbonsCurrency());
+		params.put("zagorski_price", series.getZagorskiPrice());
 		params.put("comment", series.getComment());
 		params.put("created_at", series.getCreatedAt());
 		params.put("created_by", series.getCreatedBy());

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

@@ -126,6 +126,8 @@ public static SeriesFullInfoDto forSeriesFullInfoDto(ResultSet rs, int i) throws
 		BigDecimal gibbonsPrice = rs.getBigDecimal("gibbons_price");
 		String gibbonsCurrency  = rs.getString("gibbons_currency");
 
+		BigDecimal zagorskiPrice = rs.getBigDecimal("zagorski_price");
+		
 		LinkEntityDto category =
 			createLinkEntityDto(rs, "category_id", "category_slug", "category_name");
 
@@ -150,7 +152,8 @@ public static SeriesFullInfoDto forSeriesFullInfoDto(ResultSet rs, int i) throws
 			yvertPrice,
 			yvertCurrency,
 			gibbonsPrice,
-			gibbonsCurrency
+			gibbonsCurrency,
+			zagorskiPrice
 		);
 	}
 

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

@@ -60,11 +60,16 @@ public class SeriesServiceImpl implements SeriesService {
 	private final StampsCatalogService scottCatalogService;
 	private final StampsCatalogService yvertCatalogService;
 	private final StampsCatalogService gibbonsCatalogService;
+	private final StampsCatalogService zagorskiCatalogService;
 
 	@Override
 	@Transactional
 	@PreAuthorize(HasAuthority.CREATE_SERIES)
-	@SuppressWarnings({ "PMD.NPathComplexity", "PMD.ModifiedCyclomaticComplexity" })
+	@SuppressWarnings({
+		"PMD.NPathComplexity",
+		"PMD.ModifiedCyclomaticComplexity",
+		"PMD.ExcessiveMethodLength"
+	})
 	public Integer add(AddSeriesDto dto, Integer userId, boolean userCanAddComments) {
 		Validate.isTrue(dto != null, "DTO must be non null");
 		Validate.isTrue(dto.getQuantity() != null, "Stamps quantity must be non null");
@@ -108,6 +113,10 @@ public Integer add(AddSeriesDto dto, Integer userId, boolean userCanAddComments)
 			series.setGibbonsCurrency(Currency.GBP.toString());
 		}
 
+		if (dto.getZagorskiPrice() != null) {
+			series.setZagorskiPrice(dto.getZagorskiPrice());
+		}
+
 		if (userCanAddComments && dto.getComment() != null) {
 			Validate.isTrue(
 				!dto.getComment().trim().isEmpty(),
@@ -150,6 +159,12 @@ public Integer add(AddSeriesDto dto, Integer userId, boolean userCanAddComments)
 			gibbonsCatalogService.addToSeries(id, gibbonsNumbers);
 		}
 
+		Set<String> zagorskiNumbers = CatalogUtils.parseCatalogNumbers(dto.getZagorskiNumbers());
+		if (!zagorskiNumbers.isEmpty()) {
+			zagorskiCatalogService.add(zagorskiNumbers);
+			zagorskiCatalogService.addToSeries(id, zagorskiNumbers);
+		}
+		
 		ImageInfoDto imageInfo = imageService.save(dto.getImage());
 		Integer imageId = imageInfo.getId();
 
@@ -261,6 +276,7 @@ public SeriesDto findFullInfoById(Integer seriesId, String lang) {
 		List<String> scottNumbers   = scottCatalogService.findBySeriesId(seriesId);
 		List<String> yvertNumbers   = yvertCatalogService.findBySeriesId(seriesId);
 		List<String> gibbonsNumbers = gibbonsCatalogService.findBySeriesId(seriesId);
+		List<String> zagorskiNumbers = zagorskiCatalogService.findBySeriesId(seriesId);
 
 		List<Integer> imageIds = imageService.findBySeriesId(seriesId);
 
@@ -270,6 +286,7 @@ public SeriesDto findFullInfoById(Integer seriesId, String lang) {
 			scottNumbers,
 			yvertNumbers,
 			gibbonsNumbers,
+			zagorskiNumbers,
 			imageIds
 		);
 	}

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

@@ -44,6 +44,9 @@ public interface AddSeriesDto {
 	String getGibbonsNumbers();
 	BigDecimal getGibbonsPrice();
 
+	String getZagorskiNumbers();
+	BigDecimal getZagorskiPrice();
+	
 	String getComment();
 	MultipartFile getImage();
 }

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

@@ -38,6 +38,9 @@ public class SeriesDto {
 
 	@Getter
 	private final CatalogInfoDto gibbons;
+
+	@Getter
+	private final CatalogInfoDto zagorski;
 
 	@Getter
 	private final List<Integer> imageIds;
@@ -49,14 +52,16 @@ public SeriesDto(
 		List<String> scottNumbers,
 		List<String> yvertNumbers,
 		List<String> gibbonsNumbers,
+		List<String> zagorskiNumbers,
 		List<Integer> imageIds) {
 
 		this.info     = info;
-		// CheckStyle: ignore LineLength for next 4 lines
+		// CheckStyle: ignore LineLength for next 5 lines
 		this.michel   = new CatalogInfoDto(michelNumbers, info.getMichelPrice(), info.getMichelCurrency());
 		this.scott    = new CatalogInfoDto(scottNumbers, info.getScottPrice(), info.getScottCurrency());
 		this.yvert    = new CatalogInfoDto(yvertNumbers, info.getYvertPrice(), info.getYvertCurrency());
 		this.gibbons  = new CatalogInfoDto(gibbonsNumbers, info.getGibbonsPrice(), info.getGibbonsCurrency());
+		this.zagorski = new CatalogInfoDto(zagorskiNumbers, info.getZagorskiPrice(), null /* unused field currency */);
 		this.imageIds = imageIds;
 	}
 

src/main/resources/liquibase/sql/test-series-with-zagorski-numbers.sql

@@ -0,0 +1,6 @@
+--
+-- Auto-generated by Maven, based on values from src/main/resources/test/spring/test-data.properties
+--
+
+INSERT INTO zagorski_catalog(id, code) VALUES(1, '@existing_zagorski_number@');
+INSERT INTO series_zagorski_catalog(series_id, zagorski_id) VALUES(1, 1);

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

@@ -41,5 +41,6 @@
 	<include file="0.4/2017-11-15--group_participants.xml" relativeToChangelogFile="true" />
 	<include file="0.4/2017-11-22--import_request_series_id.xml" relativeToChangelogFile="true" />
 	<include file="0.4/2017-12-18--unique_series_id_in_import_requests.xml" relativeToChangelogFile="true" />
+	<include file="0.4/2017-12-21--zagorski_catalog.xml" relativeToChangelogFile="true" />
 
 </databaseChangeLog>

src/main/resources/liquibase/version/0.4/2017-12-21--zagorski_catalog.xml

@@ -0,0 +1,46 @@
+<?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="create-zagorski_catalog-table" author="php-coder" context="scheme">
+		
+		<createTable tableName="zagorski_catalog">
+			<column name="id" type="INTEGER" autoIncrement="true">
+				<constraints primaryKey="true" />
+			</column>
+			<column name="code" type="VARCHAR(4)">
+				<constraints nullable="false" unique="true" uniqueConstraintName="uc_zagorski_catalog_code" />
+			</column>
+		</createTable>
+		
+	</changeSet>
+	
+	<changeSet id="create-series_zagorski_catalog-table" author="php-coder" context="scheme">
+		
+		<createTable tableName="series_zagorski_catalog">
+			<column name="series_id" type="INTEGER">
+				<constraints primaryKey="true" references="series(id)" foreignKeyName="fk_series_zagorski_catalog_series_id" />
+			</column>
+			<column name="zagorski_id" type="INTEGER">
+				<constraints primaryKey="true" references="zagorski_catalog(id)" foreignKeyName="fk_series_zagorski_catalog_zagorski_id" />
+			</column>
+		</createTable>
+		
+	</changeSet>
+	
+	<changeSet id="add-zagorski_price-field-to-series-field" author="php-coder" context="scheme">
+		
+		<addColumn tableName="series">
+			<column name="zagorski_price" type="DECIMAL(19,2)" afterColumn="gibbons_price" />
+		</addColumn>
+		
+	</changeSet>
+	
+	<changeSet id="add-zagorski-numbers-to-series" author="php-coder" context="test-data">
+		<sqlFile path="../../sql/test-series-with-zagorski-numbers.sql" relativeToChangelogFile="true" />
+	</changeSet>
+	
+</databaseChangeLog>

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

@@ -118,6 +118,8 @@ t_michel = Michel
 t_scott = Scott
 t_yvert = Yvert
 t_sg = Gibbons
+t_zagorski = Zagorski
+
 t_add_comment = Add comment
 t_comment = Comment
 t_image = Image

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

@@ -118,6 +118,7 @@ t_michel = Michel
 t_scott = Scott
 t_yvert = Yvert
 t_sg = Gibbons
+t_zagorski = Загорский
 t_add_comment = Добавить комментарий
 t_comment = Комментарий
 t_image = Изображение

src/main/resources/sql/series_dao_queries.properties

@@ -16,6 +16,7 @@ INSERT \
      , yvert_currency \
      , gibbons_price \
      , gibbons_currency \
+     , zagorski_price \
      , comment \
      , created_at \
      , created_by \
@@ -38,6 +39,7 @@ VALUES \
      , :yvert_currency \
      , :gibbons_price \
      , :gibbons_currency \
+     , :zagorski_price \
      , :comment \
      , :created_at \
      , :created_by \
@@ -97,6 +99,7 @@ series.find_full_info_by_id = \
         , s.yvert_currency \
         , s.gibbons_price \
         , s.gibbons_currency \
+        , s.zagorski_price \
         , s.comment \
         , s.created_by \
      FROM series s \