[ Hardik Narang ] iP #489

naranghardik16 · 2021-08-27T16:23:02Z

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~~ SUPER EASY to learn
SUPER FAST to use

All you need to do is,

add your tasks
let it manage your tasks for you 😉
download it from here.

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).runDuke();
}

This reverts commit 7ea4cc3.

LZher385 · 2021-08-30T12:03:01Z

src/main/java/Duke.java

+    public static void readInput(String userInput){
+
+        // Get command from the userInput
+        String[] splitLine = userInput.split(" ", 2);


Shouldn't a plural noun be used for the list of substrings?

LZher385 · 2021-08-30T12:06:41Z

src/main/java/Event.java

+import java.time.format.DateTimeFormatter;
+
+public class Event extends Task{
+    private LocalDateTime at;


I know its easy to tell from the context, but maybe the variable name can be a little more descriptive? I noticed this in Deadline.java too 👍

angnobel

Generally great job for abstraction, few nits on styling to fix for clarity!

angnobel · 2021-08-30T17:07:22Z

data/duke.txt

@@ -0,0 +1,8 @@
+T | 1 | new


Should the save files be uploaded to github?

You should leave duke.txt in the .gitignore file.

angnobel · 2021-08-30T17:10:10Z

src/main/java/Duke.java

+            throw new DoneAlreadyException();
+        }
+
+        // Mark the index as done


Perhaps proper javadocs could be added so IDE can display the documentation with all the information?

angnobel · 2021-08-30T17:12:08Z

src/main/java/Duke.java

+        userInput = userInput.replaceAll( RegexType.START_LINE_REGEX.getRegexType() + command + RegexType.SPACE_REGEX.getRegexType(), "");
+
+        // Check the command type then execute the commands
+        if(userInput.equals(InputType.LIST.getInputType())) {


Could this list of checks better be served with a switch statement to improve readability?

NayLin-H99

I really liked that you have done a lot of abstraction in your code.

NayLin-H99 · 2021-09-02T17:43:18Z

src/main/java/Duke.java

+import duke.InputType;
+import duke.Parser;
+import duke.Storage;
+import duke.tasks.*;


Wildcard Imports are suggested against in this module. Perhaps you can set your IDE to not "optimise" imports automatically.

NayLin-H99 · 2021-09-02T17:46:24Z

src/main/java/Duke.java

+        try {
+            return command.execute();
+        } catch (Exception e) {
+            return new CommandResult(e.getMessage(), false, null);


Did you not overload your constructor? Do you need to input the "null" argument here?

NayLin-H99 · 2021-09-02T17:52:18Z

src/main/java/Duke.java

+        userInput = in.nextLine();
+
+        // While the input is not "bye", add input to array of tasks and get another input
+        while (!userInput.equals(InputType.BYE.getInputType())) {


I think the readibility of this line can be improved by using the "bye" string directly or abstracting this into an ExitCommand as suggested under the specifications. Don't you think so?

NayLin-H99 · 2021-09-02T18:05:53Z

src/main/java/duke/Parser.java

+        if(arguments.equals(InputType.LIST.getInputType())) {
+            return new ListCommand(taskList);
+        }


Doing this kind of defeats the purpose of using enum, right? Instead of using enum purely as strings, I suggest parsing the user input into enum, then using the enum to return the appropriate commands.

An additional suggestion is to use switch case, which is recommended for enum since you can do something like:

Suggested change

if(arguments.equals(InputType.LIST.getInputType())) {

return new ListCommand(taskList);

}

switch (inputType) {

case LIST:

return new ListCommand(taskList);

NayLin-H99 · 2021-09-02T18:09:03Z

src/main/java/duke/Parser.java

+        }
+        return new EmptyCommand(taskList);
+    }
+}


At the end of every file, you should leave a newline! 😄

NayLin-H99 · 2021-09-02T18:41:08Z

src/main/java/Duke.java

+            if (commandResult.isUpdated()) {
+                taskList = commandResult.getTaskList();
+                String errorMessage = storage.writeToFile(taskList);
+
+                ui.printMessage(errorMessage);
+            }


I don't think you need to check for this. You can save the file after every command.

NayLin-H99 · 2021-09-02T18:44:05Z

src/main/java/duke/command/EmptyCommand.java

+import duke.PrintType;
+import duke.tasks.TaskManager;
+
+public class EmptyCommand extends Command{


I don't think you need to create a class just to handle an empty command? I suggest just throwing a DukeException for unrecognised strings, since you are using Regex anyways.

NayLin-H99 · 2021-09-02T18:55:03Z

src/main/java/duke/tasks/TaskManager.java

+     * @return - the message of acknowledgement in String form
+     * @throws TodoException - if the description is empty
+     */
+    public String addTodo(String userInput) throws TodoException {


I'm not sure what is the point of having individual command classes where you are doing all the commands under the Task Manager itself?

NayLin-H99 · 2021-09-02T18:57:21Z

src/main/java/duke/tasks/TaskManagerUi.java

+/**
+ * Class to maintain the UI of the list of tasks
+ */
+public class TaskManagerUi {


Your UI class should handle interactions with the user? Is this not just a tuple?

NayLin-H99 · 2021-09-02T18:58:52Z

src/main/java/duke/tasks/Todo.java

+ */
+public class Todo extends Task {
+    private TaskType type = TaskType.TODO;
+    public Todo (String description){


Try to have consistent formatting 😄

Suggested change

public Todo (String description){

public Todo (String description) {

Ensure the method/class header comments follow the format specified in the coding standard. Points improved: - The Javadoc comment is minimal. - Include tags wherever required and follow the particular order.

Make use of assert feature to document important assumptions that should hold at various points in the code. Refer to this for more details on Java assertions: https://www.geeksforgeeks.org/assertions-in-java/

Merging branch-A-CodeQuality

Add Assertions

Provide a way to attach priorities to tasks such as Low or High This will help the user to prioritize the tasks and become more efficient A task with High priority needs to be done first A task with Low priority needs to be done at the last. Have implemented the extension C-Priority Refer to the other list of extensions here: https://nus-cs2103-ay2122s1.github.io/website/se-book-adapted/projectDuke/index.html#extensions-category-b

Branch c priority

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

Add Gradle support

d839859

First commit (Level-1)

4cfc67b

Added Level-2 increment

4736ca7

Added Level-3 increment

cfd5b25

Added Level-4 Increment

bd6934e

Added Exception handling

5ef0281

Added Level-6 increment

1d94770

automate Ui testing

b53bd2b

Made minor changes (worked on organization)

702a6ac

Level-7

7ea4cc3

Made minor changes

c13f776

Revert "Level-7"

17dcb8d

This reverts commit 7ea4cc3.

Made minor changes

cce678c

Level-8

985e487

Resolving conflicts

cb0f6ce

Resolving conflict

9a37325

Merge branch 'branch-Level-7'

044eb74

Merge branch 'branch-Level-8'

9c1a2a6

LZher385 reviewed Aug 30, 2021

View reviewed changes

angnobel reviewed Aug 30, 2021

View reviewed changes

naranghardik16 added 10 commits September 1, 2021 05:34

A-MoreOOP

9d62a81

Made minor changes

58fff1d

Merge branch 'add-gradle-support'

8715041

Added support for testing

43765c6

Added JavaDoc

21bd54f

Added JavaDoc

d30698e

Added CodingStandard

ee67ca5

Added Level-9

d9c02fc

Merge branch 'branch-A-CodingStandard'

a3b3d47

Merge branch 'branch-Level-9'

23ef5fb

Merged all 3 branches and made minor changes

cd74b28

NayLin-H99 reviewed Sep 2, 2021

View reviewed changes

naranghardik16 and others added 20 commits September 20, 2021 08:12

Added GUI capabilities

b5b092f

Merge branch 'branch-Level-10'

44a8d27

Improve Code Quality

d602943

Improve Code Quality

a8ec3fc

Ensure the method/class header comments follow the format specified in the coding standard. Points improved: - The Javadoc comment is minimal. - Include tags wherever required and follow the particular order.

Improve formatting

b144d14

Add Assertions

06559aa

Make use of assert feature to document important assumptions that should hold at various points in the code. Refer to this for more details on Java assertions: https://www.geeksforgeeks.org/assertions-in-java/

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

faa775f

Merging branch-A-CodeQuality

Merge branch 'branch-A-Assertions'

31b0bd6

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

4349b1a

Add Assertions

Merge branch 'branch-C-Priority'

33cc82f

Merge pull request #4 from naranghardik16/branch-C-Priority

d05d812

Branch c priority

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

8b53d83

Make changes to text file

ad63b5c

Add representative screenshot

a79fe1b

Add User Guide

65614d9

Set theme jekyll-theme-minimal

4cfef5b

Set theme jekyll-theme-cayman

f91b546

Add UserGuide

fa07ae8

Set theme jekyll-theme-cayman

17b437e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ Hardik Narang ] iP #489

[ Hardik Narang ] iP #489

naranghardik16 commented Aug 27, 2021 •

edited

Loading

LZher385 Aug 30, 2021

LZher385 Aug 30, 2021

angnobel left a comment

angnobel Aug 30, 2021

NayLin-H99 Sep 2, 2021

angnobel Aug 30, 2021

angnobel Aug 30, 2021

NayLin-H99 left a comment

NayLin-H99 Sep 2, 2021

NayLin-H99 Sep 2, 2021

NayLin-H99 Sep 2, 2021

NayLin-H99 Sep 2, 2021

NayLin-H99 Sep 2, 2021

NayLin-H99 Sep 2, 2021

NayLin-H99 Sep 2, 2021

NayLin-H99 Sep 2, 2021

NayLin-H99 Sep 2, 2021

NayLin-H99 Sep 2, 2021

	public Todo (String description){
	public Todo (String description) {

[ Hardik Narang ] iP #489

Are you sure you want to change the base?

[ Hardik Narang ] iP #489

Conversation

naranghardik16 commented Aug 27, 2021 • edited Loading

Duke

Choose a reason for hiding this comment

Choose a reason for hiding this comment

angnobel 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

NayLin-H99 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

naranghardik16 commented Aug 27, 2021 •

edited

Loading