Merge pull request #81 from CSC207-2022F-UofT/feature-5-flashcard-creator-and-remover

Feature 5 flashcard creator and remover new

Author: Junyu11111

src/main/java/create_flashcard_use_case/FcCInteractor.java

@@ -40,8 +40,9 @@ public FcCResponseModel create(FcCRequestModel requestModel) {
             return presenter.prepareFailView("Flashcard set does not exist.");
         }
         LocalDateTime creationDate = LocalDateTime.now();
-        FlashcardDsRequestModel flashcard = new FlashcardDsRequestModel(requestModel.getTerm(),
-                requestModel.getDefinition(), creationDate,-1, requestModel.getFlashcardSetId());
+        FlashcardDsRequestModel flashcard = new FlashcardDsRequestModel(
+                requestModel.getTerm().replace("\n", " "),
+                requestModel.getDefinition().replace("\n", " "), creationDate,-1, requestModel.getFlashcardSetId());
         int flashcardId = fcDataAccess.saveFlashcard(flashcard);
         fcsDataAccess.saveFlashcardID(requestModel.getFlashcardSetId(), flashcardId);
 

src/main/java/create_flashcard_use_case/fcCScreens/FcCScreen.java

@@ -65,8 +65,8 @@ public FcCScreen(FcCController controller, JFrame fcCMain){
     public void actionPerformed(ActionEvent e) {
         try{
             //Success view.
-            FcCResponseModel responseModel = controller.create(term_text.getText().replace("\n", ""),
-                    definition_text.getText().replace("\n", ""));
+            FcCResponseModel responseModel = controller.create(term_text.getText().replace("\n", " "),
+                    definition_text.getText().replace("\n", " "));
             int action = JOptionPane.showConfirmDialog(this,
                     "Card created:\n"+responseModel.getTerm()+ "\n" + responseModel.getDefinition()
                             +"\ncreate another card?");

src/test/java/create_flashcard_use_case/FcCInteractorTest.java

@@ -22,14 +22,17 @@ public class FcCInteractorTest {
      */
     @Test
     public void create_success(){
+        //Creating database for the test.
         IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
         IFlashcardSetDataAccess flashcardSetDataAccess = new InMemoryFlashcardSet();
         DBGateway gateway = new DBGateway(flashcardDataAccess, flashcardSetDataAccess, null);
 
+        //Adding flash card set with id 0 for interactor to create flashcard in.
         flashcardSetDataAccess.saveFlashcardSet(new FlashcardSetDsRequestModel("test set","description",
                 true, 0, "user", new ArrayList<>()));
-
+        //Changed presenter for the test.
         FcCOutputBoundary presenter = new FcCOutputBoundary(){
+            //Check if the flashcard is saved when response from interactor is successful.
             @Override
             public FcCResponseModel prepareSuccessView(FcCResponseModel responseModel){
                 Assertions.assertEquals(gateway.getFlashcard(0).getTerm(), "term");
@@ -41,13 +44,15 @@ public FcCResponseModel prepareSuccessView(FcCResponseModel responseModel){
                 return null;
             }
 
+            //Errors should not happen.
             @Override
             public FcCResponseModel prepareFailView(String error){
                 Assertions.fail("Unexpected Failure.");
                 return null;
             }
         };
         FcCInputBoundary interactor = new FcCInteractor(gateway, presenter);
+        //Valid input for flashcard.
         interactor.create(new FcCRequestModel(0, "term", "definition"));
     }
 
@@ -56,27 +61,33 @@ public FcCResponseModel prepareFailView(String error){
      */
     @Test
     public void create_failure_empty_term(){
+        //Creating database for Flashcard
         IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
         IFlashcardSetDataAccess flashcardSetDataAccess = new InMemoryFlashcardSet();
         DBGateway gateway = new DBGateway(flashcardDataAccess, flashcardSetDataAccess, null);
 
+        //Adding flash card set with id 0 for interactor to create flashcard in.
         flashcardSetDataAccess.saveFlashcardSet(new FlashcardSetDsRequestModel("test set","description",
                 true, 0, "user", new ArrayList<>()));
 
+        //Changed presenter for the test.
         FcCOutputBoundary presenter = new FcCOutputBoundary(){
+            //Success should not happen with this input.
             @Override
             public FcCResponseModel prepareSuccessView(FcCResponseModel responseModel){
                 Assertions.fail("Unexpected success");
                 return null;
             }
 
+            ////Check if error thrown is correct
             @Override
             public FcCResponseModel prepareFailView(String error){
                 Assertions.assertEquals("Term or definition is empty.", error);
                 return null;
             }
         };
         FcCInputBoundary interactor = new FcCInteractor(gateway, presenter);
+        //Input with empty term.
         interactor.create(new FcCRequestModel(0, "", "definition"));
     }
 
@@ -85,56 +96,175 @@ public FcCResponseModel prepareFailView(String error){
      */
     @Test
     public void create_failure_empty_definition(){
+        //Creating data base
         IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
         IFlashcardSetDataAccess flashcardSetDataAccess = new InMemoryFlashcardSet();
         DBGateway gateway = new DBGateway(flashcardDataAccess, flashcardSetDataAccess, null);
 
+        //Adding test flashcard set.
         flashcardSetDataAccess.saveFlashcardSet(new FlashcardSetDsRequestModel("test set","description",
                 true, 0, "user", new ArrayList<>()));
 
+        //Creating new response for the test.
         FcCOutputBoundary presenter = new FcCOutputBoundary(){
+            //Success should not happen.
             @Override
             public FcCResponseModel prepareSuccessView(FcCResponseModel responseModel){
                 Assertions.fail("Unexpected success");
                 return null;
             }
 
+            //Check if error thrown is correct
             @Override
             public FcCResponseModel prepareFailView(String error){
                 Assertions.assertEquals("Term or definition is empty.", error);
                 return null;
             }
         };
         FcCInputBoundary interactor = new FcCInteractor(gateway, presenter);
+        //Input with empty definition.
         interactor.create(new FcCRequestModel(0, "term", ""));
     }
 
     /**
      * Test for Creation of flashcard with non-existing flashcard set.
      */
     @Test
-    public void create_failure_no_flashcard_set(){
+    public void create_failure_no_flashcard_set() {
+        //Creating database
         IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
         IFlashcardSetDataAccess flashcardSetDataAccess = new InMemoryFlashcardSet();
         DBGateway gateway = new DBGateway(flashcardDataAccess, flashcardSetDataAccess, null);
+        //No testing flashcard set.
+
+        //Creating presenter for test.
+        FcCOutputBoundary presenter = new FcCOutputBoundary() {
+            //Success should not happen.
+            @Override
+            public FcCResponseModel prepareSuccessView(FcCResponseModel responseModel) {
+                Assertions.fail("Unexpected success");
+                return null;
+            }
+
+            //Check if error thrown is correct.
+            @Override
+            public FcCResponseModel prepareFailView(String error) {
+                Assertions.assertEquals("Flashcard set does not exist.", error);
+                return null;
+            }
+        };
+        FcCInputBoundary interactor = new FcCInteractor(gateway, presenter);
+        //Flashcard creation.
+        interactor.create(new FcCRequestModel(0, "term", "definition"));
+    }
 
+    /**
+     * Test for Creation of flashcard with empty term and definition.
+     */
+    @Test
+    public void create_failure_empty_term_and_definition(){
+        //Creating database
+        IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
+        IFlashcardSetDataAccess flashcardSetDataAccess = new InMemoryFlashcardSet();
+        DBGateway gateway = new DBGateway(flashcardDataAccess, flashcardSetDataAccess, null);
+        //Adding testing flashcard set.
         flashcardSetDataAccess.saveFlashcardSet(new FlashcardSetDsRequestModel("test set","description",
                 true, 0, "user", new ArrayList<>()));
 
+        //Creating presenter for test.
         FcCOutputBoundary presenter = new FcCOutputBoundary(){
+            //Success should not happen.
             @Override
             public FcCResponseModel prepareSuccessView(FcCResponseModel responseModel){
                 Assertions.fail("Unexpected success");
                 return null;
             }
+            //Check if error thrown is correct.
+            @Override
+            public FcCResponseModel prepareFailView(String error){
+                Assertions.assertEquals("Term or definition is empty.", error);
+                return null;
+            }
+        };
+        FcCInputBoundary interactor = new FcCInteractor(gateway, presenter);
+        //Input with empty term and definition.
+        interactor.create(new FcCRequestModel(-1, "", ""));
+    }
+    /**
+     * Test for creation of valid flashcard with term of multiple lines.
+     */
+    @Test
+    public void create_success_multiple_lines_term(){
+        //Creating database for the test.
+        IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
+        IFlashcardSetDataAccess flashcardSetDataAccess = new InMemoryFlashcardSet();
+        DBGateway gateway = new DBGateway(flashcardDataAccess, flashcardSetDataAccess, null);
+
+        //Adding flash card set with id 0 for interactor to create flashcard in.
+        flashcardSetDataAccess.saveFlashcardSet(new FlashcardSetDsRequestModel("test set","description",
+                true, 0, "user", new ArrayList<>()));
+        //Changed presenter for the test.
+        FcCOutputBoundary presenter = new FcCOutputBoundary(){
+            //Check if the flashcard is saved when response from interactor is successful.
+            @Override
+            public FcCResponseModel prepareSuccessView(FcCResponseModel responseModel){
+                Assertions.assertEquals(gateway.getFlashcard(0).getTerm(), "term term");
+                Assertions.assertEquals(gateway.getFlashcard(0).getDefinition(), "definition");
+                List<Integer> ids = new ArrayList<>();
+                ids.add(0);
+                Assertions.assertEquals(gateway.getFlashcardSet(0).getFlashcardIds(),
+                        ids);
+                return null;
+            }
 
+            //Errors should not happen.
             @Override
             public FcCResponseModel prepareFailView(String error){
-                Assertions.assertEquals("Flashcard set does not exist.", error);
+                Assertions.fail("Unexpected Failure.");
+                return null;
+            }
+        };
+        FcCInputBoundary interactor = new FcCInteractor(gateway, presenter);
+        //Input with multiple lines.
+        interactor.create(new FcCRequestModel(0, "term\nterm", "definition"));
+    }
+    /**
+     * Test for creation of valid flashcard with definition of multiple lines.
+     */
+    @Test
+    public void create_success_multiple_lines_definition(){
+        //Creating database for the test.
+        IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
+        IFlashcardSetDataAccess flashcardSetDataAccess = new InMemoryFlashcardSet();
+        DBGateway gateway = new DBGateway(flashcardDataAccess, flashcardSetDataAccess, null);
+
+        //Adding flash card set with id 0 for interactor to create flashcard in.
+        flashcardSetDataAccess.saveFlashcardSet(new FlashcardSetDsRequestModel("test set","description",
+                true, 0, "user", new ArrayList<>()));
+        //Changed presenter for the test.
+        FcCOutputBoundary presenter = new FcCOutputBoundary(){
+            //Check if the flashcard is saved when response from interactor is successful.
+            @Override
+            public FcCResponseModel prepareSuccessView(FcCResponseModel responseModel){
+                Assertions.assertEquals(gateway.getFlashcard(0).getTerm(), "term");
+                Assertions.assertEquals(gateway.getFlashcard(0).getDefinition(),
+                        "definition definition");
+                List<Integer> ids = new ArrayList<>();
+                ids.add(0);
+                Assertions.assertEquals(gateway.getFlashcardSet(0).getFlashcardIds(),
+                        ids);
+                return null;
+            }
+
+            //Errors should not happen.
+            @Override
+            public FcCResponseModel prepareFailView(String error){
+                Assertions.fail("Unexpected Failure.");
                 return null;
             }
         };
         FcCInputBoundary interactor = new FcCInteractor(gateway, presenter);
-        interactor.create(new FcCRequestModel(-1, "term", "definition"));
+        //Input with multiple lines.
+        interactor.create(new FcCRequestModel(0, "term", "definition\ndefinition"));
     }
 }

src/test/java/delete_flashcard_use_case/FcRInteractorTest.java

@@ -22,13 +22,15 @@ public class FcRInteractorTest {
      */
     @Test
     public void delete_success(){
+        //Creating database for test.
         IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
         IFlashcardSetDataAccess flashcardSetDataAccess = new InMemoryFlashcardSet();
         DBGateway gateway = new DBGateway(flashcardDataAccess, flashcardSetDataAccess, null);
         flashcardSetDataAccess.saveFlashcardSet(new FlashcardSetDsRequestModel("title",
                 "description", true, 0,"User", new ArrayList<>()));
         gateway.saveFlashcard(new FlashcardDsRequestModel("term", "definition",
                 LocalDateTime.now(), 0,0));
+        //Creating presenter for test.
         FcROutputBoundary presenter = new FcRResponsePresenter(){
             @Override
             public FcRResponseModel prepareSuccessView(FcRResponseModel responseModel){
@@ -54,11 +56,13 @@ public FcRResponseModel prepareFailView(String error){
      */
     @Test
     public void delete_failure_no_flashcard(){
+        //Creating database for test.
         IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
         IFlashcardSetDataAccess flashcardSetDataAccess = new InMemoryFlashcardSet();
         DBGateway gateway = new DBGateway(flashcardDataAccess, flashcardSetDataAccess, null);
         flashcardSetDataAccess.saveFlashcardSet(new FlashcardSetDsRequestModel("title",
                 "description", true, 0,"User", new ArrayList<>()));
+        //Creating presenter for test.
         FcROutputBoundary presenter = new FcRResponsePresenter(){
             @Override
             public FcRResponseModel prepareSuccessView(FcRResponseModel responseModel){
@@ -81,13 +85,15 @@ public FcRResponseModel prepareFailView(String error){
      */
     @Test
     public void delete_failure_no_flashcard_set(){
+        //Creating database for test.
         IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
         IFlashcardSetDataAccess flashcardSetDataAccess = new InMemoryFlashcardSet();
         DBGateway gateway = new DBGateway(flashcardDataAccess, flashcardSetDataAccess, null);
         flashcardSetDataAccess.saveFlashcardSet(new FlashcardSetDsRequestModel("title",
                 "description", true, 1,"User", new ArrayList<>()));
         gateway.saveFlashcard(new FlashcardDsRequestModel("term", "definition",
                 LocalDateTime.now(), 0,1));
+        //Creating presenter for test.
         FcROutputBoundary presenter = new FcRResponsePresenter(){
             @Override
             public FcRResponseModel prepareSuccessView(FcRResponseModel responseModel){
@@ -109,30 +115,32 @@ public FcRResponseModel prepareFailView(String error){
      * Test deletion for delete request with existing flashcard, but not in flashcard set.
      */
     @Test
-    public void delete_failure_flashcard_not_in_flashcard_set(){
+    public void delete_failure_flashcard_not_in_flashcard_set() {
+        //Creating database for test.
         IFlashcardDataAccess flashcardDataAccess = new InMemoryFlashcard();
         IFlashcardSetDataAccess flashcardSetDataAccess = new InMemoryFlashcardSet();
         DBGateway gateway = new DBGateway(flashcardDataAccess, flashcardSetDataAccess, null);
         flashcardSetDataAccess.saveFlashcardSet(new FlashcardSetDsRequestModel("title",
-                "description", true, 0,"User", new ArrayList<>()));
+                "description", true, 0, "User", new ArrayList<>()));
         flashcardSetDataAccess.saveFlashcardSet(new FlashcardSetDsRequestModel("title",
-                "description", true, 1,"User", new ArrayList<>()));
+                "description", true, 1, "User", new ArrayList<>()));
         gateway.saveFlashcard(new FlashcardDsRequestModel("term", "definition",
-                LocalDateTime.now(), 0,1));
-        FcROutputBoundary presenter = new FcRResponsePresenter(){
+                LocalDateTime.now(), 0, 1));
+        //Creating presenter for test.
+        FcROutputBoundary presenter = new FcRResponsePresenter() {
             @Override
-            public FcRResponseModel prepareSuccessView(FcRResponseModel responseModel){
+            public FcRResponseModel prepareSuccessView(FcRResponseModel responseModel) {
                 Assertions.fail("Unexpected success.");
                 return null;
             }
 
             @Override
-            public FcRResponseModel prepareFailView(String error){
+            public FcRResponseModel prepareFailView(String error) {
                 Assertions.assertEquals("Flashcard not in this flashcard set.", error);
                 return null;
             }
         };
         FcRInputBoundary interactor = new FcRInteractor(gateway, presenter);
-        interactor.delete(new FcRRequestModel(0,0));
+        interactor.delete(new FcRRequestModel(0, 0));
     }
 }