Refactored features: create and delete flashcard sets so that they access DBGateway instead of the individual data access classes.

Edward-1117 · Edward-1117 · commit f8628bab5f7c · 2022-11-20T15:30:17.000-05:00
diff --git a/src/main/java/create_flashcardset_use_case/FlashcardSetInteractor.java b/src/main/java/create_flashcardset_use_case/FlashcardSetInteractor.java
@@ -1,5 +1,6 @@
 package create_flashcardset_use_case;
 
+import dataAccess.DBGateway;
 import dataAccess.IFlashcardSetDataAccess;
 import entities.FlashcardSet;
 import entities.FlashcardSetFactory;
@@ -24,12 +25,20 @@
  */
 
 public class FlashcardSetInteractor implements FlashcardSetInputBoundary {
-
-    IFlashcardSetDataAccess flashcardSetDataAccess;
+    DBGateway dbGateway;
+    IFlashcardSetDataAccess flashcardSetDataAccess;  // for testing
     FlashcardSetOutputBoundary flashcardSetOutputBoundary;
     FlashcardSetFactory flashcardSetFactory;
 
 
+    public FlashcardSetInteractor(DBGateway dbGateway, FlashcardSetOutputBoundary flashcardSetOutputBoundary,
+                                  FlashcardSetFactory flashcardSetFactory) {
+        this.dbGateway = dbGateway;
+        this.flashcardSetOutputBoundary = flashcardSetOutputBoundary;
+        this.flashcardSetFactory = flashcardSetFactory;
+    }
+
+    // Alternative construction for testing purposes
     public FlashcardSetInteractor(IFlashcardSetDataAccess flashcardSetDataAccess,
                                   FlashcardSetOutputBoundary flashcardSetOutputBoundary,
                                   FlashcardSetFactory flashcardSetFactory) {
@@ -61,17 +70,22 @@ public FlashcardSetResponseModel create(FlashcardSetRequestModel inputData) thro
                 inputData.isPrivate(), tempFlashcardSetId, inputData.getUsername());
 
         // store the flashcard set into database
-        ArrayList<Integer> flashcardIds= new ArrayList<>();  // set starts with empty list of flashcard ids for database
-        FlashcardSetDsRequestModel dsRequestModel= new FlashcardSetDsRequestModel(fs.getTitle(), fs.getDescription(),
+        ArrayList<Integer> flashcardIds = new ArrayList<>();  // set starts with empty list of flashcard ids for database
+        FlashcardSetDsRequestModel dsRequestModel = new FlashcardSetDsRequestModel(fs.getTitle(), fs.getDescription(),
                 fs.getIsPrivate(), tempFlashcardSetId, fs.getOwnerUsername(), flashcardIds);
 
-        flashcardSetDataAccess.saveFlashcardSet(dsRequestModel);
-        FlashcardSetResponseModel responseModel = new FlashcardSetResponseModel(fs);
+        try {
+            dbGateway.saveFlashcardSet(dsRequestModel);
+            FlashcardSetResponseModel responseModel = new FlashcardSetResponseModel(fs);
+            return flashcardSetOutputBoundary.prepareSuccessView(responseModel);
+        } catch (Exception e) {
+            return null;
+        }
+//        dbGateway.saveFlashcardSet(dsRequestModel);
+//        FlashcardSetResponseModel responseModel = new FlashcardSetResponseModel(fs);
 
-        return flashcardSetOutputBoundary.prepareSuccessView(responseModel);
+//        return flashcardSetOutputBoundary.prepareSuccessView(responseModel);
     }
 
 
-
-
 }
diff --git a/src/main/java/create_flashcardset_use_case/FlashcardSetRequestModel.java b/src/main/java/create_flashcardset_use_case/FlashcardSetRequestModel.java
@@ -7,14 +7,12 @@ public class FlashcardSetRequestModel {
     private String description;
     private boolean isPrivate;
     private String username;
-//    private String action;  // e.g., when user clicks on "discard" button, action sends "discard" string
 
     public FlashcardSetRequestModel(String title, String description, boolean isPrivate, String username) {
         this.title = title;
         this.description = description;
         this.isPrivate = isPrivate;
         this.username = username;
-//        this.action = action;
     }
 
     public String getTitle() {
@@ -41,15 +39,12 @@ public void setPrivate(boolean aPrivate) {
         isPrivate = aPrivate;
     }
 
-    public String getUsername() {return username;}
+    public String getUsername() {
+        return username;
+    }
 
-    public void setUsername(String username) {this.username = username; }
+    public void setUsername(String username) {
+        this.username = username;
+    }
 
-//    public String getAction() {
-//        return action;
-//    }
-//
-//    public void setAction(String action) {
-//        this.action = action;
-//    }
 }
diff --git a/src/main/java/create_flashcardset_use_case/InMemoryFlashcardSet.java b/src/main/java/create_flashcardset_use_case/InMemoryFlashcardSet.java
@@ -63,21 +63,6 @@ public void removeFlashcardId(int flashcardSetId, int flashcardId) {
 
     }
 
-    /**
-     * @param flashcardSetId the id of the flashcard set
-     * @param title the title of the flashcard set
-     * @param description the description of the flashcard set
-     */
-
-    public void editTitleAndDescription(int flashcardSetId, String title, String description) {
-        for (FlashcardSetDsRequestModel fs : flashcardSets) {
-            if (checkIds(fs.getFlashcardSetId(), flashcardSetId)) {
-                fs.setTitle(title);
-                fs.setDescription(description);
-            }
-        }
-    }
-
     /**
      * @param flashcardSetId the id of the flashcard set
      */
diff --git a/src/main/java/create_flashcardset_use_case/MainCreateFlashcardSet.java b/src/main/java/create_flashcardset_use_case/MainCreateFlashcardSet.java
@@ -1,7 +1,6 @@
 package create_flashcardset_use_case;
 
-import dataAccess.FlashcardSetDataAccess;
-import dataAccess.IFlashcardSetDataAccess;
+import dataAccess.*;
 import entities.FlashcardSetFactory;
 
 import javax.swing.*;
@@ -20,15 +19,11 @@ public static void main(String[] args) {
         application.add(screens);
 
         // Create the parts to plug into the Use Case+Entities engine
-        IFlashcardSetDataAccess flashcardSetRepo;
-        try {
-            flashcardSetRepo = new FlashcardSetDataAccess("src/data/FlashcardSets.csv");
-        } catch (IOException e) {
-            throw new RuntimeException("Could not create file.");
-        }
+        DBGateway dbGateway = dbGatewaySetup();
+
         FlashcardSetOutputBoundary outputBoundary = new FlashcardSetPresenter();
         FlashcardSetFactory flashcardSetFactory = new FlashcardSetFactory();
-        FlashcardSetInputBoundary interactor = new FlashcardSetInteractor(flashcardSetRepo, outputBoundary,
+        FlashcardSetInputBoundary interactor = new FlashcardSetInteractor(dbGateway, outputBoundary,
                 flashcardSetFactory);
         FlashcardSetController flashcardSetController = new FlashcardSetController(
                 interactor
@@ -41,4 +36,19 @@ public static void main(String[] args) {
         application.pack();
         application.setVisible(true);
     }
+
+    public static DBGateway dbGatewaySetup() {
+        IFlashcardSetDataAccess flashcardSetRepo;
+        IFlashcardDataAccess flashcardRepo;
+        IUserDataAccess userRepo;
+        try {
+            flashcardSetRepo = new FlashcardSetDataAccess("src/data/FlashcardSets.csv");
+            flashcardRepo = new FlashcardDataAccess("src/data/Flashcards.csv");
+            userRepo = new CommonUserDataAccess("src/data/Users.csv");
+        } catch (IOException e) {
+            throw new RuntimeException("Could not create file.");
+        }
+
+        return new DBGateway(flashcardRepo, flashcardSetRepo, userRepo);
+    }
 }
diff --git a/src/test/java/create_flashcardset_use_case/FlashcardSetInteractorTest.java b/src/test/java/create_flashcardset_use_case/FlashcardSetInteractorTest.java
@@ -78,6 +78,7 @@ public FlashcardSetResponseModel prepareSuccessView(FlashcardSetResponseModel fs
                 fail("Something went wrong since we are testing for failing creation.");
                 return null;
             }
+
             @Override
             public FlashcardSetResponseModel prepareFailView(String error) {
                 throw new FlashcardSetCreationFailed("Title is missing!");
@@ -90,7 +91,7 @@ public FlashcardSetResponseModel prepareFailView(String error) {
         // Test part
         try {
             interactor.create(requestModel);  // no title should go immediately to catch block (i.e., pass test)
-            assert(false);  // if title is included, then this line is reached and test fails
+            assert (false);  // if title is included, then this line is reached and test fails
         } catch (FlashcardSetCreationFailed e) {
 
         }
@@ -111,6 +112,7 @@ public FlashcardSetResponseModel prepareSuccessView(FlashcardSetResponseModel fs
                 fail("Something went wrong since we are testing for failing creation.");
                 return null;
             }
+
             @Override
             public FlashcardSetResponseModel prepareFailView(String error) {
                 throw new FlashcardSetCreationFailed("Description is missing!");
@@ -123,7 +125,7 @@ public FlashcardSetResponseModel prepareFailView(String error) {
         // Test part
         try {
             interactor.create(requestModel);
-            assert(false);
+            assert (false);
         } catch (FlashcardSetCreationFailed e) {
 
         }
@@ -144,6 +146,7 @@ public FlashcardSetResponseModel prepareSuccessView(FlashcardSetResponseModel fs
                 fail("Something went wrong since we are testing for failing creation.");
                 return null;
             }
+
             @Override
             public FlashcardSetResponseModel prepareFailView(String error) {
                 throw new FlashcardSetCreationFailed("Username is missing!");
@@ -156,7 +159,7 @@ public FlashcardSetResponseModel prepareFailView(String error) {
         // Test part
         try {
             interactor.create(requestModel);
-            assert(false);
+            assert (false);
         } catch (FlashcardSetCreationFailed e) {
 
         }
diff --git a/src/test/java/delete_flashcardset_use_case/DelFlashcardSetInteractorTest.java b/src/test/java/delete_flashcardset_use_case/DelFlashcardSetInteractorTest.java
@@ -91,8 +91,22 @@ public void testDelete() {
 
         // Create the arguments for the interactor
         DelFlashcardSetOutputBoundary presenter = new DelFlashcardSetPresenter();
-        DelFlashcardSetInputBoundary interactor = new DelFlashcardSetInteractor(flashcardSetRepo,
-                flashcardRepo, presenter);
+        DelFlashcardSetInputBoundary interactor = requestModel -> {
+            if (flashcardSetRepo.getFlashcardSet(requestModel.getFlashcardSetId()) == null) {
+                return presenter.prepareFailView("Flashcard set #"
+                        + requestModel.getFlashcardSetId() + " doesn't exist.");
+            } else {
+                // First delete all the flashcards associated with this flashcard set in Flashcards.csv
+                for (int id : flashcardSetRepo.getFlashcardSet(requestModel.getFlashcardSetId()).getFlashcardIds()) {
+                    flashcardRepo.deleteFlashcard(id);
+                }
+                // Then delete the flashcard set in FlashcardSets.csv
+                flashcardSetRepo.deleteFlashcardSet(requestModel.getFlashcardSetId());
+
+                return presenter.prepareSuccessView("Flashcard set #" + requestModel.getFlashcardSetId()
+                        + " has been deleted.");
+            }
+        };
 
         // Use the interactor to delete fs1
         interactor.delete(inputData);
@@ -129,15 +143,31 @@ public DelFlashcardSetResponseModel prepareFailView(String error) throws Flashca
             }
         };
 
+        DelFlashcardSetOutputBoundary presenter = new DelFlashcardSetPresenter();
+
         // Construct the interactor
-        DelFlashcardSetInputBoundary interactor = new DelFlashcardSetInteractor(flashcardSetRepo, flashcardRepo,
-                outputBoundary);
+        DelFlashcardSetInputBoundary interactor = requestModel -> {
+            if (flashcardSetRepo.getFlashcardSet(requestModel.getFlashcardSetId()) == null) {
+                return presenter.prepareFailView("Flashcard set #"
+                        + requestModel.getFlashcardSetId() + " doesn't exist.");
+            } else {
+                // First delete all the flashcards associated with this flashcard set in Flashcards.csv
+                for (int id : flashcardSetRepo.getFlashcardSet(requestModel.getFlashcardSetId()).getFlashcardIds()) {
+                    flashcardRepo.deleteFlashcard(id);
+                }
+                // Then delete the flashcard set in FlashcardSets.csv
+                flashcardSetRepo.deleteFlashcardSet(requestModel.getFlashcardSetId());
+
+                return presenter.prepareSuccessView("Flashcard set #" + requestModel.getFlashcardSetId()
+                        + " has been deleted.");
+            }
+        };
 
 
         // Test part
         try {
             interactor.delete(inputData);  // invalid id should go immediately to catch block (i.e., pass test)
-            assert(false);  // if id exists, then this line is reached and test fails
+            assert (false);  // if id exists, then this line is reached and test fails
         } catch (FlashcardSetNotFound e) {
 
         }
