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

# Conflicts:
#	src/data/FlashcardSets.csv

Author: ThomasShimUoft

README.md

@@ -4,18 +4,64 @@ This is a flashcard study application inspired by Quizlet.
 
 # Main Features
 
-### 1. Log in or sign up for the application.
+### 1a. Sign Up For The Application.
+- If the user selects the "Sign Up" option from the welcome screen the user has an option of Signing up as a user with or without admin level access 
+  - The user must select a username that does not previously exist in the database, if the user inputs a previously existing username they shall be warned with a failure in registration and must choose another username.
+  - The password needs to be greater than or equal to 5 characters in length and not blank.
+  - The repeat password must match the password entered to ensure coherency and surety.
+  - If the user does not require admin level they can leave the Admin Key field blank and they shall be registered as a common user that can access teh program.
+  - If the user does require admin level access they can input the Admin Key in the field, if there is an error in the inputting of the key the user shall be warned accordingly.
+
+### 1b. Log In For The Application.
+- If the user selects the "Log In" option from the welcome screen the user may input their respective username and password, if the username does not match an existing username from the database or incorrect password they shall be warned.
 
 ### 2. Create a flashcard or a flashcard set.
+- Flashcard Set:
+  - The user can create a flashcard set by clicking the "Add Flashcard Set" button located on the main page
+  - Once the button is clicked, the user is taken to the flashcard set creation screen
+  - The user can then enter a title and description for the flashcard set
+  - If the user clicks on "Create" with either the title or description missing, the user is alerted to include them
+  - The user can also make the flashcard set Public (unchecked box) or Private (checked box)
+  - Note: public flashcard sets are searchable by other users, while private ones are not (unless those users are Admins)
+  - If the user wishes to cancel the creation, they can do so by clicking "Cancel"
+  - Upon successful creation, the user is notified that their flashcard set has been created
 
-### 3. Edit a flashcard or a flashcard set.
+### 3a. Edit a flashcard set.
+ - If there are no flashcard sets on the main page, then we cannot edit a flashcard set.
+ - If there is a flashcard set, the user can choose which flashcard set to edit and can click the "Edit" button of the desired flashcard set.
+  - When "Edit" is clicked an Editor Main Page is shown. There is an "Edit Flashcard Set" button and when clicked a window pops up with Title and Description text prompts for the user to edit. The user cannot change the Title to an empty title.
+### 3b. Edit a flashcard in a flashcard set.
+ - If there are no flashcard sets on the main page, then we cannot edit a flashcard in a flashcard set.
+ - If there is a flashcard set, the user can choose which flashcard set to edit and can click the "Edit" button of the desired flashcard set.
+  - When "Edit" is clicked an Editor Main Page is shown.
+   - If there are no flashcards, the user cannot edit a flashcard.
+   - If there are flashcards, the user can choose which flashcard to edit by clicking the "Edit Flashcard" button. When clicked a window pops up with Term and Definition text prompts for the user to edit. The user cannot change the Term to an empty term.
 
 ### 4. Delete a flashcard or a flashcard set.
+- Flashcard Set:
+  - The user can delete a flashcard set by clicking the "Delete" button located inside a flashcard set's options box on the main page
+  - When the button is clicked, the user is then taken to the flashcard set deletion screen
+  - On this screen, user can cancel the deletion at any time by clicking the "Cancel" button
+  - If the user clicks on "Delete", the user is presented with a confirmation dialog box
+  - Selecting "No" cancels the deletion and selecting "Yes" commences the deletion process 
+  - Note: deleting a flashcard set would also delete all flashcards contained within that set
+  - Upon successful deletion, the user is notified that their flashcard set has been deleted
 
 ### 5. Search for a public flashcard set.
+- If the user selects the search button from the main page the user can search through the public community database for flashcard sets
+    - The user types in search input, and selects tags to search from (title, description, owner), or optionally they can choose to “search all”
+    - The user will be taken to a results screen where a list of all the public flashcard sets matching the user’s search will be returned, displaying the title, description, and creator for each
+    - If the user is an admin, a list of all flashcard sets will be returned, regardless if the flashcard set is public or private
+    - Once the user is on the results screen they are able to study or take a quiz for each flashcard set
+    - If the user is an admin they also have the ability to edit and delete every flashcard set in the results
 
 ### 6. Study from a flashcard set.
-
+- Given a flashcard set, the user can enter study mode
+- The user can choose how to sort the flashcard set: by creation date, by alphabetical order, or by random shuffle
+- The user can choose if they want to view the cards in order or in reverse order
+- The user can choose if the flashcard displays terms or definition by default
+- The user is then presented with the first flashcard in the flashcard set, given their sorting preferences. The user can choose to 
+flip the flashcard, go to the next card, or go to the previous card until they wish to quit studying
 ### 7. Generate and take a quiz from a flashcard set.
 - Given a flashcard set, the user can enter quiz mode.
 - Quiz mode features three types of questions: multiple choice, text entry, and true/false.

build.gradle

@@ -7,8 +7,8 @@ repositories {
 }
 
 dependencies {
-    implementation 'junit:junit:4.13.1'
-    testImplementation('org.junit.jupiter:junit-jupiter:5.6.0')
+    implementation 'junit:junit:4.13.2'
+    testImplementation('org.junit.jupiter:junit-jupiter:5.9.0')
     implementation 'com.formdev:flatlaf:2.6'
 }
 

src/data/FlashcardSets.csv

@@ -1,5 +1,4 @@
 title,description,isPrivate,flashcardSetId,ownerUsername,flashcardIds
-test set 1,for testing study use case,false,0,testUser,[0, 1, 2, 3],0,1,2,3
-empty test set,for testing study use case with empty set,true,1,testUser,[]
-Long Test Set,Insert Generic Description,false,2,testUser,[10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21],10,11,12,13,14,15,16,17,18,19,20,21
-SPA100,Beginner Spanish,true,3,tomomot,[]
+test set 1,for testing study use case,false,0,testUser,0,1,2,3
+empty test set,for testing study use case with empty set,true,1,testUser
+Long Test Set,Insert Generic Description,false,2,Anthony,10,11,12,13,14,15,16,17,18,19,20,21

src/main/java/Main.java

@@ -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/create_flashcard_set_use_case/CreateFlashcardSetInputBoundary.java

@@ -0,0 +1,22 @@
+package create_flashcard_set_use_case;
+
+// Use case (Red) layer
+
+import interface_adapters.presenters.exceptions.CreateFlashcardSetFailed;
+
+/**
+ * The input boundary interface for creating flashcard sets.
+ *
+ * @author Edward Ishii
+ */
+
+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.
+     */
+    CreateFlashcardSetResponseModel create(CreateFlashcardSetRequestModel requestModel) throws CreateFlashcardSetFailed;
+}

src/main/java/create_flashcard_set_use_case/CreateFlashcardSetInteractor.java

@@ -0,0 +1,115 @@
+package create_flashcard_set_use_case;
+
+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;
+
+// Use case (Red) layer
+
+/**
+ * [Feature 3: Creating a Flashcard Set]
+ * UI:
+ * - user enters title and description of flashcard set
+ * - user also enters their username (for ownerUsername parameter in data access request model)
+ * - user clicks on button to indicate public or private
+ * - user clicks on button to either create or discard the flashcard set
+ * Use case:
+ * - check that the flashcard set contains a title, description, and owner's username (if not, alert user)
+ * - create and store newly created flashcard set
+ * - notify successful creation of flashcard set to user
+ *
+ * @author Edward Ishii
+ */
+public class CreateFlashcardSetInteractor implements CreateFlashcardSetInputBoundary {
+    DBGateway dbGateway;
+    IFlashcardSetDataAccess flashcardSetDataAccess;  // for testing
+    CreateFlashcardSetOutputBoundary createFlashcardSetOutputBoundary;
+    FlashcardSetFactory flashcardSetFactory;
+
+    /**
+     * Constructs the use case interactor.
+     *
+     * @param dbGateway                  the database to store the flashcard set in.
+     * @param createFlashcardSetOutputBoundary the output boundary for preparing success/fail view of saving flashcard sets.
+     * @param flashcardSetFactory        the factory that creates flashcard sets.
+     */
+    public CreateFlashcardSetInteractor(DBGateway dbGateway, CreateFlashcardSetOutputBoundary createFlashcardSetOutputBoundary,
+                                        FlashcardSetFactory flashcardSetFactory) {
+        this.dbGateway = dbGateway;
+        this.createFlashcardSetOutputBoundary = createFlashcardSetOutputBoundary;
+        this.flashcardSetFactory = flashcardSetFactory;
+    }
+
+    /**
+     * Alternative constructor for testing purposes.
+     *
+     * @param flashcardSetDataAccess     the flashcard set database.
+     * @param createFlashcardSetOutputBoundary the output boundary for preparing success/fail view.
+     * @param flashcardSetFactory        the factory creating flashcard sets.
+     */
+    public CreateFlashcardSetInteractor(IFlashcardSetDataAccess flashcardSetDataAccess,
+                                        CreateFlashcardSetOutputBoundary createFlashcardSetOutputBoundary,
+                                        FlashcardSetFactory flashcardSetFactory) {
+        this.flashcardSetDataAccess = flashcardSetDataAccess;
+        this.createFlashcardSetOutputBoundary = createFlashcardSetOutputBoundary;
+        this.flashcardSetFactory = flashcardSetFactory;
+    }
+
+    /**
+     * Creates a flashcard set and stores it into the database.
+     *
+     * @param inputData the request model containing data required for creating flashcard sets.
+     * @return the response model containing the newly created flashcard set data.
+     * @throws CreateFlashcardSetFailed the error thrown if flashcard set creation fails.
+     */
+    @Override
+    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 createFlashcardSetOutputBoundary.prepareFailView("Title is missing!");
+        } else if (Objects.equals(inputData.getDescription(), "")) {
+            return createFlashcardSetOutputBoundary.prepareFailView("Description is missing!");
+        } else if (Objects.equals(inputData.getUsername(), "")) {
+            return createFlashcardSetOutputBoundary.prepareFailView("Username is missing!");
+        }
+
+        int tempFlashcardSetId = -1;  // placeholder id
+
+        // create the flashcard set
+        FlashcardSetFactory factory = new FlashcardSetFactory();
+        FlashcardSet fs = factory.create(inputData.getTitle(), inputData.getDescription(),
+                inputData.isPrivate(), tempFlashcardSetId, inputData.getUsername());
+
+        // store the flashcard set into database
+        ArrayList<Integer> flashcardIds = new ArrayList<>();  // set starts with empty list of flashcard ids
+        FlashcardSetDsRequestModel dsRequestModel = new FlashcardSetDsRequestModel(fs.getTitle(), fs.getDescription(),
+                fs.getIsPrivate(), tempFlashcardSetId, fs.getOwnerUsername(), flashcardIds);
+
+        try {
+            int savedFlashcardSetId = dbGateway.saveFlashcardSet(dsRequestModel);
+
+            // create the saved flashcard set with its proper id
+            FlashcardSet savedFs = factory.create(inputData.getTitle(), inputData.getDescription(),
+                    inputData.isPrivate(), savedFlashcardSetId, inputData.getUsername());
+
+            CreateFlashcardSetResponseModel responseModel = new CreateFlashcardSetResponseModel(savedFs);
+
+            return createFlashcardSetOutputBoundary.prepareSuccessView(responseModel);
+        } catch (NullPointerException e) {
+            return null;
+        }
+
+    }
+
+
+}

src/main/java/create_flashcard_set_use_case/CreateFlashcardSetOutputBoundary.java

@@ -0,0 +1,30 @@
+package create_flashcard_set_use_case;
+
+// 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 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.
+     */
+    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 CreateFlashcardSetFailed the error thrown when flashcard set creation fails.
+     */
+    CreateFlashcardSetResponseModel prepareFailView(String error) throws CreateFlashcardSetFailed;
+}

src/main/java/create_flashcard_set_use_case/CreateFlashcardSetRequestModel.java

@@ -0,0 +1,103 @@
+package create_flashcard_set_use_case;
+
+// Use case (Red) layer
+
+/**
+ * The request model required for creating a flashcard set.
+ *
+ * @author Edward Ishii
+ */
+public class CreateFlashcardSetRequestModel {
+    private String title;
+    private String description;
+    private boolean isPrivate;
+    private String username;
+
+    /**
+     * Constructs the request model.
+     *
+     * @param title       the title of the flashcard set.
+     * @param description the description of the flashcard set.
+     * @param isPrivate   the privacy of the flashcard set.
+     * @param username    the owner's username of the flashcard set.
+     */
+    public CreateFlashcardSetRequestModel(String title, String description, boolean isPrivate, String username) {
+        this.title = title;
+        this.description = description;
+        this.isPrivate = isPrivate;
+        this.username = username;
+    }
+
+    /**
+     * Getter for the flashcard set title.
+     *
+     * @return the title of this flashcard set.
+     */
+    public String getTitle() {
+        return title;
+    }
+
+    /**
+     * Setter for the flashcard set title.
+     *
+     * @param title the new title for this flashcard set.
+     */
+    public void setTitle(String title) {
+        this.title = title;
+    }
+
+    /**
+     * Getter for the description of the flashcard set.
+     *
+     * @return the description of this flashcard set.
+     */
+    public String getDescription() {
+        return description;
+    }
+
+    /**
+     * Setter for the description of the flashcard set.
+     *
+     * @param description the new description for this flashcard set.
+     */
+    public void setDescription(String description) {
+        this.description = description;
+    }
+
+    /**
+     * Getter for the privacy of the flashcard set.
+     *
+     * @return the privacy of this flashcard set.
+     */
+    public boolean isPrivate() {
+        return isPrivate;
+    }
+
+    /**
+     * Setter for the privacy of the flashcard set.
+     *
+     * @param aPrivate the new privacy status for this flashcard set.
+     */
+    public void setPrivate(boolean aPrivate) {
+        isPrivate = aPrivate;
+    }
+
+    /**
+     * Getter for the owner's username of the flashcard set.
+     *
+     * @return the owner's username of this flashcard set.
+     */
+    public String getUsername() {
+        return username;
+    }
+
+    /**
+     * Setter for the owner's username of the flashcard set.
+     *
+     * @param username the new owner's username of this flashcard set.
+     */
+    public void setUsername(String username) {
+        this.username = username;
+    }
+
+}