[Rebecca Lau] iP #476

rebeccalaujx · 2021-08-26T12:48:03Z

Duke

“Your mind is for having ideas, not holding them.” – David Allen (source)

Duke frees 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 it.
add your tasks.
let it manage your tasks for you 😉

And it is FREE!

Features:

Managing tasks
Managing deadlines
Reminders (coming soon)

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

    public static void main(String[] args) {
        new Duke("duke.txt").run();
    }

kleonang

Hi there, I've looked through your code and your code quality is generally good with some minor improvements to be made 😊.

Good use of OOP is evident, especially through the abstract Task and Command classes. You may also consider adding JavaDocs to the public constructors and methods to ease readability.

Great work on the code overall! 👍

kleonang · 2021-09-01T16:56:14Z

src/main/java/duke/Parser.java

@@ -0,0 +1,25 @@
+package duke;
+
+import duke.command.*;


Would be better to specifically list all duke.command imports here instead of using wildcard imports

kleonang · 2021-09-01T17:03:21Z

src/main/java/duke/Parser.java

+        } else if (input.startsWith("done")) {
+            return new DoneCommand(input);
+        } else if (input.startsWith("delete")) {
+            return new DeleteCommand(input);
+        } else if (input.startsWith("todo")) {
+            return new TodoCommand(input);
+        } else if (input.startsWith("deadline")) {
+            return new DeadlineCommand(input);
+        } else if (input.startsWith("event")) {
+            return new EventCommand(input);


Using input.startsWith("...") may cause some invalid commands to be interpreted as valid commands, e.g. when input starts with deadliner or todoy. Instead, consider using input.split(" ", 2) to get a String[], then check equality against the first element of the String[]. This way, the second element of the String[] also contains all the information you need for your Command subclasses later on.

kleonang · 2021-09-01T17:04:00Z

src/main/java/duke/Storage.java

@@ -0,0 +1,96 @@
+package duke;
+
+import duke.task.*;


Would be better to specifically list imports as before

kleonang · 2021-09-01T17:04:38Z

src/main/java/duke/Storage.java

+    String filePath;
+    PrintWriter writer;
+    TaskList ls;


Would be good to add private access modifiers here

kleonang · 2021-09-01T17:08:00Z

src/main/java/duke/Storage.java

+        } catch (FileNotFoundException e) {
+            e.printStackTrace();
+        } catch (IOException e) {
+            e.printStackTrace();
+        }


Possible to combine into a single catch statement here

Suggested change

} catch (FileNotFoundException e) {

e.printStackTrace();

} catch (IOException e) {

e.printStackTrace();

}

} catch (FileNotFoundException | IOException e) {

e.printStackTrace();

}

kleonang · 2021-09-01T17:38:25Z

src/main/java/duke/command/Command.java

+
+public abstract class Command {
+    public abstract void execute(TaskList ls, Ui ui, Storage storage) throws DukeException;
+    public abstract boolean isExit();


Since all but one of the commands have isExit() as false, this can be made into a non-abstract method.

Suggested change

public abstract boolean isExit();

public boolean isExit() {

return false;

}

kleonang · 2021-09-01T17:39:28Z

src/main/java/duke/command/DeadlineCommand.java

+    @Override
+    public boolean isExit() {
+        return false;
+    }


After the non-abstract isExit() is implemented in Command.java, there's no need to override here (and all commands except ExitCommand.java) anymore.

kleonang · 2021-09-01T17:41:23Z

src/main/java/duke/command/ExitCommand.java

+    @Override
+    public boolean isExit() {
+        return true;
+    }


Here should be the only Command subclass where overriding the isExit() method is necessary after implementing it in Command.java.

kleonang · 2021-09-01T17:43:13Z

src/main/java/duke/task/Deadline.java

+        if (description.isEmpty() || description == "" || description == " ") {
+            throw new DukeException("☹ OOPS!!! The description of a deadline cannot be empty.");
+        } else {
+            this.description = description.substring(1);
+        }
+
+        if (deadline.isEmpty() || deadline == "" || deadline == " ") {
+            throw new DukeException("☹ OOPS!!! The deadline of this task must be indicated.");


As before, these repeated checks in the if statements should not be necessary after using input.split(" ", 2) in Parser.java.

kleonang · 2021-09-01T17:44:08Z

src/main/java/duke/task/Event.java

+        if (description.isEmpty() || description == "" || description == " ") {
+            throw new DukeException("☹ OOPS!!! The description of an event cannot be empty.");
+        } else {
+            this.description = description.substring(1);
+        }
+
+        if (at.isEmpty() || at == "" || at == " ") {
+            throw new DukeException("☹ OOPS!!! The time of the event must be indicated.");


As before, these repeated checks in the if statements should not be necessary after using input.split(" ", 2) in Parser.java.

HangZelin

Overall a pretty nice job for coding standard! And your OOP design is pretty nice too. Just to remind there can be some improvements for your import and packaging naming.

Keep on your good job! 👍

HangZelin · 2021-09-03T07:52:08Z

src/main/java/duke/Parser.java

@@ -1,3 +1,7 @@
+package duke;
+
+import duke.command.*;


Is it better to not use wildcard for the import? It might be better to list all the stuff you want to import.

HangZelin · 2021-09-03T07:52:24Z

src/main/java/duke/Storage.java

@@ -1,9 +1,12 @@
+package duke;
+
+import duke.task.*;


It might be better to list all the stuff you want to import instead of using wildcard.

HangZelin · 2021-09-03T07:59:51Z

src/main/java/duke/Ui.java

@@ -15,7 +20,7 @@ public void showWelcome() {
                + "| |_| | |_| |   <  __/\n"
                + "|____/ \\__,_|_|\\_\\___|\n";
        System.out.println("Hello from\n" + logo);
-        System.out.println("Hello! I'm Duke\n" + "What can I do for you?");
+        System.out.println("Hello! I'm duke.Duke\n" + "What can I do for you?");


You may import the duke package inside, and you not really have to specify package all the time.

HangZelin · 2021-09-03T08:00:31Z

src/main/java/duke/task/Deadline.java

@@ -14,7 +17,7 @@ public Deadline(String description, String deadline) throws DukeException {
            LocalDate localDate = LocalDate.parse(deadline);
            this.date = localDate.format(DateTimeFormatter.ofPattern("MMM dd yyyy"));
        } catch (DateTimeParseException e) {
-            throw new DukeException("Deadline should be in a yyyy-mm-dd format.");
+            throw new DukeException("duke.task.Deadline should be in a yyyy-mm-dd format.");


You may import duke.task here.

… into branch-A-Gradle

The assertions feature addresses important assumptions that should hold in the code. A program that terminates the program early once a bug is observed is safer to use as it prevents the error from escalating further. Let's include the assertions feature to define assumptions about the program state so that the runtime can verify them.

Information extraction from input was largely repeated throughout the code, creating long methods and convoluted expressions. Extracting common behaviour into the common Input class reduces the amount of arrowhead style code, makes the expressions easier to understand, and shortens long methods, hence improving the code's readability. Let's improve the code quality so that the code can be more readable.

Branch assertions

Branch code quality

Users might want to delete many tasks or set many tasks as done all in one go, instead of entering a new command line for each task. MassOps allows users to delete multiple tasks or set multiple tasks as done, all in one go. Let's update the functions that delete tasks and set tasks as done to allow them to perform their function on multiple tasks at once.

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

Add Gradle support

d839859

Level-1

dce5cee

Level-2

247ac39

Level-3

78ea29d

Level-3

f15709b

Level-4

6a5d0e8

A-TextUiTesting

0be4686

A-TextUiTesting

5cb8123

Level-5

0c57b93

Level-5

310178c

Level-6

1cbdef7

rebeccalaujx changed the title ~~[{Rebecca Lau}] iP~~ [Rebecca Lau] iP Aug 26, 2021

rebeccalaujx added 7 commits August 28, 2021 17:19

save tasks to hard disk

fd0bb3d

changes dates into a MMM dd yyyy format

2ae58cc

save tasks to disk

2fcd257

merged branch 7

f2aedc3

change dates to MMM dd yyyy format

e6a51b1

merged branch 8

fe0ff94

add more OOP

e4ad385

rebeccalaujx force-pushed the master branch from 6379c5c to e4ad385 Compare September 1, 2021 10:57

rebeccalaujx added 3 commits September 1, 2021 19:10

added some OOP

8e90406

added more oop

c27673f

add files to packages

7fb685b

kleonang reviewed Sep 1, 2021

View reviewed changes

rebeccalaujx added 6 commits September 2, 2021 02:26

added JUnit tests

cb8b508

packaged the app as an executable JAR file

e48c0b5

added JavaDocs

b4758be

Tweaked the code to comply with a coding standard

f14f614

Gave users a way to find a task by searching for a keyword

db642c7

Merge branch 'branch-A-JavaDoc' and 'branch-A-CodingStandard'

80db064

Merge branch 'branch-Level-9'

621657a

HangZelin reviewed Sep 3, 2021

View reviewed changes

rebeccalaujx added 6 commits September 5, 2021 18:24

Merge branch 'add-gradle-support' of https://github.com/rebeccalaujx/ip…

07cb01c

… into branch-A-Gradle

Automate project builds using Gradle and fixed some checkstyle errors

87995c8

fixed checkstyle issues

db907f2

created basic GUI for Duke

9cf988a

used FXML for GUI

c6cc3a3

merge branch-Level-10

0972eb4

rebeccalaujx force-pushed the master branch from e6b9119 to 0972eb4 Compare September 7, 2021 14:28

rebeccalaujx and others added 21 commits September 16, 2021 13:39

Ui class: cleaned up comments

a4dd0df

Merge pull request #2 from rebeccalaujx/branch-Assertions

20a4b9e

Branch assertions

Merge pull request #1 from rebeccalaujx/branch-Assertions

b77329f

Merge branch 'master' into branch-Assertions and branch-CodeQuality

c053484

Merge pull request #3 from rebeccalaujx/branch-CodeQuality

2ef64a7

Branch code quality

Add varargs

35b27e9

Update docs/README.md

86cd0e0

Update docs/README.md

9931a27

Update docs/README.md

2e44079

Update docs/README.md

fcab3b7

Add Ui.png

764206d

Fix Storage function

7f34564

Update JavaDocs

9dcab1a

Improve GUI

308fc97

Fix Storage

454e98a

change class path

1bb04c1

fix Storage

1e77943

Update Ui.png

da29a26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Rebecca Lau] iP #476

[Rebecca Lau] iP #476

rebeccalaujx commented Aug 26, 2021 •

edited

Loading

kleonang left a comment

kleonang Sep 1, 2021

kleonang Sep 1, 2021

kleonang Sep 1, 2021

kleonang Sep 1, 2021

kleonang Sep 1, 2021

kleonang Sep 1, 2021

kleonang Sep 1, 2021

kleonang Sep 1, 2021

kleonang Sep 1, 2021

kleonang Sep 1, 2021

HangZelin left a comment

HangZelin Sep 3, 2021

HangZelin Sep 3, 2021

HangZelin Sep 3, 2021

HangZelin Sep 3, 2021

[Rebecca Lau] iP #476

Are you sure you want to change the base?

[Rebecca Lau] iP #476

Conversation

rebeccalaujx commented Aug 26, 2021 • edited Loading

Duke

kleonang 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

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

HangZelin 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

rebeccalaujx commented Aug 26, 2021 •

edited

Loading