refactor: move dao/service/mapper methods that work with PurchaseAndSaleDto to ru.mystamps.web.feature.series.sale package.

Part of #1051

Author: php-coder

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

@@ -37,8 +37,7 @@
 @SuppressWarnings({
 	"PMD.AvoidDuplicateLiterals",
 	"PMD.TooManyMethods",
-	"PMD.TooManyFields",
-	"PMD.LongVariable"
+	"PMD.TooManyFields"
 })
 @RequiredArgsConstructor
 public class JdbcSeriesDao implements SeriesDao {
@@ -78,9 +77,6 @@ public class JdbcSeriesDao implements SeriesDao {
 	@Value("${series.find_by_country_slug}")
 	private String findByCountrySlugSql;
 
-	@Value("${series_sales.find_sales_by_series_id}")
-	private String findPurchasesAndSalesBySeriesIdSql;
-	
 	@Value("${series.count_all_series}")
 	private String countAllSql;
 
@@ -290,18 +286,6 @@ public List<SeriesInGalleryDto> findByCountrySlug(String slug, String lang) {
 		return jdbcTemplate.query(findByCountrySlugSql, params, RowMappers::forSeriesInGalleryDto);
 	}
 
-	/**
-	 * @author Sergey Chechenev
-	 */
-	@Override
-	public List<PurchaseAndSaleDto> findPurchasesAndSales(Integer seriesId) {
-		return jdbcTemplate.query(
-			findPurchasesAndSalesBySeriesIdSql,
-			Collections.singletonMap("series_id", seriesId),
-			RowMappers::forPurchaseAndSaleDto
-		);
-	}
-	
 	@Override
 	public long countAll() {
 		return jdbcTemplate.queryForObject(countAllSql, Collections.emptyMap(), Long.class);

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

@@ -17,15 +17,12 @@
  */
 package ru.mystamps.web.feature.series;
 
-import ru.mystamps.web.common.Currency;
 import ru.mystamps.web.common.JdbcUtils;
 import ru.mystamps.web.common.LinkEntityDto;
-import ru.mystamps.web.feature.series.sale.SeriesCondition;
 
 import java.math.BigDecimal;
 import java.sql.ResultSet;
 import java.sql.SQLException;
-import java.util.Date;
 
 import static ru.mystamps.web.common.RowMappers.createLinkEntityDto;
 
@@ -99,42 +96,6 @@ private RowMappers() {
 			category
 		);
 	}
-	
-	/**
-	 * @author Sergey Chechenev
-	 */
-	/* default */ static PurchaseAndSaleDto forPurchaseAndSaleDto(ResultSet rs, int unused)
-		throws SQLException {
-		
-		Date date               = rs.getDate("date");
-		String sellerName       = rs.getString("seller_name");
-		String sellerUrl        = rs.getString("seller_url");
-		String buyerName        = rs.getString("buyer_name");
-		String buyerUrl         = rs.getString("buyer_url");
-		String transactionUrl   = rs.getString("transaction_url");
-		BigDecimal firstPrice   = rs.getBigDecimal("first_price");
-		Currency firstCurrency  = JdbcUtils.getCurrency(rs, "first_currency");
-		BigDecimal secondPrice  = rs.getBigDecimal("second_price");
-		Currency secondCurrency = JdbcUtils.getCurrency(rs, "second_currency");
-		
-		// LATER: consider extracting this into a helper method
-		String conditionField = rs.getString("cond");
-		SeriesCondition condition = rs.wasNull() ? null : SeriesCondition.valueOf(conditionField);
-		
-		return new PurchaseAndSaleDto(
-			date,
-			sellerName,
-			sellerUrl,
-			buyerName,
-			buyerUrl,
-			transactionUrl,
-			firstPrice,
-			firstCurrency,
-			secondPrice,
-			secondCurrency,
-			condition
-		);
-	}
 
 	/* default */ static SeriesFullInfoDto forSeriesFullInfoDto(ResultSet rs, int unused)
 		throws SQLException {

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

@@ -749,7 +749,7 @@ public static void loadErrorsFromDownloadInterceptor(
 
 		if (SecurityContextUtils.hasAuthority(Authority.VIEW_SERIES_SALES)) {
 			List<PurchaseAndSaleDto> purchasesAndSales =
-				seriesService.findPurchasesAndSales(seriesId);
+				seriesSalesService.findSales(seriesId);
 			model.put("purchasesAndSales", purchasesAndSales);
 		}
 

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

@@ -34,7 +34,6 @@ public interface SeriesDao {
 	List<SeriesInfoDto> findByIdsAsSeriesInfo(List<Integer> seriesIds, String lang);
 	List<SeriesInfoDto> findByCategorySlugAsSeriesInfo(String slug, String lang);
 	List<SeriesInGalleryDto> findByCountrySlug(String slug, String lang);
-	List<PurchaseAndSaleDto> findPurchasesAndSales(Integer seriesId);
 
 	long countAll();
 	long countAllStamps();

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

@@ -53,7 +53,5 @@ public interface SeriesService {
 	List<SeriesLinkDto> findSimilarSeries(Integer seriesId, String lang);
 	List<SitemapInfoDto> findAllForSitemap();
 
-	List<PurchaseAndSaleDto> findPurchasesAndSales(Integer seriesId);
-	
 	void markAsSimilar(AddSimilarSeriesForm dto);
 }

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

@@ -418,18 +418,6 @@ public List<SitemapInfoDto> findAllForSitemap() {
 		return seriesDao.findAllForSitemap();
 	}
 
-	/**
-	 * @author Sergey Chechenev
-	 */
-	@Override
-	@Transactional(readOnly = true)
-	@PreAuthorize(HasAuthority.VIEW_SERIES_SALES)
-	public List<PurchaseAndSaleDto> findPurchasesAndSales(Integer seriesId) {
-		Validate.isTrue(seriesId != null, "Series id must be non null");
-
-		return seriesDao.findPurchasesAndSales(seriesId);
-	}
-	
 	// @todo #1280 SeriesServiceImpl.markAsSimilar(): add unit tests
 	@Override
 	@Transactional

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

@@ -21,8 +21,11 @@
 import org.apache.commons.lang3.Validate;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;
+import ru.mystamps.web.feature.series.PurchaseAndSaleDto;
 
+import java.util.Collections;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
 @RequiredArgsConstructor
@@ -33,6 +36,9 @@ public class JdbcSeriesSalesDao implements SeriesSalesDao {
 	@Value("${series_sales.add}")
 	private String addSeriesSaleSql;
 
+	@Value("${series_sales.find_sales_by_series_id}")
+	private String findSeriesSalesBySeriesIdSql;
+	
 	@Override
 	public void add(AddSeriesSalesDbDto sale) {
 		Map<String, Object> params = new HashMap<>();
@@ -58,4 +64,16 @@ public void add(AddSeriesSalesDbDto sale) {
 		);
 	}
 
+	/**
+	 * @author Sergey Chechenev
+	 */
+	@Override
+	public List<PurchaseAndSaleDto> findSeriesSales(Integer seriesId) {
+		return jdbcTemplate.query(
+			findSeriesSalesBySeriesIdSql,
+			Collections.singletonMap("series_id", seriesId),
+			RowMappers::forPurchaseAndSaleDto
+		);
+	}
+	
 }

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

@@ -0,0 +1,70 @@
+/*
+ * 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;
+
+import ru.mystamps.web.common.Currency;
+import ru.mystamps.web.common.JdbcUtils;
+import ru.mystamps.web.feature.series.PurchaseAndSaleDto;
+
+import java.math.BigDecimal;
+import java.sql.ResultSet;
+import java.sql.SQLException;
+import java.util.Date;
+
+final class RowMappers {
+	
+	private RowMappers() {
+	}
+	
+	/**
+	 * @author Sergey Chechenev
+	 */
+	/* default */ static PurchaseAndSaleDto forPurchaseAndSaleDto(ResultSet rs, int unused)
+		throws SQLException {
+		
+		Date date               = rs.getDate("date");
+		String sellerName       = rs.getString("seller_name");
+		String sellerUrl        = rs.getString("seller_url");
+		String buyerName        = rs.getString("buyer_name");
+		String buyerUrl         = rs.getString("buyer_url");
+		String transactionUrl   = rs.getString("transaction_url");
+		BigDecimal firstPrice   = rs.getBigDecimal("first_price");
+		Currency firstCurrency  = JdbcUtils.getCurrency(rs, "first_currency");
+		BigDecimal secondPrice  = rs.getBigDecimal("second_price");
+		Currency secondCurrency = JdbcUtils.getCurrency(rs, "second_currency");
+		
+		// LATER: consider extracting this into a helper method
+		String conditionField = rs.getString("cond");
+		SeriesCondition condition = rs.wasNull() ? null : SeriesCondition.valueOf(conditionField);
+		
+		return new PurchaseAndSaleDto(
+			date,
+			sellerName,
+			sellerUrl,
+			buyerName,
+			buyerUrl,
+			transactionUrl,
+			firstPrice,
+			firstCurrency,
+			secondPrice,
+			secondCurrency,
+			condition
+		);
+	}
+	
+}

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

@@ -17,6 +17,11 @@
  */
 package ru.mystamps.web.feature.series.sale;
 
+import ru.mystamps.web.feature.series.PurchaseAndSaleDto;
+
+import java.util.List;
+
 public interface SeriesSalesDao {
 	void add(AddSeriesSalesDbDto dto);
+	List<PurchaseAndSaleDto> findSeriesSales(Integer seriesId);
 }

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

@@ -17,6 +17,11 @@
  */
 package ru.mystamps.web.feature.series.sale;
 
+import ru.mystamps.web.feature.series.PurchaseAndSaleDto;
+
+import java.util.List;
+
 public interface SeriesSalesService {
 	void add(AddSeriesSalesDto dto, Integer seriesId, Integer userId);
+	List<PurchaseAndSaleDto> findSales(Integer seriesId);
 }

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

@@ -22,9 +22,11 @@
 import org.slf4j.Logger;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.transaction.annotation.Transactional;
+import ru.mystamps.web.feature.series.PurchaseAndSaleDto;
 import ru.mystamps.web.support.spring.security.HasAuthority;
 
 import java.util.Date;
+import java.util.List;
 
 @RequiredArgsConstructor
 public class SeriesSalesServiceImpl implements SeriesSalesService {
@@ -69,4 +71,16 @@ public void add(AddSeriesSalesDto dto, Integer seriesId, Integer userId) {
 		log.info("Sale for series #{} has been added", seriesId);
 	}
 
+	/**
+	 * @author Sergey Chechenev
+	 */
+	@Override
+	@Transactional(readOnly = true)
+	@PreAuthorize(HasAuthority.VIEW_SERIES_SALES)
+	public List<PurchaseAndSaleDto> findSales(Integer seriesId) {
+		Validate.isTrue(seriesId != null, "Series id must be non null");
+		
+		return seriesSalesDao.findSeriesSales(seriesId);
+	}
+	
 }

src/test/groovy/ru/mystamps/web/feature/series/SeriesServiceImplTest.groovy

@@ -1140,29 +1140,4 @@ class SeriesServiceImplTest extends Specification {
 			result == expectedResult
 	}
 
-	//
-	// Tests for findPurchasesAndSales()
-	//
-	
-	def "findPurchasesAndSales() should throw exception when series id is null"() {
-		when:
-			service.findPurchasesAndSales(null)
-		then:
-			IllegalArgumentException ex = thrown()
-			ex.message == 'Series id must be non null'
-	}
-	
-	def "findPurchasesAndSales() should invoke dao, pass argument and return result from dao"() {
-		given:
-			Integer expectedSeriesId = Random.id()
-		and:
-			List<PurchaseAndSaleDto> expectedResult = [ TestObjects.createPurchaseAndSaleDto() ]
-		when:
-			List<PurchaseAndSaleDto> result = service.findPurchasesAndSales(expectedSeriesId)
-		then:
-			1 * seriesDao.findPurchasesAndSales(expectedSeriesId) >> expectedResult
-		and:
-			result == expectedResult
-	}
-	
 }

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

@@ -21,6 +21,8 @@ import static io.qala.datagen.RandomShortApi.nullOr
 
 import org.slf4j.helpers.NOPLogger
 import ru.mystamps.web.common.Currency
+import ru.mystamps.web.feature.series.PurchaseAndSaleDto
+import ru.mystamps.web.service.TestObjects
 import ru.mystamps.web.tests.DateUtils
 import ru.mystamps.web.tests.Random
 import spock.lang.Specification
@@ -149,4 +151,29 @@ class SeriesSalesServiceImplTest extends Specification {
 			new Date() - 10 | 'example.com' | new BigDecimal('6200') | Currency.RUB | 555
 	}
 
+	//
+	// Tests for findSales()
+	//
+	
+	def 'findSales() should throw exception when series id is null'() {
+		when:
+			service.findSales(null)
+		then:
+			IllegalArgumentException ex = thrown()
+			ex.message == 'Series id must be non null'
+	}
+	
+	def 'findSales() should invoke dao, pass argument and return result from dao'() {
+		given:
+			Integer expectedSeriesId = Random.id()
+		and:
+			List<PurchaseAndSaleDto> expectedResult = [TestObjects.createPurchaseAndSaleDto() ]
+		when:
+			List<PurchaseAndSaleDto> result = service.findSales(expectedSeriesId)
+		then:
+			1 * seriesSalesDao.findSeriesSales(expectedSeriesId) >> expectedResult
+		and:
+			result == expectedResult
+	}
+	
 }