Use constants for import request statuses.

php-coder · php-coder · commit afc42c485741 · 2017-12-04T23:11:28.000+01:00
Fix #687
diff --git a/src/main/java/ru/mystamps/web/Db.java b/src/main/java/ru/mystamps/web/Db.java
@@ -44,6 +44,18 @@ public static final class SeriesImportRequest {
 		public static final int URL_LENGTH = 285;
 	}
 	
+	public static final class SeriesImportRequestStatus {
+		// see initiate-series_import_request_statuses-table changeset
+		// in src/main/resources/liquibase/version/0.4/2017-11-08--import_series.xml
+		// @todo #687 replace set of strings by enum
+		public static final String UNPROCESSED           = "Unprocessed";
+		public static final String DOWNLOADING_SUCCEEDED = "DownloadingSucceeded";
+		public static final String DOWNLOADING_FAILED    = "DownloadingFailed";
+		public static final String PARSING_SUCCEEDED     = "ParsingSucceeded";
+		public static final String PARSING_FAILED        = "ParsingFailed";
+		public static final String IMPORT_SUCCEEDED      = "ImportSucceeded";
+	}
+	
 	public static final class SeriesSales {
 		public static final int TRANSACTION_URL_LENGTH = 255;
 	}
diff --git a/src/main/java/ru/mystamps/web/controller/event/DownloadingFailedEventListener.java b/src/main/java/ru/mystamps/web/controller/event/DownloadingFailedEventListener.java
@@ -23,6 +23,7 @@
 
 import lombok.RequiredArgsConstructor;
 
+import ru.mystamps.web.Db;
 import ru.mystamps.web.service.SeriesImportService;
 
 /**
@@ -48,7 +49,11 @@ public void onApplicationEvent(DownloadingFailed event) {
 			event.getCode()
 		);
 		
-		importService.changeStatus(requestId, "Unprocessed", "DownloadingFailed");
+		importService.changeStatus(
+			requestId,
+			Db.SeriesImportRequestStatus.UNPROCESSED,
+			Db.SeriesImportRequestStatus.DOWNLOADING_FAILED
+		);
 	}
 	
 }
diff --git a/src/main/java/ru/mystamps/web/controller/event/ParsingFailedEventListener.java b/src/main/java/ru/mystamps/web/controller/event/ParsingFailedEventListener.java
@@ -23,6 +23,7 @@
 
 import lombok.RequiredArgsConstructor;
 
+import ru.mystamps.web.Db.SeriesImportRequestStatus;
 import ru.mystamps.web.service.SeriesImportService;
 
 /**
@@ -44,7 +45,11 @@ public void onApplicationEvent(ParsingFailed event) {
 		// TODO: more info?
 		log.info("Request #{}: parsing failed", requestId);
 		
-		importService.changeStatus(requestId, "DownloadingSucceeded", "ParsingFailed");
+		importService.changeStatus(
+			requestId,
+			SeriesImportRequestStatus.DOWNLOADING_SUCCEEDED,
+			SeriesImportRequestStatus.PARSING_FAILED
+		);
 	}
 	
 }
diff --git a/src/main/java/ru/mystamps/web/service/SeriesImportServiceImpl.java b/src/main/java/ru/mystamps/web/service/SeriesImportServiceImpl.java
@@ -31,6 +31,7 @@
 
 import lombok.RequiredArgsConstructor;
 
+import ru.mystamps.web.Db.SeriesImportRequestStatus;
 import ru.mystamps.web.dao.SeriesImportDao;
 import ru.mystamps.web.dao.dto.ImportRequestDto;
 import ru.mystamps.web.dao.dto.ImportSeriesDbDto;
@@ -46,13 +47,6 @@
 @RequiredArgsConstructor
 public class SeriesImportServiceImpl implements SeriesImportService {
 	
-	// see initiate-series_import_request_statuses-table changeset
-	// in src/main/resources/liquibase/version/0.4/2017-11-08--import_series.xml
-	private static final String UNPROCESSED = "Unprocessed";
-	private static final String DOWNLOADING_SUCCEEDED = "DownloadingSucceeded";
-	private static final String PARSING_SUCCEEDED = "ParsingSucceeded";
-	private static final String IMPORT_SUCCEEDED = "ImportSucceeded";
-	
 	private final Logger log;
 	private final SeriesImportDao seriesImportDao;
 	private final SeriesService seriesService;
@@ -68,7 +62,7 @@ public Integer addRequest(RequestImportDto dto, Integer userId) {
 		
 		ImportSeriesDbDto importRequest = new ImportSeriesDbDto();
 		importRequest.setUrl(dto.getUrl());
-		importRequest.setStatus(UNPROCESSED);
+		importRequest.setStatus(SeriesImportRequestStatus.UNPROCESSED);
 		
 		Date now = new Date();
 		importRequest.setUpdatedAt(now);
@@ -95,7 +89,11 @@ public Integer addSeries(AddSeriesDto dto, Integer requestId, Integer userId) {
 		//  Here we're updating series_import_requests twice: when we set series_id field
 		//  and later when we change status_id. It's possible to do this in one-shot
 		seriesImportDao.setSeriesIdOnRequest(requestId, seriesId, now);
-		changeStatus(requestId, PARSING_SUCCEEDED, IMPORT_SUCCEEDED);
+		changeStatus(
+			requestId,
+			SeriesImportRequestStatus.PARSING_SUCCEEDED,
+			SeriesImportRequestStatus.IMPORT_SUCCEEDED
+		);
 		
 		return seriesId;
 	}
@@ -134,7 +132,11 @@ public void saveDownloadedContent(Integer requestId, String content) {
 		
 		log.info("Request #{}: page were downloaded ({} characters)", requestId, content.length());
 		
-		changeStatus(requestId, UNPROCESSED, DOWNLOADING_SUCCEEDED);
+		changeStatus(
+			requestId,
+			SeriesImportRequestStatus.UNPROCESSED,
+			SeriesImportRequestStatus.DOWNLOADING_SUCCEEDED
+		);
 	}
 	
 	@Override
@@ -180,7 +182,11 @@ public void saveParsedData(Integer requestId, RawParsedDataDto data) {
 		
 		log.info("Request #{}: page were parsed ({})", requestId, processedData);
 		
-		changeStatus(requestId, DOWNLOADING_SUCCEEDED, PARSING_SUCCEEDED);
+		changeStatus(
+			requestId,
+			SeriesImportRequestStatus.DOWNLOADING_SUCCEEDED,
+			SeriesImportRequestStatus.PARSING_SUCCEEDED
+		);
 	}
 	
 	@Override
diff --git a/src/test/groovy/ru/mystamps/web/service/SeriesImportServiceImplTest.groovy b/src/test/groovy/ru/mystamps/web/service/SeriesImportServiceImplTest.groovy
@@ -27,6 +27,7 @@ import spock.lang.Specification
 import org.slf4j.helpers.NOPLogger
 
 import ru.mystamps.web.controller.dto.RequestImportForm
+import ru.mystamps.web.Db.SeriesImportRequestStatus
 import ru.mystamps.web.dao.dto.ImportRequestDto
 import ru.mystamps.web.dao.dto.ParsedDataDto
 import ru.mystamps.web.dao.SeriesImportDao
@@ -84,7 +85,7 @@ class SeriesImportServiceImplTest extends Specification {
 		then:
 			1 * seriesImportDao.add({ ImportSeriesDbDto request ->
 				assert request.url == expectedUrl
-				assert request.status == 'Unprocessed'
+				assert request.status == SeriesImportRequestStatus.UNPROCESSED
 				assert DateUtils.roughlyEqual(request?.requestedAt, new Date())
 				assert request.requestedBy == expectedUserId
 				assert DateUtils.roughlyEqual(request?.updatedAt, new Date())
@@ -243,10 +244,10 @@ class SeriesImportServiceImplTest extends Specification {
 				assert DateUtils.roughlyEqual(date, new Date())
 				return true
 			}, { String oldStatus ->
-				assert oldStatus == 'Unprocessed'
+				assert oldStatus == SeriesImportRequestStatus.UNPROCESSED
 				return true
 			}, { String newStatus ->
-				assert newStatus == 'DownloadingSucceeded'
+				assert newStatus == SeriesImportRequestStatus.DOWNLOADING_SUCCEEDED
 				return true
 			})
 	}
diff --git a/src/test/java/ru/mystamps/web/tests/Random.java b/src/test/java/ru/mystamps/web/tests/Random.java
@@ -24,6 +24,7 @@
 
 import io.qala.datagen.RandomShortApi;
 
+import ru.mystamps.web.Db.SeriesImportRequestStatus;
 import ru.mystamps.web.dao.dto.CategoryDto;
 import ru.mystamps.web.dao.dto.EntityWithIdDto;
 import ru.mystamps.web.dao.dto.TransactionParticipantDto;
@@ -39,14 +40,14 @@
 
 public final class Random {
 	
-	// TODO: use constants for statuses
+	// @todo #687 Random.STATUSES: reduce duplication by using EnumSet.allOf()
 	private static final String[] STATUSES = new String[] {
-		"Unprocessed",
-		"DownloadingSucceeded",
-		"DownloadingFailed",
-		"ParsingSucceeded",
-		"ParsingFailed",
-		"ImportSucceeded",
+		SeriesImportRequestStatus.UNPROCESSED,
+		SeriesImportRequestStatus.DOWNLOADING_SUCCEEDED,
+		SeriesImportRequestStatus.DOWNLOADING_FAILED,
+		SeriesImportRequestStatus.PARSING_SUCCEEDED,
+		SeriesImportRequestStatus.PARSING_FAILED,
+		SeriesImportRequestStatus.IMPORT_SUCCEEDED,
 	};
 	
 	private Random() {
