[Tang-Moyan] iP #542

Tang-Moyan · 2023-09-04T02:08:58Z

Duke-Rio

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

Duke-Rio helps you store your tasks in a digital list. It's,

text-based
automaticly saving your changes
retrieving your previous list even if you close it by accident.

All you need to do is,

download it from this link
run the ip.jar
add your tasks.
let it manage your tasks for you 😁

And it is FREE!

Features:

managing tasks
find if you have a certain task
Managing deadlines (coming soon)

Here's the main method:

public class Duke {
    public static void main(String[] args) {

            new Duke("list.txt", "data").run();


    }
}

You can modify this line new Duke("list.txt", "data").run(); in the main function to decide where and what file name is used to store your list.

AustinHuang1203

Overall ok and neat code that is readable. Could consider more encapsulation and java doc comments also! But I think it is fine and nice.

AustinHuang1203 · 2023-09-05T08:42:39Z

src/main/java/Duke.java

+import java.io.IOException;
+import java.nio.file.Path;
+import HelperClass.Task;
+
 public class Duke {


Hi, not sure which level you are at but you could consider more encapsulation of code 😸

Thank you very much for your review! I am a bit falling behind in catching up with the levels. I will try to get them done sooner.

AustinHuang1203 · 2023-09-05T08:43:22Z

src/main/java/Duke.java

+        printOneLine();
+    }
+
+    public  static void Exit() {


double spacing can change to single between public and static

AustinHuang1203 · 2023-09-05T08:44:23Z

src/main/java/Duke.java

+                System.out.println("Directory '" + directoryName + "' created.");
+            } else {
+                System.err.println("Failed to create directory '" + directoryName + "'.");
+                return;


redundant return statement

AustinHuang1203 · 2023-09-05T12:30:09Z

src/main/java/Duke.java

+
+            printOneLine();
+            switch (userInput) {
+


This block of code is kindda big so maybe can encapsulate out

AustinHuang1203 · 2023-09-05T12:30:15Z

text-ui-test/input.txt

@@ -0,0 +1,3 @@
+todo


Can try to be a bit more comprehensive

AustinHuang1203 · 2023-09-05T12:30:59Z

src/main/java/HelperClass/Task.java

+public class Task {
+    private boolean isDone;
+
+    private int type;


Can consider a more clear name beside type for int

SimWPEric

Good job on your progress thus far ! A-CheckStyle increment will come in really handy for catching styling errors !

SimWPEric · 2023-09-08T15:07:37Z

src/main/java/Duke.java

+            switch (parser.getCommand()) {
+
+            case "bye":
+                //bye
+
+                wantToExit = true;
+                ui.Speak(ui.Exit());
+
+                break;
+
+            case "list":
+                //list
+                ui.Speak(tasks.displayList());
+                break;
+
+            case "mark":
+                //mark 1
+
+                try {
+                    int i = Integer.parseInt(parser.getTaskName()) - 1;
+                    ui.Speak(tasks.markTask(i));
+                    userListHaveChanges = true;
+                } catch (NumberFormatException e) {
+                    ui.Speak("need to provide an integer index of task.");
+                }
+
+
+                break;
+
+            case "unmark":
+                //unmark 1
+                try {
+                    int i = Integer.parseInt(parser.getTaskName()) - 1;
+                    ui.Speak(tasks.unmarkTask(i));
+                    userListHaveChanges = true;
+                } catch (NumberFormatException e) {
+                    ui.Speak("need to provide an integer index of task.");
+                }
+
+                break;
+
+            case "todo":
+                //todo read book
+                ui.Speak(tasks.addTask(new Task(parser.getTaskName(),
+                        1, "Null", "Null", false)));
+                userListHaveChanges = true;
+                break;
+
+            case "deadline":
+                //deadline read book /by 2022-01-01
+                ui.Speak(tasks.addTask(new Task(parser.getTaskName(),
+                        2, "Null", parser.getFirstEnteredTime(), false)));
+                userListHaveChanges = true;
+                break;
+
+            case "event":
+                //event read book /from 2022-01-01 /to 2022-01-02
+                ui.Speak(tasks.addTask(new Task(parser.getTaskName(),
+                        3, parser.getFirstEnteredTime(), parser.getSecondEnteredTime(), false)));
+                userListHaveChanges = true;
+                break;
+
+            case "delete":
+                //delete 1
+                try {
+                    int i = Integer.parseInt(parser.getTaskName()) - 1;
+                    ui.Speak(tasks.deleteTask(i));
+                    userListHaveChanges = true;
+                } catch (NumberFormatException e) {
+                    ui.Speak("need to provide an integer index of task.");
+                }
+
+                break;
+
+            case "find":
+                ui.Speak(tasks.findTask(parser.getTaskName()));
+                break;
+
+
+            default:
+                ui.Speak("OOPS!!! I'm sorry, but I don't know what that means :-(");
+
+
+            }


According to Java Coding Standard: The switch statement should have the following form: Note there is no indentation for case clauses.

SimWPEric · 2023-09-08T15:12:54Z

src/main/java/HelperClass/Ui.java

+
+public class Ui {
+
+    private String MyName;


Try using camelCase for variable names !

SimWPEric · 2023-09-08T15:14:09Z

src/main/java/HelperClass/Ui.java

+     * print message in a specific format
+     * @param message the original message to be printed


Can be good to include an empty line between the description and @param !

SimWPEric · 2023-09-08T15:20:03Z

src/test/java/HelperClass/ParserTest.java

+    public void testGetUserCommand() {
+        Parser parser = new Parser();
+        parser.processUserCommand("todo Read Book");
+        assertEquals("todo", parser.getCommand());
+    }
+
+    @Test
+    public void testGetTaskName() {
+        Parser parser = new Parser();
+        parser.processUserCommand("todo Read Book");
+        assertEquals("Read Book", parser.getTaskName());
+    }


According to CS2103T Website W3.7d code normally use camelCase for method names e.g., testStringConversion but when writing test methods, sometimes another convention is used:unitBeingTested_descriptionOfTestInputs_expectedOutcome.

SimWPEric · 2023-09-08T15:21:35Z

src/main/java/HelperClass/Task.java

+     * return the string representing how the Task object should be stored
+     * @return string representation of the Task object
+     */
+    public String ForRecordingInTextFile() {


Try using camelCase for method names !

getResponse() only return the user input. Let's update the getResponse() function so it work correctly with duke and returns the right message. In this way, duke GUI can do its job correctly.

When we have a lot of tasks in the list, it would be convenient to have a function that shows the user how many each type of task there are. Let's have a new user command, "stats", to invoke the showTaskStatics() function. It is a convenient way of showing task information to the user.

We need to check some crucial assumptions at certain time during execution of the program. Let's use assert feature to document important assumptions that should hold at various points in the code. In this way, users will know more about where went wrong when using this product.

Add A-Assertions

There are several methods that are too long. Long methods are harder for other developers to understand. Shortening them improves readability of the code. Let's divide long methods into short methods so that other developers can understand the code more easily.

Task names can be empty based on user input. Empty task name is should not be allowed becuase it will lead to bugs. Limiting the task name to be non-empty prevents bugs. Let's limit our user to give only non-empty task names, so that no bugs will occur.

Command functions (todo, deadline, event...) have some common behaviors (return a message). Common behaviors should be abstract out for better OOP practice. Abstracting out common behaviors into a super class and making each command function a separate class allow more conveninent extensions of current commands in the future. Let's have a super class Command and define all commands as child classes of the Command class. Using inheritance is preferable over composition in this situation because the common behaviors are not composable.

damithc and others added 12 commits August 9, 2023 02:16

Add Gradle support

28ad2b8

Bump gradle and lib version

ed6d4d2

Level 0 Rename, Greet, Exit

f88b6b3

Added Level 1. Echo

fedfbde

Added Level 2. Add, List

30a8d0f

Added Level 3. Mark as Done

76e279d

Added Level 4. ToDos, Events, Deadlines

05bfd79

Added UI Testing

95571af

Level 5. Handle Errors

6b91d86

Level 6. Delete

5bb12d4

Added Level 7. Save

3df8678

Small changes

e5419c6

Tang-Moyan force-pushed the master branch 2 times, most recently from 3df8678 to e5419c6 Compare September 4, 2023 08:11

Tang-Moyan added 3 commits September 4, 2023 16:12

Merge branch 'branch-Level-7'

9cd2af3

Added Leve 8. Dates and Time

61f2b5f

Merge branch 'branch-Level-8'

e55e84a

AustinHuang1203 reviewed Sep 5, 2023

View reviewed changes

Tang-Moyan added 12 commits September 6, 2023 11:49

partial OOP

748abf7

Added A-MoreOOP

4f477ac

Added A-Packages (already done in previous commit)

20f6c35

Merge remote-tracking branch 'origin/add-gradle-support' into A-branches

0b1dd0d

Fixed the bug that cannot get user command correctly

0e65df1

Added A-JUnit

9eecffa

Created A-Jar

5d8b7a3

Added JavaDoc

8a215e5

Modified Coding Standard

bf66d36

Added Level 9. Find

9f04997

Merge branch 'branch-A-JavaDoc' into branch-A-CodingStandard

44c08ab

Resolved conflict

944be72

small modification

3d841fc

SimWPEric reviewed Sep 8, 2023

View reviewed changes

Tang-Moyan and others added 17 commits September 15, 2023 15:10

Level 10. GUI

525c359

Make getResponse() return correct String

4a8adbc

getResponse() only return the user input. Let's update the getResponse() function so it work correctly with duke and returns the right message. In this way, duke GUI can do its job correctly.

Improved code quality

fc087dd

Improved code quality further

d513068

Merge pull request #2 from Tang-Moyan/branch-A-Assertions

271c84f

Add A-Assertions

Merge branch 'branch-A-CodeQuality'

c3d3018

Add sort function

a2aa77d

Add User Guide

fcd88d2

Add Ui.png

3b1f871

More improvement to the code

2e43bf1

More improvement to the code

60d851f

More improvement to the code

fc3b8e1

Limit task names to be non-empty

1442d20

Task names can be empty based on user input. Empty task name is should not be allowed becuase it will lead to bugs. Limiting the task name to be non-empty prevents bugs. Let's limit our user to give only non-empty task names, so that no bugs will occur.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Tang-Moyan] iP #542

[Tang-Moyan] iP #542

Tang-Moyan commented Sep 4, 2023 •

edited

Loading

AustinHuang1203 left a comment

AustinHuang1203 Sep 5, 2023

Tang-Moyan Sep 8, 2023

AustinHuang1203 Sep 5, 2023

AustinHuang1203 Sep 5, 2023

AustinHuang1203 Sep 5, 2023

AustinHuang1203 Sep 5, 2023

AustinHuang1203 Sep 5, 2023

SimWPEric left a comment

SimWPEric Sep 8, 2023

SimWPEric Sep 8, 2023

SimWPEric Sep 8, 2023

SimWPEric Sep 8, 2023

SimWPEric Sep 8, 2023

		* print message in a specific format
		* @param message the original message to be printed

[Tang-Moyan] iP #542

Are you sure you want to change the base?

[Tang-Moyan] iP #542

Conversation

Tang-Moyan commented Sep 4, 2023 • edited Loading

Duke-Rio

AustinHuang1203 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

SimWPEric 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

Tang-Moyan commented Sep 4, 2023 •

edited

Loading