edward wang ip by EdwardZYWang · Pull Request #194 · nus-cs2113-AY2122S1/ip

EdwardZYWang · 2021-09-01T18:42:09Z

No description provided.

Create 3 new classes that inherit Task Update (list) and (done) commands to handle new tasks.

EdisonZhong17 · 2021-09-03T03:48:51Z

+            } else if (input.contains("todo")) {
+                Task whatToDo = toDoMethod(input);
+                System.out.println("    Got it. I've added this task:\n" + "    " + whatToDo + "\n"
+                        + "    Now you have " + inputCount + " tasks in the list.");
+
+                input = in.nextLine();
+
+            } else if (input.contains("deadline")) {
+                Task whatDeadline = deadlineMethod(input);
+                System.out.println("    Got it. I've added this task:\n" + "    " + whatDeadline + "\n"
+                        + "    Now you have " + inputCount + " tasks in the list.");
+
+                input = in.nextLine();
+
+            } else if (input.contains("event")) {
+                Task whatEvent = eventMethod(input);
+                System.out.println("    Got it. I've added this task:\n" + "    " + whatEvent + "\n"
+                        + "    Now you have " + inputCount + " tasks in the list.");
+
+                input = in.nextLine();


I suggest you put all the System.out.println to separated methods, to make main class clear and clean

EdisonZhong17 · 2021-09-03T03:52:18Z

+    }
+
+    public static Task toDoMethod(String input) {
+        String toDoDescription = input.substring(4).trim();


We should avoid "magic numbers" like 4 here, you can define a CONST to replace 4

EdisonZhong17 · 2021-09-03T03:59:03Z

+    private static String taskDone(Scanner in, Task task) {
+        String statusOfTask;
+        String input;
+        System.out.println("    Nice! I've marked this task as done:" + System.lineSeparator());
+        System.out.println("    " + task + " has been updated to -->");
+
+        task.markAsDone(); //mark x in [ ]
+        statusOfTask = task.getStatusIcon();
+
+        System.out.println("    " + task);
+        input = in.nextLine();
+        return input;
+    }


For naming of a method, we usually start with a verb

EdisonZhong17 · 2021-09-03T03:59:30Z

+    public static Task deadlineMethod(String input) {
+        String[] deadlineSplitter = input.substring(9).split(" /by ");
+        String deadlineDescription = deadlineSplitter[0]; //before /by
+        String deadlineBy = deadlineSplitter[1]; // after /by
+
+        Task description = new Deadline(deadlineDescription, deadlineBy);
+        tasks[inputCount] = description;
+        inputCount++;
+
+        return description;
+    }
+
+    public static Task eventMethod(String input) {
+        String[] eventSplitter = input.substring(6).split(" /at ");
+        String eventDescription = eventSplitter[0]; //before /at
+        String eventAt = eventSplitter[1]; // after /at
+
+        Task description = new Event(eventDescription, eventAt);
+        tasks[inputCount] = description;
+        inputCount++;
+
+        return description;
+    }


same as above, the naming convention of mothods

EdisonZhong17 · 2021-09-03T04:00:02Z

+            }
+        }
+        System.out.println("    Bye! Hope to see you again soon!");
+


The whole while and if else structure is quite nice and clear!

tlyi · 2021-09-03T06:31:31Z

@@ -0,0 +1,32 @@
+public class Task {


Would be good to add descriptive header comments for all public classes/methods

tlyi · 2021-09-03T06:35:07Z

+                        + "    Now you have " + inputCount + " tasks in the list.");
+
+                input = in.nextLine();
+


Not sure if it is intended but there is some unnecessary whitespace before closing braces of if-else statements

tlyi · 2021-09-03T06:39:51Z

+        String input;
+        System.out.println("    Here are the tasks in your list:");
+
+        for (int outputCount = 0; outputCount < inputCount; outputCount++) {


Can consider using a shorter name for the "outputCount" variable as it is located within a very small scope

tlyi · 2021-09-03T06:50:34Z

+        return input;
+    }
+
+    private static String taskDone(Scanner in, Task task) {


Would be clearer if this is named as a verb, like setTaskDone()

…e user.

Add support for deleting tasks from the list.

zikunz

Great work Edward! You have definitely been following various coding guidelines and your Duke is so awesome! 💯

Overall, this version of code is very easy to understand and is very readable except for very few potential and minor coding standard and quality-related violations. Keep up the good work :)

zikunz · 2021-09-14T10:30:53Z

+                    System.out.println("    Got it. I've added this task:\n" + "    " + whatDeadline + "\n"
+                            + "    Now you have " + inputCount + " tasks in the list.");


Perhaps you could consider having a function for printing and name it as displayUserIntroText() or the like.

zikunz · 2021-09-14T12:07:36Z

+        while (!(input.equals("bye"))) {
+
+            if (input.equals("list")) {
+                input = printList(in);
+
+            } else if (input.contains("done")) {
+                input = testTaskDone(input, in);
+
+            } else if (input.contains("todo")) {


Storing "bye" / "list" / ... as constants above and naming them as
private final String INPUT_BYE = "bye" or the like could be more readable.

zikunz · 2021-09-14T12:08:28Z

+                    System.out.println("    Got it. I've added this task:\n" + "    " + whatToDo + "\n"
+                            + "    Now you have " + inputCount + " tasks in the list.");
+
+                    input = in.nextLine();
+                } catch (DukeExceptions e3) {
+                    System.out.println("☹ OOPS!!! The description of a todo cannot be empty.");


Perhaps you could consider to extract these final strings (also found in other parts of the code such as line 42) out as constants and put them into a new Message class later on?

zikunz · 2021-09-14T12:10:57Z

+        return input;
+    }
+
+    public static Task toDoMethod(String input) {


Perhaps the method name to be reprhased so that it is more descriptive about what it does? Also, from this week onwards, consider using JavaDoc comments for non-private classes / methods and non-trivial private methods in an appropriate way, as per https://nus-cs2113-ay2122s1.github.io/website/se-book-adapted/chapters/documentation.html#javadoc.

zikunz · 2021-09-14T12:11:37Z

+
+    public static Task deadlineMethod(String input) {
+
+        String[] deadlineSplitter = input.substring(9).split(" /by ");


Perhaps you can consider avoiding magic numbers like 9 here. The same applies to line 145, 157 etc.

zikunz · 2021-09-14T12:18:51Z

@@ -0,0 +1,2 @@
+public class DukeExceptions extends Exception{


Perhaps you could leave a space here before { for layout consistency.

zikunz · 2021-09-14T12:19:52Z

+    public Todo(String description, String tasksToDo) {
+        super(description);
+    }
+
+    public Todo(String description) {
+        super(description);
+    }


Great use of overloading the constructor!

zikunz · 2021-09-14T12:22:39Z

+
+    @Override
+    public String toString() {
+        return "[T]" + "[" + getStatusIcon() + "]" + " " + description;


Perhaps you could use a named constant to avoid magic strings here as well.

zikunz · 2021-09-14T12:25:05Z

+                    input = in.nextLine();
+                } catch (ArrayIndexOutOfBoundsException e2) {
+                    System.out.println("you have typed in = " + input + "\n☹ OOPS!!! where is your /by my friend? ");
+                    input = in.nextLine();
+                }
+
+            } else if (input.contains("event")) {
+                try {
+                    Task whatEvent = eventMethod(input);
+                    System.out.println("    Got it. I've added this task:\n" + "    " + whatEvent + "\n"
+                            + "    Now you have " + inputCount + " tasks in the list.");
+
+                    input = in.nextLine();


It looks like input = in.nextLine(); is called in many else if blocks, perhaps you could consider calling it only once to avoid repetitive code.

zikunz · 2021-09-14T12:26:23Z

+
+    }
+
+    public static Task deadlineMethod(String input) {


Perhaps you could rephrase the method name here so that it starts with a verb according to https://se-education.org/guides/conventions/java/index.html#naming.

# Conflicts: # src/main/java/Duke.java

add constants to represent commands change method names according to SE conventions

add relative path for duke.txt

Give users a way to find a task by searching for a keyword.

Teach Duke how to understand dates and times.

Level 8. Dates and Times

add Level 9. Find

add Parser, Storage, StorageUI, UI, TaskList classes add more OOP

created new class Keywords to store public static final variables

javadocs and OOP modifications

edit README.md added ASCII art to UI

EdwardZYWang added 9 commits August 22, 2021 17:07

Add increment Level-0

645fc9a

Add greet, echo, exit. level-1

acfa7d0

Add Level-2. Add, List

1288862

Level-3

6e7dd1f

A-CodingStandard

c3ddc64

fix for loop for catching invalid input

46e6947

Add support for tracking ToDos, Deadlines and Events.

c66184b

Create 3 new classes that inherit Task Update (list) and (done) commands to handle new tasks.

Add new methods printList, testTaskDone, taskDone

ebb84be

Add files for auto testing

d3d8b19

EdisonZhong17 reviewed Sep 3, 2021

View reviewed changes

tlyi reviewed Sep 3, 2021

View reviewed changes

EdwardZYWang added 10 commits September 3, 2021 22:16

Removed unneeded code. modified Task, Event and Deadline

17c6697

Teach Duke to deal with errors such as incorrect inputs entered by th…

2bb7b38

…e user.

editerd comments

ee6b279

add comment todo method

77cbe99

modified text in event check

7f70a01

Merge branch 'branch-Level-5'

9450f55

comment for overall check

86503c5

Merge branch 'branch-Level-5'

cdd7729

Level 6. Delete

739ca48

Add support for deleting tasks from the list.

fixed formatting

6be4c24

zikunz reviewed Sep 14, 2021

View reviewed changes

EdwardZYWang added 8 commits September 16, 2021 17:47

level-7

70a3953

Merge branch 'branch-Level-6'

ce9300c

Merge branch 'branch-level-7'

3b716b1

# Conflicts: # src/main/java/Duke.java

fixed formatting

4e1bff1

add constants to represent commands change method names according to SE conventions

add java doc for half of the methods

1cf55f4

add relative path for duke.txt

edit format and path

8eea134

add Level 9. Find

b4014d3

Give users a way to find a task by searching for a keyword.

Level 8. Dates and Times

52c5ede

Teach Duke how to understand dates and times.

EdwardZYWang and others added 28 commits September 22, 2021 23:10

Merge pull request #1 from EdwardZYWang/branch-Level-8

ae8c3bd

Level 8. Dates and Times

Merge branch 'master' of github.com:EdwardZYWang/ip

06d9e83

Merge branch 'master' into branch-Level-9

b8b9838

Merge pull request #2 from EdwardZYWang/branch-Level-9

5329daf

add Level 9. Find

Delete unused import statements

a03699b

edit "delete" method

30733e7

add Parser, Storage, StorageUI, UI, TaskList classes add more OOP

add javadocs for all classes and methods

4521d4b

created new class Keywords to store public static final variables

Merge pull request #3 from EdwardZYWang/branch-A-JavaDoc

9ec174d

javadocs and OOP modifications

Merge branch 'master' of github.com:EdwardZYWang/ip

4a503eb

modified javadoc for StorageUI

70d931f

add UG

7e884fc

edit README.md added ASCII art to UI

modified readme

3774eba

edit readme

911abc8

Set theme jekyll-theme-time-machine

3ba02cf

add imgurr links to readme

c05dc51

Merge branch 'master' of github.com:EdwardZYWang/ip

4b441a3

edit UG

f47cdf8

edit UG

3a2afdd

edit UG

7d3df38

Set theme jekyll-theme-cayman

fa577fa

updated UG

f7dc287

Update README.md

6815dbd

edit UG

f658bcd

Merge branch 'master' of github.com:EdwardZYWang/ip

ef438c6

Set theme jekyll-theme-cayman

6ae0774

Merge branch 'master' of github.com:EdwardZYWang/ip

e58f92e

updated UG

4d98d2f

edit UG

2b4a238

		+ " Now you have " + inputCount + " tasks in the list.");

		input = in.nextLine();

		System.out.println(" Got it. I've added this task:\n" + " " + whatDeadline + "\n"
		+ " Now you have " + inputCount + " tasks in the list.");


		public static Task deadlineMethod(String input) {

		String[] deadlineSplitter = input.substring(9).split(" /by ");

		@@ -0,0 +1,2 @@
		public class DukeExceptions extends Exception{

Uh oh!

Conversation

EdwardZYWang commented Sep 1, 2021

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!

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

zikunz Sep 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zikunz Sep 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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

zikunz Sep 14, 2021 •

edited

Loading

zikunz Sep 14, 2021 •

edited

Loading