[immanuelhume] iP #32

immanuelhume · 2023-01-20T01:09:21Z

Chungus

"It's Morbin Time." - Dr. Michael Morbius

Chungus (not to be confused with Big Chungus) is a simple task tracking assistant. Chungus is

Text-based
Easy to learn
Written in Java 11, one of the languages of all time 😩

Basic Usage

Download the latest release here
Ensure Java 11 is installed
Run Chungus with java -jar chungus.jar

Reading the Code

The entry point can be found in Chungus.java.

class Chungus {
    ...
    public static void main(String[] args) {
        new Chungus(System.in, System.out, DEFAULT_DB_PATH).spin();
    }
    ...
}

Each Chungus instance expects an input and output stream, as well as the path to a file on disk to store its data. By default, it uses ./chungus.db, relative to the current working directory.

Feature Roadmap

Manage different kinds of tasks - todo, deadlines, and events
Cure depression (coming soon)

Also renamed Duke.java to Chungus.java and created a new Task.java file.

Also organized imports

Also resolved some conflicts and issues with marshalling datetimes

Does not provide much benefit over a regular ArrayList for now

It was overriden to tabs somehow

Also created a new chungus.util package

Also added some more JavaDocs

Now each Chungus instance can use any Ui instance. Later, when adding a GUI in JavaFX, our lives would be easier.

Lanreath

Appreciate the commitment to chonciness 👏 👏

We mainly assert some facts about the sizes of strings when unmarshalling data. Also, the static methods on the Handler class was renamed to sound more like a verb.

This better describes its functionality, since it is important that the "init" method does not block. Callers are expected to block the application in their own event loop.

We also do a check that the dimensions in fxml match those expected in code.

Add some assertions

Improve code quality

Because I want to save my free tier minutes.

ginloy

Overall code looks gr8 with very detailed documentation. Just some minor formatting and organization issues. Consider separating the io, exceptions, tasks into different packages.

ginloy · 2023-02-05T01:41:45Z

src/main/java/chungus/Task.java

+/**
+ * A todo.
+ */
+class Todo extends Task {


Perhaps put the different tasks in separate files? And then put them all in one separate package.

src/main/java/chungus/util/Pair.java

ginloy · 2023-02-05T01:47:35Z

src/main/java/chungus/Parser.java

+     * @return An appropriate handler for the command.
+     * @throws ChungusException When the expected command format is wrong.
+     */
+    public static Handler parse(String cmd) {


Very long method. Perhaps abstract away the parsing so that it is easier to maintain and add new cases. But nice use of switch cases!

I think this is fine for now as the length comes from the number of cases. Within each case we only extract some values and pass it to the handler so it's not actually doing much. Thanks for the suggestion though!

ginloy · 2023-02-05T01:48:33Z

src/main/java/chungus/Chungus.java

+    private NonBlockingUi ui;
+    private TaskList tasks;
+    private Storage db;
+    private AtomicBoolean isRunning;
+
+    public static final String DEFAULT_DB_PATH = System.getProperty("user.dir") + "/chungus.db";


Perhaps the static attributes should be above the private final attributes according to coding standards

In which page did you find this? I wasn't able to find it at https://se-education.org/guides/conventions/java/intermediate.html

Tbh idk someone suggested that to me too.

ginloy · 2023-02-05T01:50:26Z

src/main/java/chungus/ChungusException.java

+class TaskNotFoundException extends ChungusException {
+    public TaskNotFoundException(int idx) {
+        super(String.format("Task %d does not exist", idx));
+    }
+}
+
+/**
+ * An exception to represent when the serialization of a task is invalid.
+ */
+class TaskMarshalException extends ChungusException {
+    public TaskMarshalException(String s) {
+        super(String.format("Bad marshal format: \"%s\"", s));
+    }
+}


Same as tasks, maybe put these into separate files and put all the exceptions into one package.

ginloy · 2023-02-05T01:52:45Z

src/main/java/chungus/Task.java

+    private String desc;
+    private boolean isDone;
+
+    protected HashSet<String> tags;
+
+    protected static final DateTimeFormatter DATETIME_FMT = DateTimeFormatter.ISO_LOCAL_DATE_TIME;


Same here, perhaps the static attributes should be above the private final attributes according to coding standards

Just some rephrasing and disambiguation.

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

Add Gradle support

556af3f

Add skeletal code

57aa20c

Add task saving and retrieval

3b301fe

Add "mark as done" feature

a43c46b

Add more kinds of tasks

b99b913

Add some simple text testing

798961f

Also renamed Duke.java to Chungus.java and created a new Task.java file.

Add custom exception class

17a29e0

Add delete task command

c5cfad6

Add save to file functionality

3b5ff05

Replace Strings with LocalDateTime in tasks

484eeb1

Also organized imports

Merge branch 'branch-Level-7'

bc78b5a

Merge branch 'branch-Level-8'

7a80aa5

Also resolved some conflicts and issues with marshalling datetimes

Use 4 spaces for indentation

a7f0968

Extract Ui and Parser into their own classes

f07b1d8

Add a formatter config

d37b20d

Create a TaskList class

af56589

Does not provide much benefit over a regular ArrayList for now

Extract parsing and handling logic to own classes

7381a9e

Fix indentation

75589dc

It was overriden to tabs somehow

Create chungus package

d76f3bf

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

7ece9d2

Edit paths in build.gradle

c4e9242

Clean up exception handling

2258c3b

Add some unit tests

9ed2554

Also created a new chungus.util package

Fix wrong handler for unmark command

c24ca92

Change jar file name

1759fce

Add JavaDoc

37ffed9

Edit code to follow CS2103T convention

5c4cfb8

Add command to find task by keyword

693c982

Merge branch 'branch-A-JavaDoc'

7831a96

Merge branch 'branch-A-CodingStandard'

4c835e2

immanuelhume added 5 commits January 23, 2023 10:16

Restore missing delete command from parser

01aaa57

Also added some more JavaDocs

Fix build config for VSCode

2cbd4c2

Update checkstyle config

0862b08

Make Ui abstract

b72f10f

Now each Chungus instance can use any Ui instance. Later, when adding a GUI in JavaFX, our lives would be easier.

Add JavaFX interface

5336d73

immanuelhume force-pushed the master branch from 5336d73 to 2cbd4c2 Compare January 30, 2023 03:33

Merge branch 'branch-Level-10'

162ad0d

Lanreath reviewed Feb 1, 2023

View reviewed changes

immanuelhume added 12 commits February 3, 2023 13:57

Add some assertions

93f3dea

We mainly assert some facts about the sizes of strings when unmarshalling data. Also, the static methods on the Handler class was renamed to sound more like a verb.

Enable assertions for gradlew run

b1fc998

Rename Ui to NonBlockingUi

19576bf

This better describes its functionality, since it is important that the "init" method does not block. Callers are expected to block the application in their own event loop.

Replace magic numbers with constants

706e5b4

We also do a check that the dimensions in fxml match those expected in code.

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

f928a85

Add some assertions

Merge branch 'master' into branch-A-CodeQuality

5790d4d

Merge pull request #2 from immanuelhume/branch-A-CodeQuality

f33d265

Improve code quality

Add github action

f44a963

Update actions config to cache Gradle dependencies

ff89847

Use ubuntu only for actions

16b7cc1

Because I want to save my free tier minutes.

Add tagging feature

82819c5

Merge branch 'feat-tagging'

e6acbb2

ginloy reviewed Feb 5, 2023

View reviewed changes

immanuelhume added 9 commits February 5, 2023 15:08

Make pair internals final

a460522

Fix style issues

72fb85a

Add user guide

bf2c946

Remove unnecessary eclipse config file

002a6a1

Update user guide

bf7f140

Add a window title

20bcdaf

Remove duplicate block in user guide

22c35dd

Update user guide

6d35a51

Just some rephrasing and disambiguation.

Add missing bold font

3e0b2a6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[immanuelhume] iP #32

[immanuelhume] iP #32

immanuelhume commented Jan 20, 2023 •

edited

Lanreath left a comment

ginloy left a comment

ginloy Feb 5, 2023

ginloy Feb 5, 2023

immanuelhume Feb 5, 2023

ginloy Feb 5, 2023

immanuelhume Feb 5, 2023

ginloy Feb 8, 2023

immanuelhume Feb 9, 2023

ginloy Feb 5, 2023

ginloy Feb 5, 2023

[immanuelhume] iP #32

Are you sure you want to change the base?

[immanuelhume] iP #32

Conversation

immanuelhume commented Jan 20, 2023 • edited

Chungus

Basic Usage

Reading the Code

Feature Roadmap

Lanreath left a comment

Choose a reason for hiding this comment

ginloy 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

immanuelhume commented Jan 20, 2023 •

edited