[Zayd Mahmud] ip #466

ZaydM18 · 2025-02-06T04:09:17Z

Monty -- The Obsessive Taskmaster 🤖

Monty, when he's not hounding on you for not adding to his list, is instead tending to it and curating it instead! Some of the things he can do for you include:

Making a to-do list
Tracking deadlines for important tasks
Taking note of any events you may have planned and when they'll be
Telling you if you have anything due on a certain day
Looking through your list to search for a particular word or phrase

For those of you who are interested in programming, you should know that Monty likes to maintain himself in lists too! That's right, he's compartmentalised his internal mechanisms quite well. Take a look:

import monty.parser.Parser;
import monty.storage.Storage;
import monty.task.Task;
import monty.ui.Ui;
import monty.exception.MontyException;

public class Monty {
    private final Ui ui;
    private final ArrayList<Task> tasks;

Note

Monty's design adhere's to object-oriented programming principles, which is a paradigm that views the world as a network of interacting objects. Each object has a state and a behaviour, but is never too complex! You can learn more about it [here.] (https://nus-cs2103-ay2425s2.github.io/website/schedule/week1/topics.html#W1-1)

Here are some working commands that can be used with Monty:

'list'
'todo'
'deadline' object '/by'
'event' meeting '/from' start '/to' finish.
'find'
'bye'

Some features Monty is expected to have by the end are:

This reverts commit a6aa641.

…k lists. Modify the Task class to include an abstract method to act as a toString for the file and to include a protected variable that can modify the completion status. Modify the Monty class to accommodate.

Add function to be able to retrieve the events or deadlines due/relevant on a specific date.

LuBolin

Mostly stuck with the conventions, good job!
The only thing that "needs" to be changed seems to be the .* import, and potentially having braces around one-liner if statements.
Good job!

LuBolin · 2025-02-06T17:12:16Z

src/main/java/Storage.java

@@ -0,0 +1,69 @@
+import java.io.*;


Should this import be explicit, instead of using .*?

You're right. It was supposed to be explicit, but I forgot to remove the wildcard after testing.

LuBolin · 2025-02-06T17:15:55Z

src/main/java/Monty.java

+                        break;
+
+                    case "delete":
+                        if (argument.isEmpty()) throw new MontyException(" Your task number is out of range! How am I to keep track of my-- I mean, your -- beautiful list!");


Maybe we can wrap the throw in braces?

LuBolin · 2025-02-06T17:19:02Z

src/main/java/Event.java

+
+    @Override
+    public String toString() {
+        return "[E]" + super.toString() + " (from: " + from.format(OUTPUT_FORMAT) + " to: " + to.format(OUTPUT_FORMAT) + ")";


Perhaps a line break would help with readability?

Thanks for the suggestion. I wasn't entirely sure on where to place the separators for a line like this so I just left it as a single one.

LuBolin · 2025-02-06T17:20:53Z

src/main/java/Monty.java

+                        Storage.saveTasks(tasks);
+                        break;
+
+                    default:


Good that you include a default clause in your switch case 👍

Add Parser class to handle the command execution of the chatbot. Refactor Monty to work using new classes to better reflect the Single Responsibility Principle.

Add appropriate test classes to test modular and cohesive functionality. Modified Parser class to better handle exceptions.

# Conflicts: # src/main/java/monty/Monty.java # src/main/java/monty/storage/Storage.java

Edit Ui class to include message for the 'find' feature.

# Conflicts: # src/main/java/monty/parser/Parser.java

Follow git standard (to the best of my knowledge).

VikramGoyal23

LGTM, the only nitpicks I could find were in import statement formatting and wildcard imports, with some incorrect switch statement indentation here and there. I went ahead and marked all instances I could find.

Overall, I would say you've done a great job.

VikramGoyal23 · 2025-02-08T23:50:09Z

src/main/java/monty/Monty.java

+import monty.exception.MontyException;
+import java.util.ArrayList;


A line break between these imports would help improve readability since they belong to different packages.

VikramGoyal23 · 2025-02-08T23:50:43Z

src/main/java/monty/parser/Parser.java

+
+import monty.exception.MontyException;
+import monty.storage.Storage;
+import monty.task.*;


Wildcard imports are not allowed.

VikramGoyal23 · 2025-02-08T23:51:22Z

src/main/java/monty/parser/Parser.java

+import monty.ui.Ui;
+import java.time.LocalDate;


A line break between these imports would help improve readability since they belong to different packages.

VikramGoyal23 · 2025-02-08T23:55:12Z

src/main/java/monty/parser/Parser.java

+        switch (command) {
+            case "bye": {


Coding standard dictates that switch statements should have no indentation for their case clauses, outside of Lambda-style switch statements.

VikramGoyal23 · 2025-02-08T23:57:31Z

src/main/java/monty/parser/Parser.java

+
+    private static void processDateCommand(String argument, ArrayList<Task> tasks, Ui ui) throws MontyException {


Good job putting header comments everywhere, but in my opinion, this private method is non-trivial enough to also warrant one.

VikramGoyal23 · 2025-02-09T00:02:13Z

src/test/java/monty/task/TaskTest.java

+package monty.task;
+
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;


Wildcard import.

VikramGoyal23 · 2025-02-09T00:02:22Z

src/test/java/monty/task/ToDoTest.java

+package monty.task;
+
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;


Wildcard import.

VikramGoyal23 · 2025-02-09T00:02:43Z

src/test/java/monty/ui/UiTest.java

+import org.junit.jupiter.api.Test;
+import java.io.ByteArrayOutputStream;


Line break here would be good.

VikramGoyal23 · 2025-02-09T00:02:56Z

src/test/java/monty/ui/UiTest.java

+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+
+import static org.junit.jupiter.api.Assertions.*;


Wildcard import.

VikramGoyal23 · 2025-02-09T00:07:23Z

src/test/java/monty/storage/StorageTest.java

+import org.junit.jupiter.api.Test;
+import java.util.ArrayList;
+import static org.junit.jupiter.api.Assertions.*;


Reorder the org.junit.jupiter imports to be together to follow the coding standard.

Add VarArg functionality.

To better reflect the course's coding standards, I had to make changes to my IDE's settings, especially to handle switch statements and method braces. Line breaks were more complicated to handle and required case-by-case oversight. The coding standard will need to be maintained for future commits.

Refactor code to better reflect Java Coding Standards

Added a new feature to Monty that allows users to sort their task list. ToDo tasks can be sorted alphabetically, while deadlines can be sorted chronologically. In the case of events, the current functionality is to have them automatically sorted by their start dates, but other options are being considered.

Adding the BCD extension before pulling my previous PR changes to the origin repository led to some merge conflicts. Some functionality has been altered, but a rewrite will likely be necessary in future commits.

Previously, when sorting commands using todo, deadline and events, clusters of the different event types would be sorted correctly but they would not be sorted against each other. Under the current implementation, the sort command processes tasks in the order: todo --> deadline --> event (by start time). Therefore, the issue of only sorting clusters of each task type has been resolved.

The profile pictures were made larger. They are kept in square shapes to match the general aesthetic being considered. The aesthetic elements of the UI -- the background, text bar, font and dialog boxes were changed to look more visually interesting, with inspiration being derived from the game Final Fantasy VII.

Added a 'clear' as well as a 'confirm' function to enable the user to clear the task list in a single command after asking for confirmation. The delete command has also been modified to request a confirmation beforehand. Monty's response messages have been tweaked to add more personality to the bot for a more fun and engaging user experience. Some extra, unused pieces of code and some old JavaDoc comments have been removed to make the code look cleaner.

Comprehensive user guide has been updated, and issues involving gradle appear to have been resolved.

Made some small adjustments to the documentation to match Monty's behaviour more accurately. Updated Ui.png according to changes made.

The help command was added, which links to the product site where the different commands are listed and explained.

damithc and others added 14 commits July 11, 2024 16:52

Add Gradle support

68c58c1

Level-0

70ec2fa

Level-1

eb79270

Level-2

b5c543d

Level-3

8910501

Level-4

700318e

Automated Text Testing Added

7ae3d8d

Level-4

a6aa641

Revert "Level-4"

b3ec04e

This reverts commit a6aa641.

Level-5

2cb5d68

Level-6

62dd5eb

Add a Storage class to handle functionality of saving and loading tas…

ea294f0

…k lists. Modify the Task class to include an abstract method to act as a toString for the file and to include a protected variable that can modify the completion status. Modify the Monty class to accommodate.

no message

33a8e3f

Add date feature to convert deadlines into a more readable format.

c4699dd

Add function to be able to retrieve the events or deadlines due/relevant on a specific date.

LuBolin reviewed Feb 6, 2025

View reviewed changes

ZaydM18 added 15 commits February 7, 2025 04:25

Add Ui class to handle the functionality of the chatbot interface.

fcda5fe

Add Parser class to handle the command execution of the chatbot. Refactor Monty to work using new classes to better reflect the Single Responsibility Principle.

Organise code into packages

74d3d96

Create packages

800b29b

Merge commit '68c58c12c1d631736a4b25500248a2956171496f'

e50cd24

Test Gradle

fafff27

Add JUnit testing support.

c95c5c5

Add appropriate test classes to test modular and cohesive functionality. Modified Parser class to better handle exceptions.

Add JavaDoc comments to the code

ff4f216

Reformat to coding standard, switch-case alignment not fixing

96a8dde

Merge branch 'branch-A-CodingStandard' into branch-A-JavaDoc

23f4a95

# Conflicts: # src/main/java/monty/Monty.java # src/main/java/monty/storage/Storage.java

Attempt to resolve merge conflict

4fc6eb7

Add 'find' feature to Parser class.

bfee621

Edit Ui class to include message for the 'find' feature.

Merge branch 'branch-A-JavaDoc' into branch-Level-9

fba847a

# Conflicts: # src/main/java/monty/parser/Parser.java

Add method to retrieve description in Task

217450e

Add more comments

1f0afa7

Merge branch 'branch-A-JavaDoc' into branch-Level-9

3cfcf86

ZaydM18 added 3 commits February 7, 2025 09:21

Add filler to use tag.

6350ddb

Follow git standard (to the best of my knowledge).

Fix issue with JavaDoc comment

ad3c245

Merge branch 'branch-Level-9'

6c7f07c

VikramGoyal23 reviewed Feb 9, 2025

View reviewed changes

ZaydM18 and others added 20 commits February 14, 2025 11:19

Add GUI.

0d9e2e5

Add VarArg functionality.

Add GUI and VarArgs

ca966ae

Add assertions to Task, Storage and MainWindow classes

a7c6ac2

Structure the code to better fit the guidelines

2d96c6c

Merge pull request #2 from ZaydM18/branch-A-CodeQuality

9103693

Refactor code to better reflect Java Coding Standards

Resolve merge conflicts

41361c4

Adding the BCD extension before pulling my previous PR changes to the origin repository led to some merge conflicts. Some functionality has been altered, but a rewrite will likely be necessary in future commits.

Remove unnecessary print statement

080afa9

Try to resolve issues with gradle and git commit history

2c54e3c

Add user guide and clean up gradle issues

270c5ba

Comprehensive user guide has been updated, and issues involving gradle appear to have been resolved.

Update README.md

ca972dc

Release Monty

8ce09d5

Made some small adjustments to the documentation to match Monty's behaviour more accurately. Updated Ui.png according to changes made.

Add files via upload

e035d3c

Add 'close window' functionality to 'bye' command

fd88e3a

Amend Ui and README issues

124ade0

Add help command

be301dd

The help command was added, which links to the product site where the different commands are listed and explained.

		import monty.exception.MontyException;
		import java.util.ArrayList;


		private static void processDateCommand(String argument, ArrayList<Task> tasks, Ui ui) throws MontyException {

		import org.junit.jupiter.api.Test;
		import java.io.ByteArrayOutputStream;

[Zayd Mahmud] ip #466

Are you sure you want to change the base?

[Zayd Mahmud] ip #466

Uh oh!

Conversation

ZaydM18 commented Feb 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Monty -- The Obsessive Taskmaster 🤖

Uh oh!

LuBolin 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!

VikramGoyal23 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ZaydM18 commented Feb 6, 2025 •

edited

Loading