ImageService.save(): modify return value to return full info about image.

Refactoring required for #301

No functional changes.

Author: php-coder

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

@@ -17,12 +17,14 @@
  */
 package ru.mystamps.web.dao.dto;
 
+import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 import lombok.ToString;
 
 @Getter
 @RequiredArgsConstructor
+@EqualsAndHashCode
 @ToString
 public class ImageInfoDto {
 	private final Integer id;

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

@@ -22,9 +22,10 @@
 import org.springframework.web.multipart.MultipartFile;
 
 import ru.mystamps.web.dao.dto.ImageDto;
+import ru.mystamps.web.dao.dto.ImageInfoDto;
 
 public interface ImageService {
-	Integer save(MultipartFile file);
+	ImageInfoDto save(MultipartFile file);
 	ImageDto get(Integer imageId);
 	ImageDto getOrCreatePreview(Integer imageId);
 	void addToSeries(Integer seriesId, Integer imageId);

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

@@ -55,7 +55,7 @@ public class ImageServiceImpl implements ImageService {
 	@Override
 	@Transactional
 	@PreAuthorize("isAuthenticated()")
-	public Integer save(MultipartFile file) {
+	public ImageInfoDto save(MultipartFile file) {
 		Validate.isTrue(file != null, "File must be non null");
 		Validate.isTrue(file.getSize() > 0, "Image size must be greater than zero");
 
@@ -81,7 +81,7 @@ public Integer save(MultipartFile file) {
 
 		imagePersistenceStrategy.save(file, imageInfo);
 
-		return imageId;
+		return imageInfo;
 	}
 
 	@Override

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

@@ -36,6 +36,7 @@
 import ru.mystamps.web.dao.SeriesDao;
 import ru.mystamps.web.dao.dto.AddSeriesDbDto;
 import ru.mystamps.web.dao.dto.Currency;
+import ru.mystamps.web.dao.dto.ImageInfoDto;
 import ru.mystamps.web.dao.dto.PurchaseAndSaleDto;
 import ru.mystamps.web.dao.dto.SeriesFullInfoDto;
 import ru.mystamps.web.dao.dto.SeriesInfoDto;
@@ -150,8 +151,8 @@ public Integer add(AddSeriesDto dto, Integer userId, boolean userCanAddComments)
 			gibbonsCatalogService.addToSeries(id, gibbonsNumbers);
 		}
 
-		Integer imageId = imageService.save(dto.getImage());
-		imageService.addToSeries(id, imageId);
+		ImageInfoDto imageInfo = imageService.save(dto.getImage());
+		imageService.addToSeries(id, imageInfo.getId());
 
 		LOG.info("Series #{} has been created ({})", id, series);
 
@@ -168,7 +169,8 @@ public void addImageToSeries(AddImageDto dto, Integer seriesId, Integer userId)
 
 		seriesDao.markAsModified(seriesId, new Date(), userId);
 
-		Integer imageId = imageService.save(dto.getImage());
+		ImageInfoDto imageInfo = imageService.save(dto.getImage());
+		Integer imageId = imageInfo.getId();
 		imageService.addToSeries(seriesId, imageId);
 
 		LOG.info(

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

@@ -138,13 +138,15 @@ class ImageServiceImplTest extends Specification {
 
 	def "save() should return saved image"() {
 		given:
-			Integer expectedImageId = 20
+			Integer expectedImageId = 17
+		and:
+			ImageInfoDto expectedImageInfo = new ImageInfoDto(expectedImageId, "PNG")
 		when:
-			Integer actualImageId = service.save(multipartFile)
+			ImageInfoDto actualImageInfo = service.save(multipartFile)
 		then:
 			imageDao.add(_ as String) >> expectedImageId
 		and:
-			actualImageId == expectedImageId
+			actualImageInfo == expectedImageInfo
 	}
 
 	//

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

@@ -25,6 +25,7 @@ import spock.lang.Unroll
 import ru.mystamps.web.dao.SeriesDao
 import ru.mystamps.web.dao.dto.AddSeriesDbDto
 import ru.mystamps.web.dao.dto.Currency
+import ru.mystamps.web.dao.dto.ImageInfoDto
 import ru.mystamps.web.dao.dto.SeriesFullInfoDto
 import ru.mystamps.web.model.AddImageForm
 import ru.mystamps.web.model.AddSeriesForm
@@ -38,7 +39,6 @@ import ru.mystamps.web.tests.DateUtils
 @SuppressWarnings(['ClassJavadoc', 'MethodName', 'NoDef', 'NoTabCharacter', 'TrailingWhitespace'])
 class SeriesServiceImplTest extends Specification {
 	private static final BigDecimal ANY_PRICE = new BigDecimal('17')
-	private static final Integer ANY_IMAGE_ID = 18
 
 	private final ImageService imageService = Mock()
 	private final SeriesDao seriesDao = Mock()
@@ -63,7 +63,7 @@ class SeriesServiceImplTest extends Specification {
 
 		userId = TestObjects.TEST_USER_ID
 
-		imageService.save(_) >> ANY_IMAGE_ID
+		imageService.save(_) >> TestObjects.createImageInfoDto()
 
 		service = new SeriesServiceImpl(
 			seriesDao,
@@ -497,7 +497,7 @@ class SeriesServiceImplTest extends Specification {
 			1 * imageService.save({ MultipartFile passedFile ->
 				assert passedFile == multipartFile
 				return true
-			}) >> ANY_IMAGE_ID
+			}) >> TestObjects.createImageInfoDto()
 	}
 
 	@SuppressWarnings(['ClosureAsLastMethodParameter', 'UnnecessaryReturnKeyword'])
@@ -512,7 +512,7 @@ class SeriesServiceImplTest extends Specification {
 			service.add(form, userId, false)
 		then:
 			// FIXME: why we can't use _ as MultipartFile here?
-			imageService.save(_) >> expectedImageId
+			imageService.save(_) >> new ImageInfoDto(expectedImageId, "JPEG")
 		and:
 			1 * imageService.addToSeries({ Integer seriesId ->
 				assert seriesId == expectedSeriesId
@@ -578,7 +578,7 @@ class SeriesServiceImplTest extends Specification {
 			1 * imageService.save({ MultipartFile passedFile ->
 				assert passedFile == multipartFile
 				return true
-			}) >> ANY_IMAGE_ID
+			}) >> TestObjects.createImageInfoDto()
 	}
 
 	@SuppressWarnings(['ClosureAsLastMethodParameter', 'UnnecessaryReturnKeyword'])
@@ -590,7 +590,7 @@ class SeriesServiceImplTest extends Specification {
 		when:
 			service.addImageToSeries(imageForm, expectedSeriesId, expectedUserId)
 		then:
-			imageService.save(_) >> expectedImageId
+			imageService.save(_) >> new ImageInfoDto(expectedImageId, "JPEG")
 		and:
 			1 * imageService.addToSeries({ Integer seriesId ->
 				assert seriesId == expectedSeriesId