For both my features, I fixed all IntelliJ warnings, added JDoc and made improvements to abstraction.

parmism · parmism · commit e761c06a4fa1 · 2022-11-28T13:52:15.000-05:00
diff --git a/src/main/java/entities/user_entities/User.java b/src/main/java/entities/user_entities/User.java
@@ -2,10 +2,10 @@
 
 import data_access.UserDatabase;
 import entities.chat.Chat;
+import interface_adapters.appscreen.UserAppScreenGateway;
 import interface_adapters.profile_modification_IA.UserAuthenticationI;
 import interface_adapters.login_interface_adapters.Login;
 import use_cases.user_attribute_modification_use_case.Changeable;
-import interface_adapters.app_screen_interface_adapters.UserAppScreenGateway;
 
 import java.io.File;
 import java.io.Serializable;
diff --git a/src/main/java/interface_adapters/User_search_IA/IRetrieveList.java b/src/main/java/interface_adapters/User_search_IA/IRetrieveList.java
@@ -1,8 +1,9 @@
 package interface_adapters.User_search_IA;
-
 import entities.user_entities.User;
 import java.util.List;
-
+/**
+ * allows for the User Database (whatever type it may be) to present all its users in a list format.
+ */
 public interface IRetrieveList {
     List<User> getList();
 }
diff --git a/src/main/java/interface_adapters/User_search_IA/UserPresenter.java b/src/main/java/interface_adapters/User_search_IA/UserPresenter.java
@@ -1,6 +1,8 @@
 package interface_adapters.User_search_IA;
 
-// UI implements this interface to invert the dependency of UI on the inner layers
+/**
+ * Implemented interface to invert the dependency of UI on the inner layers
+ */
 public interface UserPresenter {
     String showProfile(String username);
 }
diff --git a/src/main/java/interface_adapters/User_search_IA/UserPresenterClass.java b/src/main/java/interface_adapters/User_search_IA/UserPresenterClass.java
@@ -0,0 +1,25 @@
+package interface_adapters.User_search_IA;
+import data_access.UserDatabase;
+import entities.user_entities.User;
+import use_cases.user_profile_display_use_case.UserReader;
+
+/**
+ * User_search_IA.UserPresenter makes us implement showProfile to invert the dependency
+ */
+public class UserPresenterClass implements UserPresenter{
+    @Override
+    public String showProfile(String username) {
+        //    setting up access to the database of users:
+        UserDatabase db = new UserDatabase();
+        if (db.UserExists(username)){
+            User user = db.getUser(username);
+            UserReader reader = new UserReader();
+            String[] features = reader.ProfileReader(user);
+            String email = features[1];
+            return("<html>Username: " + username + "<br>Email: " + email + "</html>");
+        }
+        else{
+            return("User with given username does not exist.");
+        }
+    }
+}
diff --git a/src/main/java/interface_adapters/User_search_IA/UserRetriever.java b/src/main/java/interface_adapters/User_search_IA/UserRetriever.java
@@ -1,8 +1,10 @@
 package interface_adapters.User_search_IA;
-
 import use_cases.user_registration_use_cases.UserExists;
 import entities.user_entities.User;
-// gives access to user entity.
+
+/**
+ * gives access to user entity.
+ */
 public interface UserRetriever extends UserExists {
     User getUser(String username);
 }
diff --git a/src/main/java/interface_adapters/profile_modification_IA/ChangeController.java b/src/main/java/interface_adapters/profile_modification_IA/ChangeController.java
@@ -1,8 +1,8 @@
 package interface_adapters.profile_modification_IA;
 
 /**
- * To make a change to User entity.
+ * To make a change to User entity, report if successful.
  */
 public interface ChangeController {
-    public boolean reportChange(String username, String password, String feature, String newFeature);
+    boolean reportChange(String username, String password, String feature, String newFeature);
     }
diff --git a/src/main/java/interface_adapters/profile_modification_IA/UserAuthenticationI.java b/src/main/java/interface_adapters/profile_modification_IA/UserAuthenticationI.java
@@ -4,5 +4,5 @@
  * allows for ChangeController to authenticate user's username and password.
  */
 public interface UserAuthenticationI {
-    public Boolean PasswordMatch(String attempt);
+    Boolean PasswordMatch(String attempt);
 }
diff --git a/src/main/java/interface_adapters/profile_modification_IA/UserModificationGateway.java b/src/main/java/interface_adapters/profile_modification_IA/UserModificationGateway.java
@@ -2,8 +2,10 @@
 
 import entities.user_entities.User;
 
-// allows for the serialized data_access.UserDatabase to update when changes occur to user attributes.
+/**
+ * allows for the serialized data_access.UserDatabase to update when changes occur to user attributes.
+ */
 public interface UserModificationGateway {
-    public void modifyUser(String oldUsername, User modified);
+     void modifyUser(String oldUsername, User modified);
 }
 
diff --git a/src/main/java/screens/Profile_screen/UserSearchUI.java b/src/main/java/screens/Profile_screen/UserSearchUI.java
@@ -1,20 +1,16 @@
-package screens.Profile_screen; /**
- * Provides the UI elements
- */
-import data_access.UserDatabase;
-import entities.user_entities.User;
-import interface_adapters.User_search_IA.UserPresenter;
-import use_cases.user_profile_display_use_case.UserReader;
-
+package screens.Profile_screen;
+import interface_adapters.User_search_IA.UserPresenterClass;
 import javax.swing.*;
 import java.awt.*;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
-import java.io.File;
-
 
-public class UserSearchUI implements UserPresenter {
-    private JLabel label;
+/**
+ * Provides the UI elements
+ */
+public class UserSearchUI {
+    private final JLabel label;
+    private final UserPresenterClass p = new UserPresenterClass();
 
     public UserSearchUI() {
         final JFrame frame = new JFrame();
@@ -27,7 +23,7 @@ public UserSearchUI() {
         field.addActionListener(new ActionListener() {
             @Override
             public void actionPerformed(ActionEvent e) {
-                label.setText(showProfile(field.getText()));
+                label.setText(p.showProfile(field.getText()));
             }
 
         });
@@ -38,31 +34,6 @@ public void actionPerformed(ActionEvent e) {
         frame.setVisible(true);
   }
 
-    /**
-     * User_search_IA.UserPresenter makes UI implement showProfile to invert the use-case --> UI dependency
-     */
-    @Override
-    public String showProfile(String username) {
-        //    setting up access to the database of users:
-        UserDatabase db = new UserDatabase();
-        if (db.UserExists(username)){
-            User user = db.getUser(username);
-            UserReader reader = new UserReader();
-            String[] features = reader.UserReader(user);
-            String email = features[1];
-            return("<html>Username: " + username + "<br>Email: " + email + "</html>");
-        }
-        else{
-            return("User with given username does not exist.");
-        }
-    }
-
-// for trying out the code:
-//    public static void main(String[] args) {
-//        new Profile_screen.UserSearchUI();
-//
-//    }
-
 }
 
 
diff --git a/src/main/java/screens/profile_update_screen/UserModificationUI.java b/src/main/java/screens/profile_update_screen/UserModificationUI.java
@@ -1,6 +1,5 @@
 package screens.profile_update_screen;
 import interface_adapters.profile_modification_IA.ChangeControllerClass;
-
 import javax.swing.*;
 import java.awt.*;
 import java.awt.event.ActionEvent;
@@ -9,7 +8,7 @@
 
 
 /**
- * Provides the UI elements
+ * Provides the UI elements.
  */
 public class UserModificationUI {
     ChangeControllerClass c = new ChangeControllerClass();
diff --git a/src/main/java/use_cases/user_attribute_modification_use_case/Changeable.java b/src/main/java/use_cases/user_attribute_modification_use_case/Changeable.java
@@ -1,6 +1,7 @@
-
 package use_cases.user_attribute_modification_use_case;
-
+/**
+ * User entity must implement this to change a feature.
+ */
 public interface Changeable {
     void changeFeature(String feature, String newFeature);
 }
diff --git a/src/main/java/use_cases/user_profile_display_use_case/UserReader.java b/src/main/java/use_cases/user_profile_display_use_case/UserReader.java
@@ -1,16 +1,14 @@
 package use_cases.user_profile_display_use_case;
-
-
 import entities.user_entities.User;
 
-import java.io.File;
-
+/**
+ * Collects user information from user entity.
+ */
 public class UserReader {
-    public String[] UserReader(User user) {
+    public String[] ProfileReader(User user) {
         String email = user.getEmail();
         String username = user.getUsername();
-        String[] out = new String[] {username, email};
-        return out;
+        return new String[] {username, email};
     }
 
 }
diff --git a/src/test/java/TestAppScreen.java b/src/test/java/TestAppScreen.java
@@ -4,7 +4,7 @@
 import entities.chat.PrivateChat;
 import entities.message.TextMessage;
 import entities.user_entities.BasicUser;
-import screens.app_screen.AppScreen;
+import screens.appscreen.AppScreen;
 
 import java.io.File;
 import java.time.LocalDateTime;
diff --git a/src/test/java/TestUserSearch.java b/src/test/java/TestUserSearch.java
@@ -1,15 +1,18 @@
 import data_access.UserDatabase;
-import screens.Profile_screen.UserSearchUI;
+import interface_adapters.User_search_IA.UserPresenterClass;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 
+/**
+ * Simple test ofile display feature.
+ */
 public class TestUserSearch {
     @Test
     public void TestShowUser() {
         UserDatabase db = new UserDatabase();
-        UserSearchUI ui = new UserSearchUI();
+        UserPresenterClass p = new UserPresenterClass();
         db.createUser("parmism", "123", "parmis@gmail.com", "Basic");
         String output = "<html>Username: parmism<br>Email: parmis@gmail.com</html>";
-        Assertions.assertEquals((ui.showProfile("parmism")), (output));
+        Assertions.assertEquals((p.showProfile("parmism")), (output));
     }
 }
diff --git a/src/test/java/UserDatabaseTest.java b/src/test/java/UserDatabaseTest.java
@@ -41,17 +41,7 @@ public void listedUsers(){
         accountDatabase.createUser("MeenakshiGopakumar", "123", "meena@gmail.com", "Basic");
         List<User> lst = accountDatabase.getList();
         String email = lst.get(0).getEmail();
-        Assertions.assertTrue(email.equals("meena@gmail.com"));
-    }
-
-    @Test
-    public void userGot() {
-        File accounts = new File("TestUserDatabase2.csv");
-        UserDatabase accountDatabase = new UserDatabase(accounts);
-        accountDatabase.createUser("MeenakshiGopakumar", "123", "meena@gmail.com", "Basic");
-        User user = accountDatabase.getUser("MeenakshiGopakumar");
-        String email = user.getEmail();
-        Assertions.assertTrue(email.equals("meena@gmail.com"));
+        Assertions.assertEquals("meena@gmail.com", email);
     }
 
     }
diff --git a/user_accounts b/user_accounts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`package interface_adapters.User_search_IA;`
`2`	`2`
`3`		`-// UI implements this interface to invert the dependency of UI on the inner layers`
	`3`	`+/**`
	`4`	`+ * Implemented interface to invert the dependency of UI on the inner layers`
	`5`	`+ */`
`4`	`6`	`public interface UserPresenter {`
`5`	`7`	`String showProfile(String username);`
`6`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,5 @@`
`4`	`4`	`* allows for ChangeController to authenticate user's username and password.`
`5`	`5`	`*/`
`6`	`6`	`public interface UserAuthenticationI {`
`7`		`- public Boolean PasswordMatch(String attempt);`
	`7`	`+ Boolean PasswordMatch(String attempt);`
`8`	`8`	`}`