Merge branch 'main' of https://github.com/CSC207-2022F-UofT/course-project-team-bbq into Anthony's_Branch

Author: anthony-chen-ca

.idea/misc.xml

@@ -1,6 +1,6 @@
 import com.formdev.flatlaf.FlatDarculaLaf;
 
-import login_and_signup_use_case.login_and_signup_use_case_screens.WelcomeScreen;
+import frameworks_and_drivers.screens.WelcomeScreen;
 
 import java.io.IOException;
 

src/main/java/Main.java

@@ -2,19 +2,21 @@
 
 // Use case (Red) layer
 
+import interface_adapters.presenters.exceptions.CreateFlashcardSetFailed;
+
 /**
  * The input boundary interface for creating flashcard sets.
  *
  * @author Edward Ishii
  */
 
-public interface FlashcardSetInputBoundary {
+public interface CreateFlashcardSetInputBoundary {
 
     /**
      * Create a new flashcard set and store it into the database.
      *
      * @param requestModel the request model required for flashcard set creation.
      * @return the response model containing the newly created flashcard set data.
      */
-    FlashcardSetResponseModel create(FlashcardSetRequestModel requestModel) throws FlashcardSetCreationFailed;
+    CreateFlashcardSetResponseModel create(CreateFlashcardSetRequestModel requestModel) throws CreateFlashcardSetFailed;
 }

src/main/java/create_flashcard_set_use_case/FlashcardSetInputBoundary.java renamed to src/main/java/create_flashcard_set_use_case/CreateFlashcardSetInputBoundary.java

@@ -1,10 +1,11 @@
 package create_flashcard_set_use_case;
 
-import data_access.DBGateway;
-import data_access.IFlashcardSetDataAccess;
-import data_access.entity_request_models.FlashcardSetDsRequestModel;
+import frameworks_and_drivers.database.DBGateway;
+import data_access_use_case.IFlashcardSetDataAccess;
+import data_access_use_case.entity_request_models.FlashcardSetDsRequestModel;
 import entities.FlashcardSet;
 import entities.FlashcardSetFactory;
+import interface_adapters.presenters.exceptions.CreateFlashcardSetFailed;
 
 import java.util.ArrayList;
 import java.util.Objects;
@@ -25,38 +26,38 @@
  *
  * @author Edward Ishii
  */
-public class FlashcardSetInteractor implements FlashcardSetInputBoundary {
+public class CreateFlashcardSetInteractor implements CreateFlashcardSetInputBoundary {
     DBGateway dbGateway;
     IFlashcardSetDataAccess flashcardSetDataAccess;  // for testing
-    FlashcardSetOutputBoundary flashcardSetOutputBoundary;
+    CreateFlashcardSetOutputBoundary createFlashcardSetOutputBoundary;
     FlashcardSetFactory flashcardSetFactory;
 
     /**
      * Constructs the use case interactor.
      *
      * @param dbGateway                  the database to store the flashcard set in.
-     * @param flashcardSetOutputBoundary the output boundary for preparing success/fail view of saving flashcard sets.
+     * @param createFlashcardSetOutputBoundary the output boundary for preparing success/fail view of saving flashcard sets.
      * @param flashcardSetFactory        the factory that creates flashcard sets.
      */
-    public FlashcardSetInteractor(DBGateway dbGateway, FlashcardSetOutputBoundary flashcardSetOutputBoundary,
-                                  FlashcardSetFactory flashcardSetFactory) {
+    public CreateFlashcardSetInteractor(DBGateway dbGateway, CreateFlashcardSetOutputBoundary createFlashcardSetOutputBoundary,
+                                        FlashcardSetFactory flashcardSetFactory) {
         this.dbGateway = dbGateway;
-        this.flashcardSetOutputBoundary = flashcardSetOutputBoundary;
+        this.createFlashcardSetOutputBoundary = createFlashcardSetOutputBoundary;
         this.flashcardSetFactory = flashcardSetFactory;
     }
 
     /**
      * Alternative constructor for testing purposes.
      *
      * @param flashcardSetDataAccess     the flashcard set database.
-     * @param flashcardSetOutputBoundary the output boundary for preparing success/fail view.
+     * @param createFlashcardSetOutputBoundary the output boundary for preparing success/fail view.
      * @param flashcardSetFactory        the factory creating flashcard sets.
      */
-    public FlashcardSetInteractor(IFlashcardSetDataAccess flashcardSetDataAccess,
-                                  FlashcardSetOutputBoundary flashcardSetOutputBoundary,
-                                  FlashcardSetFactory flashcardSetFactory) {
+    public CreateFlashcardSetInteractor(IFlashcardSetDataAccess flashcardSetDataAccess,
+                                        CreateFlashcardSetOutputBoundary createFlashcardSetOutputBoundary,
+                                        FlashcardSetFactory flashcardSetFactory) {
         this.flashcardSetDataAccess = flashcardSetDataAccess;
-        this.flashcardSetOutputBoundary = flashcardSetOutputBoundary;
+        this.createFlashcardSetOutputBoundary = createFlashcardSetOutputBoundary;
         this.flashcardSetFactory = flashcardSetFactory;
     }
 
@@ -65,21 +66,21 @@ public FlashcardSetInteractor(IFlashcardSetDataAccess flashcardSetDataAccess,
      *
      * @param inputData the request model containing data required for creating flashcard sets.
      * @return the response model containing the newly created flashcard set data.
-     * @throws FlashcardSetCreationFailed the error thrown if flashcard set creation fails.
+     * @throws CreateFlashcardSetFailed the error thrown if flashcard set creation fails.
      */
     @Override
-    public FlashcardSetResponseModel create(FlashcardSetRequestModel inputData) throws FlashcardSetCreationFailed {
+    public CreateFlashcardSetResponseModel create(CreateFlashcardSetRequestModel inputData) throws CreateFlashcardSetFailed {
 
         // I chose to throw an exception when user gives invalid input so that the UI layer or any other caller
         // can use try-catch block to handle when to alert the user that something went wrong during creation.
 
         // throw exception if title, description, or username is missing
         if (Objects.equals(inputData.getTitle(), "")) {
-            return flashcardSetOutputBoundary.prepareFailView("Title is missing!");
+            return createFlashcardSetOutputBoundary.prepareFailView("Title is missing!");
         } else if (Objects.equals(inputData.getDescription(), "")) {
-            return flashcardSetOutputBoundary.prepareFailView("Description is missing!");
+            return createFlashcardSetOutputBoundary.prepareFailView("Description is missing!");
         } else if (Objects.equals(inputData.getUsername(), "")) {
-            return flashcardSetOutputBoundary.prepareFailView("Username is missing!");
+            return createFlashcardSetOutputBoundary.prepareFailView("Username is missing!");
         }
 
         int tempFlashcardSetId = -1;  // placeholder id
@@ -101,9 +102,9 @@ public FlashcardSetResponseModel create(FlashcardSetRequestModel inputData) thro
             FlashcardSet savedFs = factory.create(inputData.getTitle(), inputData.getDescription(),
                     inputData.isPrivate(), savedFlashcardSetId, inputData.getUsername());
 
-            FlashcardSetResponseModel responseModel = new FlashcardSetResponseModel(savedFs);
+            CreateFlashcardSetResponseModel responseModel = new CreateFlashcardSetResponseModel(savedFs);
 
-            return flashcardSetOutputBoundary.prepareSuccessView(responseModel);
+            return createFlashcardSetOutputBoundary.prepareSuccessView(responseModel);
         } catch (NullPointerException e) {
             return null;
         }

src/main/java/create_flashcard_set_use_case/FlashcardSetInteractor.java renamed to src/main/java/create_flashcard_set_use_case/CreateFlashcardSetInteractor.java

@@ -2,27 +2,29 @@
 
 // Use case (Red) layer
 
+import interface_adapters.presenters.exceptions.CreateFlashcardSetFailed;
+
 /**
  * The output boundary interface that updates the view when creating a flashcard set succeeds or fails.
  *
  * @author Edward Ishii
  */
 
-public interface FlashcardSetOutputBoundary {
+public interface CreateFlashcardSetOutputBoundary {
     /**
      * Prepares the success view when a flashcard set is created and saved.
      *
      * @param fs the flashcard set that has been created.
      * @return the response model containing the saved flashcard set data.
      */
-    FlashcardSetResponseModel prepareSuccessView(FlashcardSetResponseModel fs);
+    CreateFlashcardSetResponseModel prepareSuccessView(CreateFlashcardSetResponseModel fs);
 
     /**
      * Prepares the fail view when a flashcard set cannot be created or saved.
      *
      * @param error the failure message.
      * @return the response model containing the failure message.
-     * @throws FlashcardSetCreationFailed the error thrown when flashcard set creation fails.
+     * @throws CreateFlashcardSetFailed the error thrown when flashcard set creation fails.
      */
-    FlashcardSetResponseModel prepareFailView(String error) throws FlashcardSetCreationFailed;
+    CreateFlashcardSetResponseModel prepareFailView(String error) throws CreateFlashcardSetFailed;
 }

src/main/java/create_flashcard_set_use_case/FlashcardSetOutputBoundary.java renamed to src/main/java/create_flashcard_set_use_case/CreateFlashcardSetOutputBoundary.java

@@ -7,7 +7,7 @@
  *
  * @author Edward Ishii
  */
-public class FlashcardSetRequestModel {
+public class CreateFlashcardSetRequestModel {
     private String title;
     private String description;
     private boolean isPrivate;
@@ -21,7 +21,7 @@ public class FlashcardSetRequestModel {
      * @param isPrivate   the privacy of the flashcard set.
      * @param username    the owner's username of the flashcard set.
      */
-    public FlashcardSetRequestModel(String title, String description, boolean isPrivate, String username) {
+    public CreateFlashcardSetRequestModel(String title, String description, boolean isPrivate, String username) {
         this.title = title;
         this.description = description;
         this.isPrivate = isPrivate;

src/main/java/create_flashcard_set_use_case/FlashcardSetRequestModel.java renamed to src/main/java/create_flashcard_set_use_case/CreateFlashcardSetRequestModel.java

@@ -9,15 +9,15 @@
  *
  * @author Edward Ishii
  */
-public class FlashcardSetResponseModel {
+public class CreateFlashcardSetResponseModel {
     private final FlashcardSet fs;
 
     /**
      * Constructs a FlashcardSetResponseModel.
      *
      * @param fs the flashcard set.
      */
-    public FlashcardSetResponseModel(FlashcardSet fs) {
+    public CreateFlashcardSetResponseModel(FlashcardSet fs) {
         this.fs = fs;
     }
 

src/main/java/create_flashcard_set_use_case/FlashcardSetResponseModel.java renamed to src/main/java/create_flashcard_set_use_case/CreateFlashcardSetResponseModel.java

@@ -1,8 +1,8 @@
-package create_flashcard_set_use_case;
+package create_flashcard_set_use_case.function_testing;
 
-import data_access.IFlashcardSetDataAccess;
-import data_access.entity_request_models.FlashcardSetDsRequestModel;
-import delete_flashcard_set_use_case.FlashcardSetNotFound;
+import data_access_use_case.IFlashcardSetDataAccess;
+import data_access_use_case.entity_request_models.FlashcardSetDsRequestModel;
+import interface_adapters.presenters.exceptions.DeleteFlashcardSetFailed;
 
 import java.util.ArrayList;
 
@@ -26,7 +26,7 @@ private boolean checkIds(int id1, int id2) {
      * @return the flashcard set associated with the id.
      */
     @Override
-    public FlashcardSetDsRequestModel getFlashcardSet(int flashcardSetId) throws FlashcardSetNotFound {
+    public FlashcardSetDsRequestModel getFlashcardSet(int flashcardSetId) throws DeleteFlashcardSetFailed {
 
         for (FlashcardSetDsRequestModel fs : flashcardSets) {
             if (checkIds(fs.getFlashcardSetId(), flashcardSetId)) {