[audipras] iP by audipras · Pull Request #629 · nus-cs2103-AY2425S1/ip

audipras · 2024-09-02T08:17:46Z

MAGA Chatbot

"Despite the negative press covfefe." - Donald Trump (source)

The release of this chatbot is yuuuuuge - like, YUUUGE. It's gonna solve ALL your task-related problems. Just trust me - its the best 👌. It has:

Easy text interface
Simple, easy commands
~~TRUMP~~ DRUMPF SPEECH

Features:

Create tasks
Mark tasks complete
Create events and deadlines

People who endorse this app:

Me (Donald Trump)
The people of America
Crooked Kamala (Yes, even her!)

I support all jobs and occupations in America - yes, even our dear musicians and artists. Look at the beautiful art this bot has:

    private void printGreeting() {
        String logo = "  __  __                    \n"
                + " |  \\/  |  __ _   __ _   __ _  \n"
                + " | |\\/| | / _` | / _` | / _` | \n"
                + " | |  | || (_| || (_| || (_| || \n"
                + " |_|  |_| \\__,_| \\__, | \\__,_|  \n"
                + "                  |___/                           \n";
        System.out.println("Hello from\n" + logo +"\nI am THE best chatbot from the one and only" +
                " US of A trust me everyone says I'm the best. How can I help you serve the American people?" );
    }

Download this bot nowww 👌 - Make America Great Again!!

In build.gradle, the dependencies on distZip and/or distTar causes the shadowJar task to generate a second JAR file for which the mainClass.set("seedu.duke.Duke") does not take effect. Hence, this additional JAR file cannot be run. For this product, there is no need to generate a second JAR file to begin with. Let's remove this dependency from the build.gradle to prevent the shadowJar task from generating the extra JAR file.

This reverts commit 66ca9d2.

dominic2412

In summary, your code largely follows good naming conventions, which significantly contributes to its readability and maintainability. The main areas for improvement are in using more descriptive class names and avoiding abbreviations like descrip. These changes will make your code even more intuitive and easier for others to understand.

Keep up the good work! :))

dominic2412 · 2024-09-03T11:36:47Z

@@ -0,0 +1,80 @@
+import task.TaskList;


Parser is a good name for a class responsible for parsing input. It clearly describes its purpose. Well done here!

dominic2412 · 2024-09-03T11:37:31Z

+    private void run() {
+        printGreeting();
+        TaskManager taskManager = new TaskManager();
+        TaskList taskList = initialiseBot(taskManager);


accurately describes the action it performs, which is good practice.

dominic2412 · 2024-09-03T11:38:19Z

+    }
+
+    public void deleteTask(int taskNumber) {
+        Task tempTask = taskList[taskNumber];


tempTask is used to refer to a task temporarily during deletion or other operations, very well used!

dominic2412 · 2024-09-03T11:38:42Z

+        }
+    }
+
+    public void addTask(String input) {


The variable input is well-named as it clearly indicates that it holds user input. It is appropriately concise and descriptive.

dominic2412 · 2024-09-03T11:39:04Z

+    public void addTask(String input) {
+        Task task = new TodoTask("");
+        if(input.startsWith("todo ")) {
+            String descrip = input.substring(5).trim();


The abbreviation descrip is a bit unclear at first glance. It would be better to use the full word description for clarity.

adipanda2002

Overall, LGTM. Your OOP principles are generally well followed in your code. I feel the readability of your code could be enhanced by adding in Javadoc comments, and also perhaps using enums. Some other nits to fix here and there.

adipanda2002 · 2024-09-03T16:11:46Z

+import task.TaskList;
+import task.TaskManager;
+
+public class Maga {


I like your use of OOP concepts to make your main class clean and easy to read

adipanda2002 · 2024-09-03T16:12:42Z

+                continue;
+            }
+
+            // mark tasks as done


comments to explain each command follow coding style well and helpful in understanding the code

adipanda2002 · 2024-09-03T16:13:24Z

+    }
+
+    public void handleInput(String input) {
+        while(!input.equalsIgnoreCase("bye")) {


You could consider the use of enums instead of representing Tasks as Strings.

adipanda2002 · 2024-09-03T16:15:37Z

+    private TaskList initialiseBot(TaskManager taskManager) {
+        return taskManager.loadTasks();
+    }
+


I think you are missing Javadoc commands across your codebase? I understand it is time consuming, but perhaps writing javadocs for at least the key methods will enable future readers of your code to understand it more seamlessly.

adipanda2002 · 2024-09-03T16:18:01Z

+            String to = parts[4];
+            return new DeadlineTask(isDone, description, from, to);
+        }
+


Did you mean to have 'from' and 'to' parameters for Deadline and 'dateTime' for Event? Logically speaking, they should be the other way around don't you think?

adipanda2002 · 2024-09-03T16:19:31Z

+    public TaskList loadTasks() {
+        TaskList tasks = new TaskList(100);
+        File file = new File(FILE_PATH);
+


I like that you are sticking to the style when it comes to indenting comments relative to their position in the code

Add Command, Controller and InvalidCommandException classes Add Junit Tests for delete, mark and unmark functions

Using the exit command now properly closes javafx window after a pause. Bot now properly saves tasks to the task file after every change to the task list.

Create packages 'ui', 'middleware', 'commands' and 'exceptions' to further organise code.

Add new exception

Add assertions

Tagging tasks is unavailable. User can't categorise tasks since description can't be changed. Add new 'tag' string field to each task, and add new 'tag' command so users can tag current tasks.

No help manual for the user. Create user guide to orient the user on how to use the bot. The user can immediately use the bot without facing errors with bot usage.

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

Add Gradle support

68c58c1

Bump gradle and lib version

03523ec

level 0

48c6db5

level 1

c11a2cc

level 2

cea95f0

level 3

4c12dc8

level 4

1027d13

level 5

2844e5c

level 6

3c8575e

bug fix

66ca9d2

Revert "bug fix"

e90f71a

This reverts commit 66ca9d2.

git bug fix

8d5830d

Merge branch 'nus-cs2103-AY2425S1:master' into master

c1db7a7

Create taskList class

5f9175c

Tasklist class: fix delete and list errors

bbac10d

Create TaskManager class handling save and load

e4df571

Add date time formatting

4ec25a9

Package task-related classes into task

52b972a

dominic2412 reviewed Sep 3, 2024

View reviewed changes

adipanda2002 reviewed Sep 3, 2024

View reviewed changes

audipras added 9 commits September 4, 2024 16:51

Delete unused Duke.java file

df59e79

Merge branch 'master' into add-gradle-support

bd08a3a

Add gradle wrapper + Add wrapping duke package

51b9f6f

Fix build.gradle mainclass directory

88188ec

Refactor code structure

a0213e5

Add Command, Controller and InvalidCommandException classes Add Junit Tests for delete, mark and unmark functions

Add find function + checkstyle

242ec6f

Add java doc for most classes and public methods

aa50faa

Merge branch 'branch-A-JavaDoc'

e68be65

Fix off by 1 JUnit test bug

22f7156

audipras and others added 20 commits September 5, 2024 16:52

Amend code snippets to follow Java Coding Standard

c02933a

Fix CheckStyle errors

2db8eef

Add javafx ui

a39c42d

Add close functionality + fix save functionality

8ab40fb

Using the exit command now properly closes javafx window after a pause. Bot now properly saves tasks to the task file after every change to the task list.

Package classes

a836e16

Create packages 'ui', 'middleware', 'commands' and 'exceptions' to further organise code.

Refactor package imports

b830dd4

Delete text-ui test

f4c3b9b

Add new exception

ecd553b

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

ca0e6b0

Add new exception

Add assertions

f357a61

Merge branch 'master' into branch-A-Assertions

75e65cf

Merge pull request #3 from audipras/branch-A-Assertions

8166b8f

Add assertions

Add tagging functionality

2b4b715

Tagging tasks is unavailable. User can't categorise tasks since description can't be changed. Add new 'tag' string field to each task, and add new 'tag' command so users can tag current tasks.

Merge branch 'branch-C-Tagging'

a35ddce

Add user guide

2cb634f

No help manual for the user. Create user guide to orient the user on how to use the bot. The user can immediately use the bot without facing errors with bot usage.

Fix Readme Grammar

dc74888

Update javadocs to include tag field

fd567bc

Fix checkstyle errors

09f4b34

Fix delete test case

fac2a91

Add local txt file to .gitignore

e9df90e

Navigation Menu

Uh oh!

[audipras] iP - #629

[audipras] iP#629
audipras wants to merge 48 commits into
nus-cs2103-AY2425S1:masterfrom
audipras:master

audipras commented Sep 2, 2024 •

edited

Loading

Uh oh!

dominic2412 left a comment

Uh oh!

dominic2412 Sep 3, 2024

Uh oh!

dominic2412 Sep 3, 2024

Uh oh!

dominic2412 Sep 3, 2024

Uh oh!

dominic2412 Sep 3, 2024

Uh oh!

dominic2412 Sep 3, 2024

Uh oh!

adipanda2002 left a comment

Uh oh!

adipanda2002 Sep 3, 2024

Uh oh!

adipanda2002 Sep 3, 2024

Uh oh!

adipanda2002 Sep 3, 2024

Uh oh!

adipanda2002 Sep 3, 2024

Uh oh!

adipanda2002 Sep 3, 2024

Uh oh!

adipanda2002 Sep 3, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

audipras commented Sep 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

MAGA Chatbot

Uh oh!

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

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

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

audipras commented Sep 2, 2024 •

edited

Loading