Implemented tests, fixed a bug in DBGateway, changes made to term and definition input, changed documentation

Junyu11111 · Junyu11111 · commit b447cda1cb2d · 2022-11-28T12:59:50.000-05:00
diff --git a/src/main/java/create_flashcard_use_case/FcCInputBoundary.java b/src/main/java/create_flashcard_use_case/FcCInputBoundary.java
@@ -1,7 +1,7 @@
 package create_flashcard_use_case;
 
 /**
- * Input boundary for flashcard creator.
+ * Input boundary for flashcard creation.
  * Application business rules.
  * @author Junyu Chen
  */
diff --git a/src/main/java/create_flashcard_use_case/FcCInteractor.java b/src/main/java/create_flashcard_use_case/FcCInteractor.java
@@ -7,7 +7,7 @@
 
 import java.time.LocalDateTime;
 /**
- * Interactor for flashcard creator.
+ * Interactor for flashcard creation.
  * Application business rules.
  * @author Junyu Chen
  */
diff --git a/src/main/java/create_flashcard_use_case/FcCMain.java b/src/main/java/create_flashcard_use_case/FcCMain.java
@@ -8,7 +8,7 @@
 import java.io.IOException;
 
 /**
- * Main frame for flashcard Creator.
+ * Main frame for flashcard Creation.
  * @author Junyu Chen
  */
 public class FcCMain extends JFrame {
diff --git a/src/main/java/create_flashcard_use_case/FcCOutputBoundary.java b/src/main/java/create_flashcard_use_case/FcCOutputBoundary.java
@@ -1,6 +1,6 @@
 package create_flashcard_use_case;
 /**
- * Presenter for flashcard creator.
+ * Presenter for flashcard creation.
  * Application business rules.
  * @author Junyu Chen
  */
diff --git a/src/main/java/create_flashcard_use_case/FcCRequestModel.java b/src/main/java/create_flashcard_use_case/FcCRequestModel.java
@@ -1,6 +1,6 @@
 package create_flashcard_use_case;
 /**
- * Request model for flashcard creator.
+ * Request model for flashcard creation.
  * Application business rules.
  * @author Junyu Chen
  */
diff --git a/src/main/java/create_flashcard_use_case/FcCResponseModel.java b/src/main/java/create_flashcard_use_case/FcCResponseModel.java
@@ -2,7 +2,7 @@
 
 import java.time.LocalDateTime;
 /**
- * Response model for flashcard creator.
+ * Response model for flashcard creation.
  * Application business rules.
  * @author Junyu Chen
  */
diff --git a/src/main/java/create_flashcard_use_case/fcCScreens/FcCController.java b/src/main/java/create_flashcard_use_case/fcCScreens/FcCController.java
@@ -5,7 +5,7 @@
 import create_flashcard_use_case.FcCResponseModel;
 
 /**
- * Controller for flashcard creator.
+ * Controller for flashcard creation.
  * Interface adaptors.
  * @author Junyu Chen
  */
diff --git a/src/main/java/create_flashcard_use_case/fcCScreens/FcCFailure.java b/src/main/java/create_flashcard_use_case/fcCScreens/FcCFailure.java
@@ -1,6 +1,6 @@
 package create_flashcard_use_case.fcCScreens;
 /**
- * Failure of flashcard creator.
+ * Failure of flashcard creation.
  * Interface Adaptors.
  * @author Junyu Chen
  */
diff --git a/src/main/java/create_flashcard_use_case/fcCScreens/FcCResponsePresenter.java b/src/main/java/create_flashcard_use_case/fcCScreens/FcCResponsePresenter.java
@@ -3,6 +3,11 @@
 import create_flashcard_use_case.FcCOutputBoundary;
 import create_flashcard_use_case.FcCResponseModel;
 
+/**
+ * Presenter for flashcard creation.
+ * Interface adaptors.
+ * @author Junyu Chen
+ */
 public class FcCResponsePresenter implements FcCOutputBoundary {
     @Override
     public FcCResponseModel prepareSuccessView(FcCResponseModel responseModel) {
diff --git a/src/main/java/create_flashcard_use_case/fcCScreens/FcCScreen.java b/src/main/java/create_flashcard_use_case/fcCScreens/FcCScreen.java
@@ -57,6 +57,10 @@ public FcCScreen(FcCController controller, JFrame fcCMain){
 
     }
 
+    /**
+     * Response based on creation success or failure.
+     * @param e the event to be processed
+     */
     @Override
     public void actionPerformed(ActionEvent e) {
         try{
diff --git a/src/main/java/create_flashcard_use_case/fcCScreens/InMemoryFlashcard.java b/src/main/java/create_flashcard_use_case/fcCScreens/InMemoryFlashcard.java
@@ -6,6 +6,10 @@
 import java.util.HashMap;
 import java.util.Map;
 
+/**
+ * Database for test purposes
+ * @author Junyu Chen
+ */
 public class InMemoryFlashcard implements IFlashcardDataAccess {
     private final Map<Integer, FlashcardDsRequestModel> flashcards = new HashMap<>();
     @Override
diff --git a/src/main/java/create_flashcard_use_case/fcCScreens/InMemoryFlashcardSet.java b/src/main/java/create_flashcard_use_case/fcCScreens/InMemoryFlashcardSet.java
@@ -6,6 +6,10 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * Database for test purposes
+ * @author Junyu Chen
+ */
 public class InMemoryFlashcardSet implements IFlashcardSetDataAccess {
     private final Map<Integer, FlashcardSetDsRequestModel> flashcardSets = new HashMap<>();
     @Override
diff --git a/src/main/java/data_access/DBGateway.java b/src/main/java/data_access/DBGateway.java
@@ -86,6 +86,7 @@ public void deleteFlashcardSet(String ownerUsername, int flashcardSetID) {
     }
 
     public int saveFlashcard(FlashcardDsRequestModel flashcard) {
+
         int id = this.flashcardGateway.saveFlashcard(flashcard);
         this.flashcardSetGateway.saveFlashcardID(flashcard.getBelongsToId(), id);
         return id;
diff --git a/src/main/java/delete_flashcard_use_case/FcRInputBoundary.java b/src/main/java/delete_flashcard_use_case/FcRInputBoundary.java
@@ -1,6 +1,6 @@
 package delete_flashcard_use_case;
 /**
- * Input boundary for flashcard remover.
+ * Input boundary for flashcard removal.
  * Application business rules.
  * @author Junyu Chen
  */
diff --git a/src/main/java/delete_flashcard_use_case/FcRInteractor.java b/src/main/java/delete_flashcard_use_case/FcRInteractor.java
@@ -4,7 +4,7 @@
 
 import java.time.LocalDateTime;
 /**
- * Interactor for flashcard remover.
+ * Interactor for flashcard removal.
  * Application business rules.
  * @author Junyu Chen
  */
diff --git a/src/main/java/delete_flashcard_use_case/FcRMain.java b/src/main/java/delete_flashcard_use_case/FcRMain.java
@@ -6,7 +6,7 @@
 import javax.swing.*;
 import java.io.IOException;
 /**
- * Main frame for flashcard Remover.
+ * Main frame for flashcard removal.
  * @author Junyu Chen
  */
 public class FcRMain extends JFrame {
diff --git a/src/main/java/delete_flashcard_use_case/FcROutputBoundary.java b/src/main/java/delete_flashcard_use_case/FcROutputBoundary.java
@@ -1,6 +1,6 @@
 package delete_flashcard_use_case;
 /**
- * Presenter for flashcard remover.
+ * Presenter for flashcard removal.
  * Application business rules.
  * @author Junyu Chen
  */
diff --git a/src/main/java/delete_flashcard_use_case/FcRRequestModel.java b/src/main/java/delete_flashcard_use_case/FcRRequestModel.java
@@ -1,6 +1,6 @@
 package delete_flashcard_use_case;
 /**
- * Request model for flashcard remover.
+ * Request model for flashcard removal.
  * Application business rules.
  * @author Junyu Chen
  */
diff --git a/src/main/java/delete_flashcard_use_case/FcRResponseModel.java b/src/main/java/delete_flashcard_use_case/FcRResponseModel.java
@@ -3,7 +3,7 @@
 import java.time.LocalDateTime;
 
 /**
- * Response model for flashcard remover.
+ * Response model for flashcard removal.
  * Application business rules.
  * @author Junyu Chen
  */
diff --git a/src/main/java/delete_flashcard_use_case/FcRScreens/FcRController.java b/src/main/java/delete_flashcard_use_case/FcRScreens/FcRController.java
@@ -5,7 +5,7 @@
 import delete_flashcard_use_case.FcRResponseModel;
 
 /**
- * Controller for flashcard Remover.
+ * Controller for flashcard Removal.
  * Interface adaptors.
  * @author Junyu Chen
  */
diff --git a/src/main/java/delete_flashcard_use_case/FcRScreens/FcRFailure.java b/src/main/java/delete_flashcard_use_case/FcRScreens/FcRFailure.java
@@ -1,6 +1,6 @@
 package delete_flashcard_use_case.FcRScreens;
 /**
- * Failure of flashcard remover.
+ * Failure of flashcard removal.
  * Interface Adaptors.
  * @author Junyu Chen
  */
diff --git a/src/main/java/delete_flashcard_use_case/FcRScreens/FcRResponsePresenter.java b/src/main/java/delete_flashcard_use_case/FcRScreens/FcRResponsePresenter.java
@@ -3,7 +3,7 @@
 import delete_flashcard_use_case.FcROutputBoundary;
 import delete_flashcard_use_case.FcRResponseModel;
 /**
- * Presenter for flashcard remover.
+ * Presenter for flashcard removal.
  * Interface adaptors.
  * @author Junyu Chen
  */
diff --git a/src/test/java/create_flashcard_use_case/FcCInteractorTest.java b/src/test/java/create_flashcard_use_case/FcCInteractorTest.java
@@ -7,11 +7,19 @@
 import create_flashcard_use_case.fcCScreens.*;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
+
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Tests for create_flashcard_use_case.FcCInteractor
+ * @author Junyu Chen
+ */
 public class FcCInteractorTest {
 
+    /**
+     * Test for creation of valid flashcard.
+     */
     @Test
     public void create_success(){
         IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
@@ -43,6 +51,9 @@ public FcCResponseModel prepareFailView(String error){
         interactor.create(new FcCRequestModel(0, "term", "definition"));
     }
 
+    /**
+     * Test for Creation of flashcard with empty term.
+     */
     @Test
     public void create_failure_empty_term(){
         IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
@@ -69,6 +80,9 @@ public FcCResponseModel prepareFailView(String error){
         interactor.create(new FcCRequestModel(0, "", "definition"));
     }
 
+    /**
+     * Test for Creation of flashcard with empty definition.
+     */
     @Test
     public void create_failure_empty_definition(){
         IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
@@ -95,6 +109,9 @@ public FcCResponseModel prepareFailView(String error){
         interactor.create(new FcCRequestModel(0, "term", ""));
     }
 
+    /**
+     * Test for Creation of flashcard with non-existing flashcard set.
+     */
     @Test
     public void create_failure_no_flashcard_set(){
         IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
diff --git a/src/test/java/delete_flashcard_use_case/FcRInteractorTest.java b/src/test/java/delete_flashcard_use_case/FcRInteractorTest.java
@@ -1,19 +1,25 @@
 package delete_flashcard_use_case;
 
+import create_flashcard_use_case.fcCScreens.*;
 import data_access.DBGateway;
 import data_access.IFlashcardDataAccess;
 import data_access.IFlashcardSetDataAccess;
 import data_access.entity_request_models.FlashcardDsRequestModel;
 import data_access.entity_request_models.FlashcardSetDsRequestModel;
-import create_flashcard_use_case.fcCScreens.InMemoryFlashcard;
-import create_flashcard_use_case.fcCScreens.InMemoryFlashcardSet;
 import delete_flashcard_use_case.FcRScreens.FcRResponsePresenter;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import java.time.LocalDateTime;
 import java.util.ArrayList;
 
+/**
+ * Tests for delete_flashcard_use_case.FcRInteractor
+ * @author Junyu Chen
+ */
 public class FcRInteractorTest {
+    /**
+     * Test deletion for valid delete request.
+     */
     @Test
     public void delete_success(){
         IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
@@ -43,6 +49,9 @@ public FcRResponseModel prepareFailView(String error){
         interactor.delete(new FcRRequestModel(0,0));
     }
 
+    /**
+     * Test deletion for delete request with non-existing flashcard.
+     */
     @Test
     public void delete_failure_no_flashcard(){
         IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
@@ -67,6 +76,9 @@ public FcRResponseModel prepareFailView(String error){
         interactor.delete(new FcRRequestModel(0,0));
     }
 
+    /**
+     * Test deletion for delete request with non-existing flashcard set.
+     */
     @Test
     public void delete_failure_no_flashcard_set(){
         IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
@@ -93,6 +105,9 @@ public FcRResponseModel prepareFailView(String error){
         interactor.delete(new FcRRequestModel(0,0));
     }
 
+    /**
+     * Test deletion for delete request with existing flashcard, but not in flashcard set.
+     */
     @Test
     public void delete_failure_flashcard_not_in_flashcard_set(){
         IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();

Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,10 @@ public FcCScreen(FcCController controller, JFrame fcCMain){`
`57`	`57`
`58`	`58`	`}`
`59`	`59`
	`60`	`+ /**`
	`61`	`+ * Response based on creation success or failure.`
	`62`	`+ * @param e the event to be processed`
	`63`	`+ */`
`60`	`64`	`@Override`
`61`	`65`	`public void actionPerformed(ActionEvent e) {`
`62`	`66`	`try{`