[John Benedict] iP #14

johnbenedictyan · 2022-08-19T03:59:14Z

Aladdin Services

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

Aladdin frees your mind from 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 (coming soon)
Reminders (coming soon)

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

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

Implement a skeletal version of Duke that starts by greeting the user, simply echos commands entered by the user, and exits when the user types bye.

Add the ability to store whatever text entered by the user and display them back to the user when requested.

Add the ability to mark tasks as done. Optionally, add the ability to change the status back to not done.

Add support for tracking three types of tasks: 1. ToDos: tasks without any date/time attached to it e.g., visit new theme park 2. Deadlines: tasks that need to be done before a specific date/time e.g., submit report by 11/10/2019 5pm 3. Events: tasks that start at a specific time and ends at a specific time e.g., team project meeting on 2/10/2019 2-4pm

Use the input/output redirection technique to semi-automate the testing of Duke

Teach Duke to deal with errors such as incorrect inputs entered by the user

Use Exceptions to handle errors

Add support for deleting tasks from the list

Use Enumerations

Save the tasks in the hard disk automatically whenever the task list changes. Load the data from the hard disk when Duke starts up.

Teach Duke how to understand dates and times

Automate project builds using Gradle

Divide classes into packages

Refactor the code to extract out closely related code as classes

Add JUnit tests to test the behaviour of the code

Add JavaDoc comments to the code.

Tweak the code to comply with a coding standard

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

Use checkStyle to detect coding style violations.

Add a GUI to Duke. Use the JavaFX technology to implement the GUI.

Use Java varargs feature.

eugenelmj

Overall, good effort to abstract out the classes and obeying the OOP principles! Just take note that the overall readability could be further improved; some indentations are not very consistent and may impede the readability. Also, the JavaDocs tends to be a little verbose; maybe you can use simpler sentences to summarise what the method is achieving. Otherwise, good effort! 😄

eugenelmj · 2022-09-01T14:27:33Z

src/main/java/duke/Duke.java

+     * The function returns the result of executing that command.
+     *
+     * @param command
+     *            Pass the command object to the run command method


This line of description should be in line with @param command, otherwise the indentation may look off. :)

Ah thank you, I will take note of this!

eugenelmj · 2022-09-01T14:28:53Z

src/main/java/duke/DukeCommands.java

+ * The enum duke.Duke commands.
+ */
+public enum DukeCommands {
+    /**


Perhaps you could remove the individual JavaDocs for every type of commands to reduce the clutter here.

eugenelmj · 2022-09-01T14:31:44Z

src/main/java/duke/domain/Deadline.java

+    }
+
+    /**
+     * Of deadline.


Maybe you want to elaborate on what the description "Of deadline" here means? :)

eugenelmj · 2022-09-01T14:35:10Z

src/main/java/duke/domain/Task.java

+     * @throws InvalidTaskSpecificationException
+     *             the invalid task specification exception
+     */
+    public static Task of(


Some of the indentations in the first part of this method; perhaps you might want to change some of it to improve the readability of the code? Otherwise, it may be mistaken as a form of "Deep Nesting".

I see I will see what I can do

eugenelmj · 2022-09-01T14:35:51Z

src/main/java/duke/domain/Event.java

+        return Objects.hash(super.hashCode(), dateTime);
+    }
+
+    @Override


Good that you're abiding to the Boolean naming standards here! :)

eugenelmj · 2022-09-01T14:38:58Z

src/main/java/duke/storage/Storage.java

+    public List<Task> load(String filePath) {
+        try {
+            ensureDataFileExist(filePath);
+            List<Task> initTask = new ArrayList<>();


Since this is a list of Task objects, the variable name should be "initTasks" instead. :)

eugenelmj · 2022-09-01T14:41:42Z

src/main/java/duke/taskList/TaskList.java

+     *            Filter the tasks that are after a certain date
+     * @return A string containing the tasks that are after the datetime
+     */
+    public String outputTasksAfterString(LocalDateTime dateTime) {


Nice use of streams here. Well done!

xhphoong

Overall, your code is easy to read. Most of your method is short and concise but there are few part where the method is quite long and deeply nested. Perhaps can consider to shorten those method by separating some operation into different method?

xhphoong · 2022-09-02T03:23:10Z

src/main/java/duke/Duke.java

+ */
+public class Duke {
+
+    private static final String defaultFilePath = "src/main/java/duke/data/tasks.txt";


Perhaps the naming of this constants should be in all uppercase?

Hmm I see, thank you for pointing this out

xhphoong · 2022-09-02T03:32:54Z

src/main/java/duke/domain/Task.java

+        Boolean isEvent = Objects.equals(type, "E");
+        Boolean isDeadline = Objects.equals(type, "D");
+        Boolean isTodo = Objects.equals(type, "T");
+        if (isEvent || isDeadline || isTodo) {
+            if (isEvent || isDeadline) {


I like you done it in steps, by evaluating the boolean value first then use the evaluated value in the if statement. Avoid complicated expression and easier to read.

xhphoong · 2022-09-02T03:51:35Z

src/main/java/duke/parser/Parser.java

+     * @param userInput
+     *            Get the user input
+     */
+    public BaseCommand parse(String userInput)


Maybe can find a way to shorten this method? eg : put some of the operation in separate method and call it in here?

This is definitely one area of my code that could use refactoring, I will take note of this in the future

xhphoong · 2022-09-02T03:53:42Z

src/main/java/duke/parser/Parser.java

+                Task newDeadline = Task.of(
+                        "D",
+                        "0",
+                        deadlineTitle,
+                        deadline);


Perhaps put it in the same line to reduce the level of indentation to make it easier to read?

Oh, I thought it was easier to read like this but I shall take note

Use assert feature (not JUnit assertions) to document important assumptions that should hold at various points in the code.

Improve code quality

Use Streams

A-CodeQuality

A-Streams

A-Assertions

GitHub Actions will run custom workflow every time certain project events are triggered (e.g., when a PR is updated, or the master branch is updated). This workflow will help to automate mundane task like: * checking the compilation of the gradle project * checking the style of the project using checkstyle

Generate javadocs to fulfil checkstyle

Add the sorting feature

Add the ability for the user to ask for help and what commands are available

Updated the ui of the duke bot so that it is more visually pleasing to the users

Updated the command messages so that the duke bot appears more unique and friendly

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

Add Gradle support

556af3f

Level 1. Greet, Echo, Exit

1a08237

Implement a skeletal version of Duke that starts by greeting the user, simply echos commands entered by the user, and exits when the user types bye.

Level 2. Add, List

4684662

Add the ability to store whatever text entered by the user and display them back to the user when requested.

Level 3. Mark as Done

0c3b836

Add the ability to mark tasks as done. Optionally, add the ability to change the status back to not done.

Test using the I/O redirection technique

75ffbe7

Use the input/output redirection technique to semi-automate the testing of Duke

Level 5. Handle Errors

42c6669

Teach Duke to deal with errors such as incorrect inputs entered by the user

A-Exceptions

f1efa27

Use Exceptions to handle errors

Level 6. Delete

2e0dfc5

Add support for deleting tasks from the list

A-Enums

3eaaa9e

Use Enumerations

Refactor greeting functions

3ea20b7

Refactor task control flow with new task controller class

ee86507

Refactor code

075ed42

Refactor code

7bc87fc

Add javadoc

a1b132a

Refactor folder structure

ade32cb

Level 7. Save

aada865

Save the tasks in the hard disk automatically whenever the task list changes. Load the data from the hard disk when Duke starts up.

Level 8. Dates and Times

812c48f

Teach Duke how to understand dates and times

Merge remote-tracking branch 'upstream/add-gradle-support'

63cb852

A-Gradle

df388ea

Automate project builds using Gradle

A-Packages

351bea5

Divide classes into packages

A-MoreOOP

961e2a2

Refactor the code to extract out closely related code as classes

A-JUnit

26a9e28

Add JUnit tests to test the behaviour of the code

A-JUnit

df12bfd

Add JUnit tests to test the behaviour of the code

A-JavaDoc

9c47fc4

Add JavaDoc comments to the code.

A-CodingStandard

2ae11e1

Tweak the code to comply with a coding standard

Level 9. Find

e8c70a9

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

Merge branch-A-CodingStandard into master.

0d47ec9

Merge branch-Level-9 into master.

b9cef36

A-CheckStyle

50fe134

Use checkStyle to detect coding style violations.

johnbenedictyan added 2 commits August 31, 2022 00:11

Level 10. GUI

5669425

Add a GUI to Duke. Use the JavaFX technology to implement the GUI.

A-Varargs

f3545a1

Use Java varargs feature.

eugenelmj reviewed Sep 1, 2022

View reviewed changes

xhphoong reviewed Sep 2, 2022

View reviewed changes

johnbenedictyan added 25 commits September 5, 2022 13:28

A-Assertions

87ae671

Use assert feature (not JUnit assertions) to document important assumptions that should hold at various points in the code.

A-CodeQuality

cd9e60a

Improve code quality

A-Streams

5ff07e0

Use Streams

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

9e33d5a

A-CodeQuality

Merge pull request #2 from johnbenedictyan/branch-A-Streams

94b7687

A-Streams

Deconflict merge

3ba60a1

Merge pull request #1 from johnbenedictyan/branch-A-Assertions

a74a0ee

A-Assertions

Generate Javadocs

be0b419

Generate javadocs to fulfil checkstyle

C-Sort

92ed8d1

Add the sorting feature

Add ability to display help task

f261e0a

Add the ability for the user to ask for help and what commands are available

Implement Better UI

c9e1a52

Updated the ui of the duke bot so that it is more visually pleasing to the users

Style Javadocs

8688724

Implement Duke Personality

5d4febf

Updated the command messages so that the duke bot appears more unique and friendly

Improve testing and parser

c95f555

Update github pages configuration

ece159b

Fix test indentation

34e6186

Remove ui picture

a047a99

Upload ui picture

494bc6c

Rename ui picture

0f84726

Rename ui picture

e1008ef

Update github page config file

1d885de

Add a User Guide

768719b

Fix gradle for release

29647bd

Fix storage file creation and access

cbccb22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[John Benedict] iP #14

[John Benedict] iP #14

johnbenedictyan commented Aug 19, 2022 •

edited

Loading

eugenelmj left a comment

eugenelmj Sep 1, 2022

johnbenedictyan Sep 2, 2022

eugenelmj Sep 1, 2022

eugenelmj Sep 1, 2022

eugenelmj Sep 1, 2022

johnbenedictyan Sep 2, 2022

eugenelmj Sep 1, 2022

johnbenedictyan Sep 2, 2022

eugenelmj Sep 1, 2022

eugenelmj Sep 1, 2022

xhphoong left a comment

xhphoong Sep 2, 2022

johnbenedictyan Sep 2, 2022

xhphoong Sep 2, 2022

johnbenedictyan Sep 2, 2022

xhphoong Sep 2, 2022

johnbenedictyan Sep 2, 2022

xhphoong Sep 2, 2022

johnbenedictyan Sep 2, 2022

[John Benedict] iP #14

Are you sure you want to change the base?

[John Benedict] iP #14

Conversation

johnbenedictyan commented Aug 19, 2022 • edited Loading

Aladdin Services

eugenelmj 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

xhphoong 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

johnbenedictyan commented Aug 19, 2022 •

edited

Loading