[hyizhak] iP #448

hyizhak · 2025-02-03T13:05:22Z

Bard (iP) Update

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

Bard (iP) frees your mind from the burden of memorization. It's:

Text-based
Easy to learn
~~Fast~~ SUPER FAST to use

Here are some steps to get started:

Download the latest release.
Copy the jar file into an empty folder. Open a command window in that folder.
Run the command

java -jar "bard.jar"

Add your tasks.
Let Bard manage them for you 😉

Features

Managing tasks
Managing deadlines and events
Reminders (coming soon)

If you are a Java programmer, you can use Bard to practice Java too. Here’s the main method for reference:

public class Bard {
    public static void main(String[] args) {
        Bard bard = new Bard();
        bard.run();
    }
}

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.

Merge Level-7 Save Branch to the master

TanJieHaoAmos

Looks good. Just missing the packages for the classes as well as the javadocs. Code looks clean.

TanJieHaoAmos · 2025-02-05T06:24:47Z

src/main/java/Bard.java

+    public static void main(String[] args){
+        Bard bard = new Bard();
+        bard.run();
+    }


No JavaDocs written for the methods and the class

TanJieHaoAmos · 2025-02-05T06:25:18Z

src/main/java/BardException.java

@@ -0,0 +1,10 @@
+public class BardException extends Exception {


Similarly, no JavaDocs written for this class.

TanJieHaoAmos · 2025-02-05T06:27:43Z

src/main/java/Bard.java

@@ -0,0 +1,164 @@
+import java.time.LocalDate;


Missing package for the class.
https://se-education.org/guides/conventions/java/intermediate.html#:~:text=Put%20every%20class%20in%20a%20package

TanJieHaoAmos · 2025-02-05T06:28:13Z

src/main/java/BardException.java

@@ -0,0 +1,10 @@
+public class BardException extends Exception {


Class is not inside a package.
https://se-education.org/guides/conventions/java/intermediate.html#:~:text=Put%20every%20class%20in%20a%20package

TanJieHaoAmos · 2025-02-05T06:29:37Z

src/main/java/BardStorage.java

@@ -0,0 +1,83 @@
+import java.io.File;


Class is not inside a package.
https://se-education.org/guides/conventions/java/intermediate.html#:~:text=Put%20every%20class%20in%20a%20package

TanJieHaoAmos · 2025-02-05T06:37:23Z

src/main/java/Event.java

+    public String toFileString() {
+        return "E | " + super.toFileString() + " | " + from + "-" + to;
+    }
+}


Missing JavaDocs for the class and its methods.

TanJieHaoAmos · 2025-02-05T06:37:43Z

src/main/java/Task.java

@@ -0,0 +1,31 @@
+public class Task {


Class is not inside a package.
https://se-education.org/guides/conventions/java/intermediate.html#:~:text=Put%20every%20class%20in%20a%20package

TanJieHaoAmos · 2025-02-05T06:38:05Z

src/main/java/Task.java

+
+    public Task(String description) {
+        this.description = description;
+        this.isDone = false;


Missing JavaDocs for the class and its methods.

TanJieHaoAmos · 2025-02-05T06:38:35Z

src/main/java/Todo.java

@@ -0,0 +1,18 @@
+public class Todo extends Task {


Class is not inside a package.
https://se-education.org/guides/conventions/java/intermediate.html#:~:text=Put%20every%20class%20in%20a%20package

TanJieHaoAmos · 2025-02-05T06:38:59Z

src/main/java/Todo.java

+    public String toFileString() {
+        return "T | " + super.toFileString();
+    }
+}


Missing JavaDocs for the class and its methods.

Zonnie-23

Overall, in terms of coding syntax, it is mostly compliant. The only missing things are the javaDoc and the packaging of the classes. Code is easily understandable, although packaging it into packages would make it easier to understand how the various function interact.

Zonnie-23 · 2025-02-06T15:38:49Z

src/main/java/DateParser.java

+            case "fri", "friday" -> DayOfWeek.FRIDAY;
+            case "sat", "saturday" -> DayOfWeek.SATURDAY;
+            case "sun", "sunday" -> DayOfWeek.SUNDAY;
+            default -> throw new IllegalArgumentException("Invalid day: " + day);


Interesting use of switch case to directly return the right enum variable . The formatting looks correct

Zonnie-23 · 2025-02-06T15:42:44Z

src/main/java/Bard.java

+        tasks.remove(taskNumber - 1);
+        System.out.println(" Now you have " + tasks.size()
+                + " tasks in the list." + "\n" + horizontalLine);
+    }


Would be good to package all functions above in a command package/parser package

…function from Text UI - Added assertions in the command parser to validate critical assumptions before executing commands. - Integrated assertions in the main program to ensure that key invariants are maintained. - Implemented the exit function from the Text UI, allowing for a controlled shutdown of the application. These changes enhance the overall robustness and reliability of the application, ensuring that failures in critical areas are caught early and the exit behavior is clearly defined.

- Refactored the command parser's createTask method: - Replaced the if-else chain with a switch statement for better clarity. - Introduced guard clauses and input trimming to validate command inputs early. - Improved error handling by throwing descriptive exceptions for missing or malformed arguments. - Refactored the DateParser class: - Consolidated time parsing logic to avoid redundancy and improve maintainability. - Enhanced input validation and error messaging for both date and day formats. - Added a private constructor to enforce the utility class pattern. These improvements result in more robust, readable, and maintainable parsing logic across the application.

- Replaced switch statement in CommandParser.parse with enhanced switch

feat: Add assertions in command parser and main program; set up exit function from Text UI

- Merged latest changes from master into the PR branch. - Manually resolved conflicts in src/main/java/bard/parser/CommandParser.java by integrating modifications from both branches. - Ensured that command parsing logic remains consistent and all tests pass post-resolution. - Cleaned up redundant code and aligned with upstream changes to maintain feature integrity.

Code quality enhancement

- Added a new workflow file ("Java CI") to automatically build and test the project on push and pull_request events. - Configured a build matrix to run on ubuntu-latest, macos-latest, and windows-latest for broad platform coverage. - Included steps to: - Check out the repository (with a specific checkout for the master branch). - Merge the current commit using a forceful checkout. - Validate the Gradle Wrapper via the gradle/wrapper-validation-action. - Set up JDK 17 with JavaFX support using actions/setup-java. - Build the project and run tests using './gradlew check'. - Execute IO redirection tests on Linux, macOS, and Windows with respective scripts. These changes ensure consistent, automated testing and build verification across multiple operating systems.

CI: set up cross-platform Java CI pipeline with GitHub Actions

- Added comprehensive Javadoc comments to public classes and methods across the project (e.g., TaskList, CommandParser, DateParser, etc.). - Reorganized import orders and adjusted whitespace to address Checkstyle violations. - Ran Spotless to auto-apply formatting fixes, ensuring that the code conforms to our style rules. These changes enhance code readability, documentation quality, and maintain consistent style throughout the codebase.

Add required JavaDoc so the code can pass CI

- Implemented a new compareTo method for tasks: - Incomplete tasks are prioritized over completed ones. - Deadline tasks are sorted based on their 'by' time. - Event tasks are sorted based on their 'from' time. - Ensured tasks marked as done always appear at the bottom. - Integrated the updated sorting logic into the chatbot functionality to enhance task management. This update improves task prioritization and overall user experience within the chatbot.

feat: Add task sorting and integrate into chatbot functionality

Add more JUnit testing for Task class

Modify the styling css to highlight errors

Adjust the logic of storage-related exception

Add the user guide in readme.md

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

Add Gradle support

68c58c1

Bump gradle and lib version

03523ec

Accomplish Level 0. Rename, Greet, Exit

db5d24b

Accomplish Level 1. Echo

fd73c29

Accomplish Level 2. Add, List

a679bb9

Accomplish Level 3. Mark as Done

f3cc2f0

Accomplish Level 4. ToDos, Events, Deadlines

05fd18c

Accomplish Level 5. Handle Errors

7b0bfaa

Accomplish Level 6. Delete

8cde5a4

Accomplish Level 7. Save

39df199

Merge branch 'branch-Level-7'

20fa645

Merge Level-7 Save Branch to the master

Accomplish Level 8. Dates and Times

1ee607f

Merge branch 'branch-Level-8'

504336c

TanJieHaoAmos reviewed Feb 5, 2025

View reviewed changes

Zonnie-23 reviewed Feb 6, 2025

View reviewed changes

hyizhak added 14 commits February 10, 2025 21:39

Accomplish A-MoreOOP

095dff5

Merge branch 'A-MoreOOP'

0a7a1fb

Accomplish A-Packages

171b7e6

Merge branch 'A-Packages'

300b370

Merge branch 'add-gradle-support'

a429219

Accomplish A-JUnit

a52e764

Merge branch 'A-JUnit'

33c3a54

Accomplish A-JavaDoc

adf84d1

Accomplish A-CodingStandard

59bed36

Accomplish Level 9. Find

babe287

Merge branch 'branch-A-JavaDoc'

637142c

Merge branch 'branch-A-CodingStandard'

38fe4f8

Merge branch 'branch-Level-9'

689c4d2

Accomplish Level 10. GUI

8cce03d

hyizhak added 30 commits February 22, 2025 11:28

refactor: Enhance task command parsing code quality

48d4114

- Replaced switch statement in CommandParser.parse with enhanced switch

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

51e76ac

feat: Add assertions in command parser and main program; set up exit function from Text UI

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

3d9be02

Code quality enhancement

Merge pull request #4 from hyizhak/branch-A-CI

79d844b

CI: set up cross-platform Java CI pipeline with GitHub Actions

Correct the directory name to workflows

4c94171

Modify the workflow so it only runs on Linux

0028385

Modify the workflow so it only runs on Linux

b527883

Merge pull request #5 from hyizhak/branch-A-CI

7f111f7

Add required JavaDoc so the code can pass CI

Merge pull request #6 from hyizhak/branch-C-Sort

bce7fec

feat: Add task sorting and integrate into chatbot functionality

Add more JUnit testing for Task class

1f4dc25

Modify the styling css to highlight errors

9626c5c

Merge pull request #7 from hyizhak/branch-A-MoreTesting

390b637

Add more JUnit testing for Task class

Merge pull request #8 from hyizhak/branch-A-BetterGui

722473c

Modify the styling css to highlight errors

Adjust the logic of storage-related exception

b4f1106

Merge pull request #9 from hyizhak/branch-A-MoreErrorHandling

1bc9425

Adjust the logic of storage-related exception

Add the user guide in readme.md

7dc2d81

Merge pull request #10 from hyizhak/branch-A-UserGuide

3bdd569

Add the user guide in readme.md

Modify the user guide file

f047e8e

Upload UI screenshot

b1162c4

release: version 0.3

6ec1dc1

fix: remove all sout so error information is handled consistently

8727d30

fix: update JUnit test to match the new error info

560b55d

fix: update text ui test

8354dad

docs: Change the readme

7ffe962

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[hyizhak] iP #448

[hyizhak] iP #448

hyizhak commented Feb 3, 2025 •

edited

Loading

TanJieHaoAmos left a comment

TanJieHaoAmos Feb 5, 2025

TanJieHaoAmos Feb 5, 2025

TanJieHaoAmos Feb 5, 2025

TanJieHaoAmos Feb 5, 2025

TanJieHaoAmos Feb 5, 2025

TanJieHaoAmos Feb 5, 2025

TanJieHaoAmos Feb 5, 2025

TanJieHaoAmos Feb 5, 2025

TanJieHaoAmos Feb 5, 2025

TanJieHaoAmos Feb 5, 2025

Zonnie-23 left a comment

Zonnie-23 Feb 6, 2025

Zonnie-23 Feb 6, 2025

		@@ -0,0 +1,10 @@
		public class BardException extends Exception {

[hyizhak] iP #448

Are you sure you want to change the base?

[hyizhak] iP #448

Conversation

hyizhak commented Feb 3, 2025 • edited Loading

Bard (iP) Update

Features

TanJieHaoAmos 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

Zonnie-23 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hyizhak commented Feb 3, 2025 •

edited

Loading