PR for Week 4 peer review #543

amosting · 2023-09-04T02:30:54Z

No description provided.

Deleted Duke.java, replaced with Jarvis.java and edited Jarvis.java

Added logic to echo user commands. If user enters anything other than bye, echo. If user enters bye, reply with goodbye message.

Added logic to store tasks and print out a list of tasks when the request "list" is given.

Added Task.java. Added logic for "mark" and "unmark"

Added Todo.java, Event.java and Dealine.java which inherit from Task.java Added logic in Jarvis.java to handle "todo", "event" and "deadline" commands

Added command line inputs into input.txt and expected outputs into expected.txt. Added simple logic to handle erroneous inputs, this is not completed. Removed ASCII art because it was causing too many issues with the input output comparison.

Added JarvisException.java which is the parent of IncorrectJarvisCommandException.java, InvalidTaskNumberException.java and WrongJarvisCommandFormatException.java Added logic to handle errors in Jarvis.java

Added logic to handle delete command. Added error handling for delete command. Organised error handling to become more modular and added regex matching.

Added save logic to allow for task list to be saved to local drive. Used gitignore on data.txt so that git will not track changes to data.txt as it is the file that stores the task list data. Further modularised and cleaned up code in main.

This reverts commit 4aea4a8.

This reverts commit 8cfc1a6.

Added logic in Deadline class to handle date recognition. Added empty function in Task class for inheritance in Deadline class.

TaskList.java added to extract out tasklist related code from main to keep code modular. appendTask, addTask, deleteTask, getTask, countTask, isValidTaskNumber, printTask, printDelete, printTaskList all added into TaskList.java

Storage.java added to extract out loading and saving file related code from main to keep code modular. load, deleteContents, save methods added Logic for instantiating TaskList object from a saved file also added

Parser.java added to process user commands and execute the proper actions needed, this logic was shifted from Jarvis.java for OOP Ui.java added to handle UI interfacing with users, printing the proper information needed for a pleasant user experience, this logic was shifted form Jarvis.java for OOP Jarvis.java edited to handle the increase in OOP

Organised all .java files into the Jarvis Package

This reverts commit 48cf1ab.

Organised classes into Jarvis package for better organisation

Changed the file name in the Gradle build file so that gradle can run the program.

Added ToDoTest and DeadlineTest classes and used JUnit to test the toString() methods ToDo and Deadline classes respectively.

Added archiveFileName in order for .jar file to be named correctly

Added findTask to TaskList class to identify matching tasks and return them in a Task ArrayList. Added printFoundTask to Ui.java to show the user the found files.

Added JavaDoc descriptions to the Deadline, Event, Jarvis, Parser, Task, TaskList and ToDo classes.

ivanleekk · 2023-09-04T05:59:32Z

src/main/java/Jarvis/Parser.java

+    /**
+     * Adds the list of valid commands into the validCommands ArrayList.
+     */
+    private void addValidCommands() {


good job on naming the method as a verb and writing it in camelCase, keep it up!

ivanleekk · 2023-09-04T06:05:25Z

src/main/java/Jarvis/Parser.java

+        boolean uncheckMatch = inputCommand.matches("unmark \\d+");
+        boolean todoMatch = inputCommand.matches("todo .+");
+        boolean deadlineMatch = inputCommand.matches("deadline .+ /.+");
+        boolean eventMatch = inputCommand.matches("event .+ /.+ /.+");


if possible try to use a prefix like is, has or was to make it clearer that it is a boolean

awhb

Looks good 👍
Some cosmetic changes requested.

awhb · 2023-09-05T06:12:22Z

src/main/java/Jarvis/TaskList.java

+                System.out.println(line);
+                System.out.println(e.getMessage());
+                System.out.println("    There are currently " + this.taskList.size() + " tasks in the list.");
+                System.out.println(line);


Do consider letting your implemented UI class handle rendering the text to the user!

awhb · 2023-09-05T06:17:58Z

src/main/java/Jarvis/Task.java

+ *     the basic information and operations related to a task.
+ * </p>
+ */
+public class Task {


Do consider adding the abstract keyword to abstract classes and methods so it is more obvious to others as well!

awhb · 2023-09-05T06:21:51Z

src/main/java/Jarvis/Ui.java

+    private static final String name = "Jarvis";
+    private static final String line = "____________________________________________________________";
+    private static final String greeting = "Good day Sir! I'm ";
+    private static final String question = "How can I help you today Sir?";
+    private static final String signOff = "Good bye Sir!";
+    private static final String listInforming = "Here are the tasks in your list Sir:";
+    private static final String markInforming = "Roger that Sir, I've marked this task as done:";
+    private static final String uncheckInforming = "Noted Sir, I've marked this task as NOT done yet:";
+    private static final String taskInforming = "As you please Sir, I've added the task:";
+    private static final String deleteInforming = "Alright Sir, I've removed this task";
+    private static final String findInforming = "Here are the matching tasks in your list Sir:";


Given that these are meant to be constants, do consider naming them using the constant names style stated in the Java coding standard for this course!

Suggested change

private static final String name = "Jarvis";

private static final String line = "____________________________________________________________";

private static final String greeting = "Good day Sir! I'm ";

private static final String question = "How can I help you today Sir?";

private static final String signOff = "Good bye Sir!";

private static final String listInforming = "Here are the tasks in your list Sir:";

private static final String markInforming = "Roger that Sir, I've marked this task as done:";

private static final String uncheckInforming = "Noted Sir, I've marked this task as NOT done yet:";

private static final String taskInforming = "As you please Sir, I've added the task:";

private static final String deleteInforming = "Alright Sir, I've removed this task";

private static final String findInforming = "Here are the matching tasks in your list Sir:";

private static final String NAME = "Jarvis";

private static final String LINE = "____________________________________________________________";

private static final String GREETING_MESSAGE = "Good day Sir! I'm ";

private static final String QUESTION_MESSAGE = "How can I help you today Sir?";

private static final String SIGN_OFF_MESSAGE = "Good bye Sir!";

private static final String LIST_MESSAGE = "Here are the tasks in your list Sir:";

private static final String MARK_MESSAGE = "Roger that Sir, I've marked this task as done:";

private static final String UNCHECK_MESSAGE = "Noted Sir, I've marked this task as NOT done yet:";

private static final String TASK_MESSAGE = "As you please Sir, I've added the task:";

private static final String DELETE_MESSAGE = "Alright Sir, I've removed this task";

private static final String FIND_MESSAGE = "Here are the matching tasks in your list Sir:";

Added CheckStyle to detect coding style violations, added logic in build.gradle to support checkstyle. Edited existing code after adding CheckStyle make sure coding style is not violated.

ryanozx · 2023-09-06T00:10:26Z

src/main/java/Jarvis/Deadline.java

+ * </p>
+ */
+public class Deadline extends Task {
+    protected String by;


These names seem to have the potential to confuse, perhaps a more descriptive name will make the differences between the two variables clearer?

ryanozx · 2023-09-06T00:14:34Z

src/main/java/Jarvis/Parser.java

+     * @param validInputCommand the valid command which the user inputted
+     */
+    // identifies which command has wrong formatting and prints feedback to user
+    public static void isWrongFormat(String inputCommand, String validInputCommand) {


The method name seems to imply that it will return a boolean, perhaps a more appropriate method name could be "handleWrongFormat"?

ryanozx · 2023-09-06T00:20:44Z

src/main/java/Jarvis/TaskList.java

+ * </p>
+ */
+public class TaskList {
+    private ArrayList<Task> taskList;


Perhaps a more appropriate name for this variable could be "tasks" to highlight that it stores a collection?

ryanozx · 2023-09-06T00:24:49Z

src/main/java/Jarvis/TaskList.java

+        return isValid;
+    }
+
+    public ArrayList<Task> findTask(String keyword) {


Since multiple tasks can be returned, perhaps a more appropriate name could be "findTasks"?

Added DialogBox, Launcher, Main and MainWindow classes to support javaFx. Edited Jarvis, Parser, TaskList and Ui classes to support javaFx.

starrylight99 · 2023-09-09T14:53:48Z

src/main/java/Jarvis/Parser.java

+        }
+        return null;
+    }
+}


code seems to be a little convoluted, maybe try using enums to replace the if/else statements. For exception handling, i think it would be better if you create separate classes for the different exceptions instead of handling it using if/else

Added assertions to Jarvis, Parser, Storage, TaskList, Ui classes.

…asses. Dead code and unused variables are redundant and confuses other developers. Wrong use of static keyword confuses others developers as class level methods and attributes are not actually meant to be as such. Delete dead code and remove unnecessary static keywords. So as to declutter code and fix wrong class level methods.

Added gradle.yml file to set up CI for iP.

… and its children. To support adding priority levels to tasks.

…tional priority value in Tasks. The current pattern recognition logic does not support the additional priority string. And the current constructors used to construct Task objects does not support Task classes. New pattern recognition logic recognises when the user adds low/medium/high after typing the previous format of tasks.

…r input. Edited regex expression in TaskList to handle priority field. Edited return statements in Ui.java to return correct task format for new priority feature.

Edited README.md to have a proper user guide for Jarvis chatbot. Edited some small Ui class return strings to ensure proper and consistent formatting.

damithc and others added 27 commits August 9, 2023 02:16

Add Gradle support

28ad2b8

Bump gradle and lib version

ed6d4d2

Level 0. Rename, Greet, Exit.

26b9e67

Deleted Duke.java, replaced with Jarvis.java and edited Jarvis.java

Level 1. Echo

07ec1b4

Added logic to echo user commands. If user enters anything other than bye, echo. If user enters bye, reply with goodbye message.

Level 2. Add, List.

92d1e60

Added logic to store tasks and print out a list of tasks when the request "list" is given.

Level 3. Mark as Done.

16ff2bc

Added Task.java. Added logic for "mark" and "unmark"

Level 4. ToDos, Events, Deadlines

9352ee1

Added Todo.java, Event.java and Dealine.java which inherit from Task.java Added logic in Jarvis.java to handle "todo", "event" and "deadline" commands

A-TextUiTesting: Automated Text UI Testing

2cf0402

Added command line inputs into input.txt and expected outputs into expected.txt. Added simple logic to handle erroneous inputs, this is not completed. Removed ASCII art because it was causing too many issues with the input output comparison.

Level 5. Handle Errors.

c59aaf2

Added JarvisException.java which is the parent of IncorrectJarvisCommandException.java, InvalidTaskNumberException.java and WrongJarvisCommandFormatException.java Added logic to handle errors in Jarvis.java

Level 6. Delete.

51a3755

Added logic to handle delete command. Added error handling for delete command. Organised error handling to become more modular and added regex matching.

Add Level 7. Save.

4aea4a8

Added save logic to allow for task list to be saved to local drive. Used gitignore on data.txt so that git will not track changes to data.txt as it is the file that stores the task list data. Further modularised and cleaned up code in main.

Revert "Add Level 7. Save."

8cfc1a6

This reverts commit 4aea4a8.

Revert "Revert "Add Level 7. Save.""

9eadc16

This reverts commit 8cfc1a6.

Add Level 8. Dates and Times.

dc10fae

Added logic in Deadline class to handle date recognition. Added empty function in Task class for inheritance in Deadline class.

Add TaskList.java

d8cb2c5

TaskList.java added to extract out tasklist related code from main to keep code modular. appendTask, addTask, deleteTask, getTask, countTask, isValidTaskNumber, printTask, printDelete, printTaskList all added into TaskList.java

Add Storage.java

27a6152

Storage.java added to extract out loading and saving file related code from main to keep code modular. load, deleteContents, save methods added Logic for instantiating TaskList object from a saved file also added

A-Packages. Organize into Packages.

48cf1ab

Organised all .java files into the Jarvis Package

Revert "A-Packages. Organize into Packages."

04a8164

This reverts commit 48cf1ab.

A-Packages. Organise into packages.

6958f1b

Organised classes into Jarvis package for better organisation

Merge commit 'ed6d4d25bd4e34461919ffe785a6f10f4c087552' into A-Gradle

ef14643

Add A-Gradle. Use Gradle.

5cf8a7f

Changed the file name in the Gradle build file so that gradle can run the program.

A-JUnit. Add JUnit Tests.

f27d99a

Added ToDoTest and DeadlineTest classes and used JUnit to test the toString() methods ToDo and Deadline classes respectively.

A-Jar. Create a JAR File.

b02aef4

Added archiveFileName in order for .jar file to be named correctly

Add Level-9. Find.

29329cd

Added findTask to TaskList class to identify matching tasks and return them in a Task ArrayList. Added printFoundTask to Ui.java to show the user the found files.

Add. A-JavaDoc. JavaDoc.

c429a82

Added JavaDoc descriptions to the Deadline, Event, Jarvis, Parser, Task, TaskList and ToDo classes.

Merge branch 'Level-9'

2f4acb9

ivanleekk reviewed Sep 4, 2023

View reviewed changes

awhb reviewed Sep 5, 2023

View reviewed changes

Add A-CheckStyle. Use CheckStyle.

2c7c4ca

Added CheckStyle to detect coding style violations, added logic in build.gradle to support checkstyle. Edited existing code after adding CheckStyle make sure coding style is not violated.

ryanozx reviewed Sep 6, 2023

View reviewed changes

Add Level-10. GUI.

3e4610c

Added DialogBox, Launcher, Main and MainWindow classes to support javaFx. Edited Jarvis, Parser, TaskList and Ui classes to support javaFx.

starrylight99 reviewed Sep 9, 2023

View reviewed changes

amosting added 11 commits September 13, 2023 17:41

Add A-Assertions. Use Assertions.

fb007b2

Added assertions to Jarvis, Parser, Storage, TaskList, Ui classes.

A-CI. Set up CI.

460f202

Added gradle.yml file to set up CI for iP.

Add priority attribute, methods and priority level enum to Task class…

d77a671

… and its children. To support adding priority levels to tasks.

Add logic to handle new priority feature, for checking of correct use…

6ecc802

…r input. Edited regex expression in TaskList to handle priority field. Edited return statements in Ui.java to return correct task format for new priority feature.

Add Ui screenshot of product

80f3eb2

Add User Guide.

6f2d229

Edited README.md to have a proper user guide for Jarvis chatbot. Edited some small Ui class return strings to ensure proper and consistent formatting.

Renamed to Ui.png

4b00c23

Bug fixes

159f381

Merge branch 'master' of https://github.com/amosting/ip

71c19f3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PR for Week 4 peer review #543

PR for Week 4 peer review #543

amosting commented Sep 4, 2023

ivanleekk Sep 4, 2023

ivanleekk Sep 4, 2023

awhb left a comment

awhb Sep 5, 2023

awhb Sep 5, 2023

awhb Sep 5, 2023

ryanozx Sep 6, 2023

ryanozx Sep 6, 2023

ryanozx Sep 6, 2023

ryanozx Sep 6, 2023

starrylight99 Sep 9, 2023

PR for Week 4 peer review #543

Are you sure you want to change the base?

PR for Week 4 peer review #543

Conversation

amosting commented Sep 4, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

awhb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment