[Xiangcheng] iP by Xczheng0105 · Pull Request #616 · nus-cs2103-AY2425S1/ip

Xczheng0105 · 2024-09-01T08:24:48Z

Trackie

“You don’t need a new plan for next year. You need ~~a commitment~~ TRACKIE BOT RIGHT NOW.” – Seth Godin(modified)

Trackie is a bot to help you track your tasks.

simple
effective
reliable

(And did I forget to mention, it's FREE!)

All you need to do is:

Launch the bot
Add you tasks
Let it track 'em all 😎

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

public static void main(String[] args) {
        new Trackie("src").run();
    }

Features:

Add tasks
Remove tasks
Mark/unmark tasks
GUI interface (Work in Progress)

If you can type fast: Then this is the right task tracker for you!

In build.gradle, the dependencies on distZip and/or distTar causes the shadowJar task to generate a second JAR file for which the mainClass.set("seedu.duke.Duke") does not take effect. Hence, this additional JAR file cannot be run. For this product, there is no need to generate a second JAR file to begin with. Let's remove this dependency from the build.gradle to prevent the shadowJar task from generating the extra JAR file.

…ture

… of code.

* branch-Level-7: Fix some bugs related to loading of tasks on startup Re-implement functionality for saving tasks Add support for reading and writing to a data file

* branch-level-8: Change the way of storing deadlines

* branch-A-moreOOP: Add more OOP

* branch-A-Packages: Sort the classes into packages

* add-gradle-support: build.gradle: Prevent generating a second JAR file Bump gradle and lib version Add Gradle support

Professional-Procrastinat0r · 2024-09-04T08:18:39Z

src/main/java/trackie/commands/AddCommand.java

+    @Override
+    public void execute(TaskList tasklist, Ui ui, Storage storage) {
+        try {
+            switch (arguments[0]) {


Should not have indentation for case clauses.

Professional-Procrastinat0r · 2024-09-04T08:20:37Z

src/main/java/trackie/parsing/Parser.java

+                return new ListCommand();
+            case "bye":
+                return new ExitCommand();
+            default:


Good use of default to catch invalid commands

Professional-Procrastinat0r · 2024-09-04T08:23:43Z

src/main/java/trackie/commands/AddCommand.java

@@ -0,0 +1,32 @@
+package trackie.commands;


Good adherence to package and import statements orderings

Professional-Procrastinat0r · 2024-09-04T08:24:25Z

src/main/java/trackie/parsing/Parser.java

+public class Parser {
+    public static Command parseCommand(String input) {
+        String[] arguments = input.split(" ");
+        switch (arguments[0]) {


Likewise, case clauses should not be indented

Professional-Procrastinat0r · 2024-09-04T08:29:11Z

src/main/java/trackie/ui/Trackie.java

+import trackie.storage.Storage;
+import trackie.storage.TaskList;
+
+public class Trackie {


Can consider adding javadoc comments to your classes for clarity

Professional-Procrastinat0r · 2024-09-04T08:30:02Z

src/main/java/trackie/commands/AddCommand.java

@@ -0,0 +1,32 @@
+package trackie.commands;
+
+import trackie.storage.Storage;


Good adherence to explicitly import specific classes

maertan

Good job on overall code quality! Here are some suggestions in the comments below:

maertan · 2024-09-05T08:59:49Z

src/main/java/trackie/commands/Command.java

+import trackie.ui.Ui;
+
+public abstract class Command {
+    protected String[] arguments;


Good naming of arguments as plural due to it being an array.

maertan · 2024-09-05T09:00:16Z

src/main/java/trackie/commands/Command.java

+        this.isExit = isExit;
+    }
+
+    public boolean isExit() {


Good naming of the boolean - starts with "is".

maertan · 2024-09-05T09:01:01Z

src/main/java/trackie/parsing/Parser.java

@@ -0,0 +1,27 @@
+package trackie.parsing;
+
+import trackie.commands.*;


Perhaps you should have explicit import statements rather than using *

maertan · 2024-09-05T09:02:02Z

src/main/java/trackie/storage/Storage.java

+
+public class Storage {
+    private TaskList taskList;
+    private File fPtr;


Perhaps fPtr could be written out as a full word, filePointer I'm guessing? So that it would be easier for other people reading your code to understand.

maertan · 2024-09-05T09:02:59Z

src/main/java/trackie/storage/TaskList.java

+            throw new TrackieException("Correct usage: event [desc] /from [start] /to [end]");
+        }
+        //retrieve the start time
+        StringBuilder sb2 = new StringBuilder();


Perhaps you could use another way of naming to distinguish the StringBuilders rather than using numbers.

maertan · 2024-09-05T09:04:17Z

src/main/java/trackie/tasks/Task.java

+
+public abstract class Task {
+    protected String description;
+    protected boolean completed;


You could consider naming this boolean something like isCompleted so that it sounds like a boolean.

* branch-Level-10: Delete the Ui class (did not manage to delete properly beforehand)

Some methods in the code are over 100 lines long. This may hinder code readability. Let's refactor the code and extract some smaller methods from the long method. This will make the code more readable.

Refactoring of code

Start and end times are stored as strings in an event task. This can lead to nonsensical inputs. Let's change the type of start and end time to a LocalDateTime. This way, start and end times will not contain blatantly nonsensical inputs.

# Conflicts: # src/main/java/trackie/commands/AddCommand.java

For event classes, the default date and time syntax to follow is quite awkward and complicated. This can result in a bad user experience. Let's change the date and time syntax to something that is more user-friendly. This way, dates and times will be presented in a more user-readable format.

# Conflicts: # src/main/java/trackie/commands/InvalidCommand.java

damithc and others added 22 commits July 11, 2024 16:52

Add Gradle support

68c58c1

Bump gradle and lib version

03523ec

refactor from "Duke" to trackie, add greeting and exit messages

a0697d0

add support for echo, design improvements

7138744

add support for add tasks and list tasks feature, remove the echo fea…

d52af6a

…ture

add functionalities for marking and unmarking tasks, some refactoring…

7bdc7a5

… of code.

add support for adding different types of tasks - todo, deadline, event

d6c728b

add support for semi-automated testing.

2a0a7da

add support for error handling

c64b084

add support for deleting tasks, update testcases

f4a74d4

Add support for reading and writing to a data file

875d557

Re-implement functionality for saving tasks

82d54e5

Fix some bugs related to loading of tasks on startup

6eacbaf

Merge branch 'branch-Level-7'

e3462c7

* branch-Level-7: Fix some bugs related to loading of tasks on startup Re-implement functionality for saving tasks Add support for reading and writing to a data file

Change the way of storing deadlines

ed4c04e

Merge branch 'branch-level-8'

07eb12b

* branch-level-8: Change the way of storing deadlines

Add more OOP

3df0a42

Merge branch 'branch-A-moreOOP'

4eeee92

* branch-A-moreOOP: Add more OOP

Sort the classes into packages

7478209

Merge branch 'branch-A-Packages'

5a82fe8

* branch-A-Packages: Sort the classes into packages

Merge branch 'add-gradle-support'

7e6e096

* add-gradle-support: build.gradle: Prevent generating a second JAR file Bump gradle and lib version Add Gradle support

Professional-Procrastinat0r reviewed Sep 4, 2024

View reviewed changes

Xczheng0105 added 3 commits September 4, 2024 17:42

Add gradle support

44abef4

Add support for junit testing and minor fixes

de8ac14

Add support for jar file and fix some minor bugs

442cc87

maertan reviewed Sep 5, 2024

View reviewed changes

Xczheng0105 added 3 commits September 5, 2024 23:25

Include JavaDoc for some functions

7d94e52

Tweak the code to adhere to the coding standard

71fb56f

Add support for finding tasks that match a query

cc8a352

Xczheng0105 and others added 30 commits September 14, 2024 00:24

Delete the Ui class (did not manage to delete properly beforehand)

81b2d58

Merge branch 'branch-Level-10'

530830d

* branch-Level-10: Delete the Ui class (did not manage to delete properly beforehand)

Add assertions for the add command

5a8d1a1

Refactor the code

4f1b7e5

Some methods in the code are over 100 lines long. This may hinder code readability. Let's refactor the code and extract some smaller methods from the long method. This will make the code more readable.

Change the name of one variable to adhere to coding standard

e4fcece

Merge pull request #2 from Xczheng0105/heads/A-CodeQuality

c3634b7

Refactoring of code

Merge branch 'branch-A-Assertions'

30f1461

# Conflicts: # src/main/java/trackie/commands/AddCommand.java

Change some keywords for commands

d1d7e6b

Clean up commands

b9f2caa

Merge branch 'branch-C-FriendlierSyntax'

b507fe3

Improve the UI

4fdfe10

Give the bot a more unique personality

bae53a0

Improve testing for Trackie bot

f0d437a

Merge branch 'branch-A-Personality' into branch-A-MoreTesting

49be16c

# Conflicts: # src/main/java/trackie/commands/InvalidCommand.java

Merge branch 'branch-A-MoreTesting'

a7b622a

Update the error message for invalid command

dfa4e52

Fix a minor bug

77b318f

Update the README file

b65da00

Fix formatting issues

10d590c

Fix a minor formatting issue

bc060a1

Fix minor formatting issues

d858b95

Update the representative screenshot

05aa272

Provide more JavaDocs

ecfb15a

Update docs/README.md

090c4c8

Update docs/README.md

3474cc0

Update docs/README.md

3783237

Update docs/README.md

f7f7308

Fix some minor bugs

0fdb8ea

		@@ -0,0 +1,32 @@
		package trackie.commands;

		import trackie.storage.Storage;

		@@ -0,0 +1,27 @@
		package trackie.parsing;

		import trackie.commands.*;

Conversation

Xczheng0105 commented Sep 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Trackie

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maertan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Xczheng0105 commented Sep 1, 2024 •

edited

Loading