[Gerald Koh Kheng Guan] iP by geraldkoh4 · Pull Request #192 · nus-cs2113-AY2223S2/ip

geraldkoh4 · 2023-01-31T12:31:38Z

No description provided.

irving11119

I think your code quality is fairly decent. However, you can look at abstracting your main method using other methods or classes to make it shorter. Also you should be careful of your lack of a default statement for your switch case as it might create exceptions which your program might not be able to handle.

irving11119 · 2023-02-02T05:59:46Z

    public static void main(String[] args) {
-        String logo = " ____        _        \n"
-                + "|  _ \\ _   _| | _____ \n"
-                + "| | | | | | | |/ / _ \\\n"
-                + "| |_| | |_| |   <  __/\n"
-                + "|____/ \\__,_|_|\\_\\___|\n";
-        System.out.println("Hello from\n" + logo);
+        Methods.printGreetings();
+
+        Task[] actions = new Task[100];
+        int actionCounter = 0;
+
+        String line;
+        Scanner in = new Scanner(System.in);
+        int taskNumber;
+        String[] decisions;
+        Task toBeAdded;
+        String[] dates;
+        do {
+            line = in.nextLine();
+            decisions = line.split(" ");
+            dates = line.split("/");
+            switch (decisions[0]) {
+                case "echo":
+                    System.out.println(Methods.findTaskDetails(line));
+                    break;
+
+                case "todo":
+                    toBeAdded = new Todo(Methods.findTaskDetails(line));
+                    actions[actionCounter] = toBeAdded;
+                    actionCounter++;
+                    Methods.printAcknowledgement(toBeAdded,actionCounter);
+                    break;
+
+                case "event":
+                    toBeAdded = new Event(Methods.findTaskDetails(dates[0]), Methods.findTaskDetails(dates[1]), Methods.findTaskDetails(dates[2]));
+                    actions[actionCounter] = toBeAdded;
+                    actionCounter++;
+                    Methods.printAcknowledgement(toBeAdded,actionCounter);
+                    break;
+
+                case "deadline":
+                    toBeAdded = new Deadline(Methods.findTaskDetails(dates[0]), Methods.findTaskDetails(dates[1]));
+                    actions[actionCounter] = toBeAdded;
+                    actionCounter++;
+                    Methods.printAcknowledgement(toBeAdded,actionCounter);
+                    break;
+
+                case "mark":
+                    taskNumber = Integer.parseInt(decisions[1]) - 1;
+                    actions[taskNumber].mark();
+                    Methods.printDoneMarkingTasks(actions[taskNumber]);
+                    break;
+
+                case "unmark":
+                    taskNumber = Integer.parseInt(decisions[1]) - 1;
+                    actions[taskNumber].unmark();
+                    Methods.printDoneMarkingTasks(actions[taskNumber]);
+                    break;
+
+                case "list":
+                    if (actionCounter == 0) {
+                        Methods.printEmptyList();
+                        continue;
+                    }
+                    for (int iterator = 0; iterator < actionCounter; iterator++) {
+                        Methods.printListElement(iterator, actions[iterator]);
+                    }
+                    break;
+            }
+        } while (!decisions[0].equals("bye"));
+        System.out.println("That's all from me! Goodbye!");
    }
 }


Perhaps you can consider how to abstract your main method into various different methods as currently it is rather lengthy (Greater than 30 LOC).

irving11119 · 2023-02-02T06:03:07Z

+import java.util.Scanner;
+public class Methods {
+    public static void printGreetings() {
+        String logo = " ____        _        \n"


You might want to consider declaring these variables as constants instead as they are they do not need to change.

irving11119 · 2023-02-02T06:05:03Z

+                        Methods.printListElement(iterator, actions[iterator]);
+                    }
+                    break;
+            }


Perhaps you could include a default branch for your switch block so in the case where your command is not caught by any of the case statements, your code will still function.

irving11119 · 2023-02-02T06:08:55Z

+import java.util.Scanner;
+public class Methods {
+    public static void printGreetings() {
+        String logo = " ____        _        \n"
+                + "|  _ \\ _   _| | _____ \n"
+                + "| | | | | | | |/ / _ \\\n"
+                + "| |_| | |_| |   <  __/\n"
+                + "|____/ \\__,_|_|\\_\\___|\n"
+                + "__________________________\n";
+        System.out.println("Hello from\n" + logo);
+        System.out.println("Hello! Do you need anything from me?\n"
+                + "I have only been trained to greet, echo and list you so far.\n"
+                + "Once my owner is more proficient in what he does, he will give me more functions!\n"
+                + "Key in a number based on the function\n 1)echo \n 2)todo\n 3)mark\n 4)unmark\n 5)deadline\n 6)event\n"
+                + "When you wish to exit, do tell me by typing : bye");
+    }
+    public static void print(String input) {
+        System.out.println(input);
+    }
+
+    public static void printEmptyList() {
+        System.out.println("There is nothing to list!");
+    }
+
+    public static void printListElement(int iterator, Task action) {
+        Methods.print(iterator + 1
+                + ")"
+                + action.toString());
+    }
+    public static void printDoneMarkingTasks(Task action) {
+        Methods.print("Done!\n" + action.toString());
+    }
+    public static String findTaskDetails(String line) {
+        return line.substring(line.indexOf(" ") + 1);
+    }
+    public static void printAcknowledgement(Task action, int actionCounter) {
+        System.out.println("Got it. I've added this task:\n" + action.toString() + System.lineSeparator() + "Now you have " + actionCounter + " tasks in the list.");
+    }
+}


I think you did a good job at making your method names simple yet descriptive. This makes it easy to follow the program flow.

dsicol

Good job overall on your coding standards. Remember to wrap all texts with an indent of 8 spaces.

dsicol · 2023-02-02T07:39:10Z

+                    break;
+
+                case "event":
+                    toBeAdded = new Event(Methods.findTaskDetails(dates[0]), Methods.findTaskDetails(dates[1]), Methods.findTaskDetails(dates[2]));


When wrapping texts, remember to indent 8 spaces (or 2 tabs) from former line

dsicol · 2023-02-02T07:41:16Z

+                        Methods.printListElement(iterator, actions[iterator]);
+                    }
+                    break;
+            }


Good job on formatting your case statements!

dsicol · 2023-02-02T07:42:18Z

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


Remember to remove extra new lines in your code!

dsicol · 2023-02-02T07:45:18Z

@@ -0,0 +1,39 @@
+import java.util.Scanner;
+public class Methods {


Good use on plurals to define your class!

dsicol · 2023-02-02T07:47:03Z

+                + "| |_| | |_| |   <  __/\n"
+                + "|____/ \\__,_|_|\\_\\___|\n"
+                + "__________________________\n";
+        System.out.println("Hello from\n" + logo);


Good job on wrapping the texts!

…-> actions.size()

sevenseasofbri

Good job Gerald! 💯 You've mostly adhered to the coding standard and readability requirements. I have added comments wherever necessary. If you think my suggestion applies to another part of the code where I haven't commented, please make the changes accordingly.

sevenseasofbri · 2023-02-19T07:37:12Z

+    public void setUpArrayList() {
+        FileHandler.setUpFile(actions);
+    }
+    public void execute() {


This method is quite long (>30 lines). Consider refactoring the code to a new method OR see how you can combine common things from the case statements together. See here

sevenseasofbri · 2023-02-19T07:38:04Z

+            File directory = new File("data");
+            if (!directory.exists()) {
+                boolean success = directory.mkdir();
+                if (!success) {


Avoid deep nesting to improve readability. If needed, you can refactor the inner nests to a new method. See here

sevenseasofbri · 2023-02-19T07:38:59Z

+            File f = new File("data/savedList.txt");
+            File directory = new File("data");


Perhaps avoid the usage of magic literals. You can store the string literals as constants and use them (final static vars). See here

sevenseasofbri · 2023-02-19T07:39:40Z

+
+public class FileHandler {
+
+    public static void setUpFile(ArrayList<Task> actions) {


This function is also quite long, maybe see how you can refactor some things inside it.

sevenseasofbri · 2023-02-19T07:42:38Z

+
+import tasks.Task;
+
+public class Methods {


The name of this class does not describe what it is used for. Maybe consider naming itUi instead since it seems to handle the functions for console output operations. See here

sevenseasofbri · 2023-02-19T07:43:27Z

@@ -0,0 +1,114 @@
+package utility;
+
+public class commandChecker {


Class names should be in PascalCase. See here

Implemented JavaDoc and other Ui debugging and formatted strings.

Update README.md

geraldkoh4 added 7 commits January 25, 2023 01:24

Achieved Level 0

de8ed4d

Minor Change in spelling

5d5cc71

Finished Level 1

bc93fd2

Finished Level-2

7d21da9

Finished Level-3

6d10d3f

Finished level-4 and edited level 0, 1, 2 and 3

444b5c0

Minor format changes

f7d165c

irving11119 reviewed Feb 2, 2023

View reviewed changes

dsicol reviewed Feb 2, 2023

View reviewed changes

geraldkoh4 added 8 commits February 7, 2023 21:26

Finished Level 5

25dffa2

Merge branch 'branch-Level-5'

609c4a9

Minor changes to main, added DukeSession and fixed minor bugs

544ba64

Level-6 done, with some minor changes to arraylist and actioncounter …

8902eae

…-> actions.size()

Merge branch 'branch-Level-6'

69d4b63

Finished Level-7, fixed some bugs for Level-6 as well

959c5a4

Merge branch 'branch-Level-7'

13f7505

No idea what this does. Im trying to keep everything up to date.

8a06c04

sevenseasofbri reviewed Feb 19, 2023

View reviewed changes

geraldkoh4 and others added 12 commits March 2, 2023 02:48

Finished Level-9

e0c6dc9

Merge branch 'branch-Level-9'

391f7bf

Implemented JavaDoc and other Ui debugging and formatted strings.

77ef37e

Merge pull request #1 from geraldkoh4/branch-A-JavaDoc

6ba8f86

Implemented JavaDoc and other Ui debugging and formatted strings.

Update README.md

f423633

Merge pull request #2 from geraldkoh4/A-UserGuide

bf20902

Update README.md

Final and Minor formatting changes. Hope everything is working well!

cbc2097

Update README.md

c9f98f4

Minor Bug fixes

7831692

Update README.md

6df56ee

Update README.md

f4792f0

Update README.md

a7d571e

		@@ -0,0 +1,39 @@
		import java.util.Scanner;
		public class Methods {

		File f = new File("data/savedList.txt");
		File directory = new File("data");


		public class FileHandler {

		public static void setUpFile(ArrayList<Task> actions) {

		@@ -0,0 +1,114 @@
		package utility;

		public class commandChecker {

Conversation

geraldkoh4 commented Jan 31, 2023

Uh oh!

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

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

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

4 participants