[Eric Leow Yu Quan] iP #98

shittake · 2023-01-22T11:48:06Z

Duke is a bot that can help you manage your to-do list and keep them in one place!

Often find yourself overwhelmed and forgetting to do tasks?
Want to have a place to keep track of what's there to be done?
Afraid that you may miss out on something ~~trivial~~ important like your other half's birthday? 😍

You're not alone! Scientists show that memory is much more transient than you may think

So, cognitive psychologists divide memory into the first 15-30 seconds, and they call this short-term memory, and alllllll the rest of memory that lasts beyond 30 seconds is long-term memory. - (source)

Features:

Keep track of your tasks
Allow marking tasks as complete
Managing deadlines (Coming soon)

Strengths

Easy to use
Free!
More features to come

If you are a Java programmer, you can use it to practise Java too. Here's the main method:

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

This reverts commit 2b287c3.

…ation

…wishes to see the current list

…ut in order when requested by the user

…et by the user

… added by the user

…nce properly

…been marked as completed

…er adding a valid task

…their separate descriptions and timings

…t Tasks

…about previously added information

… the session

…t and printing out in MMM dd yyyy format using the LocalDate class

markusyeo

LGTM! Except the formatting of your javadocs might need to follow the coding standard

markusyeo · 2023-02-03T20:36:54Z

src/main/java/duke/Deadline.java

+
+    /**
+     * Returns the string representation of a Deadline instance in MMM d yyyy format.
+     * @return the desired string representation of a Deadline instance.


Perhaps you should have an empty line between description and parameter section?

Thanks for pointing that out! I wasn't aware of this coding standard

markusyeo · 2023-02-03T20:37:53Z

src/main/java/duke/Deadline.java

+    }
+
+    /**
+     * Returns the string representation of a Deadline instance in YYYY-MM-DD format.


You might have missed a spacing between the descriptions and parameter section here as well.

mandykqh

Overall, your code is pretty clean aside from those few nits. Nice job! 👍

mandykqh · 2023-02-05T08:44:56Z

src/main/java/duke/TaskList.java

+     */
+    public String printContents() {
+        String response = "Attempting to print out your tasks...\n";
+        if (lstOfItems.size() == 0 ) {


You might have added an extra space after "0".

mandykqh · 2023-02-05T08:50:01Z

src/main/java/duke/TaskList.java

+    }
+
+    /**
+     * A method stub to test the TaskList class.


Perhaps you may consider starting the method header with an active verb.
Eg. "Tests the TaskList class."

mandykqh · 2023-02-05T09:00:29Z

src/main/java/Duke.java

+import javafx.stage.Stage;
+
+
+public class Duke extends Application {


Perhaps you may consider adding JavaDoc comments for your classes too!

mandykqh · 2023-02-05T09:06:26Z

src/main/java/duke/TaskList.java

+        if (currentTask.charAt(1) == 'T') {
+            task = new Todo(currentTask.substring(7));
+        } else if (currentTask.charAt(1) == 'D') {
+            String[] split = currentTask.split("by: ");


You may consider renaming split into a plural form since it is a String array.

KS2499

Overall LGTM, I really like the way you commented your code and gave credit to your sources!

KS2499 · 2023-02-05T09:24:28Z

src/main/java/duke/Ui.java

+    public String instruct() {
+        String instructString = "There are various commands you can instruct me to do.\n";
+        instructString += ("A. If you want to see your list of tasks, type 'list'\n");
+        instructString += ("B. If you want to add a task, there are three possible commands:\n");
+        instructString += ("\t1. Type 'todo (name of task)' to add a todo task.\n");
+        instructString += ("\t2. Type 'deadline (name of task) /by (date in YYYY-MM-DD)\n");
+        instructString += (" to add a task that is to be done by a certain date.\n");
+        instructString += ("\t3. Type 'event (name of task) /from (date and time) /to ");
+        instructString += ("(date and time) to add in a time-limited event.\n");
+        instructString += ("C. To delete a task, type 'delete X' where X is the task number\n");
+        instructString += ("D. To mark a task as completed, type 'mark X'\n");
+        instructString += ("E. To save and exit, type 'bye'\n");
+        return instructString;
+    }


I like the way you formatted your paragraph line by line. Perhaps you could look into using StringBuilder here.

KS2499 · 2023-02-05T09:27:34Z

src/main/java/duke/TaskList.java

+
+public class TaskList {
+
+    private ArrayList<Task> lstOfItems;


Suggested change

private ArrayList<Task> lstOfItems;

private ArrayList<Task> lstOfTasks;

KS2499 · 2023-02-05T09:30:09Z

src/main/java/duke/Task.java

+     * Marks the task as completed.
+     * It does not matter whether the task has previously been marked as completed.
+     */
+    public void makeCompleted() {


Perhaps a more intuitive name like markAsCompleted can be used here?

KS2499 · 2023-02-05T09:32:36Z

src/main/java/duke/Storage.java

+     * Adds and saves the user's tasks into the File at the filePath.
+     * @param tasks the user's list of tasks before termination of the chatbot.
+     */
+    public void addToFile(TaskList tasks) {


Any reason why you named it as such instead of save (like load and save)?

Lack of documentation for constructors that may make it difficult to understand certain parameters if not explained Explaining the parameters used in all constructors allows for easier appreciation of the purpose of each class, and increases ease in bug- fixing in the future as it is easier to pinpoint which class or attribute is responsible for the bug

@params

Some coding standard violations such as not leaving a line in JavaDocs between the description and the @params and @return statements Made changes accordingly to fit the guidelines for standardization, to ensure that JavaDocs written adhere to these standards and are of high quality, and to maximize learning. Names of some variables were also changed to better represent what items they were actually storing to avoid any misconceptions.

Clean up code with the aid of comments given by peers and improve code to adhere to code quality guidelines

No assertions present that could lead to instances where a code does not work properly as intended, such as attempting to access a list that was not even created Add assertions that kept track of assumptions made in code, to check if these assumptions are held when certain parts of the code is run, to avoid undefined behaviour or errors

Add assertions to key parts of code

to allow saving and loading of previous tasks involving their respective priority levels. There was no ability to save previous priority levels, causing all tasks to have low priority level every time the application is launched Add ability to toggle priority level incrementally (among the 3 possible priority levels). Allow saving of data to save user time and to ensure that users do not need to set priority level of tasks manually each time.

Long methods such as run() in Duke class and manual checking of user's input for certain words resulted in arrow-head code and overly long methods. Manual checking of input was abstracted into more methods in the Parser class, with a checking of valid integers. Code is cleaner and easier to follow.

methods implemented, such as unmark task and find keyword

damithc and others added 30 commits July 31, 2022 17:20

Add Gradle support

556af3f

add new message for testing

2b287c3

Revert "add new message for testing"

8141869

This reverts commit 2b287c3.

Add welcome message with introMessage method

c677700

Add functionality to echo user input until user decides to end program

6df5fab

Abstract out endMessage() method for better readability

d03b28d

Add additional checker class and checkEnd method for user input valid…

d9e23a1

…ation

Add checkListRequest method to Checker class that will check if user …

94a4893

…wishes to see the current list

Add functionality to allow storage of all userinputs and print them o…

ed0d926

…ut in order when requested by the user

Add ability to print out custom message if no items have been added y…

6bb44ed

…et by the user

Create Task class which encapsulates the name and status of each task…

dc1d810

… added by the user

Override toString() method in Task class for easy printing

de27fb0

Add Task instances into the lstOfItems to capture state of each insta…

ec923ec

…nce properly

Add functionality to mark Task as completed and fix minor bugs

3676c55

Include message that is printed out to let user know that a task has …

1df88ae

…been marked as completed

Add message that tells user the number of tasks present currently aft…

8c20fcb

…er adding a valid task

Create Deadline, Event and Todo classes that inherit from Task class

01abd62

Add functionality to add different types of Tasks into the list with …

4096bae

…their separate descriptions and timings

Add Test UI Testing

b8a295f

Create new DukeException class to handle custom exceptions

cf348de

Add functionality to check for empty todo command and invalid commands

20649e0

Add exceptions to check for incorrect formatting of Deadline and Even…

ba11963

…t Tasks

Add functionality to remove previously added tasks

2da5cf1

Create preliminary txt file that will later on store all information …

5983fb6

…about previously added information

Create new text file if it is not present in user's directory

92f6c7c

Add functionality to parse previously saved file to retrieve information

7fc4c99

Add functionality to save contents into hard disk when the user exits…

2b574e4

… the session

Add functionality to store deadline dates by parsing yyyy-mm-dd forma…

6874886

…t and printing out in MMM dd yyyy format using the LocalDate class

Merge branch 'branch-Level-7'

ed1c698

Merge branch 'branch-Level-8'

31880f5

markusyeo reviewed Feb 3, 2023

View reviewed changes

mandykqh reviewed Feb 5, 2023

View reviewed changes

This comment was marked as off-topic.

Sign in to view

KS2499 reviewed Feb 5, 2023

View reviewed changes

shittake and others added 26 commits February 7, 2023 21:34

Merge pull request #1 from shittake/branch-A-CodeQuality

01e9d39

Clean up code with the aid of comments given by peers and improve code to adhere to code quality guidelines

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

480d197

Merge branch 'master' into branch-A-Assertions

bef849e

Merge pull request #2 from shittake/branch-A-Assertions

cc8a98d

Add assertions to key parts of code

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

f06f542

Tackle bug involving incorrect variable name due to merge conflicts

b5c3cea

Add functionality to disable further userInput upon termination

8c9cc35

Abstract method to check for termination for cleaner code

4afd408

Add priority level for tasks using enums

7219202

Add functionality to sort tasks based on priority level

29ec014

Merge branch 'branch-BCD-Extension'

1b93558

Fix bug where an extra space is added each time the list is loaded

1c28063

Add instructions to introductory message

f5aa345

Fix bug where mainClassName is not "Launcher"

67adbbc

Add more comprehensive tests for TaskListTest to account for other

bd6986f

methods implemented, such as unmark task and find keyword

Add functionality to display tutorial again if needed

1a6fa5a

Add JavaDocs for all classes

443731f

Add more comprehensive test cases for TaskTest

3f4c3e3

Add JavaDocs for methods in Duke class

8271ed6

Add representative screenshot of product

4559c3f

Add User Guide to product

c0d20f6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Eric Leow Yu Quan] iP #98

[Eric Leow Yu Quan] iP #98

shittake commented Jan 22, 2023 •

edited

markusyeo left a comment

markusyeo Feb 3, 2023

shittake Feb 7, 2023

markusyeo Feb 3, 2023

mandykqh left a comment

mandykqh Feb 5, 2023

mandykqh Feb 5, 2023

mandykqh Feb 5, 2023

mandykqh Feb 5, 2023

This comment was marked as off-topic.

KS2499 left a comment

KS2499 Feb 5, 2023

KS2499 Feb 5, 2023

KS2499 Feb 5, 2023

KS2499 Feb 5, 2023

		import javafx.stage.Stage;


		public class Duke extends Application {

	private ArrayList<Task> lstOfItems;
	private ArrayList<Task> lstOfTasks;

[Eric Leow Yu Quan] iP #98

Are you sure you want to change the base?

[Eric Leow Yu Quan] iP #98

Conversation

shittake commented Jan 22, 2023 • edited

Duke is a bot that can help you manage your to-do list and keep them in one place!

markusyeo 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

mandykqh 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

This comment was marked as off-topic.

KS2499 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

shittake commented Jan 22, 2023 •

edited