[Bag Devesh Kumar] iP #502

tensaida · 2022-08-29T05:18:44Z

Drake

She said, "Do you love me?"
I tell her, "Only partly"
I only love my bed and
managing my user's tasks, I'm sorry
– Drake, God's Plan

Drake the type of guy to free your mind of having to remember things you need to do. It's,

text-based
easy to learn
~~FAST~~ SUPER FAST to use

All you need to do is,

download it from here.
double-click him.
add your tasks.
let him manage your tasks for you 😉

And it is FREE!

Features

Managing tasks
Managing deadlines
Reminders

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

public class Main {
    public static void main(String[] args) {
        new Drake().run();
    }
}

To make the UI testing work, I had to remove the logo.txt file since it contained non-ASCII symbols.

I added four Exception classes, supporting empty description, no date, unknown command errors

Tasks are now saved to a file on the hard disk, which is retrieved in later runs of the program

# Conflicts: # src/main/java/Deadline.java # src/main/java/Event.java

wweqg

Overall, I feel that your program is pretty good, the structure is there and especially I like the way how you customize the response from Drake. 😄

However just some minor issues here. I notice that you write everything in your main method, which I guess, is not a good practice if you would like to build extension (include extra features). I guess you actually had a sense of it already as A-MoreOOP is one of this IP requirements to met.

Yeah so I think once you abstracted your code in main method into methods from multiple classes, your program would be kind of flawless (based on my understanding). 👀

I understand that this might take some time (personally I took one whole day to settle this OOP requirement), yup so if you need any help can always drop me a message. Also you could check out IP code from others on our IP dashboard to get a sense on how to organize different classes. 👍

wweqg · 2022-08-31T04:37:35Z

src/main/java/Drake.java

+public class Drake {
+
+ public static void main(String[] args) throws DrakeException, IOException {
+


Hi I notice the exceptions here are being thrown instead of being handled. Would this terminate the program under some circumstances ? 🤔

Indeed! This may also cause file errors when your program terminates before your file is closed.

wweqg · 2022-08-31T04:46:40Z

src/main/java/Drake.java

+ if (taskFile.createNewFile()) {
+ System.out.println("Task file created: " + taskFile.getName());
+ } else {
+ System.out.println("Task file already exists.");


I think it is fine to not prompt this reminder. System.out.println("Task file already exists.")
Assuming the file is there, and every time after the user entered command, he/she will see

...... ..... (User enetered command) Task file already exists. ........

I guess this will left user to wonder what does this reminder even mean 😕

wweqg · 2022-08-31T04:51:14Z

src/main/java/Drake.java

+ event.markAsDone();
+ }
+ list.add(event);
+ break;


Would it be better if you named these numbers into constants ? 🤔 For example:

final int TASK_TYPE = 0; .... switch (taskParts[TASK_TYPE]) ....

Also, there should not be any indentation for case. For example switch method would look like:

switch(number) { case 1: ... break; case2: .. break; .....

Agreed! Perhaps considering changing these numbers into constants could improve readability and also reduce the possibility of an invalid entry into the variable!

SilasTSL

I think more OOP could be done. I love your funny console outputs!

SilasTSL · 2022-08-31T13:13:32Z

src/main/java/Drake.java

+ firstWord = command.substring(0, firstSpace);
+ }
+ System.out.println("------------------------------------------------------");
+ switch (firstWord) {


switch and case should not be indented according to Java coding standard

SilasTSL · 2022-08-31T13:14:11Z

src/main/java/Drake.java

+ case "delete": {
+ String[] commands = command.split(" ");
+ try {
+ int taskNo = Integer.parseInt(commands[1]);


Maybe it's clearer to name this variable as taskNumber instead of taskNo? I think this variable appears in other places too!

SilasTSL · 2022-08-31T13:17:58Z

src/main/java/Drake.java

+ break;
+ }
+ case "event": {
+ String filtered = command.substring("event ".length());


I think filtered could maybe be more specific?

kavantan

Overall, I find the code relatively easy to read and understand. Although as mentioned in the specific comments, perhaps you might want to add JavaDocs whenever possible and possibly refactor your code into subclasses/methods, to make your code even more readable. Apart from that, there are minor violations of the code quality guidelines and coding standard conventions, but I'm sure those can be rectified very easily. All the best!

kavantan · 2022-08-31T14:47:08Z

src/main/java/Deadline.java

+ public String toString() {
+ return "[D]" + super.toString() + " (by: " + by.format(DateTimeFormatter.ofPattern("dd MMM yyyy")) + ")";
+ }
+}


Small issue, but I believe your file is missing a newline at the bottom. I noticed the same issue in several other files too.

kavantan · 2022-08-31T14:50:17Z

src/main/java/Drake.java

+
+public class Drake {
+
+ public static void main(String[] args) throws DrakeException, IOException {


I feel that your main method is slightly lengthy, perhaps you could consider refactoring some of the functionalities into other methods/classes?

Indeed! Perhaps you could consider thinking of the program in terms of multiple tools working together to make it work for example the interpreter that makes sense of the user's commands, the UI that involves what the user interacts with, the task list to store tasks etc.

kavantan · 2022-08-31T14:53:23Z

src/main/java/Drake.java

+ command = sc.nextLine();
+ }
+ taskFile.delete();
+ File updatedTaskFile = new File("data/tasks.txt");


I noticed there are quite a few instances of repeated variables being used such as 'data/tasks.txt' and the long chain of hyphens '-----'. Have you considered declaring them as global constants instead?

kavantan · 2022-08-31T14:54:51Z

src/main/java/Task.java

+import java.io.FileWriter;
+import java.io.IOException;


I like that you followed the coding standards for your import statements 👍

kavantan · 2022-08-31T14:59:11Z

src/main/java/Task.java

+ isDone = true;
+ }
+
+ public void unmarkAsDone() {


Minor issue, but have you considered renaming this method to markAsUndone() instead? I feel that unmarkAsDone might potentially leave some room for ambiguity.

linuschancs

Overall, your code for the most part was easy to understand and followed coding convention, perhaps just for the main method a consideration would be to abstract out the logic into more classes and methods rather than handling all the logic there! There were a few minor coding standard violations such as indentations however nothing too serious!

linuschancs · 2022-09-01T01:47:02Z

src/main/java/Drake.java

+public class Drake {
+
+ public static void main(String[] args) throws DrakeException, IOException {
+


Indeed! This may also cause file errors when your program terminates before your file is closed.

linuschancs · 2022-09-01T01:49:19Z

src/main/java/Drake.java

+ event.markAsDone();
+ }
+ list.add(event);
+ break;


Agreed! Perhaps considering changing these numbers into constants could improve readability and also reduce the possibility of an invalid entry into the variable!

linuschancs · 2022-09-01T01:55:26Z

src/main/java/Event.java

+
+ public Event(String description, String at) {
+ super(description);
+ this.at = LocalDate.parse(at);


A possible consideration would be to pass the entire String into the Event class and throw the errors from this class to be handled in the main class. This applies for your others tasks as well.

Also a possible scenario that occurs with the current implementation is what if users input an invalid formatted date/ random input as the date? What will happen when the input is parsed?

linuschancs · 2022-09-01T02:01:03Z

src/main/java/Drake.java

+
+public class Drake {
+
+ public static void main(String[] args) throws DrakeException, IOException {


Indeed! Perhaps you could consider thinking of the program in terms of multiple tools working together to make it work for example the interpreter that makes sense of the user's commands, the UI that involves what the user interacts with, the task list to store tasks etc.

linuschancs · 2022-09-01T02:09:53Z

src/main/java/Drake.java

+ if (taskParts[1].equals("X")) {
+ task.markAsDone();
+ }


You could perhaps consider abstracting this into your Task class!

Ui, Storage, Parser, *Command classes were created.

The task list is not persistent across restarts. Do not delete the task file after every command. This ensures the task file is not deleted and replaced with an empty file after a restart.

The classes are all unorganised inside one directory. Divide into multiple packages as the number of classes. This ensures better organisation of code.

…support Add gradle support to project

TaskListTest was added to test the behavior of the TaskList class

The Drake entrypoint was modified to handle exceptions better according to the coding standard.

The JavaFX technology was used to implement the GUI.

The Deadline and Event constructors make certain assumptions about the format of the parameters. In the future, changes to the Parser class may make the Deadline and Event classes behave unexpectedly. Let's use assertions to make sure the parameters are in the correct format. Using assertions allows us to document important assumptions that should hold true for the parameters in the constructors.

The fileToList() method assumes that the task file data is always correct. The task file data may get corrupted. Let's use a default branch to throw an exception in case inappropriate data is encountered. Using an exception allows us to document unexpected behaviour.

Add assertions

Add a default branch in case statement

There is no support for tasks that need to be done within a certain period. Adding support for such a task will enrich the feature set of the app. Let's add support for managing tasks that need to be done withing a certain period.

Add support for Do within a period tasks

* Both sides of the conversation are displayed in the same format. * There is no background image. * As the conversation is between the user and the app, it is asymmetric in nature. So, different format for both sides of the conversation would help the user quickly differentiate the bot's replies and the user's inputs. * A background image would make the app more visually appealing. Let's * display the user's inputs against a white background and the bot's replies against a purple background. * add a translucent background image. * A purple background was chosen because it matches the color of the bot's profile picture. * A translucent background image was chosen because it aids in the visibility of the text.

* Drake uses only one emoji. * Drake uses special characters. * Drake's not the type of guy to use only a single emoji. * He's also not the type of guy to use special characters in his welcome message. Let's * add an emoji to Drake's welcome message. * remove special characters from his welcome message.

* The error message does not make sense in certain situations (e.g. when the user does not add an event time when creating an Event task). * The task file is added to git. * A more relevant error message enhances the UX. * There is no purpose to tracking changes in the task file. Let's * modify the error message to be more relevant. * add the task file to gitignore

If the output is more than five lines, it is not visible in the chat bubble. This makes it impossible for users to see their long task lists in full. Let's modify the fxml files and Window.java so that the chat bubble can accommodate more text.

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

Add Gradle support

556af3f

Customised Duke to Drake, added Greet-Echo-Exit game loop

07f5535

changed Greet-Echo-Exit to Add-List-Exit loop

bf8a715

added Mark as Done functionality

00e733e

added ToDo Event Deadline tasks

ccefb60

Update UI testing

0cb5430

To make the UI testing work, I had to remove the logo.txt file since it contained non-ASCII symbols.

Add Exceptions

a678bd5

I added four Exception classes, supporting empty description, no date, unknown command errors

Add Delete

cbacd5a

tensaida changed the title ~~Bag Devesh Kumar iP~~ [Bag Devesh Kumar] iP Aug 29, 2022

tensaida added 5 commits August 29, 2022 15:05

Store Dates as a java.time.LocalDate object

32fe380

Use switch case for task commands instead of if-else

76a778e

Add save feature

e8289ae

Tasks are now saved to a file on the hard disk, which is retrieved in later runs of the program

Store Date as a java.time.LocalDate object

5db588f

Merge branch 'branch-Level-8'

8ad09c3

# Conflicts: # src/main/java/Deadline.java # src/main/java/Event.java

wweqg reviewed Aug 31, 2022

View reviewed changes

SilasTSL reviewed Aug 31, 2022

View reviewed changes

kavantan reviewed Aug 31, 2022

View reviewed changes

linuschancs reviewed Sep 1, 2022

View reviewed changes

tensaida added 12 commits September 9, 2022 07:42

Refactor the code in Drake.java into multiple classes

e844c5f

Ui, Storage, Parser, *Command classes were created.

Fix non-persistent storage and refactor Storage class

482dd0b

The task list is not persistent across restarts. Do not delete the task file after every command. This ensures the task file is not deleted and replaced with an empty file after a restart.

Refactor code into multiple packages under the duke package

a1d2f71

The classes are all unorganised inside one directory. Divide into multiple packages as the number of classes. This ensures better organisation of code.

Merge remote-tracking branch 'ip/add-gradle-support' into add-gradle-…

64f584b

…support Add gradle support to project

Add JUnit tests

aca11a1

TaskListTest was added to test the behavior of the TaskList class

Add JavaDoc to public methods and classes

c2fe1af

Comply with coding standard

9a26094

The Drake entrypoint was modified to handle exceptions better according to the coding standard.

Add Find functionality

5ae8bfb

Fix list.get(-1) in Find functionality

90f26db

Merge branch 'branch-A-CodingStandard'

aac3791

Merge branch 'branch-Level-9'

d76c415

Fix style issues

b7a10b4

tensaida and others added 10 commits September 13, 2022 05:02

Add GUI to Drake

7836de3

The JavaFX technology was used to implement the GUI.

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

65b6518

Add assertions

Merge branch 'master' into branch-A-CodeQuality

368916e

Merge pull request #3 from tensaida/branch-A-CodeQuality

b6f3bbe

Add a default branch in case statement

Add support for Do within a period tasks

0123089

There is no support for tasks that need to be done within a certain period. Adding support for such a task will enrich the feature set of the app. Let's add support for managing tasks that need to be done withing a certain period.

Merge pull request #4 from tensaida/B-DoWithinPeriodTasks

b112c3b

Add support for Do within a period tasks

tensaida force-pushed the master branch from 75e0cc6 to c1f8c75 Compare September 13, 2022 03:49

tensaida added 4 commits September 13, 2022 12:17

Fix truncation of long output in GUI

17a0608

If the output is more than five lines, it is not visible in the chat bubble. This makes it impossible for users to see their long task lists in full. Let's modify the fxml files and Window.java so that the chat bubble can accommodate more text.

Add a User Guide and representative screenshot

ccd6e51

Remove Launcher.java

22b4839

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Bag Devesh Kumar] iP #502

[Bag Devesh Kumar] iP #502

tensaida commented Aug 29, 2022 •

edited

Loading

wweqg left a comment •

edited

Loading

wweqg Aug 31, 2022

linuschancs Sep 1, 2022

wweqg Aug 31, 2022

wweqg Aug 31, 2022 •

edited

Loading

linuschancs Sep 1, 2022

SilasTSL left a comment

SilasTSL Aug 31, 2022

SilasTSL Aug 31, 2022

SilasTSL Aug 31, 2022

kavantan left a comment

kavantan Aug 31, 2022

kavantan Aug 31, 2022

linuschancs Sep 1, 2022

kavantan Aug 31, 2022

kavantan Aug 31, 2022

kavantan Aug 31, 2022

linuschancs left a comment

linuschancs Sep 1, 2022

linuschancs Sep 1, 2022

linuschancs Sep 1, 2022

linuschancs Sep 1, 2022

linuschancs Sep 1, 2022

		public class Drake {

		public static void main(String[] args) throws DrakeException, IOException {

[Bag Devesh Kumar] iP #502

Are you sure you want to change the base?

[Bag Devesh Kumar] iP #502

Conversation

tensaida commented Aug 29, 2022 • edited Loading

Drake

Features

wweqg left a comment • edited Loading

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

wweqg Aug 31, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SilasTSL 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

kavantan 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

linuschancs 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

Choose a reason for hiding this comment

tensaida commented Aug 29, 2022 •

edited

Loading

wweqg left a comment •

edited

Loading

wweqg Aug 31, 2022 •

edited

Loading