Merge pull request #62 from CSC207-2022F-UofT/feature-1-and-2-login-and-signup

Added Testing for Login interactor

Author: Junyu11111

src/main/java/Main.java

@@ -1,7 +1,6 @@
-import com.formdev.flatlaf.FlatIntelliJLaf;
 import com.formdev.flatlaf.FlatDarculaLaf;
 
-import loginAndSignupUseCase.loginAndSignupUseCaseScreens.WelcomeScreen;
+import login_and_signup_use_case.login_and_signup_use_case_screens.WelcomeScreen;
 import java.io.IOException;
 
 /**

src/main/java/MainPage/FlashcardSetDataPanel.java

@@ -3,7 +3,7 @@
 import EditorMainPage.EditorMainPage;
 import dataAccess.DBGateway;
 import delete_flashcardset_use_case.*;
-import loginAndSignupUseCase.UserLoginResponseModel;
+import login_and_signup_use_case.UserLoginResponseModel;
 import quizUseCase.*;
 import quizUseCase.screens.QuizSettingsScreen;
 import studyMode.*;

src/main/java/MainPage/HomePage.java

@@ -3,8 +3,8 @@
 import create_flashcardset_use_case.*;
 import dataAccess.*;
 import entities.FlashcardSetFactory;
-import loginAndSignupUseCase.UserLoginResponseModel;
-import loginAndSignupUseCase.loginAndSignupUseCaseScreens.WelcomeScreen;
+import login_and_signup_use_case.UserLoginResponseModel;
+import login_and_signup_use_case.login_and_signup_use_case_screens.WelcomeScreen;
 import search_use_case.*;
 
 import javax.swing.*;

src/main/java/MainPage/ListOfFlashcardSetsDataPanel.java

@@ -2,7 +2,7 @@
 
 
 import dataAccess.DBGateway;
-import loginAndSignupUseCase.UserLoginResponseModel;
+import login_and_signup_use_case.UserLoginResponseModel;
 
 import javax.swing.*;
 import java.awt.*;

src/main/java/create_flashcardset_use_case/CreationScreen.java

@@ -1,6 +1,6 @@
 package create_flashcardset_use_case;
 
-import loginAndSignupUseCase.UserLoginResponseModel;
+import login_and_signup_use_case.UserLoginResponseModel;
 
 import javax.swing.*;
 import java.awt.*;

src/main/java/delete_flashcardset_use_case/DeletionScreen.java

@@ -1,7 +1,7 @@
 package delete_flashcardset_use_case;
 
 
-import loginAndSignupUseCase.UserLoginResponseModel;
+import login_and_signup_use_case.UserLoginResponseModel;
 
 import javax.swing.*;
 import java.awt.*;

src/main/java/entities/CommonUser.java

@@ -2,22 +2,39 @@
 
 import java.util.ArrayList;
 
+/**
+ * A user that has their username, password, whether they have admin access, and the list of all the ids
+ * of the flashcard sets that belong to them
+ *<p>
+ * Enterprise Business Rules
+ * @author Aryan Chablani
+ */
+
 public class CommonUser implements User{
 
     private String username;
-
     private String password;
     private boolean isAdmin;
     final String ADMIN_KEY = "BuiltDifferent";
     final ArrayList<Integer> flashcardSetIds;
 
+    /**
+     * Constructor for Common User
+     * Precondition: No common user for this username exists yet
+     * @param username the username of the user
+     * @param password the password of the user
+     * @param isAdmin whether the user is an admin or not
+     * @return a CommonUser object
+     * Post Condition: A common user will be instantiated.
+     */
     public CommonUser(String username, String password, boolean isAdmin){
         this.username = username;
         this.password = password;
         this.isAdmin = isAdmin;
         this.flashcardSetIds = new ArrayList<>();
     }
 
+    //GETTERS AND SETTERS
     @Override
     public String getUsername() {
         return username;
@@ -36,11 +53,6 @@ public void setPassword(String password) {
         this.password = password;
     }
 
-    @Override
-    public boolean passwordIsValid() {
-        return password != null && password.length() > 5;
-    }
-
     @Override
     public boolean getIsAdmin() {
         return isAdmin;
@@ -55,6 +67,20 @@ public ArrayList<Integer> getFlashcardSetIds() {
         return flashcardSetIds;
     }
 
+    /**
+     * Checks whether the password is valid by not being nothing and greater in length by 5
+     * @return whether the password is valid
+     */
+    @Override
+    public boolean passwordIsValid() {
+        return password != null && password.length() > 5;
+    }
+
+    /**
+     * Checks whether the admin key entered is similar to the actual admin key in the business rules
+     * @param adminKey the username of the use
+     * @return whether the admin is the same as the one stored in the enterprise rules
+     */
     @Override
     public boolean adminKeyValid(String adminKey) {
         return adminKey.equals(ADMIN_KEY);

src/main/java/entities/CommonUserFactory.java

@@ -1,7 +1,23 @@
 package entities;
 
+/**
+ * A class to call the constructor of the CommonUser and create a Common User object to ensure Clean Architecture
+ *<p>
+ * Enterprise Business Rules
+ * @author Aryan Chablani
+ */
+
 public class CommonUserFactory implements UserFactory {
 
+    /**
+     * A factory to create a Common User object
+     * Precondition: No common user for this username exists yet
+     * @param username the username of the use
+     * @param password the password of the use
+     * @param isAdmin whether the user is an admin or not
+     * @return a CommonUser object
+     * Post Condition: A common user will be instantiated.
+     */
     @Override
     public User create(String username, String password, boolean isAdmin) {
         return new CommonUser(username, password, isAdmin);

src/main/java/entities/User.java

@@ -1,6 +1,13 @@
 package entities;
 import java.util.*;
 
+/**
+ * A user interface that has their username, password, whether they have admin access, and the list of all the ids
+ * of the flashcard sets that belong to them
+ *<p>
+ * Enterprise Business Rules
+ * @author Aryan Chablani
+ */
 public interface User {
     String username = null;
 
@@ -15,12 +22,20 @@ public interface User {
 
     String getPassword();
 
-
-    boolean passwordIsValid();
-
     boolean getIsAdmin();
 
     ArrayList<Integer> getFlashcardSetIds();
 
+    /**
+     * Checks whether the password is valid by not being nothing and greater in length by 5
+     * @return whether the password is valid
+     */
+    boolean passwordIsValid();
+
+    /**
+     * Checks whether the admin key entered is similar to the actual admin key in the business rules
+     * @param adminKey the username of the use
+     * @return whether the admin is the same as the one stored in the enterprise rules
+     */
     boolean adminKeyValid(String adminKey);
 }

src/main/java/entities/UserFactory.java

@@ -1,9 +1,22 @@
 package entities;
 
-import java.util.ArrayList;
-import java.util.Map;
+/**
+ * A class to call the constructor of the CommonUser and create a Common User object to ensure Clean Architecture
+ *<p>
+ * Enterprise Business Rules
+ * @author Aryan Chablani
+ */
 
 public interface UserFactory {
 
+    /**
+     * A factory to create a user object
+     * Precondition: No User for this username exists yet
+     * @param username the username of the user
+     * @param password the password of the user
+     * @param isAdmin whether the user is an admin or not
+     * @return a User object
+     * Post Condition: A User will be creates.
+     */
     User create(String username, String password, boolean isAdmin);
 }