[Qi Ting] iP by nqt230 · Pull Request #492 · nus-cs2103-AY2223S1/ip

nqt230 · 2022-08-28T01:12:41Z

Duke prototype 0.2

"By failing to prepare, you are preparing to fail."
– Benjamin Franklin

Features

~~Command Line~~ Text-based with GUI interface
Super fast
Easy to use 🤔
- Straightforward text commands to perform all functions
Task managing functionality:
- Supports creation of multiple kinds of tasks
- Marking of tasks
- Deletion of tasks
- Local saving and loading of tasks

Setting up:

Download the latest release from here.
Run the file (double-click duke.jar).
Done! You can start using Duke to manage your tasks.

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

public class Launcher {
    public static void main(String[] args) {
        Application.launch(Main.class, args);
    }
}

Planned features

Basic create, update and delete operations for task management.
Task filtering and sorting by date.
Task tagging.

- Add basic greeting and exit phrases - Implement basic input reading

- Create ParseInput method to parse commands to the bot and call the relevant methods - Create AddToList and DisplayList methods to support text list feature > AddToList stores a given text string to a list > DisplayList prints all the text strings stored so far in order - Remove unused Echo method from Level-1

- Rework text list feature to a to-do list > Create Task class to represent tasks that can be added to the to-do list > Implement methods to support marking of Tasks as completed - Implement ParseArgs method to support chatbot commands with arguments

- Create Deadline, Event and ToDo classes that inherit from Task to support different types of Task creation - Refactor input parsing logic to support creation of different types of tasks

- Add test input to input.txt file - Performed testing using Runtest.bat - Fix bug where tasks could be created with empty name or date

- Create DukeException class to be thrown by and handled by methods in Duke - Refactor methods to use DukeException class in error handling

- Implement delete command > Tasks can now be deleted from the list by index - Modify test input to test deletion feature

- Chat history with Duke is now saved between runs and loaded on start

- Modify parsing of input to parse date arguments - Modify Deadline and Event class to store date as LocalDate instead of String

- Modify all code to follow coding style - Refactor task saving logic to be cleaner - Update javadocs

- Set up gradle

- Create Ui, TaskList, Storage, and Parser classes to handle different operations of Duke - Refactor code to these new classes

- Packaged all classes into one package Duke

- Added JUnit tests for adding tasks, loading and saving tasks, and parsing input commands

- Added JavaDocs to more methods

- Adjust code to follow coding standard where not done previously

- Add getter for taskName to Task class - Add search task by taskName functionality to TaskList class - Modify Parser class to accept search command - Add display text function for search command to Ui class

- Add checkstyle plugin to gradle - Use chcekstyle to find coding style violations - Resolve coding style violations

- Create GUI for Duke - User input is now received from the TextField component in MainWindow - handleUserInput function in MainWindow passes the user input to Duke - Duke takes the input and passes it to Parser - Duke now also stores the response to the user generated by Ui to be displayed by MainWindow

RachelChua

LGTM! I like your error handling and OOP used! Also, your code follows the java coding standards very well. Good job!

RachelChua · 2022-09-01T06:31:21Z

+    public static Task addEvent(String args) throws DukeException {
+        String[] argsArr = args.split(" /at ", 2);
+        if (argsArr.length < 2) {
+            throw new DukeException("Failed to create event: Invalid number of arguments");


I like how you handle many different types of errors. Good job on error handling!

RachelChua · 2022-09-01T06:34:16Z

@@ -0,0 +1,231 @@
+package duke;


Perhaps you can divide into multiple packages 😃

Haha will take note

RachelChua · 2022-09-01T06:38:46Z

+ * A class used to represent a task. A task has a name and completion status.
+ */
+public abstract class Task {
+    protected static final String MARK_CHARACTER = "X";


Good use of static constants!

RachelChua · 2022-09-01T06:46:40Z

+/**
+ * A class that handles the displaying of information to the user.
+ */
+public class Ui {


I like the abstraction and OOP used here!

totsukatomofumi

LGTM! Very simple yet beautiful logic of code. Coding standard has been well adhered to. Good job!

totsukatomofumi · 2022-09-01T12:31:54Z

+            break;
+        default:
+            throw new DukeException("Command not recognised");
+        }


I like how simple yet powerful you have made your parser.

totsukatomofumi · 2022-09-01T12:34:27Z

+/**
+ * Class used to represent a ToDo type task that has no date.
+ */
+public class ToDo extends Task {


I like the use of inheritance for a more OOP approach.

totsukatomofumi · 2022-09-01T12:35:08Z

+     *
+     * @return A string that can be used to reconstruct the task.
+     */
+    public abstract String toSaveFormatString();


I like the naming idea for this method.

totsukatomofumi · 2022-09-01T12:36:41Z

+            + "| | | | | | | |/ / _ \\\n"
+            + "| |_| | |_| |   <  __/\n"
+            + "|____/ \\__,_|_|\\_\\___|\n";
+    private static final String BOT_NAME = "Duke";


I like the use of a constant for this string that will be used often.

- Add Java asserts to handle some previously unhandled exceptions - TaskList: Use asserts to ensure null tasks cannot be added to the list - Duke: Use asserts to ensure Duke initializes correctly

* Refactor application launch process. - Move Launcher.main method to Duke.main. - Remove Launcher class since it is no longer used. * Add constant TASK_TYPE_CHARACTER to ToDo, Deadline and Event. This is to centralize the information of which character refers to which type of task e.g. T associated to ToDo. - Modify toString and toSaveFormatString methods in all subclasses of Task to make use of this constant. - Modify Storage class to check against this constant when attempting to load in tasks from file. * Move print statements to Duke's addToResponse method since all text to be displayed goes through that method.

Improve code quality

Branch a assertions

- Move gradle.yml file to .github\workflows folder

- Add sorting command to Parser - Add functionality to TaskList to sort by name - Update Ui to respond correctly to new command

Implement C-Sort

- Adjust argument format to be more flexible

- Update JUnit tests to account for changes to command format - Remove new line from TaskList::addEvent exception message for invalid arguments

- Change GUI color scheme to dark mode - Add help command to display available commands - Add command format info to user feedback when user inputs invalid command

Improve GUI and user friendliness

- Add usage information for all commands to user guide

Implement A-UserGuide

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

Add Gradle support

556af3f

Implement Level-1

43932c7

- Add basic greeting and exit phrases - Implement basic input reading

Implement Level-3

162e54a

- Rework text list feature to a to-do list > Create Task class to represent tasks that can be added to the to-do list > Implement methods to support marking of Tasks as completed - Implement ParseArgs method to support chatbot commands with arguments

Implement Level-4

76c13a6

- Create Deadline, Event and ToDo classes that inherit from Task to support different types of Task creation - Refactor input parsing logic to support creation of different types of tasks

Implement A-TextUiTesting

1dd0b26

- Add test input to input.txt file - Performed testing using Runtest.bat - Fix bug where tasks could be created with empty name or date

Implement Level-5

8960774

- Create DukeException class to be thrown by and handled by methods in Duke - Refactor methods to use DukeException class in error handling

Implement Level-6

ecd6e8b

- Implement delete command > Tasks can now be deleted from the list by index - Modify test input to test deletion feature

Implement Level-7

acfd4da

- Chat history with Duke is now saved between runs and loaded on start

Implement Level-8

5e3049b

- Modify parsing of input to parse date arguments - Modify Deadline and Event class to store date as LocalDate instead of String

Merge branch 'branch-Level-8'

e4c4464

nqt230 marked this pull request as draft August 31, 2022 03:10

nqt230 added 14 commits August 31, 2022 13:17

Clean up and refactor code

b469e7b

- Modify all code to follow coding style - Refactor task saving logic to be cleaner - Update javadocs

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

40e712e

Implement A-Gradle

094719a

- Set up gradle

Implement A-MoreOOP

7797764

- Create Ui, TaskList, Storage, and Parser classes to handle different operations of Duke - Refactor code to these new classes

Implement A-Packages

07b4d5f

- Packaged all classes into one package Duke

Implement A-JUnit

0689b3f

- Added JUnit tests for adding tasks, loading and saving tasks, and parsing input commands

Implement A-Jar

c123f90

Implement A-JavaDoc

e55211e

- Added JavaDocs to more methods

Implement A-CodingStandard

5c007e4

- Adjust code to follow coding standard where not done previously

Implement Level-9

508ff58

- Add getter for taskName to Task class - Add search task by taskName functionality to TaskList class - Modify Parser class to accept search command - Add display text function for search command to Ui class

Merge branch 'branch-A-CodingStandard'

1d5b8f9

Merge branch 'branch-Level-9'

94442d5

Add Javadocs headers to Level-9 methods

19d17fa

Implement A-Checkstyle

5b097c0

- Add checkstyle plugin to gradle - Use chcekstyle to find coding style violations - Resolve coding style violations

nqt230 marked this pull request as ready for review September 1, 2022 02:08

nqt230 added 2 commits September 1, 2022 11:16

Edit JavaDocs header

7fe4a23

RachelChua reviewed Sep 1, 2022

View reviewed changes

totsukatomofumi reviewed Sep 1, 2022

View reviewed changes

nqt230 added 18 commits September 7, 2022 22:29

Implement A-Assertions

beb44bb

- Add Java asserts to handle some previously unhandled exceptions - TaskList: Use asserts to ensure null tasks cannot be added to the list - Duke: Use asserts to ensure Duke initializes correctly

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

cc9c6aa

Improve code quality

Merge branch 'master' into branch-A-Assertions

6bbfad1

Merge pull request #3 from nqt230/branch-A-Assertions

e7d7698

Branch a assertions

Update Duke.main javadocs header

0c4b946

Implement A-CI

36fd55b

Fix CI not set up correctly

daa005c

- Move gradle.yml file to .github\workflows folder

Implement C-Sort

71521d5

- Add sorting command to Parser - Add functionality to TaskList to sort by name - Update Ui to respond correctly to new command

Merge pull request #4 from nqt230/BCD-Extensions

9bbb054

Implement C-Sort

Modify event and deadline creation in tasklist

c23716b

- Adjust argument format to be more flexible

Update tests and adjust exception message

ca8df6d

- Update JUnit tests to account for changes to command format - Remove new line from TaskList::addEvent exception message for invalid arguments

Improve GUI and user friendliness

0bf8aa3

- Change GUI color scheme to dark mode - Add help command to display available commands - Add command format info to user feedback when user inputs invalid command

Merge pull request #5 from nqt230/branch-A-BetterGUI

c3954c1

Improve GUI and user friendliness

Add Ui.png and edit User Guide

9cc8e3e

Update User Guide

c5acf7e

- Add usage information for all commands to user guide

Merge pull request #6 from nqt230/A-UserGuide

018dc3b

Implement A-UserGuide

Replace Ui.png with better app screenshot

74ea91e

Uh oh!

Conversation

nqt230 commented Aug 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Duke prototype 0.2

Uh oh!

RachelChua 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!

totsukatomofumi 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nqt230 commented Aug 28, 2022 •

edited

Loading