[Nigel Yeo] iP #18

NigelYeoTW · 2024-08-31T11:32:50Z

No description provided.

echos commands entered by the user, and exits when the user types the command bye

Stores the tasks that user inputs and outputs the list when user enter command "list"

Currently, the bot is only able to store the list of task being done but there is no way of allowing users to track if task is done Added marking symbols with "X" between "[ ]" braces after the indexing of task to allow user to track if task is done. User is able to ivoke markTask() and unmarkTask() functions through entering keywords such as "mark" and "unmark" respectively followed by the index of the task in list() function to mark and unmark the tasks.

The code is only able to mark and unmark indexes up to 9 due to the way the function is implemented. The number of task that the bot is implemented for is up to 100 meaning the indexes goes up to 99. Thus it needs to be changed to accomodate this. The code is rectified and fixed to fit the constrain.

Currently, we are only able to add tasks through the bot to the list and this is not very effective as there may be differing types of tasks that require more specific details such as due dates or event timings The bot now is able to have 3 types of Task catergorisation namely, Todo, Deadline Task and Event. Users need to input in "todo", "deadline" and "event" keywords at the start of the input before typing the task to categorise them. Deadline tasks are able to set a deadline for the task by adding a deadline after the "/by" keyword in the input after the task and for events it is able to give a range of time with the "/from" and "/to" keywords after the input of the task.

Test files are correct as of 1 September 2024 after level-4 increment done

This reverts commit e5bb5b4.

Test files are correct as of 1 September 2024 after level-4 increment done

Abstracted methods and conform to naming conventions to improve code readability

chewycj

Overall, I found your code easy to read! There are two changes to take note of, one for line wrapping and another for the default case in the switch statement 👍

chewycj · 2024-09-04T02:50:48Z

src/main/java/Event.java

+        int startingIndexOfEventStart = input.indexOf("/from") + 6;
+        int endingIndexOfEventStart = input.indexOf("/to") - 1;
+        int startingIndexOfEventEnd = endingIndexOfEventStart + 5;


I like how you named these variables, it helps me understand how this part of the code works :)

chewycj · 2024-09-04T02:53:04Z

src/main/java/Legin.java

+            default:
+                echo(input);


Should there be a break; after echo(input)?

chewycj · 2024-09-04T02:55:05Z

src/main/java/Legin.java

+            switch (command) {
+            case "bye":
+                saidBye = true;
+                break;
+            case "list":
+                list();
+                break;
+            case "mark":
+                indexOfTaskToMark = Integer.parseInt(words[1]);
+                markTask(indexOfTaskToMark);
+                break;
+            case "unmark":
+                indexOfTaskToMark = Integer.parseInt(words[1]);
+                unmarkTask(indexOfTaskToMark);
+                break;
+            case "todo":
+                addTodo(input);
+                break;
+            case "deadline":
+                addDeadline(input);
+                break;
+            case "event":
+                addEvent(input);
+                break;


This part of the code is really clean, with good indentations! :D

chewycj · 2024-09-04T04:02:17Z

src/main/java/Legin.java

+        System.out.println("Bye " +
+            Character.toString(0x1F44B) +
+            ". Hope to see you again really soon! " +
+            Character.toString(0x1F608));


Should this indentation for wrapped lines be 8 spaces instead of 4 spaces?

Suggested change

System.out.println("Bye " +

Character.toString(0x1F44B) +

". Hope to see you again really soon! " +

Character.toString(0x1F608));

System.out.println("Bye " +

Character.toString(0x1F44B) +

". Hope to see you again really soon! " +

Character.toString(0x1F608));

crystal-bys

I like how the code is kept simple and neat down the code, and I am inspired to do the same for mine. Great job!

crystal-bys · 2024-09-04T06:57:11Z

src/main/java/Legin.java

+    public static void horizontalLine() {
+        System.out.println("______________________" +
+                "______________________________________");
+    }


good to do this! as one might want to print lines for every output, doing this is logical so you can call it when needed and keep things neat.

crystal-bys · 2024-09-04T07:00:47Z

src/main/java/Legin.java

+    private static void printAddedTaskMessage() {
+        horizontalLine();
+        System.out.println("Got it. I've added this task:");
+        System.out.println(tasks[currentTaskCount]);
+        currentTaskCount++;
+        System.out.println("Now you have " + currentTaskCount + " tasks in the list.");
+        horizontalLine();
+    }


good job doing this as it prevents repeated lines of code! I see that you call this quite often below :)

crystal-bys · 2024-09-04T07:03:38Z

src/main/java/Legin.java

+    public static void main(String[] args) {
+        greet();
+        runBot();
+        bye();
+    }


I was surprised when I see this, good to see that all you managed to keep things simple here

crystal-bys · 2024-09-04T07:04:42Z

src/main/java/Legin.java

+            default:
+                echo(input);


I didn't think of doing a default case. good job!

Currently, the bot is unable to verify or validate the input of the users which may lead to various unexpected outcomes and behaviours that is not intended. The bot thus added try catch statements for customised exceptions for the bot. The exceptions are as follows: 1. When user inputs no task for his/her todos, events, deadlines 2. When user inputs an invalid command 3. When user missed out parameters for a given event or deadline The bot will catch these human errors and output them to the user so he/her can edit the input and give the bot the expected one.

Currently, the bot is unable to delete the task which is is required by the user when he/she wants to remove a task that is no longer relevant. The current implementation is of a fixed size array of 100 which makes it inconvininet to delete task efficiently. The bot now runs with an ArrayList instead of fixed length array to leverage on the remove function of the collection. This allows easy deletion of tasks. The user can use the delete function with the following input 'delete [task number]'.

Currently, users cannot save their task data on the bot and will restart to an empty task list everytime they run the bot, this defeats the purpose of having a bot that tracks your daily and future tasks. Filewriting to a local file is implemented such that the file loads the user's data from the file into the bot everytime it is ran and updates the file each time the bot shuts down using the bye funciton.

tzerbin

It is a very good attempt to follow all the guidelines.
Do make sure you get rid of magic strings / numbers and change some of the naming for methods and boolean variables.

tzerbin · 2024-09-19T17:08:04Z

src/main/java/Legin.java

+import task.Task;
+import task.Todo;
+import java.io.IOException;
+import java.util.ArrayList;


Good job on providing explicit imports. Perhaps you would want to order them in a collated order e.g. java.util.ArrayList is together with java.util.Scanner, since both comes from java.util package.
Note that this is part of Java coding standard - Intermediate.

tzerbin · 2024-09-19T17:09:38Z

src/main/java/Legin.java

+    private static int currentTaskCount = 0;
+    private static final String FILE_PATH = "./tasklist.txt";
+
+    public static void horizontalLine() {


You would want to use verbs to name a method instead of nouns.

Suggested change

public static void horizontalLine() {

public static void printHorizontalLine() {

tzerbin · 2024-09-19T17:13:15Z

src/main/java/Legin.java

+    public static void addTextDataToArray(String[] words) throws LeginEmptyTaskException {
+        String taskType = words[0];
+        switch(taskType) {
+        case "T":


Could you prevent the usage of magic numbers and characters?

tzerbin · 2024-09-19T17:16:55Z

src/main/java/Legin.java

+            while (s.hasNext()) {
+                String[] words = s.nextLine().split("\\|");
+                addTextDataToArray(words);
+            }


Please look out for indentations.

tzerbin · 2024-09-19T17:17:59Z

src/main/java/Legin.java

+        }
+    }
+
+    public static void list() {


Perhaps be more specific on the naming of this method.

tzerbin · 2024-09-19T17:20:08Z

src/main/java/Legin.java

+    }
+
+    public static void runBot() {
+        boolean saidBye = false;


Perhaps name the boolean with a prefix "has"?

tzerbin · 2024-09-19T17:21:41Z

src/main/java/Legin.java

+        inputTextFileData();
+        horizontalLine();
+    }
+    public static void bye() throws IOException {


Similar to a previous issue, would you like to use verbs for this method instead?

tzerbin · 2024-09-19T17:23:20Z

src/main/java/task/Deadline.java

+        return input.substring(input.indexOf(" ") + 1, input.indexOf("/by") - 1);
+    }
+
+    private static void validityCheck(String input) throws LeginMissingParamsException,


You would want to use a verb here instead.

Suggested change

private static void validityCheck(String input) throws LeginMissingParamsException,

private static void checkValidity(String input) throws LeginMissingParamsException,

tzerbin · 2024-09-19T17:24:11Z

src/main/java/task/Deadline.java

+    private static void validityCheck(String input) throws LeginMissingParamsException,
+            LeginEmptyTaskException {
+        int indexOfBy = input.indexOf("/by");
+        if (indexOfBy == 9) {


Would you be able to remove the magic numbers in this file (as well as other files)?

tzerbin · 2024-09-19T17:24:56Z

src/main/java/task/Deadline.java

+        this.by = input.substring(startingIndexOfDueDate);
+    }
+
+    public Deadline(String description, String by) throws LeginEmptyTaskException {


What does "by" refers to? It would be good if this is named more appropriately.

tzerbin · 2024-09-19T17:36:16Z

src/main/java/Legin.java

+            break;
+        case "E":
+            tasks.add(new Event(words[2], words[3], words[4]));
+            break;


You may want to prevent error-prone code by adding default branch.

Currently, the coding structure lacks seperate containers to group the type of functions in the Main class. This makes the code untidy and unorganised. Additional classes Ui, Parser, TaskList and Storage are created. Ui class contains of all the required print statements for the entire program and all classes use Ui methods to print or take in input. Parser class deals with user input and parses it into command, the actual task, date and more. Parser mainly calls TaskList methods accordingly after retrieving the relevant details from the input. TaskList class stores all the Task for the session and its methods change the current tasklist such as adding task, deleting task, marking them and more. Storage class is used in the initial start up of the programme as well as before the program closes, it loads the text file information into the program as well as save its state before the user exits.

Currently, the scope of usage remains to smaller number of task but as we expand the usage to accomodate higher number of tasks, the need for a find function becomes more apparent to ease the usage of finding tasks when the list gets long. Find function is implemented and ivoked with the command 'find' followed by the words that the user wishes to match. The output list all matching tasks with those keywords.

Add find function to bot

Add JavaDoc comments for the entire code base

Repackage files and clean up code

NigelYeoTW added 11 commits August 17, 2024 21:07

Changed Duke to Legin and completed greet and bye functions

ba42b3f

Added echo function

9480bca

echos commands entered by the user, and exits when the user types the command bye

Added list function

9f79a46

Stores the tasks that user inputs and outputs the list when user enter command "list"

Minor edits to conform to coding standards

e7570df

Add text ui testing files for regression testing

e5bb5b4

Test files are correct as of 1 September 2024 after level-4 increment done

Revert "Add text ui testing files for regression testing"

3d3adbf

This reverts commit e5bb5b4.

Add text ui testing files for regression testing

ff4197b

Test files are correct as of 1 September 2024 after level-4 increment done

Refactor code to improve code quality

eacfe95

Abstracted methods and conform to naming conventions to improve code readability

chewycj reviewed Sep 4, 2024

View reviewed changes

crystal-bys reviewed Sep 4, 2024

View reviewed changes

NigelYeoTW added 10 commits September 7, 2024 18:35

Merge branch 'branch-Level-5'

fe7a47c

Package current files into task and exception

81669a4

Merge branch 'branch-A-Packages'

423cced

Minor changes to fix update file bug

2b5dfa1

Remove unneeded code blocks

0d7ceca

Merge branch 'branch-Level-6'

b17a881

Merge branch 'branch-Level-7'

b23c82f

tzerbin reviewed Sep 19, 2024

View reviewed changes

NigelYeoTW and others added 5 commits September 23, 2024 16:55

Merge branch 'branch-A-MoreOOP'

8eb51ec

Merge pull request #1 from NigelYeoTW/branch-Level-9

e153271

Add find function to bot

Add JavaDoc comments for the entire code base

76a1379

NigelYeoTW and others added 25 commits September 24, 2024 12:10

Merge pull request #2 from NigelYeoTW/branch-A-JavaDoc

38071a3

Add JavaDoc comments for the entire code base

Minor changes to tidy up code

79e8102

Remove magic numbers from code

33034ee

Update README.md

5a7094d

Edit constants to fix bug

57717d6

Update README.md

ea61d86

Update README.md

9850c6f

Update README.md

49e3636

Update README.md

f2ba19f

Rename variables with better readability

9e137a2

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

d72baff

Update README.md

dc3c9ec

Update README.md

1032379

Update README.md

9ef22f1

Update README.md

7426f4b

Update README.md

88097a9

Update README.md

a10412d

Update README.md

e950539

Update README.md

5f5c2fc

Update README.md

c8f728c

Update README.md

d46b4aa

Repackage files and clean up code

62a277d

Merge branch 'branch-cleanUp'

289f50c

Merge pull request #3 from NigelYeoTW/branch-cleanUp

08bc279

Repackage files and clean up code

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

8c4c8f5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Nigel Yeo] iP #18

[Nigel Yeo] iP #18

NigelYeoTW commented Aug 31, 2024

chewycj left a comment

chewycj Sep 4, 2024

chewycj Sep 4, 2024

chewycj Sep 4, 2024

chewycj Sep 4, 2024

crystal-bys left a comment

crystal-bys Sep 4, 2024

crystal-bys Sep 4, 2024

crystal-bys Sep 4, 2024

crystal-bys Sep 4, 2024

tzerbin left a comment

tzerbin Sep 19, 2024

tzerbin Sep 19, 2024

tzerbin Sep 19, 2024

tzerbin Sep 19, 2024

tzerbin Sep 19, 2024

tzerbin Sep 19, 2024

tzerbin Sep 19, 2024

tzerbin Sep 19, 2024

tzerbin Sep 19, 2024

tzerbin Sep 19, 2024

tzerbin Sep 19, 2024

	public static void horizontalLine() {
	public static void printHorizontalLine() {

	private static void validityCheck(String input) throws LeginMissingParamsException,
	private static void checkValidity(String input) throws LeginMissingParamsException,

[Nigel Yeo] iP #18

Are you sure you want to change the base?

[Nigel Yeo] iP #18

Conversation

NigelYeoTW commented Aug 31, 2024

chewycj 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

crystal-bys 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

tzerbin 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment