[CS2113-T12-3] TASync by vihaan27 · Pull Request #26 · nus-cs2113-AY2425S2/tp

vihaan27 · 2025-02-20T13:13:10Z

Provide convenient management of tutor’s administrative tasks like attendance, remarks and planning, optimized for CLI.

…th-categories Add JUnit tests and text UI test cases

irving11119

Overall, the code mostly has decent coding quality and there aren't many blatant violations of the coding standards. There are quite a number of methods which are quite long, try to those down into more methods.

Also note the comment on the data, if it is test data, I would advise not to commit this to repo and rather add it to the .gitignore

irving11119 · 2025-03-28T15:13:17Z

+            System.out.print("[C]");
+            break;
+        default:
+            break;


It would be better to catch the default case and throw an error, rather than just breaking

irving11119 · 2025-03-28T15:21:58Z

+    public Student getStudentByName(String name) {
+        Scanner scanner = new Scanner(System.in);
+        List<Student> matched = new ArrayList<>();
+
+        for (Student s : students) {
+            if (s.getName().equalsIgnoreCase(name)) {
+                matched.add(s);
+            }
+        }
+
+        if (matched.isEmpty()) {
+            System.out.println("No student found with the name: " + name);
+            return null;
+        }
+
+        if (matched.size() == 1) {
+            return matched.get(0);
+        }
+
+        boolean allSame = matched.stream().allMatch(s -> s.getName().equalsIgnoreCase(name));
+
+
+        System.out.println("Multiple students found with the name '" + name + "':");
+
+        for (int i = 0; i < matched.size(); i++) {
+            Student s = matched.get(i);
+            System.out.println((i + 1) + ". " + s.getName() + " (Matric No: " + s.getMatricNumber() + ")");
+        }
+
+        if (allSame) {
+            System.out.print("Please enter the matric number to identify the student: ");
+            String matric = scanner.nextLine();
+            return getStudentByMatricNumber(matric);
+        } else {
+            System.out.print("Enter the number (1-" + matched.size() + ") or full name: ");
+            String input = scanner.nextLine();
+
+            try {
+                int index = Integer.parseInt(input);
+                if (index >= 1 && index <= matched.size()) {
+                    return matched.get(index - 1);
+                } else {
+                    System.out.println("Invalid index.");
+                }
+            } catch (NumberFormatException e) {
+                for (Student s : matched) {
+                    if (s.getName().equalsIgnoreCase(input)) {
+                        return s;
+                    }
+                }
+                System.out.println("No match for input name.");
+            }
+        }
+
+        return null;
+    }


This method is quite long, you could break this down into multiple private methods. Also note ideally your public functions should all have Java Docs.

irving11119 · 2025-03-28T15:25:00Z

+    /**
+     * Prints the schedule for today including todos, deadlines, events, consultations, and tutorial classes.
+     */
+    public void displayScheduleForToday() {


This method is quite long, try to break it down into multiple smaller methods. Also do try your best to write Java docs for your public methods

irving11119 · 2025-03-28T15:26:19Z

+                String tutorialInfo = " - " + "Tutorial Name: " + tutorial.getTutorialName() +
+                        ", Day of Week: " + tutorial.getDayOfWeek() +
+                        ", From: " + tutorial.getStartTime() +
+                        ", To: " + tutorial.getEndTime();
+                System.out.println(tutorialInfo);


You have a number of complicated print statements. Consider delegating these functionalities to your UI class.

irving11119 · 2025-03-28T15:30:23Z

+                ? String.valueOf(DateTimeFormatterUtil.parseDateTime(consultationStart))
+                : "INVALID DATE";
+        String formattedEnd = isEndValid
+                ? String.valueOf(DateTimeFormatterUtil.parseDateTime(consultationEnd))
+                : "INVALID DATE";


Try to avoid using magic strings in your code, in this case "INVALID DATE" is a hardcoded constant

irving11119 · 2025-03-28T15:34:27Z

+        try {
+            // Validate input string
+            if (input == null || input.trim().isEmpty()) {
+                throw TASyncException.invalidNewTutorialCommand();
+            }
+
+            // Split the input to get tutorial details
+            String[] inputParts = input.split("\\s+");
+            if (inputParts.length != 4) {
+                throw TASyncException.invalidNewTutorialCommand();
+            }
+
+            String tutorialName = inputParts[0];
+            String dayOfWeekStr = inputParts[1];
+            String startTimeStr = inputParts[2];
+            String endTimeStr = inputParts[3];
+
+            // Parse and validate day of the week
+            int dayOfWeek;
+            try {
+                dayOfWeek = Integer.parseInt(dayOfWeekStr);
+                if (dayOfWeek < 1 || dayOfWeek > 7) {
+                    throw TASyncException.invalidDayOfWeek();
+                }
+            } catch (NumberFormatException e) {
+                throw TASyncException.invalidDayOfWeek();
+            }
+
+            // Parse and validate start and end time
+
+            LocalTime startTime = LocalTime.parse(startTimeStr);
+            LocalTime endTime = LocalTime.parse(endTimeStr);
+
+            // Check if the tutorial already exists in the list
+            for (TutorialClass existingTutorial : tutorialClassList.getTutorialClasses()) {
+                if (existingTutorial.getTutorialName().equals(tutorialName) &&
+                        existingTutorial.getDayOfWeek().getValue() == dayOfWeek &&
+                        existingTutorial.getStartTime().equals(startTime) &&
+                        existingTutorial.getEndTime().equals(endTime)) {
+                    throw TASyncException.duplicateTutorial();
+                }
+            }
+
+            // Create a new TutorialClass object
+            StudentList emptyStudentList = new StudentList(); // Empty list for students
+            TutorialClass newTutorial = new TutorialClass();
+            newTutorial.setTutorialName(tutorialName);
+            newTutorial.setDayOfWeek(DayOfWeek.of(dayOfWeek));  // Convert int to DayOfWeek
+            newTutorial.setStartTime(startTime);
+            newTutorial.setEndTime(endTime);
+            newTutorial.setStudentList(emptyStudentList);  // Set an empty student list
+
+            // Add the new tutorial to the tutorial class list
+            tutorialClassList.addTutorialClass(newTutorial);
+
+            // Output success message
+            System.out.println("New tutorial added: " + newTutorial);
+


This method is pretty long, you try to break it down more

irving11119 · 2025-03-28T15:39:31Z

+
+public class ViewStudentCommentsCommand implements Command<AttendanceFile> {
+    //parts in format of tutname,week,studentname,matricnum
+    public void execute(String parts, AttendanceFile attendanceList) {


Try your best to document public methods with Java Docs

irving11119 · 2025-03-28T15:41:24Z

+    public static Command createCommand(String commandString) {
+        String[] parts = commandString.split("\\s+", 3); // Split into command, type, and rest of input
+        if (parts.length < 2) {
+            System.out.println("Invalid command format. Please use: /add -[type] [task details]");
+            return null;
+        }
+
+        // Remove the leading '/' and convert the command to uppercase
+        String command = parts[0].toUpperCase();
+        String taskTypeShortcut = parts[1];
+        String listType = parts[1];
+
+        if ("HELP".equals(command)) {
+            CommandListPrinter.printCommands();
+            return null;
+        }
+
+        if ("ADD".equals(command)) {
+            TaskType taskType = TaskType.fromShortcut(taskTypeShortcut);
+            if (taskType == null) {
+                System.out.println("Invalid task type. Use -c (Consultation), -pt (Todo), -pe (Event), -pd (Deadline)");
+                return null;
+            }
+
+            switch (taskType) {
+            case TODO:
+                return new TodoCommand();
+            case EVENT:
+                return new EventCommand();
+            case DEADLINE:
+                return new DeadlineCommand();
+            case CONSULTATION:
+                return new ConsultationCommand();
+            default:
+                System.out.println("Unknown task type: " + taskType);
+                return null;
+            }
+        }
+
+
+        // Handle TaskList commands
+        if (listType.equalsIgnoreCase("-p")) {
+            switch (command) {
+            case "DELETE":
+                return new DeleteTaskCommand();
+            case "MARK":
+                return new MarkTaskCommand();
+            case "UNMARK":
+                return new UnmarkTaskCommand();
+            case "LIST":
+                return new ListTaskCommand();
+            case "FIND":
+                return new FindTaskCommand();
+            case "RENAME":
+                return new RenameTaskCommand();
+            default:
+                System.out.println("Sorry, TASync does not know what \"" + command + "\" means.");
+                CommandListPrinter.printCommands();
+                return null;
+            }
+        } else if (listType.equalsIgnoreCase("-t")) {
+            switch (command) {
+            case "NEWTUTORIAL":
+                return new NewTutorialCommand();
+            case "DELETE":
+                return new DeleteTutorialCommand();
+            case "LIST":
+                return new ListUpcomingTutorialsCommand();
+            case "NEWSTUDENT":
+                return new NewStudentCommand();
+            case "DELETESTUDENT":
+                return new DeleteStudentCommand();
+            case "LISTSTUDENTS":
+                return new ListTutorialStudentsCommand();
+            case "FIND":
+                return new FindStudentCommand();
+            case "CHANGEREMARK":
+                return new ChangeRemarkCommand();
+            case "CHECKREMARK":
+                return new CheckRemarkCommand();
+            default:
+                System.out.println("Sorry, TASync does not know what \"" + command + "\" means.");
+                CommandListPrinter.printCommands();
+                return null;
+            }
+        }  else if (listType.equalsIgnoreCase("-a")) {
+            switch (command) {
+            case "MARK":
+                return new MarkStudentAttendanceCommand();
+            case "UNMARK":
+                return new UnmarkStudentAttendanceCommand();
+            case "COMMENT":
+                return new CommentOnStudentCommand();
+            case "VIEWCOMMENT":
+                return new ViewStudentCommentsCommand();
+            case "DELETECOMMENT":
+                return new DeleteStudentComment();
+            case "LIST":
+                return new ShowAttendanceListCommand();
+            default:
+                System.out.println("Sorry, TASync does not know what \"" + command + "\" means.");
+                CommandListPrinter.printCommands();
+                return null;
+            }
+        } else if (listType.equalsIgnoreCase("-at")) {
+            if (command.equals("CREATE")) {
+                return new CreateNewAttendanceList();
+            }
+            System.out.println("Sorry, TASync does not know what \"" + command + "\" means.");
+            CommandListPrinter.printCommands();
+            return null;
+        }
+
+        if (command.equals("BYE")) {
+            return new ByeCommand();
+        }
+
+        return null;
+    }


This method is pretty long, try to break it down into smaller parts

irving11119 · 2025-03-28T15:45:15Z

I think it would be advisable not to commit test data for your program. Your data should be generated fresh when running the jar file and then subsequently saved. Assuming this is all test data generated, you should add it to the .gitgnore file so its not committed.

irving11119 · 2025-03-28T15:46:45Z

You can add this to the .gitignore as well

Dev guide for AttendanceListCommands

- Abstract setUp code for each test in order to reduce code duplication - Create ChangeRemarkCommandTest, CheckRemarkCommandTest, DeleteStudentCommandTest,FindStudentCommandTest and NewStudentCommandTest for easy testing of methods

Add tests for more studentcommands

Add JUnit test for task commands

jessican1212

Overall, I think the written portion of your Developer Guide is very strong and I had a difficult time finding errors to critique. The professor did mention that there needs to be more diagrams. I think that is the main issue.

jessican1212 · 2025-04-02T03:13:05Z

+  - Removes the task from the `TaskList`.
+  - Displays a confirmation message upon successful removal.
+  - If the task is not found, an error message is shown.
+


I believe the DG should include diagrams (UML diagrams, class diagrams, sequence diagrams, etc.)

jessican1212 · 2025-04-02T03:15:13Z

+
+The class implements the following main operation:
+
+- `NewStudentCommand#execute()`


Is this a typo? Should it be NewStudentcommand.execute()?

jessican1212 · 2025-04-02T03:16:13Z

+- The hashMap containing the attendance status of the students will be printed.
+- A different message will be printed if this hashMap is empty(signalling that the attendanceList has no students in it).
+- An error message will be printed when an Exception is handled.
+- 


This bullet point should probably be deleted if it's empty!

jessican1212 · 2025-04-02T03:18:08Z

+
+#### Implementation details
+This class implements the Command<AttendanceList> interface.Its function is to take in the input from the user and extract the tutorial and week the user has given
+and print the names and attendance status of the students in that tutorial,if it exists.


Ensure to fix small typos such as forgotten spaces after periods and commas for professionalism.

Update developer guide for task commands

- Amend the formatting of the User Guide - Add student command details for users - Add important notes for users to take note of during command execution

Add Junit tests for marks and marksList.

Add DG documentation for marks commands.

jing-yen

Good effort for your DG. Can be improved by explaning the architecture and supplementing it with UML diagrams

jing-yen · 2025-04-03T05:25:23Z

 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}

-## Design & implementation
+## **Design & implementation**


It would be a good idea to describe the architecture of TASync project, before explaining the specifics (an architecture diagram would be very welcome!)

jing-yen · 2025-04-03T05:29:08Z

+
+- `attendancelistcommands` - Handles commands related to attendance lists.
+- `commandhandler` - Manages the processing and execution of various commands
+- `student commands` - Implements commands specific to student-related operations


Ensure correct naming of the sub-packages. For instance, the space should be omitted from student commands sub-package.

jing-yen · 2025-04-03T05:40:45Z

+- Parses the input to extract the tutorial class code and matriculation number. 
+- Validates the input to ensure it follows the expected format and does not contain any errors. 
+- Retrieves the specified tutorial class based on the provided class code. 
+- Checks if the tutorial class exists. If it does not, an error message is shown. 
+- Retrieves the student list from the tutorial class. 
+- Checks if the student with the given matriculation number exists in the class. 
+- If the student exists, retrieves their remark. 
+- If the student has a remark, displays it. Otherwise, indicates that no remarks were found. 
+- If the student does not exist, an error message is shown indicating that no such student was found. 
+- Handles any exceptions by displaying relevant error messages if validation fails or the tutorial class is not found.


For step-by-step operations, consider using numerical bullets (with possible sub-lists for conditional cases) instead of round bullets.

jing-yen · 2025-04-03T05:47:53Z

+and print the names and attendance status of the students in that tutorial,if it exists.
+
+#### operations
+- `ShowAttendanceListCommand.execute()`


The operation code should be unindented (or the following description indented more) for clarity.

jing-yen · 2025-04-03T05:50:34Z

+- `ShowAttendanceListCommand.execute()`
+- extracts tutorial name and week number from the given input.
+- Exception thrown if no input or not enough input given.
+- The AttendancFile is searched to find the relevant AttendanceList


AttendancFile should be AttendanceFile

update default value of Student Class

- Amend the formatting of the User Guide - Add tutorial command details for users - Add important notes for users to take note of during command execution

Update user guide

Dg bugs

checkstyle fixes

Add class diagram for marks.

Fix bug in class diagram

- Make them less detailed but easier to comprehend to readers - Change DG formatting

Update class diagrams

Upload png files for class diagrams

Edit command name for UG

Update NewTutorialCommandSequenceDiagram.puml

update sequence diagram to remove numbering

Standardise test case format in appendix E

Update User Guide

Stop tracking data folder

Update PPP to meet page limits

nus-se-bot closed this Feb 21, 2025

damithc reopened this Feb 21, 2025

nus-cs2113-AY2425S2 deleted a comment from nus-se-bot Feb 21, 2025

xubin0 force-pushed the master branch from e2b527f to bc81559 Compare February 25, 2025 06:01

Ashertan256 pushed a commit to Ashertan256/tp that referenced this pull request Mar 18, 2025

Merge pull request nus-cs2113-AY2425S2#26 from matthewyeo1/combine-wi…

f5bc8bd

…th-categories Add JUnit tests and text UI test cases

irving11119 reviewed Mar 28, 2025

View reviewed changes

wongyihao02 and others added 5 commits April 1, 2025 22:48

Merge pull request #101 from wongyihao02/DG_wyh

051820d

Dev guide for AttendanceListCommands

Add tests for more studentcommands

ac8a888

- Abstract setUp code for each test in order to reduce code duplication - Create ChangeRemarkCommandTest, CheckRemarkCommandTest, DeleteStudentCommandTest,FindStudentCommandTest and NewStudentCommandTest for easy testing of methods

Add JUnit test for task commands

a6eae1d

Merge pull request #103 from samstt/junit-more-student-commands

a310432

Add tests for more studentcommands

Merge pull request #104 from kmnyn/taskcommand-test-coverage

ac0719b

Add JUnit test for task commands

jessican1212 reviewed Apr 2, 2025

View reviewed changes

kmnyn and others added 13 commits April 2, 2025 11:47

Update developer guide for task commands

5fce015

Merge pull request #105 from kmnyn/Developer-Gude

04489e1

Update developer guide for task commands

Merge branch 'master' into Junittests

797bde4

Update User Guide with student commands

20dcdae

- Amend the formatting of the User Guide - Add student command details for users - Add important notes for users to take note of during command execution

Update User Guide with student commands

a3123e6

- Amend the formatting of the User Guide - Add student command details for users - Add important notes for users to take note of during command execution

Merge pull request #102 from vihaan27/branch-Tests

ab0a6fd

Add Junit tests for marks and marksList.

Add DG documentation for marks commands.

26555c6

started on showattendanceList tests

262a23a

no message

ec9a633

Merge branch 'master' into Junittests

4a6d30f

Merge pull request #108 from vihaan27/branch-DG

a3aa796

Add DG documentation for marks commands.

no message

239151e

update default value of Student Class

7c6b1cb

jing-yen reviewed Apr 3, 2025

View reviewed changes

xubin0 and others added 4 commits April 3, 2025 14:13

update default value for studentList

478ee4f

Merge pull request #109 from xubin0/master

01473be

update default value of Student Class

Update User Guide with tutorial commands

300170b

- Amend the formatting of the User Guide - Add tutorial command details for users - Add important notes for users to take note of during command execution

Merge pull request #107 from samstt/update-user-guide

61f7b4b

Update user guide

vihaan27 and others added 30 commits April 8, 2025 11:16

Correct DG formatting

fdc4761

Merge pull request #240 from vihaan27/dg-bugs

7836ec4

Dg bugs

checkstyle fixes

fd4828f

Merge branch 'master' into bug_fixing

06b678f

checkstyle fix

34ee793

Merge pull request #241 from wongyihao02/bug_fixing

d17b130

checkstyle fixes

Add class diagram for marks.

939cc6e

Merge pull request #242 from vihaan27/uml-class

a04d42b

Add class diagram for marks.

Fix bug in class diagram

ccc037b

Merge pull request #243 from vihaan27/fix-uml

95a7ef4

Fix bug in class diagram

Update class diagrams

f0131fa

- Make them less detailed but easier to comprehend to readers - Change DG formatting

Merge pull request #244 from samstt/fix-final-formatting-issues

59c244f

Update class diagrams

Upload png files for class diagrams

467ff37

Merge pull request #245 from samstt/fix-final-formatting-issues

3c171f7

Upload png files for class diagrams

Edit command name for UG

4f94188

Merge pull request #246 from kmnyn/User-Guide

7a2cd51

Edit command name for UG

update sequence diagram without number

37d0fd7

Update NewTutorialCommandSequenceDiagram.puml

2d5d516

update image

82efe19

Standardise test case format in appendix E

c7b9d50

Merge pull request #247 from samstt/fix-dg-bugs

88fa80f

Update NewTutorialCommandSequenceDiagram.puml

Merge pull request #248 from xubin0/master

1a71795

update sequence diagram to remove numbering

Merge pull request #249 from vihaan27/fix-manual-testing

07e5516

Standardise test case format in appendix E

Update User Guide

aa59e80

Merge pull request #250 from samstt/update-UG

5c9a64f

Update User Guide

Stop tracking data folder

eb2d130

Merge pull request #251 from samstt/fix-git-ignore

7ec5eab

Stop tracking data folder

Update PPP to meet page limits

f9c8dbd

Update UG to fix naming error

2af6331

Merge pull request #252 from samstt/edit-PPP-length

4e9383e

Update PPP to meet page limits


		The class implements the following main operation:

		- `NewStudentCommand#execute()`

Uh oh!

Conversation

vihaan27 commented Feb 20, 2025

Uh oh!

irving11119 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jessican1212 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jing-yen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants