Skip to content

Commit

Permalink
Squashed commit of the following:
Browse files Browse the repository at this point in the history
commit 83c122e36b3b99f8c991ca916acdff57eb40c38e
Author: Darryl L. Pierce <mcpierce@gmail.com>
Date:   Sat Feb 29 14:38:48 2020 -0500

    [Issue #163] Remove logger instance variable.

commit 0fe56b4c8e8fb92338b901c3614dc1b3fb9335b8
Author: Darryl L. Pierce <mcpierce@gmail.com>
Date:   Sat Feb 29 14:37:13 2020 -0500

    [Issue #163] Rename filename => comicFilename.

commit 388e6dda5ed4a451b64a06457cf8995756fe9ec6
Author: Darryl L. Pierce <mcpierce@gmail.com>
Date:   Sat Feb 29 14:35:32 2020 -0500

    [Issue #163] Throw TaskException instead of Exception.

commit 61b87ba082a0a6b2eb7319f1e874bf0de3040bec
Author: Darryl L. Pierce <mcpierce@gmail.com>
Date:   Sat Feb 29 14:34:14 2020 -0500

    [Issue #163] Convert HashMap to EnumMap.

commit 9d234260321a5da382428a3505b3ce30badecf15
Author: Darryl L. Pierce <mcpierce@gmail.com>
Date:   Sat Feb 29 14:30:55 2020 -0500

    [Issue #163] Convert TaskType enums to all caps.
  • Loading branch information
mcpierce committed Jun 21, 2020
1 parent edac686 commit 1e6602e
Show file tree
Hide file tree
Showing 22 changed files with 46 additions and 57 deletions.
Expand Up @@ -24,9 +24,9 @@
* @author Darryl L. Pierce
*/
public enum TaskType {
AddComic,
ProcessComic,
RescanComic,
DeleteComic,
DeleteComics;
ADD_COMIC,
PROCESS_COMIC,
RESCAN_COMIC,
DELETE_COMIC,
DELETE_COMICS;
}
Expand Up @@ -61,7 +61,7 @@ public void testGetTasksToRun() {
assertFalse(result.isEmpty());
final Task task = result.get(0);
assertEquals(TEST_FIRST_TASK_ID, task.getId().longValue());
assertSame(TaskType.AddComic, task.getTaskType());
assertSame(TaskType.ADD_COMIC, task.getTaskType());
assertEquals(TEST_ADD_COMIC_FILENAME, task.getProperty("filename"));
assertTrue(Boolean.valueOf(task.getProperty("delete-blocked-pages")));
assertFalse(Boolean.valueOf(task.getProperty("ignore-metadata")));
Expand Down
6 changes: 3 additions & 3 deletions comixed-library/src/test/resources/test-comics.xml
Expand Up @@ -141,7 +141,7 @@
scan_type_id="2"
format_id="1"/>
<tasks id="1000"
task_type="AddComic"
task_type="ADD_COMIC"
created="2020-02-19 08:24:00"/>
<task_properties task_id="1000"
name="filename"
Expand All @@ -153,11 +153,11 @@
name="ignore-metadata"
value="false"/>
<tasks id="1001"
task_type="ProcessComic"
task_type="PROCESS_COMIC"
comic_id="1000"
created="2020-02-19 08:24:00"/>
<tasks id="1002"
task_type="AddComic"
task_type="ADD_COMIC"
created="2020-02-19 08:24:00"/>
<comic_characters comic_id="1000"
character_name="Captain America"/>
Expand Down
Expand Up @@ -126,8 +126,8 @@ private void loadFilesUnder(final List<FileDetails> files, final File directory)
}

public int getImportStatus() throws InterruptedException {
return this.taskService.getTaskCount(TaskType.AddComic)
+ this.taskService.getTaskCount(TaskType.ProcessComic);
return this.taskService.getTaskCount(TaskType.ADD_COMIC)
+ this.taskService.getTaskCount(TaskType.PROCESS_COMIC);
}

public int importComicFiles(
Expand Down
Expand Up @@ -144,7 +144,7 @@ public Comic updateComic(final long id, final Comic update) {
public long getProcessingCount() {
this.logger.debug("Getting the current processing count");

final long result = this.taskService.getTaskCount(TaskType.ProcessComic);
final long result = this.taskService.getTaskCount(TaskType.PROCESS_COMIC);

this.logger.debug("There {} {} record{} to be processed", result, result == 1 ? "" : "s");

Expand All @@ -154,7 +154,7 @@ public long getProcessingCount() {
public int getRescanCount() {
this.logger.debug("Getting the current rescan count");

return this.taskService.getTaskCount(TaskType.RescanComic);
return this.taskService.getTaskCount(TaskType.RESCAN_COMIC);
}

public List<LastReadDate> getLastReadDatesSince(final String email, final long timestamp) {
Expand Down Expand Up @@ -195,7 +195,7 @@ public int rescanComics() {
count++;
try {
this.logger.debug("Queueing comic for rescan: {}", comic.getFilename());
RescanComicTaskEncoder encoder = this.taskAdaptor.getEncoder(TaskType.RescanComic);
RescanComicTaskEncoder encoder = this.taskAdaptor.getEncoder(TaskType.RESCAN_COMIC);

encoder.setComic(comic);
this.taskAdaptor.save(encoder.encode());
Expand Down
Expand Up @@ -77,6 +77,6 @@ public List<LastReadDate> getLastReadDatesSince(String email, Date lastReadDate)

public long getProcessingCount() {
this.logger.debug("Getting processing count");
return this.taskService.getTaskCount(TaskType.ProcessComic);
return this.taskService.getTaskCount(TaskType.PROCESS_COMIC);
}
}
Expand Up @@ -154,8 +154,8 @@ public void testGetAllComicsUnder() throws IOException {
public void testGetImportStatus() throws NoSuchAlgorithmException, InterruptedException {
int addCount = SecureRandom.getInstanceStrong().nextInt(21275);
int importCount = SecureRandom.getInstanceStrong().nextInt(21275);
Mockito.when(taskService.getTaskCount(TaskType.AddComic)).thenReturn(addCount);
Mockito.when(taskService.getTaskCount(TaskType.ProcessComic)).thenReturn(importCount);
Mockito.when(taskService.getTaskCount(TaskType.ADD_COMIC)).thenReturn(addCount);
Mockito.when(taskService.getTaskCount(TaskType.PROCESS_COMIC)).thenReturn(importCount);

int result = service.getImportStatus();

Expand Down
Expand Up @@ -328,14 +328,14 @@ public void testUpdateComic() {

@Test
public void testGetProcessingCount() {
Mockito.when(taskService.getTaskCount(TaskType.ProcessComic)).thenReturn(10);
Mockito.when(taskService.getTaskCount(TaskType.PROCESS_COMIC)).thenReturn(10);

assertEquals(10, this.comicService.getProcessingCount());
}

@Test
public void testGetRescanCount() {
Mockito.when(taskService.getTaskCount(TaskType.RescanComic)).thenReturn(10);
Mockito.when(taskService.getTaskCount(TaskType.RESCAN_COMIC)).thenReturn(10);

assertEquals(10, this.comicService.getRescanCount());
}
Expand Down Expand Up @@ -383,7 +383,7 @@ public void testRescanComics() throws TaskException {
assertEquals(comics.size(), result);

Mockito.verify(comicRepository, Mockito.times(1)).findAll();
Mockito.verify(taskAdaptor, Mockito.times(1)).getEncoder(TaskType.RescanComic);
Mockito.verify(taskAdaptor, Mockito.times(1)).getEncoder(TaskType.RESCAN_COMIC);
Mockito.verify(taskEncoder, Mockito.times(1)).setComic(comic);
}

Expand Down
Expand Up @@ -81,7 +81,8 @@ public void testGetComicsUpdatedSince() {

@Test
public void testGetProcessingCount() {
Mockito.when(taskService.getTaskCount(TaskType.ProcessComic)).thenReturn(TEST_PROCESSING_COUNT);
Mockito.when(taskService.getTaskCount(TaskType.PROCESS_COMIC))
.thenReturn(TEST_PROCESSING_COUNT);

long result = libraryService.getProcessingCount();

Expand Down
Expand Up @@ -41,7 +41,7 @@ public void testGetTaskCount() {
Mockito.when(taskRepository.getTaskCount(Mockito.any(TaskType.class)))
.thenReturn(TEST_TASK_COUNT);

final int result = service.getTaskCount(TaskType.AddComic);
final int result = service.getTaskCount(TaskType.ADD_COMIC);

assertEquals(TEST_TASK_COUNT, result);
}
Expand Down
Expand Up @@ -19,7 +19,7 @@
package org.comixed.task.adaptors;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.EnumMap;
import java.util.List;
import java.util.Map;
import org.comixed.model.tasks.Task;
Expand Down Expand Up @@ -50,7 +50,7 @@ public class TaskAdaptor implements InitializingBean {
@Autowired private TaskRepository taskRepository;

private List<TaskTypeEntry> adaptors = new ArrayList<>();
Map<TaskType, String> adaptorMap = new HashMap<>();
Map<TaskType, String> adaptorMap = new EnumMap<>(TaskType.class);

public List<TaskTypeEntry> getAdaptors() {
return adaptors;
Expand Down Expand Up @@ -79,10 +79,10 @@ public void afterPropertiesSet() throws Exception {
this.adaptorMap.clear();
for (TaskTypeEntry entry : this.adaptors) {
if (this.adaptorMap.containsKey(entry.getType())) {
throw new Exception("Configuration already set for type: " + entry.getType());
throw new TaskException("Configuration already set for type: " + entry.getType());
} else {
if (!this.applicationContext.containsBean(entry.getName()))
throw new Exception("Missing decoder bean: " + entry.getName());
throw new TaskException("Missing decoder bean: " + entry.getName());

this.adaptorMap.put(entry.getType(), entry.getName());
}
Expand Down
Expand Up @@ -40,21 +40,21 @@ public class AddComicTaskEncoder extends AbstractTaskEncoder<AddComicWorkerTask>

@Autowired private ObjectFactory<AddComicWorkerTask> addComicWorkerTaskObjectFactory;

private String filename;
private String comicFilename;
private boolean deleteBlockedPages;
private boolean ignoreMetadata;

@Override
public Task encode() {
this.logger.debug(
"Encoding add comic task: filename={} delete blocked pages={} ignore metadata={}",
this.filename,
this.comicFilename,
this.deleteBlockedPages,
this.ignoreMetadata);

final Task result = new Task();

result.setProperty(FILENAME, this.filename);
result.setProperty(FILENAME, this.comicFilename);
result.setProperty(DELETE_BLOCKED_PAGES, String.valueOf(this.deleteBlockedPages));
result.setProperty(IGNORE_METADATA, String.valueOf(this.ignoreMetadata));

Expand All @@ -75,8 +75,8 @@ public AddComicWorkerTask decode(final Task task) {
return result;
}

public void setFilename(final String filename) {
this.filename = filename;
public void setComicFilename(final String comicFilename) {
this.comicFilename = comicFilename;
}

public void setDeleteBlockedPages(final boolean deleteBlockedPages) {
Expand Down
Expand Up @@ -22,8 +22,6 @@
import org.comixed.model.tasks.Task;
import org.comixed.model.tasks.TaskType;
import org.comixed.task.model.DeleteComicWorkerTask;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.ObjectFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
Expand All @@ -35,8 +33,6 @@
public class DeleteComicTaskEncoder extends AbstractTaskEncoder<DeleteComicWorkerTask> {
public static final String DELETE_COMIC = "delete-comic";

private final Logger logger = LoggerFactory.getLogger(this.getClass());

@Autowired private ObjectFactory<DeleteComicWorkerTask> deleteComicWorkerTaskObjectFactory;

private Comic comic;
Expand All @@ -47,7 +43,7 @@ public Task encode() {
this.logger.debug("Encoding delete comic task: comic={}", this.comic.getId());

final Task result = new Task();
result.setTaskType(TaskType.DeleteComic);
result.setTaskType(TaskType.DELETE_COMIC);
result.setComic(comic);
result.setProperty(DELETE_COMIC, String.valueOf(this.deleteComicFile));
return result;
Expand Down
Expand Up @@ -22,8 +22,6 @@
import org.comixed.model.tasks.Task;
import org.comixed.model.tasks.TaskType;
import org.comixed.task.model.ProcessComicTask;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.ObjectFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
Expand All @@ -36,8 +34,6 @@ public class ProcessComicTaskEncoder extends AbstractTaskEncoder<ProcessComicTas
public static final String DELETE_BLOCKED_PAGES = "delete-blocked-pages";
public static final String IGNORE_METADATA = "ignore-metadata";

private Logger logger = LoggerFactory.getLogger(this.getClass());

@Autowired private ObjectFactory<ProcessComicTask> processComicTaskObjectFactory;

private Comic comic;
Expand All @@ -54,7 +50,7 @@ public Task encode() {

final Task result = new Task();

result.setTaskType(TaskType.ProcessComic);
result.setTaskType(TaskType.PROCESS_COMIC);
result.setComic(this.comic);
result.setProperty(DELETE_BLOCKED_PAGES, String.valueOf(this.deleteBlockedPages));
result.setProperty(IGNORE_METADATA, String.valueOf(this.ignoreMetadata));
Expand Down
Expand Up @@ -23,8 +23,6 @@
import org.comixed.model.tasks.TaskType;
import org.comixed.repositories.tasks.TaskRepository;
import org.comixed.task.model.RescanComicWorkerTask;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.ObjectFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
Expand All @@ -34,8 +32,6 @@
@Component
@Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
public class RescanComicTaskEncoder extends AbstractTaskEncoder<RescanComicWorkerTask> {
private final Logger logger = LoggerFactory.getLogger(this.getClass());

@Autowired private TaskRepository taskRepository;
@Autowired private ObjectFactory<RescanComicWorkerTask> rescanComicWorkerTaskObjectFactory;

Expand All @@ -50,7 +46,7 @@ public Task encode() {
this.logger.debug("Encoding rescan comic task: comic={}", this.comic.getId());

final Task result = new Task();
result.setTaskType(TaskType.RescanComic);
result.setTaskType(TaskType.RESCAN_COMIC);
result.setComic(this.comic);
result.setProperty("DUMMY", "PROPERTY");

Expand Down
Expand Up @@ -58,7 +58,7 @@ public void startTask() throws WorkerTaskException {
if (comic != null) {
try {
final DeleteComicTaskEncoder encoder;
encoder = this.taskAdaptor.getEncoder(TaskType.DeleteComic);
encoder = this.taskAdaptor.getEncoder(TaskType.DELETE_COMIC);
encoder.setComic(comic);
encoder.setDeleteComicFile(false);
this.taskAdaptor.save(encoder.encode());
Expand Down
Expand Up @@ -81,7 +81,7 @@ public void startTask() throws WorkerTaskException {

this.logger.debug("Comic file: {}", filename);

task.setTaskType(TaskType.AddComic);
task.setTaskType(TaskType.ADD_COMIC);
task.setProperty(AddComicTaskEncoder.FILENAME, filename);
task.setProperty(
AddComicTaskEncoder.DELETE_BLOCKED_PAGES, String.valueOf(this.deleteBlockedPages));
Expand Down
Expand Up @@ -52,15 +52,15 @@ public class TaskAdaptorTest {
public void testGetAdaptorForUnsupportedTask() throws TaskException {
adaptor.adaptorMap.clear();

adaptor.getEncoder(TaskType.AddComic);
adaptor.getEncoder(TaskType.ADD_COMIC);
}

@Test
public void testGetAdaptor() throws TaskException {
adaptor.adaptorMap.put(TaskType.AddComic, TEST_ADAPTOR_NAME);
adaptor.adaptorMap.put(TaskType.ADD_COMIC, TEST_ADAPTOR_NAME);
Mockito.when(applicationContext.getBean(Mockito.anyString())).thenReturn(taskEncoder);

final TaskEncoder<?> result = adaptor.getEncoder(TaskType.AddComic);
final TaskEncoder<?> result = adaptor.getEncoder(TaskType.ADD_COMIC);

assertNotNull(result);
assertSame(taskEncoder, result);
Expand Down
Expand Up @@ -49,7 +49,7 @@ public class AddComicTaskEncoderTest {

@Test
public void testEncode() {
adaptor.setFilename(TEST_FILENAME);
adaptor.setComicFilename(TEST_FILENAME);
adaptor.setDeleteBlockedPages(deleteBlockedPages);
adaptor.setIgnoreMetadata(ignoreMetadata);

Expand Down
Expand Up @@ -55,7 +55,7 @@ public void testEncode() {
final Task result = encoder.encode();

assertNotNull(result);
assertSame(TaskType.ProcessComic, result.getTaskType());
assertSame(TaskType.PROCESS_COMIC, result.getTaskType());
assertSame(comic, result.getComic());
assertEquals(
this.deleteBlockedPages,
Expand Down
Expand Up @@ -57,7 +57,7 @@ public void testStartTask() throws WorkerTaskException, TaskException {
task.setComicIds(ids);
task.startTask();

Mockito.verify(taskAdaptor, Mockito.times(ids.size())).getEncoder(TaskType.DeleteComic);
Mockito.verify(taskAdaptor, Mockito.times(ids.size())).getEncoder(TaskType.DELETE_COMIC);
Mockito.verify(deleteComicTaskEncoder, Mockito.times(ids.size())).setComic(comic);
Mockito.verify(deleteComicTaskEncoder, Mockito.times(ids.size())).setDeleteComicFile(false);
Mockito.verify(taskAdaptor, Mockito.times(ids.size())).save(taskArgumentCaptor.getValue());
Expand Down
Expand Up @@ -73,7 +73,7 @@ public void testStartTaskDeleteBlockedPages() throws WorkerTaskException {
workerTask.startTask();

final Task record = taskArgumentCaptor.getValue();
assertEquals(TaskType.AddComic, record.getTaskType());
assertEquals(TaskType.ADD_COMIC, record.getTaskType());
assertEquals(filenames.get(0), record.getProperty(AddComicTaskEncoder.FILENAME));
assertEquals(
Boolean.TRUE.toString(), record.getProperty(AddComicTaskEncoder.DELETE_BLOCKED_PAGES));
Expand All @@ -93,7 +93,7 @@ public void testStartTaskIgnoreMetadata() throws WorkerTaskException {
workerTask.startTask();

final Task record = taskArgumentCaptor.getValue();
assertEquals(TaskType.AddComic, record.getTaskType());
assertEquals(TaskType.ADD_COMIC, record.getTaskType());
assertEquals(filenames.get(0), record.getProperty(AddComicTaskEncoder.FILENAME));
assertEquals(
Boolean.FALSE.toString(), record.getProperty(AddComicTaskEncoder.DELETE_BLOCKED_PAGES));
Expand All @@ -113,7 +113,7 @@ public void testStartTaskDeleteBlockedPagesAndIgnoreMetadata() throws WorkerTask
workerTask.startTask();

final Task record = taskArgumentCaptor.getValue();
assertEquals(TaskType.AddComic, record.getTaskType());
assertEquals(TaskType.ADD_COMIC, record.getTaskType());
assertEquals(filenames.get(0), record.getProperty(AddComicTaskEncoder.FILENAME));
assertEquals(
Boolean.TRUE.toString(), record.getProperty(AddComicTaskEncoder.DELETE_BLOCKED_PAGES));
Expand Down

0 comments on commit 1e6602e

Please sign in to comment.