[Brian Chow] iP by brian16600 · Pull Request #296 · nus-cs2103-AY2122S2/ip

brian16600 · 2022-01-29T09:24:15Z

Duke

Duke is a interactive chatbot with UI.

"Your mind is for having ideas, not holding them" - David Allen

Duke is a task tracker that can track three categories of tasks:

Todo
Deadline
Event

Setting up

Setting up Duke is extremely easy. All you need to do is:

Download JDK 11 and above from here
Download the latest JAR file release from the right side of this repository
Run the command java -jar ip.jar

It's that simple! :)

Commands

There are a few commands you can run in Duke. These include:

Using an IDE

You can further edit/modify Duke by navigating to the src folder which contains all the java files

You can run it from Launcher.java by using main:

public class Launcher {
    public static void main(String[] args) {
        Application.launch(Main.class,args);
    }
}

… levelTwoRespond

Added Event, Deadline and Todo subclasses of Task. Updated if-else in levelFourRespond to handle the 3 subclasses.

Created DukeException class to handle incorrect input length/commands. Shifted if-else loop to a switch-case in InputHandler.java,

Added recommended inputs for exceptions and added delete case in InputHandler.java.

Rewrote code into InputHandler.java. Added Storage.java to handle the storage of tasks as well as writing to data.txt file for saving.

declanleeler

I found the code easy to read and follow. There are a couple of coding standard violations. The InputHandler class is also very long and could be shortened with the use of more classes to split up the code in the switch-case and if-else.

declanleeler · 2022-02-03T02:57:45Z

src/main/java/Task.java

+ * Represents a Task. Contains a Task constructor, two methods to mark and unmark tasks, toString() method as well as a isMark() method to check if Task is marked
+ */
+public class Task {
+    private boolean mark;


Not sure I like the naming of the boolean variable. As much as possible, use a prefix such as is, has, was, etc. for boolean variable/method names so that linters can automatically verify that this style rule is being followed. Perhaps it would be better to name it as follows?

Suggested change

private boolean mark;

private boolean isMarked;

declanleeler · 2022-02-03T03:02:31Z

src/main/java/Task.java

+    /**
+     * markTask as done
+     */
+    public void markTask () {


Should this be named in this manner? Perhaps the following would comply with the coding standards better.

Suggested change

public void markTask () {

public void setMarkedTask () {

declanleeler · 2022-02-03T03:02:50Z

src/main/java/Task.java

+    /**
+     * unmarkTask
+     */
+    public void unmarkTask() {


Should this be named in this manner? Perhaps the following would comply with the coding standards better.

Suggested change

public void unmarkTask() {

public void setUnmarkedTask () {

declanleeler · 2022-02-03T03:04:07Z

src/main/java/Task.java

+     *
+     * @return boolean on whether task is marked
+     */
+    public boolean isMark() {


Should this be changed to another name, if you do decide to accept the suggestion of the boolean variable naming? Perhaps the following would work.

Suggested change

public boolean isMark() {

public void hasBeenMarked () {

declanleeler · 2022-02-03T03:08:47Z

src/main/java/InputHandler.java

+        String[] splitInput = input.split(" ");
+        String inputCommand = splitInput[0];
+        switch (inputCommand) {
+            case "todo":


I didn't like the indentation after the switch, are you sure this complies with the coding standard? Consider leaving no indentation for the case statements.

Changed multiple variable names to better suit their purposes. Added ability to take in specific date/time for Event/Deadline classes in yyyy-mm-dd hh:mm format and convert it. Added handling for DateTimeParseException

xMashedxTomatox

Looks pretty neat overall, LGTM! Just need to clean up a little on the javadocs and abstracting out certain logic to make the code a little bit better to read.

xMashedxTomatox

Looks pretty neat overall, LGTM! Just need to clean up a little on the javadocs and abstracting out certain logic to make the code a little bit better to read.

xMashedxTomatox · 2022-02-03T15:25:29Z

src/main/java/Deadline.java

+ */
+public class Deadline extends Task {
+    private String dueDate;
+    public Deadline(String name, String time) {super(name); this.dueDate = time;}


Missing javadocs for constructor.

xMashedxTomatox · 2022-02-03T15:28:23Z

src/main/java/Deadline.java

+    /**
+     * @override
+     * @return String of Deadline task, eg [D][X] Deadline (by:XX)
+     */


Override should not be in the javadoc. Missing method's description for the javadoc.
Recommendation:

/** * Prints the String representation for the Deadline task. * * @return String of Deadline task, eg [D][X] Deadline (by:XX) * / @Override public String toString() {...}

xMashedxTomatox · 2022-02-03T15:28:51Z

src/main/java/DukeException.java

@@ -0,0 +1,12 @@
+public class DukeException extends Exception{


Missing javadoc for class.

xMashedxTomatox · 2022-02-03T15:29:45Z

src/main/java/InputHandler.java

+ * Processes the input into 7 categories: Todo, Event, Deadline, list, mark, unmark, bye and throws error
+ */
+public class InputHandler {
+    private ArrayList<Task> arr;


Might be better to have a more specific and plural name for a list of task.
Recommendation:

private ArrayList<Task> tasks;

xMashedxTomatox · 2022-02-03T15:30:07Z

src/main/java/InputHandler.java

+
+
+    /**
+     *


Missing method description for javadoc.

xMashedxTomatox · 2022-02-03T15:30:53Z

src/main/java/InputHandler.java

+    public boolean handleInput(String input) throws DukeException {
+        String[] splitInput = input.split(" ");
+        String inputCommand = splitInput[0];
+        switch (inputCommand) {
+            case "todo":
+                if (splitInput.length > 1) {
+                    String[] nameArray = Arrays.copyOfRange(splitInput, 1, splitInput.length);
+                    String name = String.join(" ", nameArray);
+                    Todo newTodo = new Todo(name);
+                    arr.add(newTodo);
+                    printAddTaskMessage(newTodo);
+                    return false;
+                } else {
+                    throw new DukeException(":( OOPS!!! The description of a todo cannot be empty. Correct usage: todo [task]");
+                }
+            case "event":
+                if (splitInput.length > 3) {
+                    String[] stringArrayExcludingEvent = Arrays.copyOfRange(splitInput, 1, splitInput.length);
+                    String stringExcludingEvent = String.join(" ", stringArrayExcludingEvent);
+                    String[] nameAndTimeArray = stringExcludingEvent.split("/at");
+                    String name = nameAndTimeArray[0];
+                    String time = nameAndTimeArray[1];
+                    Event newEvent = new Event(name, time);
+                    arr.add(newEvent);
+                    printAddTaskMessage(newEvent);
+                    return false;
+                } else {
+                    throw new DukeException(":( OOPS!!! The description of a event cannot be empty. Correct usage: event [task] /at [time]");
+                }
+            case "deadline":
+                if (splitInput.length > 3) {
+                    String[] stringArrayExcludingDeadline = Arrays.copyOfRange(splitInput, 1, splitInput.length);
+                    String stringExcludingDeadline = String.join(" ", stringArrayExcludingDeadline);
+                    String[] nameAndTimeArray = stringExcludingDeadline.split("/by");
+                    String name = nameAndTimeArray[0];
+                    String time = nameAndTimeArray[1];
+                    Deadline newDeadline = new Deadline(name, time);
+                    arr.add(newDeadline);
+                    printAddTaskMessage(newDeadline);
+                    return false;
+                } else {
+                    throw new DukeException(":( OOPS!!! The description of a deadline cannot be empty. Correct usage: deadline [task] /by [time]");
+                }
+            case "list":
+                if (splitInput.length == 1) {
+                    System.out.println("Here are the tasks in your list:");
+                    int i = 0;
+                    for (Task item : arr) {
+                        i += 1;
+                        if (item.isMark()) {
+                            System.out.println(i + ". " + item);
+                        } else {
+                            System.out.println(i + ". " + item);
+                        }
+                    }
+                    return false;
+                } else {
+                    throw new DukeException("Wrong usage of list! Correct usage: list");
+                }
+            case "mark":
+                if (splitInput.length == 2) {
+                    System.out.println("Nice! I've marked this task as done:\n");
+                    int idx = Integer.parseInt(splitInput[1]) - 1;
+                    Task taskToBeMarked = arr.get(idx);
+                    taskToBeMarked.markTask();
+                    return false;
+                } else {
+                    throw new DukeException("Wrong usage of mark! Correct usage: mark [index]");
+                }
+            case "unmark":
+                if (splitInput.length == 2) {
+                    System.out.println("OK, I've marked this task as not done yet:\n");
+                    int idx = Integer.parseInt(splitInput[1]) - 1;
+                    Task taskToBeUnmarked = arr.get(idx);
+                    taskToBeUnmarked.unmarkTask();
+                    return false;
+                } else {
+                    throw new DukeException("Wrong usage of unmark! Correct usage: unmark [index]");
+                }
+            case "delete":
+                if (splitInput.length == 2) {
+                    int idx = Integer.parseInt(splitInput[1]) - 1;
+                    Task taskToBeDeleted = arr.get(idx);
+                    arr.remove(idx);
+                    System.out.println("Noted. I've removed this task:\n" + taskToBeDeleted + "\nNow you have " + arr.size() + " tasks in the list");
+                    return false;
+                } else {
+                    throw new DukeException("Wrong usage of delete! Correct usage: delete [index]");
+                }
+            case "bye":
+                return true;
+            default:
+                throw new DukeException(":( OOPS!!! I'm sorry, but I don't know what that means! Possible commands: todo [task], event [task] /at [time],"
+                + " deadline [task] /by [time], mark [index], unmark [index], delete [index], bye");
+        }


This method severely exceeds the recommended number of lines in a method (30).
Recommendation:
Can try to abstract out the details of each case statement into a different method.

xMashedxTomatox · 2022-02-03T15:31:59Z

src/main/java/Task.java

+    public String name;
+
+    /**
+     * Constructor


Might be better to have a more specific description of a constructor instead of simply "Constructor".
Recommendation:

/** * Creates a task object with the given parameter as the name of the task. * @param name name of the task */

Dineshraj555

Overall, code was easy to read. Just minor coding standard violations to take down note of. Good job.

Dineshraj555 · 2022-02-03T15:53:32Z

src/main/java/Deadline.java

+    private String dueDate;
+    public Deadline(String name, String time) {super(name); this.dueDate = time;}


Could leave spacing for better readability.

Dineshraj555 · 2022-02-03T15:54:24Z

src/main/java/Duke.java

+
+
+
+
+
+
+
+
+


Could clear by these empty spaces.

Dineshraj555 · 2022-02-03T15:55:13Z

src/main/java/Event.java

+ */
+public class Event extends Task {
+    private String dueDate;
+    public Event (String name, String time) { super(name); this.dueDate = time;}


This do not follow the module coding standards.

Dineshraj555 · 2022-02-03T15:55:58Z

src/main/java/InputHandler.java

+            case "bye":
+                return true;
+            default:
+                throw new DukeException(":( OOPS!!! I'm sorry, but I don't know what that means! Possible commands: todo [task], event [task] /at [time],"


Could add indentation.

Dineshraj555 · 2022-02-03T15:56:21Z

src/main/java/Task.java

+import java.util.Arrays;
+
+/**
+ * Represents a Task. Contains a Task constructor, two methods to mark and unmark tasks, toString() method as well as a isMark() method to check if Task is marked


Could add indentation.

… tasks with methods and Parser makes sense of user input for Duke

…ot in correct format. Added proper javadocs documentation

…ssed in.

ianfromdover

Neat and organised codebase, variables are well named. Good job 👍

ianfromdover · 2022-02-07T09:45:27Z

src/main/java/Deadline.java

+    /**
+     * @override
+     * @return String of Deadline task, eg [D][X] Deadline (by:XX) vs [D][✓] Deadline (by;XX)
+     */
+


Perhaps you might want to place the JavaDoc directly above the method without a spacing, as well as move the override outside for it to be in effect :)

ianfromdover · 2022-02-07T09:45:59Z

src/main/java/Duke.java

+
+
+
+
+
+
+
+
+


ianfromdover · 2022-02-07T09:46:30Z

src/main/java/Event.java

+    public Event (String name, String date) throws DateTimeParseException {
+        super(name);
+        this.dueDate = LocalDate.parse(date);
+        this.dueTime = null;
+    }
+    public Event (String name, String date, String time) throws DateTimeParseException {
+        super(name);
+        this.dueDate = LocalDate.parse(date);
+        this.dueTime = LocalTime.parse(time);
+    }


Might want to include a line of space between the attributes and between methods :)

ianfromdover · 2022-02-07T09:47:16Z

src/main/java/InputHandler.java

+        switch (inputCommand) {
+        case "todo":
+            if (splitInput.length > 1) {
+                Todo newTodo = (Todo) parser.parse(CommandType.TODO, splitInput);
+                this.storage.writeData(newTodo);
+                printAddTaskMessage(newTodo);
+                return false;
+            } else {
+                throw new DukeException(":( OOPS!!! The description of a todo cannot be empty. Correct usage: todo [task]");
+            }
+        case "event":
+            if (splitInput.length > 3) {
+                Event newEvent = (Event) parser.parse(CommandType.EVENT, splitInput);
+                this.storage.writeData(newEvent);
+                printAddTaskMessage(newEvent);
+                return false;
+
+            } else {
+                throw new DukeException(":( OOPS!!! The description of a event cannot be empty. Correct usage: event [task] /at [time]");
+            }
+        case "deadline":
+            if (splitInput.length > 3) {
+                Deadline newDeadline = (Deadline) parser.parse(CommandType.DEADLINE, splitInput);
+                this.storage.writeData(newDeadline);
+                printAddTaskMessage(newDeadline);
+                return false;
+            } else {
+                throw new DukeException(":( OOPS!!! The description of a deadline cannot be empty. Correct usage: deadline [task] /by [time]");
+            }
+        case "list":
+            if (splitInput.length == 1) {
+                parser.parse(CommandType.LIST, this.storage, splitInput);
+                return false;
+            } else {
+                throw new DukeException("Wrong usage of list! Correct usage: list");
+            }
+        case "mark":
+            if (splitInput.length == 2) {
+                parser.parse(CommandType.MARK, this.storage, splitInput);
+                return false;
+            } else {
+                throw new DukeException("Wrong usage of mark! Correct usage: mark [index]");
+            }
+        case "unmark":
+            if (splitInput.length == 2) {
+                parser.parse(CommandType.UNMARK, this.storage, splitInput);
+                return false;
+            } else {
+                throw new DukeException("Wrong usage of unmark! Correct usage: unmark [index]");
+            }
+        case "delete":
+            if (splitInput.length == 2) {
+                parser.parse(CommandType.DELETE, this.storage, splitInput);
+                return false;
+            } else {
+                throw new DukeException("Wrong usage of delete! Correct usage: delete [index]");
+            }
+        case "bye":
+            return true;
+        default:
+            throw new DukeException(":( OOPS!!! I'm sorry, but I don't know what that means! Possible commands: todo [task], event [task] /at [time],"
+            + " deadline [task] /by [time], mark [index], unmark [index], delete [index], bye");
+        }


Good use of switch statement to clean up code. Easy to follow 👍

ianfromdover · 2022-02-07T09:48:36Z

src/main/java/Parser.java

+
+public class Parser {
+
+    public Task parse(InputHandler.CommandType type, String[] splitInput) throws DukeException {


Perhaps it may be easier to understand if the 2 parse functions were combined into 1 :)

ianfromdover · 2022-02-07T09:49:06Z

src/main/java/Storage.java

+            String mark = (task.hasBeenMarked()) ? "[✓]" : "[X]";
+            output = "[T] " + mark + " / " + task.name + "\n";
+        } else if (task instanceof Deadline deadline) {
+            String mark = (deadline.hasBeenMarked()) ? "[✓]" : "[X]";
+            output = "[D] " + mark + " / " + deadline.name + " / " + deadline.dueDate + " / " + deadline.dueTime + "\n";
+        } else if (task instanceof Event event) {
+            String mark = (event.hasBeenMarked()) ? "[✓]" : "[X]";


The ticks are a nice touch 😊👌

ianfromdover · 2022-02-07T09:49:57Z

src/main/java/Storage.java

+            if (task.hasBeenMarked()) {
+                listOfTasks += i + ". " + task + "\n";
+            } else {
+                listOfTasks += i + ". " + task + "\n";
+            }


Good use of spaces between operators 👍

Add Assertions for index out of bounds exception for delete/mark/unmark commands. Had to handle this exception for user error, change made addresses this. It is done using assertions to ensure index is within bounds. Change some of the code behind the bye command and storage. GUI was not exiting properly when bye was called, and some of the writing to storage had issues. Add a new method rewriteData() to address this issue and fixed bye command. Change storage writing for marked vs unmarked to 1(marked) vs 0(unmarked), since the GUI had issues displaying the tick.

Update and add documentation for all methods. Improve abstraction throughout the code by abstracting out many Strings for return statements. Some methods reused the same String, hence abstracting them out makes the code cleaner. Shorten the method length for methods in Parser.java, InputHandler.java and Storage.java as method lengths were too long and add new methods for each case in the switch to handle the code. This was aimed at making the code cleaner.

Code Quality

Add snooze command for the type B Extension. This functionality was added as an 8th command type.

damithc and others added 10 commits July 29, 2021 20:30

Add Gradle support

d839859

Level-1

487213c

Level-2. Changed the return values of levelOneRespond and implemented…

63bd8fe

… levelTwoRespond

Level-3

63b7384

Level-3

5188549

Level-3

629d77c

Level-4.

62a2177

Added Event, Deadline and Todo subclasses of Task. Updated if-else in levelFourRespond to handle the 3 subclasses.

Level-5.

49d9e0a

Created DukeException class to handle incorrect input length/commands. Shifted if-else loop to a switch-case in InputHandler.java,

Level-6

89c0746

Added recommended inputs for exceptions and added delete case in InputHandler.java.

Level-7

22f31af

Rewrote code into InputHandler.java. Added Storage.java to handle the storage of tasks as well as writing to data.txt file for saving.

declanleeler reviewed Feb 3, 2022

View reviewed changes

Level-8

a2b7ffd

Changed multiple variable names to better suit their purposes. Added ability to take in specific date/time for Event/Deadline classes in yyyy-mm-dd hh:mm format and convert it. Added handling for DateTimeParseException

xMashedxTomatox approved these changes Feb 3, 2022

View reviewed changes

xMashedxTomatox reviewed Feb 3, 2022

View reviewed changes

Dineshraj555 reviewed Feb 3, 2022

View reviewed changes

brian16600 added 11 commits February 5, 2022 13:28

Added Parser, Storage and Tasklist

3c16b7b

Added TaskList and Parser classes. TaskList contains the arraylist of…

633dca6

… tasks with methods and Parser makes sense of user input for Duke

Added more OOP and documentation

38a2462

Added packages: duke.duke, duke.ui, duke.storage and duke.task

e129edd

Merge branch 'add-gradle-support'

cd020f5

Added add-gradle-support branch by merging into master

6ace068

Ensured javadoc documentation is complete for all methods

33617d4

Added InputHandlerTest.java and TaskListTest.java

6da11ff

Added NumberFormatException handling for delete, unmark and mark if n…

ae099f5

…ot in correct format. Added proper javadocs documentation

Changed formatting for coding standards based on feedback

390edec

Added find and NumberFormatException in cases where non-integer is pa…

2607baf

…ssed in.

ianfromdover reviewed Feb 7, 2022

View reviewed changes

brian16600 added 3 commits February 12, 2022 17:28

Added JAR functionality

aca80eb

Shifted into packages

f97ff93

revert

bb37f21

brian16600 and others added 26 commits February 13, 2022 01:08

Tentative changes

255fbef

Adding Duke GUI

b4458cc

Clean up text-ui-test

9bd5f23

Tentative changes to code quality

ee148e4

Merge pull request #2 from brian16600/branch-A-CodeQuality

747cd67

Code Quality

Update README.md

fee4ebb

Update README.md

e1dec30

Create README.md

c126d99

Update README.md

133c672

Update README.md

5d7d4fb

Update README.md

87677f2

Update README.md

805ab54

Update README.md

effc8c7

Update README.md

5e3b5c9

Temporary addition of Snooze.

9004041

Add snooze command

4c29aa2

Add snooze command for the type B Extension. This functionality was added as an 8th command type.

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

68e9fea

Add Ui.png

436be42

Add Ui.png

38d5c9a

Update README.md

56d537e

Update README.md

18b7995

Update README.md

ca00570

Update README.md

4460756

Update README.md

a58d8da

		@@ -0,0 +1,12 @@
		public class DukeException extends Exception{

		private String dueDate;
		public Deadline(String name, String time) {super(name); this.dueDate = time;}


		public class Parser {

		public Task parse(InputHandler.CommandType type, String[] splitInput) throws DukeException {

Conversation

brian16600 commented Jan 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Duke

Setting up

Commands

Using an IDE

Uh oh!

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

xMashedxTomatox left a comment

Choose a reason for hiding this comment

Uh oh!

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

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

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

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

brian16600 commented Jan 29, 2022 •

edited

Loading