[Ryan Tan] iP by ryan-txn · Pull Request #103 · nus-cs2113-AY2425S1/ip

ryan-txn · 2024-09-03T08:17:46Z

No description provided.

This reverts commit 812d612.

This reverts commit 5f645dc.

Add functions to print the intro and exit messages, add elements to the list and print the list.

LTK-1606

Overall, looks pretty ok! Incorporating Error Handling and Classes could save you a lot of headache in the future

LTK-1606 · 2024-09-04T05:41:48Z

+                int taskIndex = Integer.parseInt(input.substring(5)) - 1;
+                markTask(taskIndex);
+            } else if (input.startsWith("unmark ")) {
+                int taskIndex = Integer.parseInt(input.substring(7)) - 1;
+                unmarkTask(taskIndex);


Consider not having multiple levels of abstraction in a single code fragment

LTK-1606 · 2024-09-04T05:42:00Z

+        Scanner scanner = new Scanner(System.in);
+        String input;
+
+        while (true) {


Maybe consider using a variable instead for readability

LTK-1606 · 2024-09-04T05:42:25Z

+    private static final String[] tasks = new String[MAX_TASKS];  // Array to store tasks
+    private static final boolean[] isCompleted = new boolean[MAX_TASKS];  // Array to store task completion status
+    private static int taskCount = 0;  // Counter to keep track of the number of tasks


Why not use a Class to represent all instances of tasks?

LTK-1606 · 2024-09-04T05:44:47Z

+        if (index >= 0 && index < taskCount) {
+            isCompleted[index] = true;
+            printLine();
+            System.out.println("Awesomesauce! I've marked this task as done:");
+            System.out.println("  [X] " + tasks[index]);
+            printLine();
+        }


Consider including error handling

LTK-1606 · 2024-09-04T05:45:52Z

+    }
+
+    private static void printLine() {
+        System.out.println("____________________________________________________________");


Consider using ( "_*30" ) instead

Zackermax · 2024-09-04T05:49:55Z

+                          " ______                   \n"
+                        + "/_  __/__  __ _  __ _  (_)\n"
+                        + " / / / _ \\/  ' \\/  ' \\/ / \n"
+                        + "/_/  \\___/_/_/_/_/_/_/_/  \n"
+                        + "____________________________________________________________\n"
+                        + "Hello! I'm Tommi!\n"
+                        + "What can I do for you?\n"
+                        + "____________________________________________________________\n";


Indentation for wrapped lines should be 8 spaces (i.e. twice the normal indentation of 4 spaces) more than the parent line.

Zackermax · 2024-09-04T05:52:18Z

+            if (input.equals("bye")) {
+                printExitMessage();
+                break; // Exit the loop
+            } else if (input.equals("list")) {
+                listTasks();
+            } else if (input.startsWith("mark ")) {
+                int taskIndex = Integer.parseInt(input.substring(5)) - 1;
+                markTask(taskIndex);
+            } else if (input.startsWith("unmark ")) {
+                int taskIndex = Integer.parseInt(input.substring(7)) - 1;
+                unmarkTask(taskIndex);
+            } else {
+                addTask(input);
+            }


Code would be much neater with a switch-case structure instead of if-else.

Zackermax · 2024-09-04T05:58:10Z

+import java.util.Scanner;
+
+public class Tommi {
+    private static final int MAX_TASKS = 100;
+    private static final String[] tasks = new String[MAX_TASKS];  // Array to store tasks
+    private static final boolean[] isCompleted = new boolean[MAX_TASKS];  // Array to store task completion status
+    private static int taskCount = 0;  // Counter to keep track of the number of tasks
+
+    public static void main(String[] args) {
+        printIntroMessage();
+
+        Scanner scanner = new Scanner(System.in);
+        String input;
+
+        while (true) {
+            input = scanner.nextLine(); // Read user input
+
+            if (input.equals("bye")) {
+                printExitMessage();
+                break; // Exit the loop
+            } else if (input.equals("list")) {
+                listTasks();
+            } else if (input.startsWith("mark ")) {
+                int taskIndex = Integer.parseInt(input.substring(5)) - 1;
+                markTask(taskIndex);
+            } else if (input.startsWith("unmark ")) {
+                int taskIndex = Integer.parseInt(input.substring(7)) - 1;
+                unmarkTask(taskIndex);
+            } else {
+                addTask(input);
+            }
+        }
+    }
+
+    private static void printIntroMessage() {
+        String intro =
+                          " ______                   \n"
+                        + "/_  __/__  __ _  __ _  (_)\n"
+                        + " / / / _ \\/  ' \\/  ' \\/ / \n"
+                        + "/_/  \\___/_/_/_/_/_/_/_/  \n"
+                        + "____________________________________________________________\n"
+                        + "Hello! I'm Tommi!\n"
+                        + "What can I do for you?\n"
+                        + "____________________________________________________________\n";
+        System.out.println(intro);
+    }
+
+    private static void addTask(String task) {
+        tasks[taskCount] = task;
+        isCompleted[taskCount] = false;
+        taskCount++;
+        printLine();
+        System.out.println("added: " + task);
+        printLine();
+    }
+
+    private static void listTasks() {
+        printLine();
+        System.out.println("Here are the tasks in your list:");
+        for (int i = 0; i < taskCount; i++) {
+            String status = isCompleted[i] ? "[X]" : "[ ]";
+            System.out.println((i + 1) + "." + status + " " + tasks[i]);
+        }
+        printLine();
+    }
+
+    private static void markTask(int index) {
+        if (index >= 0 && index < taskCount) {
+            isCompleted[index] = true;
+            printLine();
+            System.out.println("Awesomesauce! I've marked this task as done:");
+            System.out.println("  [X] " + tasks[index]);
+            printLine();
+        }
+    }
+
+    private static void unmarkTask(int index) {
+        if (index >= 0 && index < taskCount) {
+            isCompleted[index] = false;
+            printLine();
+            System.out.println("OK, I've marked this task as undone:");
+            System.out.println("  [ ] " + tasks[index]);
+            printLine();
+        }
+    }
+
+    private static void printExitMessage() {
+        printLine();
+        System.out.println("Bye. Hope to see you again soon!");
+        printLine();
+    }
+
+    private static void printLine() {
+        System.out.println("____________________________________________________________");
+    }
+}


The code is good overall. It avoids long methods, deep nesting, complicated expressions and magic numbers. The code is well structured and easily understood.

3CCLY

Looks good to me in general, just some nitpick

3CCLY · 2024-09-04T05:53:14Z

+    private static final String[] tasks = new String[MAX_TASKS];  // Array to store tasks
+    private static final boolean[] isCompleted = new boolean[MAX_TASKS];  // Array to store task completion status
+    private static int taskCount = 0;  // Counter to keep track of the number of tasks


3CCLY · 2024-09-04T05:54:47Z

+        if (index >= 0 && index < taskCount) {
+            isCompleted[index] = true;
+            printLine();
+            System.out.println("Awesomesauce! I've marked this task as done:");


I like the personality added to the chatbot

3CCLY · 2024-09-04T05:58:18Z

+        String intro =
+                          " ______                   \n"
+                        + "/_  __/__  __ _  __ _  (_)\n"
+                        + " / / / _ \\/  ' \\/  ' \\/ / \n"
+                        + "/_/  \\___/_/_/_/_/_/_/_/  \n"
+                        + "____________________________________________________________\n"
+                        + "Hello! I'm Tommi!\n"
+                        + "What can I do for you?\n"
+                        + "____________________________________________________________\n";


You can consider using 8 spaces to split up your line as stated in the coding standard

3CCLY · 2024-09-04T05:59:03Z

@@ -0,0 +1,96 @@
+import java.util.Scanner;


You can consider adding comments to help with readability

Use encapsulation to encapsulate input handler. Implement function abstraction in Tommi.java

Yvorm

Overall, I think this is very concise and readable. The logic used is straightforward and effective too. In some places I have nits regarding edge case inputs which may crash the program, but according to the project specifications everything has been done very well!

Yvorm · 2024-09-06T15:36:16Z

+    private static void printIntroMessage() {
+        String intro = """
+                 ______                  \s
+                /_  __/__  __ _  __ _  (_)
+                 / / / _ \\/  ' \\/  ' \\/ /\s
+                /_/  \\___/_/_/_/_/_/_/_/ \s
+                ____________________________________________________________
+                Hello! I'm Tommi!
+                What can I do for you?
+                ____________________________________________________________
+                """;
+        System.out.println(intro);
+    }


I appreciate the effort gone to customise your logo, and abstract it to a function for later use!

Yvorm · 2024-09-06T15:40:19Z

+public class Deadline extends Task{
+
+    protected String by;
+
+    public Deadline(boolean isDone, String taskName, String by) {
+        super(isDone, taskName);
+        this.by = by;
+    }
+
+    public Deadline updateIsDone(boolean newIsDone) {
+        return new Deadline(newIsDone, this.taskName, this.by);
+    }
+
+    @Override
+    public String toString() {
+        return "[D]" + super.toString() + " (by: " + by + ")";
+    }
+}


I like the immutability of the updateIsDone method and the clear toString representation. A small suggestion would be to validate the by field if it's supposed to follow a specific format (like a date or time). You might also want to add a method to update the deadline (by) in the future, just like you did for isDone. Otherwise, everything looks really well-structured!

Yvorm · 2024-09-06T15:43:56Z

+    public static void processInputCases(String input) {
+        if (input.equals("list")) {
+            TaskList.listTasks();
+            return;
+        }
+
+        String[] words = input.split(" ");
+        int taskIndex;
+
+        switch (words[0]) {
+        case "mark":
+            taskIndex = Integer.parseInt(words[1]) - 1;
+            TaskList.markTask(taskIndex);
+            break;
+        case "unmark":
+            taskIndex = Integer.parseInt(input.substring(7)) - 1;
+            TaskList.unmarkTask(taskIndex);
+            break;
+        case "todo":
+            TaskList.addTask(new ToDo(false, input.substring(5)));
+            break;
+        case "deadline":
+            String[] deadlineParts = input.substring(9).split("/by", 2);
+            TaskList.addTask(new Deadline(false, deadlineParts[0], deadlineParts[1]));
+            break;


I like the clear logic, use of switch and how compact everything is! One thing to consider is adding more error handling, especially around Integer.parseInt() and array indexing, to prevent crashes on invalid inputs. It might also be worth refactoring the splitting of strings into helper methods for better readability .

Yvorm · 2024-09-06T15:47:22Z

+public class TaskList {
+
+    private static final int MAX_TASKS = 100;
+
+    private static final Task[] tasks = new Task[MAX_TASKS];  // Array to store tasks
+    private static int tasksCount = 0;  // Counter to keep track of the number of tasks
+
+    public static void listTasks() {
+        Tommi.printLine();
+        System.out.println("Here are the tasks in your list:");
+        for (int i = 0; i < tasksCount; i++) {
+            System.out.println((i + 1) + ". "  + tasks[i]);
+        }
+        Tommi.printLine();
+    }
+
+    public static void addTask(Task task) {
+        tasks[tasksCount] = task;
+        tasksCount++;
+        Tommi.printLine();
+        System.out.println("Sure. I've added the task: " + System.lineSeparator()
+                + task + System.lineSeparator()
+                + "There are now " + tasksCount + " tasks in the list.");
+        Tommi.printLine();


The class is well structured, and the methods are concise and really easy to understand 😄. Would you want to switch a dynamic data structure later down the track (i.e. ArrayList), to give you some scalability? It might also be good to add boundary checks for adding tasks to ensure it doesn’t exceed MAX_TASKS. Overall, great foundation!

Print error message for input with no task type, list or bye, and throw exception when doing so.

This reverts commit 85d21eb.

This reverts commit baaa892.

This reverts commit 85d21eb.

adding a change to level 5 branch so it branches after updating it to main

This reverts commit 792321a.

wenxin-c

Overall good job in coding standard and code quality, just a few points for you to consider.

wenxin-c · 2024-09-19T14:51:02Z

+                TaskList.markTask(taskIndex);
+                break;
+            case "unmark":
+                taskIndex = Integer.parseInt(input.substring(7)) - 1;


Try to avoid magic literals(e.g. numbers, strings), you can consider using named constants to give the literals a meaning so that it will be easier to understand.
E.g.

static final double PI = 3.14236; static final int MAX_SIZE = 10; ... return PI; ... return MAX_SIZE - 1;

wenxin-c · 2024-09-19T14:54:58Z

+                + task + System.lineSeparator()
+                + "There are now " + tasksCount + " tasks in the list.");


Please be consistent in placing the + sign. In InputHandler.java file you have been putting the + sign at the back when you wrap lines. You can consider following course website e.g.

setText("Long line split" + "into two parts."); if (isReady) { setText("Long line split" + "into two parts."); }

wenxin-c · 2024-09-19T14:56:44Z

+    public static void markTask(int index) {
+        if (index >= 0 && index < tasksCount) {
+            Tommi.printLine();
+            System.out.println("Awesomesauce! I've marked this task as done:");
+            tasks[index] = tasks[index].updateIsDone(true);
+            System.out.println(tasks[index]);
+            Tommi.printLine();
+        }
+    }
+
+    public static void unmarkTask(int index) {
+        if (index >= 0 && index < tasksCount) {
+            Tommi.printLine();
+            System.out.println("OK, I've marked this task as undone:");
+            tasks[index] = tasks[index].updateIsDone(false);
+            System.out.println(tasks[index]);
+            Tommi.printLine();
+        }
+    }


You can consider extracting these two functions further and pass in variables since they are pretty similar.

Branch level 9

Make Task an abstract class

JavaDoc comments

Minor code touch ups

Update User Guide

Handle first time opening file error caused by new save file not created

ryan-txn added 7 commits August 23, 2024 00:34

replace Duke file with Tommi file

812d612

Revert "replace Duke file with Tommi file"

5f645dc

This reverts commit 812d612.

Reapply "replace Duke file with Tommi file"

398cd22

This reverts commit 5f645dc.

Add repeating strings and detecting "bye" string

c034cfe

Add list of tasks

e40ebef

Add functions to print the intro and exit messages, add elements to the list and print the list.

Add checklist

ac8dc0f

Fix coding standards

629ee35

LTK-1606 reviewed Sep 4, 2024

View reviewed changes

Zackermax reviewed Sep 4, 2024

View reviewed changes

3CCLY reviewed Sep 4, 2024

View reviewed changes

ryan-txn added 2 commits September 6, 2024 14:14

Employ OOP Princples

2e66a92

Use encapsulation to encapsulate input handler. Implement function abstraction in Tommi.java

Include ToDo, Deadline and Event Task subclasses

24f24e1

Yvorm reviewed Sep 6, 2024

View reviewed changes

ryan-txn added 9 commits September 13, 2024 04:10

Handle exceptions

85d21eb

Print error message for input with no task type, list or bye, and throw exception when doing so.

Revert "Handle exceptions"

baaa892

This reverts commit 85d21eb.

Reapply "Handle exceptions"

b541ecf

This reverts commit baaa892.

Revert "Handle exceptions"

3f8a8c4

This reverts commit 85d21eb.

Merge branch 'master' into branch-Level-5

86955e5

Merge branch 'branch-Level-5'

f6e1caf

Redo exception handling, Package code

0026848

add commit for branch

792321a

adding a change to level 5 branch so it branches after updating it to main

Revert "add commit for branch"

1deffba

This reverts commit 792321a.

wenxin-c reviewed Sep 19, 2024

View reviewed changes

ryan-txn added 7 commits September 20, 2024 15:50

Use ArrayList to replace Array and Add delete task function

320ae65

Merge branch 'branch-Level-6'

6fc8417

Add save and load functions

13228d4

Merge branch 'branch-Level-7'

4f06d99

Rename classes and add Task package

125ed9b

Add Search function

ca9594a

Improve readability and Shift readInputStrings method from Ui to Parser

f7f975c

ryan-txn and others added 8 commits October 10, 2024 16:50

Move all print functions to Ui class

5a0c049

Improve OOP

0c922cd

Merge pull request #1 from ryan-txn/branch-Level-9

7abb9b4

Branch level 9

JavaDoc comments

0e51847

Make Task an abstract class

Merge pull request #2 from ryan-txn/heads/A-JavaDoc

2af8a9f

JavaDoc comments

Update User Guide

4cdbe9d

Minor code touch ups

Merge pull request #3 from ryan-txn/heads/A-UserGuide

eb37c84

Update User Guide

Save file bug fix

2cd120d

Handle first time opening file error caused by new save file not created

		+ task + System.lineSeparator()
		+ "There are now " + tasksCount + " tasks in the list.");

Conversation

ryan-txn commented Sep 3, 2024

Uh oh!

LTK-1606 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!

3CCLY 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!

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

wenxin-c 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants