+
+ + +#### Storage component + + +Figure 6. Class Diagram of the Storage component + +API: StorageManager.java + +The Storage component, +* Creates the necessary data files for the operation of Plan&Score. +* Reads encoded data from Plan&Score’s data files. +* Writes encoded data to Plan&Score’s data files. + +There are 3 categories of data stored by Plan&Score: `event`, `quiz` and `config` + +Plan&Score loads data automatically from .txt files in the `data` directory. +Each `StorageManager` reads in their respective data files through a `decoder` and writes to the same file through an `encoder` + +##### Event Storage + + +Figure 7. Class Diagram of EventStorageManager + +API: EventStorageManager.java +`EventStorageManager` is responsible for the reading and writing of data from Plan&Score’s `events.txt` file, located in the `{root}/data` directory. + +It utilises a decoder (`EventListDecoder.java`) for the reading of data, and an encoder (`EventListEncoder.java`) for the writing of data. + +##### Reading events + +`EventListDecoder` is responsible for the decoding of data from `events.txt`. + +It returns an `EventParameter` to `EventStorageManager`. + + + +Figure 8. Sequence Diagram of the reading of data + +##### Writing events + +`EventListEncoder` is responsible for the creation of the encoded strings for `EventStorageManager` to write to `events.txt`. + +It returns a `String` to `EventStorageManager` for further writing. + + + +Figure 9. Sequence Diagram of the writing of data + + + +##### Quiz Storage +API: QuizStorageManager.java + + + +Figure 10. Sequence Diagram of the writing of data + + + +Figure 11. Sequence Diagram of the reading of data + +The Quiz Storage, +* Checks existence of the quiz data file in the `data` directory. If the file does not exist, create a new data file for quiz storage. +* Invokes the `quizListEncoder` class to encode the ArrayList of type Quiz into its String representations and writes them into the quiz data file. +* Invokes the `quizListDecoder` class to decode the String representations of quizzes in the quiz data file and add the quizzes back into the ArrayList of type Quiz. + + + +##### Config Storage +API: ConfigStorageManager.java + + +Figure 12. Class Diagram of the ConfigStorageManager + +The Config Storage, +* Checks existence of the config data file in the `data` directory. If the file does not exist, create a new data file for config storage. +* Invokes the `configEncoder` class to encode the String of user name, the integer number of recommended hours and finally, the boolean which checks if the program has run before. The encoded string is written into a config data file. +* Invokes the `configDecoder` class to decode the String user name, the integer number of recommended hours and the boolean which checks if the program has run before from a config data file. The three variables are used to show a different welcome message. + + +The Config Parameter, +* Helps to store the String of user name, the integer number of recommended hours and finally, the boolean which checks if the program has run before. +* Contents stored in the parameter are subsequently used by configEncoder to encode them into a string. + + +--- + +## Implementation + +This section describes some noteworthy details on how certain features are implemented. + + +### User Interface +The user interface of Plan&Score uses the singleton design. There is only one instance of UserInterface to be used throughout the application. The API for the user interface is UserInterface.java. + +#### Printing to user +Instead of using the default method `System.out.println()` provided by Java to display messages to the user, use `showToUser(String …)` where multiple strings can be added into the arguments. Each string provided that is separated by `,` will be printed on the next line. + +Example input: +``` +UserInterface userInterface = UserInterface.getInstance(); + +String string1 = "Hello"; +String string2 = "How are you?"; + +userInterface.showToUser(string1, string2); +``` + +Example output: +``` +Hello +How are you? +``` + +Code: +``` +public void showToUser(String... message) { + for (String m : message) { + out.println(m); + } +} +``` + + + +#### Printing arrays to user + +The method `printArray(ArrayList
+WARNING: +
+ +* `[number of hours]` must be written in numerals. + + + + + + +#### Category: Class (Chan Wan Ting Elizabeth) +##### Adding a class: `add class` +Allows you to add a new class with a name, date and time. + +Firstly, type `add` in the command line as seen below, followed by the category type which is the class. Afterwards, key in the description of the class as well as its start and end date and time. Press 'Enter' to execute it. + + + +The output is seen in the console. The date and time is converted to a more readable form, enabling you to read it more pleasantly. + + + +
+WARNING: +
+ +* `[name of class]` can be in a natural language format and +cannot contain '/'. + +* `[start date-time of class]` and `[end date-time of class]` must be in yyyy-mm-dd HHMM format with HHMM in 24-hour format. + +* Parameters `/n`, `/s`, `/e` cannot be swapped. + + + + + + + +
+ +##### Deleting a class: `delete class` +Allows you to delete a class based on its index in the list. + +Firstly, type ‘delete’ in the command line as seen below, followed by the category type which is the class. Afterwards, key in the corresponding index of the class you would like to delete. Press 'Enter' to execute it. + + +The output is seen in the console. The date and time is converted to a more readable form, enabling you to read it more pleasantly. + + +
+WARNING: +
+ +* `[class number]` must be written in numerals. + + + + + +
+ +#### Category: Cca (Chen Jinran) +##### Adding a cca: `add cca` +Allow you to add a new cca with a name, date and time. + +Firstly, type `add` in the command line as seen below, followed by the category type which is the cca. Afterwards, key in the description of the cca as well as its start and end date and time. Press 'Enter' to execute it. + + + +The output is seen in the console. The date and time is converted to a more readable form, enabling you to read it more pleasantly. + + + +
+WARNING: +
+ +* `[name of cca]` can be in a natural language format and +cannot contain '/'. + +* `[start date-time of cca]` and `[end date-time of cca]` must be in yyyy-mm-dd HHMM format with HHMM in 24-hour format. + +* Parameters `/n`, `/s`, `/e` cannot be swapped. + + + + + +
+ +##### Deleting a cca: `delete cca` +Allows you to delete a cca based on its index in the list. + +Firstly, type `delete` in the command line as seen below, followed by the category type which is the cca. Afterwards, key in the corresponding index of the cca you would like to delete. Press 'Enter' to execute it. + + + +The output is seen in the console. The date and time is converted to a more readable form, enabling you to read it more pleasantly. + + + +
+WARNING: +
+ +* `[cca number]` must be written in numerals. + + + + + +
+ + +#### Category: Test (Alicia Ho Shimin) +##### Adding a test: `add test` +Allows you to add a new test with a name, date and time. + +Firstly, type `add` in the command line as seen below, followed by the category type which is the test. Afterwards, key in the description of the test as well as its start and end date and time. Press 'Enter' to execute it. + + + +The output is seen in the console. The date and time is converted to a more readable form, enabling you to read it more pleasantly. + + + +
+WARNING: +
+ +* `[name of test]` can be in a natural language format and +cannot contain '/'. + +* `[start date-time of test]` and `[end date-time of test]` must be in yyyy-mm-dd HHMM format with HHMM in 24-hour format. + +* Parameters `/n`, `/s`, `/e` cannot be swapped. + + + + + +
+ +##### Deleting a test: `delete test` +Allows you to delete a test event based on its index in the list. + +Firstly, type `delete` in the command line as seen below, followed by the category type which is the test. Afterwards, key in the corresponding index of the test you would like to delete. Press 'Enter' to execute it. + + + +The output is seen in the console. The date and time is converted to a more readable form, enabling you to read it more pleasantly. + + + +
+WARNING: +
+ +* `[test number]` must be written in numerals. + + + + + +
+ + + +#### Category: Tuition (Chan Xu Hui) +##### Adding a tuition: `add tuition` +Allows you to add a new test with a name, date, time, location. + +Firstly, type `add` in the command line as seen below, followed by the category type which is the tuition. Afterwards, key in the description of the tuition, its start and end date and time as well as its location. Press 'Enter' to execute it. + + + +The output is seen in the console. The date and time is converted to a more readable form, enabling you to read it more pleasantly. + + + +
+WARNING: +
+ +* `[name of tuition]` and `[location of tuition]` can be in a natural language format and +cannot contain '/'. + +* `[start date-time of tuition]` and `[end date-time of tuition]` must be in yyyy-mm-dd HHMM format with HHMM in 24-hour format. + +* Parameters `/n`, `/s`, `/e`, `/l` cannot be swapped. + + + + + +
+ +##### Deleting a tuition: `delete tuition` +Allows you to delete a tuition based on its index in the list. + +Firstly, type `delete` in the command line as seen below, followed by the category type which is the tuition. Afterwards, key in the corresponding index of the tuition you would like to delete. Press 'Enter' to execute it. + + + +The output is seen in the console. The date and time is converted to a more readable form, enabling you to read it more pleasantly. + + + +
+WARNING: +
+ +* `[tuition number]` must be written in numerals. + + + + + +
+ + + +#### Listing out schedule: `list event
+ + +##### List event today: `list event today` (Alicia Ho Shimin) + +Secondly, to list out all events today, type `list event today` in the command line, as seen below. Press 'Enter' to execute it. + + + +The output is seen in the console. The list is arranged by their respective categories. The date and time is converted to a more readable form, enabling you to read it more pleasantly. The index of the event is corresponding to its index in the entire list. + + + +
+ + + +##### List event week: `list event week` (Chan Xu Hui) + +Thirdly, to list out all events in the current week, type `list event week` in the command line, as seen below. Press 'Enter' to execute it. + + + +The output is seen in the console. It is displayed in a calendar format for easier readability. The events are listed according to time. The date and time is converted to a more readable form, enabling you to read it more pleasantly. + + + +
+ +##### List event next week: `list event nextweek` (Chan Xu Hui) + +Fourthly, to list out all events in the next week, type `list event nextweek` in the command line, as seen below. Press 'Enter' to execute it. + + + +The output is seen in the console. It is displayed in a calendar format for easier readability. The events are listed according to time. The date and time is converted to a more readable form, enabling you to read it more pleasantly. + + + +
+ + + +##### List event date: `list event [desired date]` (Alicia Ho Shimin) + +Lastly, to list out all events on a particular date, type `list event [desired date]` in the command line, as seen below. Press 'Enter' to execute it. + + + +The output is seen in the console. The list is arranged by their respective categories. The date and time is converted to a more readable form, enabling you to read it more pleasantly. The index of the event is corresponding to its index in the entire list. + + + +
+ + + +#### Finding events: `find event` (Andre Wong Zhi Hua) +Allows you to look for classes, ccas and tests and tuitions that match your given keyphrase. + +In the case when you have many events in your schedule and you need to find a specific event to check the date. You can use the `find event` command to look for the event you want by entering keywords related to it. + +Let's say we need to find out when my vocabulary test is on. +We can first type `find event vocabulary` into the command box, and press 'Enter' to execute it. + + + +The output can then be seen in the console. + + + +And we can find the date we are looking for as pointed out by the yellow arrow below. + + + +
+
+
++ +### Score component of Plan&Score +Enables the following category type: +quiz + +The quiz feature enables you to spend the extra time resulting from your productive scheduling to hone your Mathematics for your upcoming PSLE. + +#### Taking a Quiz: `quiz` (Chan Wan Ting Elizabeth) +Taking a Mathematics quiz with any number of questions you want, ranging from just 1 question to the total number of questions in the quiz list. + +First, enter `quiz`, followed by the number of questions you would like to take in your quiz. For example, you could enter `quiz 1` to attempt a quiz with 1 question. + +The following output would then be displayed. +
+ +
+ + +#### Adding a Quiz Question: `add quiz` (Andre Wong Zhi Hua) +Allows you to add a Mathematics multiple-choice quiz question to the quiz list. + +Note that the `/e (explanation)` is an optional parameter. You can add a quiz question with or without an explanation. + +First, enter `add quiz`, follow by `/q`. + +Then, enter the question you would like to add. + +Next, enter `/o1`, followed by the answer option you would like to enter. Repeat this for the rest of the three options. + +Now, enter `/a`, followed by the number corresponding to the correct answer option. + +Lastly, enter `/e`, followed by the explanation to the solution of the question. This last part is optional. + +An example of such a command would be: `add quiz /q What is 26+5? /o1 28 /o2 31 /o3 38 /o4 41 /a 2 /exp Adding 5 to 26 gives us 31.`. + +The corresponding output would then be displayed as shown below. +
+ +
+ + +#### Deleting a Quiz Question: `delete quiz` (Chen Jinran) +Allows you to delete a quiz question from the quiz list. + +Simply enter `delete quiz`, followed by the index number corresponding to the quiz question you would like to delete in your quiz list. + +For example, you could enter `delete quiz 1`. + +You would expect to see this output. +
+ +
+ +#### Listing out All Quiz Questions: `list quiz` (Andre Wong Zhi Hua) +Allows you to list out all the questions in the quiz list. + +All you have to enter is `list quiz` for this command. + +This output should then be seen. +
+ + + +#### Finding a quiz: `find quiz` (Chen Jinran) +Look for quizzes that match the given keyword(s) that you want. + +Note that searches are case-insensitive and user can provide multiple words to compare with + +The format for this command is `find quiz`, followed by the keyword(s) you would like to search for in your list of quiz questions. + +For example, you could enter `find quiz 26`. + +Then, you would expect to see this in your output. +
+ + +#### Searching for former incorrect quiz questions: `quiz record` (Chen Jinran) +Allows you to list out the incorrect quizzes in your last quiz attempt. + +Simply enter `quiz record`. + +You should see the full list of questions you have answered wrongly in your previous quiz attempt, as shown below. +
+ + + +### Contact component of Plan&Score + +#### Adding a contact `add contact` (Chen Jinran) +Allows you to add a teacher's contact details to the contact list. + +Firstly, type `add` in the command line as seen below, followed by the category type which is the contact. +Afterwards, key in the description of the contact. Press 'Enter' to execute it. + + + +The output is seen in the console. + + + +WARNING: +* `[subject of contact]`, `[name of contact]`, `[phone number of contact]` and +`[email of contact]` can be in a natural language format and cannot contain '/'. +* Parameters `/s`, `/n`, `/p`, `/e` cannot be swapped. + + + + + +#### Deleting a contact `delete contact` (Chen Jinran) +Allows you to delete a contact from the contact list. + +Firstly, type `delete` in the command line as seen below, followed by the category type which is the contact. +Afterwards, key in the corresponding index of the contact you would like to delete. Press 'Enter' to execute it. + + + +The output is seen in the console. + + + +WARNING: +* `[contact number]` must be written in numerals. + + + + + +#### Listing out contacts `list contact` (Chen Jinran) +Allows you to list out all the contacts in the contact list + +To list out all contacts, type `list contact` in the command line, as seen below. +Press `Enter` to execute it. + + + +The output is seen in the console. + + + + +#### Finding a contact `find contact` (Andre Wong Zhi Hua) +Look for contacts that match the given keywords you want. + +In the case when you have many contacts in your list and you need to find a specific contact, you can use the +`find contact` command to look for the contact you want by entering keywords related to it. + +Let's say we need to find out the contact of our math teacher. We can type `find contact math` +into the command box, and press 'Enter' to execute it. + + + +The output can then be seen in the console. + + + +
+
+
+
+### Exits Program: `bye` (Alicia Ho Shimin)
+Exits the program once you have finished using it.
+
+Type the command and press 'Enter' to execute it.
+
+
+
+The output is shown in the console. It contains a simple goodbye message.
+
+
+
+
+
+## Saving Data (Chan Xu Hui)
+Plan&Score saves all your data automatically after every command. There is no need to save manually.
+However, if your storage file is detected to be unreadable, Plan&Score will offer to reset itself to its default settings,
+wiping all data stored in the text file.
+
+
+
+## FAQ -**Q**: How do I transfer my data to another computer? +**Q**: How do I transfer my data to another computer? + +**A**: We recommend you to transfer the entire folder containing `[CS2113T-W12-4][ Plan&Score].jar` and the `data` directory. Then, follow instructions given in our `Quick Start` section to set up Plan&Score. + +## Troubleshooting (Chan Xu Hui) + +**Q**: Plan&Score is unable to start, and I do not want to lose my data through factory resetting. How can I fix this? + +**A**: Your data files might have been corrupted. To fix this, you can attempt the following steps: + +**We recommend adult supervision for this process.** + +1. Locate the `data` directory. It should be in the same directory as where Plan&Score is located. +1. Open the `events.txt` file. +1. Check if any of the data are violating our decoding formats: + * For class/cca/test, the format should be: `[IDENTIFIER]|[true/false]|[DESCRIPTION]|[DATE IN YYYY-MM-DD HHMM]|[DATE IN YYYY-MM-DD HHMM]` + * For tuition, the format should be: `[IDENTIFIER]|[true/false]|[DESCRIPTION]|[DATE IN YYYY-MM-DD HHMM]|[DATE IN YYYY-MM-DD HHMM]|location` +1. Edit the file to the correct formats shown above +1. Launch Plan&Score +1. Confirm that Plan&Score runs without any error -**A**: {your answer here} +In the unfortunate event where the error persists, please reset Plan&Score to factory settings. +We recommend keeping a duplicate of the contents in `events.txt` to assist with the re-adding of events. +1. Ensure you have duplicated `events.txt` +1. Delete `events.txt` +1. Launch Plan&Score +1. Confirm that Plan&Score runs without any error +1. `events.txt` should appear in the `data` directory +1. Copy any unaffected events from the duplicated file in Step 1 +1. Re-add affected events through the command line interface + -## Command Summary +## Command Summary (Team) -{Give a 'cheat sheet' of commands here} -* Add todo `todo n/TODO_NAME d/DEADLINE` +Action | Format | Examples +-------|--------|-------- +help|`help` +add event|`add [class/cca/test] /n [description] /s [start-date-time] /e [end date-time]`, `add [tuition] /n [description] /s [start-date-time] /e [end-date-time] /l [location]`|`add class /n Math /s 2020-09-06 1300 /e 2020-09-06 1400`, `add tuition /n Math /s 2020-09-06 1300 /e 2020-09-06 1400 /l home` +add quiz|`add quiz /q [question] /o1 [option 1] /o2 [option 2] /o3 [option 3] /o4 [option 4] /a [option answer] /e (explanation)`|`add quiz /q 1 + 1 = ? /o1 1 /o2 2 /o3 3 /o4 4 /a 2 /exp no explanation needed` +add contact|`add contact /s [subject] /n [name of contact person] /p [phone number] /e [email address]`|`add contact /s math /n thomas /p 91779977 /e thomas@gmail.com` +delete event|`delete [class/cca/test/tuition] [item number]`|`delete class 1`, `delete test 1`, `delete cca 1` +delete quiz|`delete quiz [item number]`|`delete quiz 1` +delete contact|`delete contact [item number]`|`delete contact 1` +list event|`list event (
+ What it does: Allow users to add a test to their schedule. +
+ Justification: This feature improves the product because the users can tests to their schedule to better plan for it. Hence, allowing them to revise for their tests well in advance. +
+ * Delete test +
+ What it does: Allow users to delete a test to their schedule. +
+ Justification: This feature improves the product because the users can delete any past tests or tests that have been cancelled. + Hence, allowing them to better plan their schedule. +
+ * Set Recommended hours +
+ What it does: Allow users to set their recommended hours per day. +
+ Justification: This feature improves the product because the users are able to set the amount of productive hours they want to accomplish. + This allows users to remain within their recommended hours thus preventing them from overloading. +
+ Highlights: This enhancement affects existing commands and commands to be added in the future e.g checking if time exceeded. + The implementation was challenging as it required changes to existing commands and classes. +
+ * List event today/[date] +
+ What it does: Allow users to list their events for today or the date they desire. +
+ Justification: This feature improves the product because users are able to check the schedule for that day. +
+ * Time left +
+ What it does: Allow users to see the amount of productive hours they have for a particular day. +
+ Justification: This feature improves the product because users are able to know how + many productive hours they have left for that day thus, they are able to better plan their schedule and not overload. +
+ Highlights: This enhancement affects existing commands e.g add/delete/list event. + The implementation was challenging as it required changes to existing commands and classes. +
+ * Date Time conversion +
+ What it does: Converts date time from yyyy-MM-dd HHmm to date time in natural language format. +
+ Justification: This feature improves the product because users can intuitively know the date time of their events. +
+ Highlights: This enhancement affects existing commands e.g add/delete. + The implementation was challenging as it required changes to existing commands and classes. +
+ Credits: [To find out ordinal numbers](https://stackoverflow.com/questions/4011075/how-do-you-format-the-day-of-the-month-to-say-11th-21st-or-23rd-ordinal) + +* Code contributed: [RepoSense link](https://nus-cs2113-ay2021s1.github.io/tp-dashboard/#breakdown=true&search=&sort=groupTitle&sortWithin=title&since=2020-09-27&timeframe=commit&mergegroup=&groupSelect=groupByRepos&checkedFileTypes=docs~functional-code~test-code~other&tabOpen=true&tabType=authorship&zFR=false&tabAuthor=AliciaHo&tabRepo=AY2021S1-CS2113T-W12-4%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other) +* Project management: + * Reviewed PRs: [CS2113-W12-4](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/355#pullrequestreview-525631892) + +* Community: + * Reported bugs and suggestions for other teams: [CS2113-T13-2](https://github.com/AY2021S1-CS2113-T13-2/tp) + * Review DG: [#16](https://github.com/nus-cs2113-AY2021S1/tp/pull/16) + +* Contribution to user guide + * Wrote documentation and did diagrams for `add test`,`delete test`,`list event today`, + `list event [date]`,`bye` + * Help to enhance documentation and did diagrams for `help`, `add class`, `delete class`, `add cca`, + `delete cca`, `add tuition`, `delete tuition`, `list event`, `list event week`, `list event nextweek` + * Wrote documentation and did diagrams for Initialisation + * Update table for `command summary` + + +* Contribution to developer guide + * Wrote documentation and did UML for `configStorage`, `set hours` + * Wrote documentation for `help`, `product scope` + * Did UML for `add` and `delete` feature \ No newline at end of file diff --git a/docs/team/andrewongzh.md b/docs/team/andrewongzh.md new file mode 100644 index 0000000000..52d2683e1b --- /dev/null +++ b/docs/team/andrewongzh.md @@ -0,0 +1,63 @@ +## Project: Plan&Score + +Plan&Score is a Java command-line application that allows Primary 6 students to plan and track their classes, CCAs and test dates. This enables the students to remember their schedule, so they can plan well in advance for their tests and score better. + +## Contributions by Andre Wong +Given below are my contributions to the project. +* Features: + * List events [#18](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/18) + * What it does: allows the user to list out all their classes, ccas, tests and tuitions. + * Justification: Allow users to view all their schedule at a glance. The numbering that appears here also corresponds to which events to delete later. + * Find events [#178](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/178) + * What it does: allows the user to search for all the events by keywords. + * Justification: Allows user to look for events in which they cannot remember the exact details such as start date. + * Add quiz [#123](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/123) + * What it does: allows the user to add a quiz question to quiz manager + * Justification: Users can create their own question freely to test themselves afterwards. This helps to improve learning. + * Find contacts [#240](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/240) + * What it does: allows the user to find contacts. + * Justification: Users can search by email, phone number , name or subject if they cannot remember them all. + * Contacts storage [#347](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/347) + * What it does: allows the application to store the contacts in a text file. + * Justification: The data will now be persistent even after the application closes. + +* Unused Feature: + * Quiz Notification [#217](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/217) + * What it does: shows notification to user if quiz has not been attempted since two days ago. + * Justification: Reminds users to attempt quiz if they forgot to do their quiz. + +* Code contributed: [RepoSense link](https://nus-cs2113-ay2021s1.github.io/tp-dashboard/#breakdown=true&search=&sort=groupTitle&sortWithin=title&since=2020-09-27&timeframe=commit&mergegroup=&groupSelect=groupByRepos&checkedFileTypes=docs~functional-code~test-code~other&tabOpen=true&tabType=authorship&tabAuthor=AndreWongZH&tabRepo=AY2021S1-CS2113T-W12-4%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other) + +* Enhancements: + * Refactor code in controller package to have a command and model parser to extract out commands and models so to adhere to single responsibility principle + * Create a command factory that generates the correct command class to execute on + * All commands inherit from abstract class command have method execute() + * EventManager class to add another layer of abstraction + * Storage class inherit from abstract StorageManager to merge duplicated methods [#125](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/125) + * Logger class follows a singleton pattern [#146](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/146) + * Add encapsulation to models by adding an interface to all the modelManagers + * Command sanitized to ensure cases where there are extra or swapped parameters, command in uppercase and command with extra whitespaces are handled + * Factory reset to ensure the program can still loop after factory reset. + +* Project management: + * Update code using forking workflow when doing pull requests + * Set up issue tracker and milestones for `v1.0`, `v2.0` and `v2.1` + * Set up github project dashboard to track progress + * Released `v2.0` onto github + * Reviewed PRs: [#17](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/17) [#355](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/355) [#363](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/363) [#375](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/375) + +* Community: + * Contributed to forum discussions: [#29](https://github.com/nus-cs2113-AY2021S1/forum/issues/29) [#37](https://github.com/nus-cs2113-AY2021S1/forum/issues/87) + * Reported bugs and suggestions for other teams: [#2](https://github.com/nus-cs2113-AY2021S1/tp/pull/2) + +* Contribution to user guide + * Wrote documentation for `Finding events`, `Finding contacts`, `Listing events`, `Adding quiz` + * Added images initially for initialization, help, add and delete class + * Added images under section `Finding events` and enhanced table for `command summary` + +* Contribution to developer guide + * Add colors and removed footboxes to UML diagrams + * Add UML diagrams for figure 1, 3, 4, 5, 17, 18 + * Wrote documentation for `Architecture`, `Controller component` and `Model component` in the Design section + * Wrote documentation for `List contact/quiz`, `List event (date /today)` and `Find event
+Allows students to plan and track their: +
-
+
- School classes +
- CCAs +
- Tests +
- Tuition +
+Allows students to practice quizzes regularly and consistently, honing their required skills for their upcoming PSLE. + +Apart from that, Plan&Score also allows students to save contact details of their teachers, cca coaches, or any other relevant person in a highly convenient way. + +In essence, Plan&Score is not merely a scheduling application like many other applications in the market. It is a one-of-a-kind and all-encompassing application, tailored for Primary 6 students in Singapore (for now). + + +#### Summary of Contributions + +Link to my code contribution (via RepoSense): +[My contributions](https://nus-cs2113-ay2021s1.github.io/tp-dashboard/#breakdown=true&search=elizabethcwt&sort=groupTitle&sortWithin=title&since=2020-09-27&timeframe=commit&mergegroup=&groupSelect=groupByRepos&checkedFileTypes=docs~functional-code~test-code~other) + +Given below are my contributions to Plan&Score. + +- Feature: Help + - What it does: Displays the updated list of available features and corresponding commands for user + - Justification: By including the required format to enter the input via quotation marks, provides a convenient way for users to remember how to input commands. It also allows them to view and track new features during application updates. + - Highlights: This feature is usually what the user first accesses when launching the application, and provides a bird’s eye view of the whole application before delving into each individual feature. + +- Feature: Class + - What it does: Stores user’s classes, attains class list size, allows adding and deleting of classes + - Justification: This feature allows users to schedule well, by entering their school classes into the application. Users can then remove any of these classes once they’re done, or no longer relevant. Users can then view exactly how many classes, as well as which classes they have, to manage their workload and time better. + - Highlights: This feature affects existing commands and commands to be added in future. It requires an in-depth analysis of design alternatives. + - Relevant classes in source code: EventClass.java class and EventClassManager.java + +- Feature: Take Quiz + - What it does: Displays a number of quiz questions, as specified by the user, in randomised order. Then, reviews the correctness of the user’s answers, an explanation for each question, as well as the user’s score. + - Justification: This feature allows users to score well, by allowing them to take quizzes of any size they’d like, according to how much time they have. Since it is integrated into this application, along with the scheduler, it is highly accessible for users. + - Highlights: This feature requires the use of a manager, to manage multiple arraylists. It also requires a lot of checks to handle different user inputs for each question, valid or invalid. + - Relevant classes in source code: Quiz.java, QuizManager.java and UserAnswerManager.java + +- Project Management + - Managed release `v1.0` on GitHub + - Reviewed PRs: [#363](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/363) + +- Documentation + - User Guide + - Created structure and added hyperlinks + - Created photos of tips and warnings boxes + - Added photos for score component features/commands + - Added details for `help`, `add class`, `delete class`, and `quiz` commands/features + - Added `help` and `quiz` components in the Command Summary + + - Developer's Guide + - Added explanation for help feature + - Added UML diagrams for the `quiz storage` and `find quiz` features. + +- Community + - Reported bugs and gave suggestions to other teams based on their newest release (jarfile): + [T13-3](https://github.com/AY2021S1-CS2113-T13-3/tp/releases) + + - Reviewed and gave comments and suggestions to the Developer's Guide for another team: + [T13-2](https://ay2021s1-cs2113t-w13-2.github.io/tp/DeveloperGuide.html) \ No newline at end of file diff --git a/docs/team/johndoe.md b/docs/team/johndoe.md deleted file mode 100644 index ab75b391b8..0000000000 --- a/docs/team/johndoe.md +++ /dev/null @@ -1,6 +0,0 @@ -# John Doe - Project Portfolio Page - -## Overview - - -### Summary of Contributions diff --git a/docs/team/untitle4.md b/docs/team/untitle4.md new file mode 100644 index 0000000000..f71ead6434 --- /dev/null +++ b/docs/team/untitle4.md @@ -0,0 +1,53 @@ +# Chen Jinran's Project Portfolio Page + +## Project: Plan&Score + +Plan&Score is a Command Line Interface application for primary 6 students to +possess a schedule, quiz and contact tracker. It is written in Java. + +Given below are my contributions to the project. + +* Features: + * Add/Delete ccas [#25](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/25) + * What it does: Allows the user to add an event of type cca in the schedule. + Allows the user to delete the existing ccas in the schedule. + * Justification: This is a basic feature for constructing the schedule. + * Quiz storage [#121](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/121) + * What it does: Allows the application to store the quizzes in a text file automatically. + * Delete quiz [#121](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/121) + * What it does: Allows the user to delete the existing quizzes in the quiz list. + * Find quiz [#185](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/185) + * What it does: Allows users to find quizzes in the quiz list with input keyword(s). + * List quiz [#127](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/127) + * What it does: Allows users to list out all quiz questions in the quiz list. + * Quiz record [#213](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/213) + * What it does: Allows users to review the incorrect quizzes in their last quiz attempt. + * Add/Delete contacts [#131](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/131) + * What it does: Allows users to add a contact in the contact list. + Allows the user to delete the existing contacts in the contact list. + +* Unused Features: + * Set ccas done [#34](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/34) + * What it does: Allows users to set a cca from `NOT DONE` to `DONE`. + +* Code contributed: [RepoSense link](https://nus-cs2113-ay2021s1.github.io/tp-dashboard/#breakdown=true&search=&sort=groupTitle&sortWithin=title&since=2020-09-27&timeframe=commit&mergegroup=&groupSelect=groupByRepos&checkedFileTypes=docs~functional-code~test-code~other&tabOpen=true&tabType=authorship&tabAuthor=untitle4&tabRepo=AY2021S1-CS2113T-W12-4%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code) + +* Project management: + * PRs reviewed: [#363](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/363) + +* Enhancements to existing features: + * Added an optional parameter `explanation` for a quiz question: [#150](https://github.com/AY2021S1-CS2113T-W12-4/tp/pull/150) + +* Documentation: + * User Guide: + * Added implementation details of the `add`, `delete`, + `list` and `find` features for quiz. + * Added implementation details of the `add` and `delete` for cca. + * Added picture demonstration of the `add`, `delete`, `list` and `find` command for contacts + and update the corresponding implementation details. + * Developer Guide: + * Drafted the description of the `quiz` feature. + * Added UML diagrams for the `quiz storage` and `find quiz` features. + +* Community: + * Reported bugs and suggestions for other teams in the class (example: [Reviewing T14-3](https://github.com/untitle4/ped/issues/4)) \ No newline at end of file diff --git a/logfile.txt.1 b/logfile.txt.1 new file mode 100644 index 0000000000..b1c3829287 --- /dev/null +++ b/logfile.txt.1 @@ -0,0 +1,274 @@ +Nov 08, 2020 8:27:49 PM seedu.duke.storage.config.ConfigStorageManager loadData +INFO: Loading storage... +Nov 08, 2020 8:27:49 PM seedu.duke.storage.StorageManager createDataFile +INFO: Directory found... +Nov 08, 2020 8:27:49 PM seedu.duke.storage.config.ConfigStorageManager loadData +INFO: Data file found, reading data file... +Nov 08, 2020 8:27:49 PM seedu.duke.storage.config.ConfigStorageManager loadData +INFO: Load successful +Nov 08, 2020 8:27:49 PM seedu.duke.storage.contact.ContactStorageManager loadData +INFO: Loading storage... +Nov 08, 2020 8:27:49 PM seedu.duke.storage.StorageManager createDataFile +INFO: Directory found... +Nov 08, 2020 8:27:49 PM seedu.duke.storage.contact.ContactStorageManager loadData +INFO: Data file found, reading data file... +Nov 08, 2020 8:27:49 PM seedu.duke.storage.contact.ContactStorageManager loadData +INFO: Load successful +Nov 08, 2020 8:27:49 PM seedu.duke.storage.quiz.QuizStorageManager loadData +INFO: Loading storage... +Nov 08, 2020 8:27:49 PM seedu.duke.storage.StorageManager createDataFile +INFO: Directory found... +Nov 08, 2020 8:27:49 PM seedu.duke.storage.quiz.QuizStorageManager loadData +INFO: Data file found, reading data file... +Nov 08, 2020 8:27:49 PM seedu.duke.storage.quiz.QuizStorageManager loadData +INFO: Load successful +Nov 08, 2020 8:27:49 PM seedu.duke.storage.event.EventStorageManager loadData +INFO: Loading storage... +Nov 08, 2020 8:27:49 PM seedu.duke.storage.StorageManager createDataFile +INFO: Directory found... +Nov 08, 2020 8:27:49 PM seedu.duke.storage.event.EventStorageManager loadData +INFO: Data file found, reading data file... +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.controller.parser.DateTimeParser convertStringToCalendar +INFO: converting string to calendar +Nov 08, 2020 8:27:49 PM seedu.duke.storage.event.EventStorageManager loadData +INFO: Load successful +Nov 08, 2020 8:27:49 PM seedu.duke.ui.ConfigManager getIntroductoryVariables +INFO: getting username and recommended hours from user +Nov 08, 2020 8:27:55 PM seedu.duke.controller.ControlManager runLogic +INFO: Running controller logic now +Nov 08, 2020 8:27:55 PM seedu.duke.controller.ControlManager runLogic +INFO: Extracting command +Nov 08, 2020 8:27:55 PM seedu.duke.controller.parser.CommandParser extractCommand +INFO: Extracting command now... +Nov 08, 2020 8:27:55 PM seedu.duke.controller.ControlManager runLogic +INFO: Extracting model +Nov 08, 2020 8:27:55 PM seedu.duke.controller.parser.ModelParser extractModel +INFO: Extracting model now... +Nov 08, 2020 8:27:55 PM seedu.duke.controller.ControlManager runLogic +INFO: Executing command +Nov 08, 2020 8:27:55 PM seedu.duke.ui.ConfigManager editHours +INFO: editing hours to take in new hours input +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 8:27:57 PM seedu.duke.controller.parser.DateTimeParser convertCalendarToString +INFO: converting calendar to string +Nov 08, 2020 10:49:00 PM seedu.duke.Main run +SEVERE: Program ended undexpectedly diff --git a/src/main/java/seedu/duke/Duke.java b/src/main/java/seedu/duke/Duke.java deleted file mode 100644 index 5c74e68d59..0000000000 --- a/src/main/java/seedu/duke/Duke.java +++ /dev/null @@ -1,21 +0,0 @@ -package seedu.duke; - -import java.util.Scanner; - -public class Duke { - /** - * Main entry-point for the java.duke.Duke application. - */ - public static void main(String[] args) { - String logo = " ____ _ \n" - + "| _ \\ _ _| | _____ \n" - + "| | | | | | | |/ / _ \\\n" - + "| |_| | |_| | < __/\n" - + "|____/ \\__,_|_|\\_\\___|\n"; - System.out.println("Hello from\n" + logo); - System.out.println("What is your name?"); - - Scanner in = new Scanner(System.in); - System.out.println("Hello " + in.nextLine()); - } -} diff --git a/src/main/java/seedu/duke/Main.java b/src/main/java/seedu/duke/Main.java new file mode 100644 index 0000000000..efa874007a --- /dev/null +++ b/src/main/java/seedu/duke/Main.java @@ -0,0 +1,109 @@ +package seedu.duke; + +import seedu.duke.common.LogManager; +import seedu.duke.common.Messages; +import seedu.duke.exception.StorageCorruptedException; +import seedu.duke.model.Model; +import seedu.duke.model.contact.ContactManager; +import seedu.duke.model.event.EventManager; +import seedu.duke.model.event.EventParameter; +import seedu.duke.model.quiz.QuizManager; +import seedu.duke.storage.StorageExceptionHandler; +import seedu.duke.storage.contact.ContactStorageManager; +import seedu.duke.storage.quiz.QuizStorageManager; +import seedu.duke.storage.event.EventStorageManager; +import seedu.duke.model.config.ConfigManager; +import seedu.duke.ui.UserInterface; + +import java.util.NoSuchElementException; +import java.util.logging.Level; +import java.util.logging.Logger; + +import static seedu.duke.storage.StorageManager.CONTACT_FILE_NAME; +import static seedu.duke.storage.StorageManager.EVENT_FILE_NAME; +import static seedu.duke.storage.StorageManager.QUIZ_FILE_NAME; + +public class Main { + private static final Logger logger = LogManager.getLogManagerInstance().getLogger(); + + private static UserInterface userInterface; + private static boolean isRunning = true; + + private EventStorageManager eventStorageManager; + private QuizStorageManager quizStorageManager; + private ContactStorageManager contactStorageManager; + private ConfigManager configManager; + private Model model; + + private boolean isActive; + + public Main() throws StorageCorruptedException { + userInterface = UserInterface.getInstance(); + initializeStorageManagers(); + isActive = true; + loadModel(); + } + + /** + * Main entry-point for the java.duke.Duke application. + */ + public static void main(String[] args) { + while (isRunning) { + try { + new Main().run(); + } catch (StorageCorruptedException e) { + userInterface.showToUser(Messages.MESSAGE_STORAGE_CORRUPTED); + StorageExceptionHandler storageExceptionHandler = new StorageExceptionHandler(); + isRunning = storageExceptionHandler.handleCorruptedStorage(); + } + } + } + + /** + * Loops continuously through and lets the user interface ask user for input. + * + * @throws StorageCorruptedException If there is error when reading config values. + */ + public void run() throws StorageCorruptedException { + try { + userInterface.showToUser(Messages.MESSAGE_HELLO_FROM_DUKE); + configManager.getIntroductoryVariables(configManager.getConfig()); + userInterface.showWelcomeMessage(configManager.getConfig()); + + while (isActive) { + isActive = userInterface.runUi(model, eventStorageManager, quizStorageManager, contactStorageManager); + isRunning = isActive; + } + } catch (NoSuchElementException e) { + logger.log(Level.SEVERE, "Program ended unexpectedly"); + } + + // Exit Message + userInterface.showToUser(Messages.MESSAGE_BYE); + } + + //@@author AndreWongZH + /** + * Sets up the eventManager, quizManager, contactManager and configManager to be saved into model. + * + * @throws StorageCorruptedException If unable to load data correctly. + */ + private void loadModel() throws StorageCorruptedException { + ContactManager contactManager = new ContactManager(contactStorageManager.loadData()); + QuizManager quizManager = new QuizManager(quizStorageManager.loadData()); + EventParameter eventParameter = eventStorageManager.loadData(); + EventManager eventManager = new EventManager(eventParameter, configManager.getConfig()); + model = new Model(eventManager, contactManager, quizManager, configManager); + } + + //@@author AndreWongZH + /** + * Sets up storage managers to get data from text file storage. + */ + private void initializeStorageManagers() { + eventStorageManager = new EventStorageManager(EVENT_FILE_NAME); + quizStorageManager = new QuizStorageManager(QUIZ_FILE_NAME); + contactStorageManager = new ContactStorageManager(CONTACT_FILE_NAME); + configManager = ConfigManager.getInstance(); + } +} diff --git a/src/main/java/seedu/duke/common/LogManager.java b/src/main/java/seedu/duke/common/LogManager.java new file mode 100644 index 0000000000..84d7ad586f --- /dev/null +++ b/src/main/java/seedu/duke/common/LogManager.java @@ -0,0 +1,63 @@ +package seedu.duke.common; + +import seedu.duke.ui.UserInterface; + +import java.io.IOException; +import java.util.logging.FileHandler; +import java.util.logging.Level; +import java.util.logging.Logger; +import java.util.logging.SimpleFormatter; + +//@@author AndreWongZH +/** + * Represents the objects that logs all the processes of the program at each step. + */ +public class LogManager { + public static final String LOG_FILE_LOCATION = "./logfile.txt"; + private static LogManager logManager = null; + private static final Logger LOGGER = Logger.getLogger("log"); + + /** + * The constructor here is only called once when program runs to initialize a new LogManager instance. + */ + private LogManager() { + UserInterface userInterface = UserInterface.getInstance(); + + try { + FileHandler fileHandler = new FileHandler(LOG_FILE_LOCATION); + fileHandler.setFormatter(new SimpleFormatter()); + + // set log level, defaults to Level.INFO + LOGGER.setLevel(Level.INFO); + + // prevents printing of log messages to console + LOGGER.setUseParentHandlers(false); + + // redirects log messages to a file instead + LOGGER.addHandler(fileHandler); + } catch (IOException e) { + userInterface.showToUser(Messages.MESSAGE_INITIALIZATION_LOGGER_FAILED); + } + } + + /** + * Returns an instance of the LogManager class for users to get the logger instance. + * + * @return LogManager instance. + */ + public static LogManager getLogManagerInstance() { + if (logManager == null) { + logManager = new LogManager(); + } + return logManager; + } + + /** + * Returns a logger instance that the programmer can use to log process info. + * + * @return A logger instance. + */ + public Logger getLogger() { + return LOGGER; + } +} diff --git a/src/main/java/seedu/duke/common/Messages.java b/src/main/java/seedu/duke/common/Messages.java new file mode 100644 index 0000000000..76f7b760d8 --- /dev/null +++ b/src/main/java/seedu/duke/common/Messages.java @@ -0,0 +1,236 @@ +package seedu.duke.common; + +public class Messages { + //@@author durianpancakes + // Intro related messages + public static final String MESSAGE_LOGO = " ------ - -----\n" + + "| _ | | | | ____|\n" + + "| | | | | | | |___\n" + + "| |_| | | | ----- ----- & |____ | ------ ----- ----- -----\n" + + "| | | | / - \\ | _ | | | | _____| / - \\ / ___\\ / -- \\\n" + + "| ---- | | | | | | | | | | ___| | | | | | | | | / | ___|\n" + + "| | | | | |_| \\ | | | | | | | |____ | |_| | | | | |____\n" + + "|_| |_| \\____/\\_\\ |_| |_| |_____| |______| \\_____/ |_| \\_____/"; + //@@author + public static final String MESSAGE_HELLO_FROM_DUKE = "Hello from\n" + + Messages.MESSAGE_LOGO; + public static final String MESSAGE_PROMPT_NAME = "What is your name?"; + public static final String MESSAGE_PROMPT_HOURS = "Key in the number of hours you would like " + + "to be productive each day (not more than 12)?"; + public static final String MESSAGE_SHOW_HOURS = "This is your recommended hours per day: "; + public static final String MESSAGE_SHOW_NEW_HOURS = "This is your new recommended hours per day: "; + public static final String MESSAGE_HELLO = "Hello "; + public static final String MESSAGE_PROMPT_COMMAND = "What can we do for you? " + + "(Enter 'help' for the list of available commands!)\n"; + public static final String MESSAGE_HOURS_ERROR_NON_NUMBER = "Please indicate in NUMERALS, " + + "how many hours you would like to set!"; + + // General error messages + //@@author durianpancakes + public static final String MESSAGE_STORAGE_READ_ERROR = "There was an error loading your files."; + public static final String MESSAGE_STORAGE_INITIALIZATION_ERROR = "STORAGE: There was an error"; + public static final String MESSAGE_STORAGE_CORRUPTED = "): Storage file corrupted."; + public static final String MESSAGE_FACTORY_RESET_PROMPT = "Would you like to reset Plan&Score? [y/n]" + + "(NOTE: This will result in the loss of all data!)"; + public static final String MESSAGE_MANUAL_TROUBLESHOOT_PROMPT = "Otherwise, consider going through the " + + "troubleshooting steps provided in our User Guide to fix the problem manually."; + public static final String MESSAGE_FACTORY_RESET_INVALID_INPUT_PROMPT = "Please enter [y/n] only!"; + public static final String MESSAGE_FACTORY_RESET_SUCCESSFUL = "Reset successful!"; + public static final String MESSAGE_FACTORY_RESET_FAILED_OR_CANCELLED = "Reset failed/cancelled. " + + "Please follow troubleshooting steps provided in our User Guide to reset Plan&Score."; + public static final String MESSAGE_INCOMPLETE_LIST_PARAMETERS = "Please tell me what you want to be listed! " + + "You can either 'list event' or 'list quiz' or 'list contact'"; + public static final String MESSAGE_RECOMMENDED_TIME_EXCEEDED = "Recommended time exceeded!"; + public static final String MESSAGE_PROMPT_CHECK_START_END_INPUTS = "Please check the start and end inputs again!"; + public static final String MESSAGE_ERROR_START_AFTER_END = "The start time given is later " + + "than the end time given!\n" + + "Please check your inputs again!"; + public static final String MESSAGE_ERROR_EQUALS_END = "The start time given is the same as " + + "the end time given!\n" + + "Please check your inputs again!"; + //@@author AndreWongZH + public static final String MESSAGE_EMPTY_SCHEDULE_LIST = "Schedule is %s. Add some!"; + public static final String MESSAGE_INITIALIZATION_LOGGER_FAILED = "Failed to set up logger"; + public static final String MESSAGE_MISSING_MODEL = ":( Oops! Category type is missing! " + + "Enter 'help' if needed!"; + public static final String MESSAGE_INCOMPLETE_FIND_PARAMETERS = "Please tell me what you want to be listed! " + + "You can either 'find event' or 'find quiz' or 'find contact'"; + public static final String MESSAGE_SWAPPED_PARAMETERS = ":( Please do not swap the parameters"; + //@@author elizabethcwt + public static final String MESSAGE_MISSING_PARAMETERS = ":( OOPS!!! " + + "Remember to include ALL %s inputs!"; + public static final String MESSAGE_EMPTY_PARAMETERS = ":( OOPS!!! Ensure ALL parameters are filled up!"; + public static final String MESSAGE_INVALID_COMMAND = ":( Oops! I did not recognize that command! " + + "Enter 'help' if needed!"; + public static final String MESSAGE_INVALID_MODEL = ":( Oops! I did not recognize that category type" + + " or category not compatible with command! " + + "Enter 'help' if needed!"; + public static final String MESSAGE_INVALID_EXTRA_PARAM = ":( OOPS!!! Please do not enter extra inputs"; + //@@author Aliciaho + //Messages for date time + public static final String MESSAGE_LIST_INVALID_DATE = ":( OOPS!!! Please enter today/week/valid date" + + "and time in format yyyy-mm-dd!"; + public static final String MESSAGE_INVALID_DATE = ":( OOPS!!! " + + "Please enter valid date and time in format yyyy-mm-dd HHMM!"; + + //@@author durianpancakes + // Messages from CalendarWeekRenderer + public static final String MESSAGE_MONDAY_LABEL = "[MON]"; + public static final String MESSAGE_TUESDAY_LABEL = "[TUE]"; + public static final String MESSAGE_WEDNESDAY_LABEL = "[WED]"; + public static final String MESSAGE_THURSDAY_LABEL = "[THU]"; + public static final String MESSAGE_FRIDAY_LABEL = "[FRI]"; + public static final String MESSAGE_SATURDAY_LABEL = "[SAT]"; + public static final String MESSAGE_SUNDAY_LABEL = "[SUN]"; + + //@@author untitle4 + // Messages from Contact related classes + public static final String MESSAGE_CONTACT_ADD_SUCCESS = "Got it. I've added this contact: "; + public static final String MESSAGE_CONTACT_DELETE_SUCCESS = "Noted. I've removed this contact: "; + public static final String MESSAGE_CONTACT_DELETE_ERROR_NON_NUMBER = ":( OOPS!!! " + + "Please indicate in NUMERALS, which contact you'd like to delete!"; + public static final String MESSAGE_CONTACT_DELETE_ERROR_NO_NUMBER_GIVEN = ":( OOPS!!! " + + "Please indicate which contact you'd like to delete!"; + public static final String MESSAGE_INVALID_CONTACT_INDEX = ":( OOPS!!! Please indicate a valid contact index!"; + public static final String MESSAGE_EMPTY_CONTACT_LIST = "Contact list is empty. Add some!!"; + public static final String MESSAGE_CONTACT_INDEX_OUT_OF_BOUNDS = "There is not such a contact in your list!"; + + //@@author elizabethcwt + // Messages from Class related classes + public static final String MESSAGE_CLASS_ADD_SUCCESS = "Got it. I've added this class: "; + public static final String MESSAGE_CLASS_DELETE_SUCCESS = "Noted. I've removed this class: "; + public static final String MESSAGE_CLASS_DELETE_ERROR_NON_NUMBER = ":( OOPS!!! " + + "Please indicate in NUMERALS, which class you'd like to delete!"; + public static final String MESSAGE_CLASS_DELETE_ERROR_NO_NUMBER_GIVEN = ":( OOPS!!! " + + "Please indicate which class you'd like to delete!"; + public static final String MESSAGE_CLASS_DONE_SUCCESS = "Nice! I've marked this class as done:"; + public static final String MESSAGE_CLASS_DONE_ERROR_NON_NUMBER = ":( OOPS!!! " + + "Please indicate in NUMERALS, which class you'd like to set as Done!"; + public static final String MESSAGE_CLASS_DONE_ERROR_NO_NUMBER_GIVEN = ":( OOPS!!! " + + "Please indicate which class you'd like to set as Done!"; + public static final String MESSAGE_INVALID_CLASS_INDEX = ":( OOPS!!! Please indicate a valid class index!"; + + //@@author untitle4 + // Messages from Cca related classes + public static final String MESSAGE_CCA_ADD_SUCCESS = "Got it. I've added this cca: "; + public static final String MESSAGE_CCA_DELETE_SUCCESS = "Noted. I've removed this cca: "; + public static final String MESSAGE_CCA_DELETE_ERROR_NON_NUMBER = ":( OOPS!!! " + + "Please indicate in NUMERALS, which cca you'd like to delete!"; + public static final String MESSAGE_CCA_DELETE_ERROR_NO_NUMBER_GIVEN = ":( OOPS!!! " + + "Please indicate which cca you'd like to delete!"; + public static final String MESSAGE_CCA_DONE_SUCCESS = "Nice! I've marked this cca as done:"; + public static final String MESSAGE_CCA_DONE_ERROR_NON_NUMBER = ":( OOPS!!! " + + "Please indicate in NUMERALS, which cca you'd like to set as Done!"; + public static final String MESSAGE_CCA_DONE_ERROR_NO_NUMBER_GIVEN = ":( OOPS!!! " + + "Please indicate which cca you'd like to set as Done!"; + public static final String MESSAGE_INVALID_CCA_INDEX = ":( OOPS!!! Please indicate a valid cca index!"; + + //@@author Aliciaho + // Messages from Test related classes + public static final String MESSAGE_TEST_ADD_SUCCESS = "Got it. I've added this test: "; + public static final String MESSAGE_TEST_DELETE_SUCCESS = "Noted. I've removed this test: "; + public static final String MESSAGE_TEST_DELETE_ERROR_NON_NUMBER = ":( OOPS!!! " + + "Please indicate in NUMERALS, which test you'd like to delete!"; + public static final String MESSAGE_TEST_DELETE_ERROR_NO_NUMBER_GIVEN = ":( OOPS!!! " + + "Please indicate which test you'd like to delete!"; + public static final String MESSAGE_TEST_DONE_SUCCESS = "Nice! I've marked this test as done:"; + public static final String MESSAGE_TEST_DONE_ERROR_NON_NUMBER = ":( OOPS!!! " + + "Please indicate in NUMERALS, which test you'd like to set as Done!"; + public static final String MESSAGE_TEST_DONE_ERROR_NO_NUMBER_GIVEN = ":( OOPS!!! " + + "Please indicate which test you'd like to set as Done!"; + public static final String MESSAGE_INVALID_TEST_INDEX = ":( OOPS!!! Please indicate a valid test index!"; + public static final String MESSAGE_TIME_LEFT_HEADER = "Time left for this day: "; + + //@@author durianpancakes + // Messages from Tuition related classes + public static final String MESSAGE_MISSING_TUITION_SUFFIX = ":( OOPS!!! " + + "Remember to include ALL '/n', '/s', '/e', '/l' suffixes!"; + public static final String MESSAGE_MISSING_TUITION_INPUT = ":( OOPS!!! " + + "Remember to include ALL '/n', '/s', '/e', '/l' inputs!"; + public static final String MESSAGE_TUITION_ADD_SUCCESS = "Got it. I've added this tuition: "; + public static final String MESSAGE_TUITION_DELETE_SUCCESS = "Noted. I've removed this tuition: "; + public static final String MESSAGE_TUITION_DELETE_ERROR_NON_NUMBER = ":( OOPS!!! " + + "Please indicate in NUMERALS, which tuition you'd like to delete!"; + public static final String MESSAGE_TUITION_DELETE_ERROR_NO_NUMBER_GIVEN = ":( OOPS!!! " + + "Please indicate which tuition you'd like to delete!"; + public static final String MESSAGE_TUITION_DONE_SUCCESS = "Nice! I've marked this tuition as done:"; + public static final String MESSAGE_TUITION_DONE_ERROR_NON_NUMBER = ":( OOPS!!! " + + "Please indicate in NUMERALS, which tuition you'd like to set as Done!"; + public static final String MESSAGE_TUITION_DONE_ERROR_NO_NUMBER_GIVEN = ":( OOPS!!! " + + "Please indicate which tuition you'd like to set as Done!"; + public static final String MESSAGE_INVALID_TUITION_INDEX = ":( OOPS!!! Please indicate a valid tuition index!"; + + //@@author elizabethcwt + // Messages from Quiz related classes + public static final String MESSAGE_QUIZ_DELETE_ERROR_NON_NUMBER = ":( OOPS!!! Please indicate in NUMERALS, " + + "which quiz you'd like to delete!\n"; + public static final String MESSAGE_INVALID_QUIZ_COMMAND = ":( OOPS!!! Are you trying to take a quiz or add/delete a" + + " quiz question? Enter 'help' to check the correct format!"; + public static final String MESSAGE_EMPTY_QUIZ_LIST = "Quiz list is empty. Add some!"; + public static final String MESSAGE_QUIZ_INDEX_OUT_OF_BOUND = "There is no such question in your quiz list!"; + public static final String MESSAGE_QUIZ_QUESTION_NOT_FOUND = "No question provided"; + public static final String MESSAGE_QUIZ_ANSWER_NOT_FOUND = "No answer provided"; + public static final String MESSAGE_QUIZ_OPTIONS_NOT_FOUND = "Options not provided"; + public static final String MESSAGE_QUIZ_ADD_SUCCESSFUL = "Quiz question added!"; + public static final String MESSAGE_QUIZ_INVALID_ANS_PROVIDED = ":( OOPS! Incorrect answer format! " + + "Your answer can only be either 1, 2, 3 or 4!"; + public static final String MESSAGE_QUIZ_FULL_MARKS = "Congratulations! You got full marks in your last attempt!"; + public static final String MESSAGE_QUIZ_WRONG_QUESTIONS_HEADER = "Here are the incorrect questions " + + "in your last quiz attempt:"; + public static final String MESSAGE_QUIZ_LIST_HEADER = "Here are the questions in your quiz list:"; + public static final String MESSAGE_QUIZ_MISSING_ANSWER = ":( OOPS! Please enter your answer for the " + + "question above!"; + public static final String MESSAGE_NO_QUIZ_ATTEMPTS = "You have not taken a quiz yet!"; + + public static String invalid_number_of_quiz_questions_message(int size) { + return ":( OOPS!!! Please enter a valid number of quiz questions to attempt! (1~" + size + ")"; + } + + public static final String MESSAGE_MISSING_QUIZ_PARAM = "Please indicate the command you would like to apply on" + + " quiz!"; + + public static final String MESSAGE_QUIZ_NON_NUMBER = "Please enter a valid number or " + + "enter 'quiz record' to see your incorrect questions in your previous quiz!"; + + public static String print_quiz_score(int correctCounter, int noOfQues) { + return "You scored " + correctCounter + " out of " + noOfQues + "!" + + "Scroll up to review your quiz."; + } + + //@@author elizabethcwt + public static final String MESSAGE_HELP = "Hello! Here is a list of commands you can try:\n\n" + + "\t1. Add class: 'add class /n [name of class] /s [start date-time of class] /e" + + " [end date-time of class]'\n" + + "\t2. Delete class: 'delete class [class number]'\n\n" + + "\t3. Add cca: 'add cca /n [name of cca] /s [start date-time of cca] /e [end date-time of cca]'\n" + + "\t4. Delete cca: 'delete cca [cca number]'\n\n" + + "\t5. Add test: 'add test /n [name of test] /s [start date-time of test] /e " + + "[end date-time of test]'\n" + + "\t6. Delete test: 'delete test [test number]'\n\n" + + "\t7. Add tuition: 'add tuition /n [name of tuition] /s [start date-time of tuition] /e " + + "start date-time of tuition] /l [location of tuition]'\n" + + "\t8. Delete tuition: 'delete tuition [tuition number]'\n\n" + + "\t9. List events (class, test, cca, tuition): 'list'\n\n" + + "\t10. Find relevant event(s): 'find [keyword(s)]'\n\n" + + "\t11. Add contact: 'add contact /s [subject] /n [name of contact person] /p [phone number]" + + " /e [email address]'\n" + + "\t12. Delete contact: 'delete contact [contact number]'\n" + + "\t13. List contact: 'list contact'\n" + + "\t14. Find contact: 'find contact [keyword(s)]'\n\n" + + "\t15. Take Mathematics quiz: 'quiz [no. of questions]'\n" + + "\t16. Add quiz question: 'add quiz /q [question] /o1 [option 1] /o2 [option 2] /o3 [option 3]" + + " /o4 [option 4] /a [option answer] /exp (explanation)'\n" + + "\t17. Delete quiz question: 'delete quiz [question number]'\n" + + "\t18. List quiz questions: 'list quiz'\n" + + "\t19. Find quiz questions: 'find quiz [keyword(s)]'\n" + + "\t20. Display former incorrect quiz question records: 'quiz record'\n\n" + + "\t21. Exit program: 'bye'\n\n" + + "\n\tNOTE:\n\t1. Please enter the date-time in the following format: YYYY-MM-DD " + + "[time in 24hr format]\n\te.g. 2020-08-19 1300\n\n" + + "\t2. For command 16 (Add quiz question), the 'explanation' field is OPTIONAL\n\n"; + + public static final String MESSAGE_BYE = "BYE BYE! SEE YOU NEXT TIME! :3"; + public static final String MESSAGE_EXTRA_HELP_PARAM = "OOPS! Were you trying to ask for help? Just enter 'help'!"; + public static final String MESSAGE_NO_EVENTS_FOUND = "Sorry but your searches yield no results!"; + public static final String MESSAGE_NO_QUIZZES_FOUND = "Sorry but there is not such a quiz in your list!"; +} diff --git a/src/main/java/seedu/duke/controller/ControlManager.java b/src/main/java/seedu/duke/controller/ControlManager.java new file mode 100644 index 0000000000..c766835255 --- /dev/null +++ b/src/main/java/seedu/duke/controller/ControlManager.java @@ -0,0 +1,220 @@ +package seedu.duke.controller; + +import seedu.duke.common.LogManager; +import seedu.duke.common.Messages; + +import seedu.duke.controller.command.Command; +import seedu.duke.controller.command.CommandFactory; +import seedu.duke.controller.parser.ModelExtractor; +import seedu.duke.controller.parser.ModelParser; +import seedu.duke.exception.EmptyParameterException; +import seedu.duke.exception.ExtraParameterException; +import seedu.duke.exception.IncompleteFindCommandException; +import seedu.duke.exception.IncompleteListCommandException; +import seedu.duke.exception.InvalidCommandException; +import seedu.duke.exception.InvalidHelpCommandException; +import seedu.duke.exception.InvalidModelException; +import seedu.duke.exception.MissingModelException; +import seedu.duke.exception.MissingParameterException; +import seedu.duke.exception.SwappedParameterException; +import seedu.duke.model.Model; +import seedu.duke.controller.parser.CommandParser; +import seedu.duke.controller.parser.CommandType; +import seedu.duke.controller.parser.ModelType; +import seedu.duke.model.ModelMain; +import seedu.duke.model.event.Event; +import seedu.duke.model.quiz.Quiz; +import seedu.duke.storage.contact.ContactStorageManager; +import seedu.duke.storage.event.EventStorageManager; +import seedu.duke.storage.quiz.QuizStorageManager; +import seedu.duke.ui.UserInterface; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.logging.Level; +import java.util.logging.Logger; + +import static seedu.duke.storage.StorageManager.CONTACT_FILE_NAME; +import static seedu.duke.storage.StorageManager.QUIZ_FILE_NAME; + +//@@author AndreWongZH +/** + * Manages the parsing of commands and models and the execution of commands. + */ +public class ControlManager { + private String userInput; + private final Model model; + private final UserInterface userInterface; + private final EventStorageManager eventStorageManager; + private final QuizStorageManager quizStorageManager; + private final ContactStorageManager contactStorageManager; + private static final Logger logger = LogManager.getLogManagerInstance().getLogger(); + + public ControlManager(String userInput, Model model, EventStorageManager eventStorageManager, + QuizStorageManager quizStorageManager, ContactStorageManager contactStorageManager) { + assert userInput != null : "ControlManager must not accept null userInput"; + this.userInput = userInput; + this.model = model; + userInterface = UserInterface.getInstance(); + this.eventStorageManager = eventStorageManager; + this.quizStorageManager = quizStorageManager; + this.contactStorageManager = contactStorageManager; + } + + /** + * Executes generated command class with a model. + * + * @return CommandType back to user interface to determine if program exits. + */ + public CommandType runLogic() { + CommandType commandType = null; + ModelType modelType = null; + ModelMain dataModel = null; + + try { + logger.log(Level.INFO, "Running controller logic now"); + trimWhitespace(); + logger.log(Level.INFO, "Extracting command"); + commandType = new CommandParser(userInput).extractCommand(); + final Command actionableCommand = new CommandFactory(commandType, userInput).generateActionableCommand(); + + if (commandType == CommandType.BYE) { + logger.log(Level.INFO, "User terminates program"); + return commandType; + } + + // Only extract model for certain commands(add, delete, list, find, quiz, done, set). + if (doesRequireModel(commandType)) { + logger.log(Level.INFO, "Extracting model"); + modelType = new ModelParser(userInput).extractModel(); + dataModel = new ModelExtractor(model, modelType).retrieveModel(); + } + checkInvalidModels(commandType, modelType); + + logger.log(Level.INFO, "Executing command"); + actionableCommand.execute(dataModel); + } catch (InvalidHelpCommandException e) { + userInterface.showToUser(Messages.MESSAGE_EXTRA_HELP_PARAM); + } catch (InvalidCommandException e) { + userInterface.showToUser(Messages.MESSAGE_INVALID_COMMAND); + } catch (InvalidModelException e) { + userInterface.showToUser(Messages.MESSAGE_INVALID_MODEL); + } catch (MissingParameterException e) { + userInterface.showToUser(String.format(Messages.MESSAGE_MISSING_PARAMETERS, e.getMessage())); + } catch (EmptyParameterException e) { + userInterface.showToUser(Messages.MESSAGE_EMPTY_PARAMETERS); + } catch (IncompleteListCommandException e) { + userInterface.showToUser(Messages.MESSAGE_INCOMPLETE_LIST_PARAMETERS); + } catch (MissingModelException e) { + userInterface.showToUser(Messages.MESSAGE_MISSING_MODEL); + } catch (IncompleteFindCommandException e) { + userInterface.showToUser(Messages.MESSAGE_INCOMPLETE_FIND_PARAMETERS); + } catch (ExtraParameterException e) { + userInterface.showToUser(Messages.MESSAGE_INVALID_EXTRA_PARAM); + } catch (IndexOutOfBoundsException e) { + userInterface.showToUser(Messages.MESSAGE_CONTACT_INDEX_OUT_OF_BOUNDS); + } catch (SwappedParameterException e) { + userInterface.showToUser(Messages.MESSAGE_SWAPPED_PARAMETERS); + } finally { + refreshEvents(); + refreshQuizzes(); + refreshContacts(); + } + + return commandType; + } + + /** + * Replaces all multiple spaces with only a single space and trims spaces at the start and end. + */ + private void trimWhitespace() { + userInput = userInput.trim().replaceAll(" +", " "); + } + + /** + * Checks if user entered an invalid model after the command. + * Commands such as add, delete and done cannot be paired with a model type event. + * + * @param commandType Command Type to be checked. + * @param modelType Model Type to be compared against. + * @throws InvalidModelException If add, delete or done is followed after event model. + */ + private void checkInvalidModels(CommandType commandType, ModelType modelType) throws InvalidModelException { + if ((commandType == CommandType.ADD || commandType == CommandType.DELETE || commandType == CommandType.DONE) + && modelType == ModelType.EVENT) { + throw new InvalidModelException(); + } + + if ((commandType == CommandType.FIND || commandType == CommandType.LIST) + && (modelType != ModelType.EVENT && modelType != ModelType.CONTACT + && modelType != ModelType.QUIZ && modelType != null)) { + throw new InvalidModelException(); + } + + if ((commandType == CommandType.SET) && (modelType != ModelType.HOURS)) { + throw new InvalidModelException(); + } + } + + /** + * Checks if a modelType is required to be extracted out. + * Help and Bye command need not require any model. + * + * @param commandType The command type to be checked. + * @return Boolean to inform a need for model extraction. + */ + private boolean doesRequireModel(CommandType commandType) { + boolean isAdd = commandType == CommandType.ADD; + boolean isDelete = commandType == CommandType.DELETE; + boolean isDone = commandType == CommandType.DONE; + boolean isList = commandType == CommandType.LIST; + boolean isFind = commandType == CommandType.FIND; + boolean isQuiz = commandType == CommandType.QUIZ; + boolean isSet = commandType == CommandType.SET; + + return isAdd || isDelete || isDone || isList || isFind || isQuiz || isSet; + } + + /** + * Saves the contacts data in ContactManager into contact.txt + */ + private void refreshContacts() { + try { + contactStorageManager.saveData(model.getContactManager().getContacts(), CONTACT_FILE_NAME); + } catch (IOException e) { + userInterface.showToUser(Messages.MESSAGE_STORAGE_INITIALIZATION_ERROR); + } + } + + //@@author durianpancakes + /** + * Obtains the latest Events from the data file. + */ + private void refreshEvents() { + ArrayList
handleHelp()
+ * Prints out all available features users can use. + * @exception InvalidHelpCommandException to inform the user if their help input is invalid. + */ + private void handleHelp() throws InvalidHelpCommandException { + String[] userInputs = userInput.split(" "); + if (userInputs.length == 1) { + logger.log(Level.INFO, "printing out all features users can use"); + userInterface.showToUser(Messages.MESSAGE_HELP); + } else { + logger.log(Level.WARNING, "invalid help command"); + throw new InvalidHelpCommandException(); + } + } +} diff --git a/src/main/java/seedu/duke/controller/command/ListCommand.java b/src/main/java/seedu/duke/controller/command/ListCommand.java new file mode 100644 index 0000000000..c02e9e05f2 --- /dev/null +++ b/src/main/java/seedu/duke/controller/command/ListCommand.java @@ -0,0 +1,50 @@ +package seedu.duke.controller.command; + +import seedu.duke.exception.ExtraParameterException; +import seedu.duke.exception.IncompleteListCommandException; +import seedu.duke.model.ModelMain; +import seedu.duke.model.contact.ContactManager; +import seedu.duke.model.event.EventManager; +import seedu.duke.model.quiz.QuizManager; + +//@@author AndreWongZH +/** + * Represents the command for listing events, quizzes and contacts. + */ +public class ListCommand extends Command { + public static final String INPUT_SPACE = " "; + public static final int INPUT_LENGTH_TWO = 2; + + public ListCommand(String userInput) { + super(userInput); + } + + /** + * Runs list command on corresponding model type. + * + * @param modelMain A model type to be modified or read. + * @throws IncompleteListCommandException If model is missing. + * @throws ExtraParameterException If user adds extra parameters to list contacts or quiz. + */ + @Override + public void execute(ModelMain modelMain) throws IncompleteListCommandException, ExtraParameterException { + if (modelMain == null) { + throw new IncompleteListCommandException(); + } + + String[] separatedInputs = userInput.split(INPUT_SPACE); + + if (modelMain instanceof EventManager) { + EventManager eventManager = (EventManager) modelMain; + eventManager.list(userInput); + } else if (modelMain instanceof QuizManager && separatedInputs.length == INPUT_LENGTH_TWO) { + QuizManager quizManager = (QuizManager) modelMain; + quizManager.list(); + } else if (modelMain instanceof ContactManager && separatedInputs.length == INPUT_LENGTH_TWO) { + ContactManager contactManager = (ContactManager) modelMain; + contactManager.list(); + } else { + throw new ExtraParameterException(); + } + } +} diff --git a/src/main/java/seedu/duke/controller/command/QuizCommand.java b/src/main/java/seedu/duke/controller/command/QuizCommand.java new file mode 100644 index 0000000000..8150a29ff0 --- /dev/null +++ b/src/main/java/seedu/duke/controller/command/QuizCommand.java @@ -0,0 +1,46 @@ +package seedu.duke.controller.command; + +import seedu.duke.exception.ExtraParameterException; +import seedu.duke.model.ModelMain; +import seedu.duke.model.quiz.QuizManager; + +import static seedu.duke.common.Messages.MESSAGE_MISSING_QUIZ_PARAM; +import static seedu.duke.common.Messages.MESSAGE_QUIZ_NON_NUMBER; + +//@@author AndreWongZH +/** + * Represents the command for taking and recording of quizzes. + */ +public class QuizCommand extends Command { + + public static final String INPUT_SPACE = " "; + public static final int MAX_PARAM_SIZE = 2; + public static final String INPUT_RECORD = "record"; + + public QuizCommand(String userInput) { + super(userInput); + } + + //@@author untitle4 + @Override + public void execute(ModelMain modelMain) throws ExtraParameterException { + QuizManager quizManager = (QuizManager) modelMain; + assert userInput != null; + String[] separatedInputs = userInput.trim().split(INPUT_SPACE); + if (separatedInputs.length > MAX_PARAM_SIZE) { + throw new ExtraParameterException(); + } + + try { + if (separatedInputs[1].toLowerCase().equals(INPUT_RECORD)) { + quizManager.recordedQuizzes(); + } else { + quizManager.checkQuizSizeValidity(separatedInputs); + } + } catch (ArrayIndexOutOfBoundsException e) { + System.out.println(MESSAGE_MISSING_QUIZ_PARAM); + } catch (NumberFormatException e) { + System.out.println(MESSAGE_QUIZ_NON_NUMBER); + } + } +} diff --git a/src/main/java/seedu/duke/controller/command/SetHoursCommand.java b/src/main/java/seedu/duke/controller/command/SetHoursCommand.java new file mode 100644 index 0000000000..d29e76afa2 --- /dev/null +++ b/src/main/java/seedu/duke/controller/command/SetHoursCommand.java @@ -0,0 +1,28 @@ +package seedu.duke.controller.command; + +import seedu.duke.exception.ExtraParameterException; +import seedu.duke.model.ModelMain; +import seedu.duke.model.config.ConfigManager; + +//@@author Aliciaho +public class SetHoursCommand extends Command { + public static final String INPUT_SPACE = " "; + + /** + * Runs if the execution requires passing the user input to the model. + * + * @param userInput String given from the user. + */ + protected SetHoursCommand(String userInput) { + super(userInput); + } + + @Override + public void execute(ModelMain modelMain) throws NumberFormatException, ExtraParameterException { + if (userInput.split(INPUT_SPACE).length > 2) { + throw new ExtraParameterException(); + } + ConfigManager configManager = (ConfigManager) modelMain; + configManager.editHours(); + } +} diff --git a/src/main/java/seedu/duke/controller/parser/CommandParser.java b/src/main/java/seedu/duke/controller/parser/CommandParser.java new file mode 100644 index 0000000000..ad167b47c7 --- /dev/null +++ b/src/main/java/seedu/duke/controller/parser/CommandParser.java @@ -0,0 +1,103 @@ +package seedu.duke.controller.parser; + +import seedu.duke.common.LogManager; +import seedu.duke.exception.ExtraParameterException; +import seedu.duke.exception.InvalidCommandException; +import seedu.duke.exception.MissingModelException; + +import java.util.logging.Level; +import java.util.logging.Logger; + +//@@author AndreWongZH +/** + * Represents the process of extracting out the commands. + */ +public class CommandParser { + public static final String INPUT_ADD = "add"; + public static final String INPUT_DELETE = "delete"; + public static final String INPUT_DONE = "done"; + public static final String INPUT_LIST = "list"; + public static final String INPUT_BYE = "bye"; + public static final String INPUT_HELP = "help"; + public static final String INPUT_FIND = "find"; + public static final String INPUT_SPACES = " "; + public static final int LENGTH_SINGLE_WORD = 1; + public static final String INPUT_QUIZ = "quiz"; + public static final int MAIN_COMMAND_INDEX = 0; + public static final String INPUT_SET = "set"; + + private final String[] separatedInputs; + + private CommandType commandType; + private static final Logger logger = LogManager.getLogManagerInstance().getLogger(); + + public CommandParser(String userInput) { + separatedInputs = userInput.toLowerCase().split(INPUT_SPACES); + commandType = null; + } + + /** + * Checks if the first word in the input string matches any command word. + * If it contains any command word, returns the respective commandType. + * + * @return CommandType corresponding to the command. + * @throws InvalidCommandException If no command word matches the first word. + * @throws MissingModelException If command is missing a model word. + * @throws ExtraParameterException If command contains extra parameters. + */ + public CommandType extractCommand() throws InvalidCommandException, MissingModelException, ExtraParameterException { + logger.log(Level.INFO, "Extracting command now..."); + + switch (separatedInputs[MAIN_COMMAND_INDEX]) { + case INPUT_ADD: + checkSingleLengthWord(); + commandType = CommandType.ADD; + break; + case INPUT_DELETE: + checkSingleLengthWord(); + commandType = CommandType.DELETE; + break; + case INPUT_DONE: + checkSingleLengthWord(); + commandType = CommandType.DONE; + break; + case INPUT_LIST: + commandType = CommandType.LIST; + break; + case INPUT_BYE: + if (separatedInputs.length > LENGTH_SINGLE_WORD) { + throw new ExtraParameterException(); + } + commandType = CommandType.BYE; + break; + case INPUT_HELP: + commandType = CommandType.HELP; + break; + case INPUT_FIND: + commandType = CommandType.FIND; + break; + case INPUT_QUIZ: + commandType = CommandType.QUIZ; + break; + case INPUT_SET: + checkSingleLengthWord(); + commandType = CommandType.SET; + break; + default: + throw new InvalidCommandException(); + } + + return commandType; + } + + /** + * Throws error if user input only have one word. + * + * @throws MissingModelException If user input only have one word. + */ + private void checkSingleLengthWord() throws MissingModelException { + if (separatedInputs.length == LENGTH_SINGLE_WORD) { + throw new MissingModelException(); + } + } +} diff --git a/src/main/java/seedu/duke/controller/parser/CommandType.java b/src/main/java/seedu/duke/controller/parser/CommandType.java new file mode 100644 index 0000000000..1ef2430079 --- /dev/null +++ b/src/main/java/seedu/duke/controller/parser/CommandType.java @@ -0,0 +1,9 @@ +package seedu.duke.controller.parser; + +//@@author AndreWongZH +/** + * Represents all possible commands available to the user. + */ +public enum CommandType { + ADD, DELETE, DONE, HELP, LIST, BYE, QUIZ, FIND, SET +} diff --git a/src/main/java/seedu/duke/controller/parser/DateTimeParser.java b/src/main/java/seedu/duke/controller/parser/DateTimeParser.java new file mode 100644 index 0000000000..037925255b --- /dev/null +++ b/src/main/java/seedu/duke/controller/parser/DateTimeParser.java @@ -0,0 +1,270 @@ +package seedu.duke.controller.parser; + +import seedu.duke.common.LogManager; + +import java.time.Duration; +import java.text.SimpleDateFormat; +import java.time.format.DateTimeParseException; +import java.util.ArrayList; +import java.util.Calendar; +import java.util.Date; +import java.text.ParseException; +import java.util.logging.Level; +import java.util.logging.Logger; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +//@@author Aliciaho +/** + * To configure the Date and Time of the events from yyyy-mm-dd HHMM format to dd suffix mm yyyy, hh:mm aa format. + */ +public class DateTimeParser { + + private static final Logger logger = LogManager.getLogManagerInstance().getLogger(); + public static final int MAX_HHMM = 2400; + + //@@author Aliciaho-reused + /** + * Get the suffix for each day. + * ref to: https://stackoverflow.com/questions/4011075/how-do-you-format-the-day-of-the-month-to-say-11th-21st-or-23rd-ordinal + * @param day day number of the month + * @return respective suffix for the day inputted + */ + private String getDayNumberSuffix(int day) { + assert day > 0; + assert day < 31; + + if (day >= 11 && day <= 13) { + return "th"; + } + switch (day % 10) { + case 1: + return "st"; + case 2: + return "nd"; + case 3: + return "rd"; + default: + return "th"; + } + } + + /** + * Convert time from HH:mm format to hh:mma format. + * + * @param calendar date time inputted + * @return the time in hh:mma format + */ + public String parseTime(Calendar calendar) { + logger.log(Level.INFO, "converting time to hh:mma"); + SimpleDateFormat sdf = new SimpleDateFormat("hh:mma"); + return sdf.format(calendar.getTime()); + } + + /** + * Convert day and month into MM-yyyy format. + * + * @param calendar date time inputted + * @return the date in MM-yyyy format + */ + public String parseDayAndMonth(Calendar calendar) { + logger.log(Level.INFO, "converting date to MM-yyyy"); + SimpleDateFormat sdf = new SimpleDateFormat("MM-yyyy"); + return sdf.format(calendar.getTime()); + } + + /** + * Convert a string input to date time format yyyy-MM-dd HHmm in Calendar form. + * + * @param string user input string + * @return calendar date time in yyyy-MM-dd HHmm in Calendar form + * @exception ParseException exception thrown when valid date and time is not inputted + */ + public Calendar convertStringToCalendar(String string) throws ParseException { + logger.log(Level.INFO, "converting string to calendar"); + checkDateTimeFormat(string); + SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HHmm"); + Calendar calendar = Calendar.getInstance(); + + Date date = sdf.parse(string); + calendar.setTime(date); + + return calendar; + } + + //@@author AndreWongZH + /** + * Validates if the datetime string is following the correct format (yyyy-MM-dd HHmm). + * + * @param string User input string. + * @throws ParseException If date is not according to the format. + */ + private void checkDateTimeFormat(String string) throws ParseException { + Pattern pattern = Pattern.compile("^\\d\\d\\d\\d-\\d\\d-\\d\\d (\\d\\d\\d\\d)$"); + Matcher matcher = pattern.matcher(string); + if (!matcher.find()) { + throw new ParseException("Invalid datetime", 0); + } + + if (Integer.parseInt(matcher.group(1)) > MAX_HHMM) { + throw new ParseException("Invalid datetime", 0); + } + } + + //@@author Aliciaho + /** + * Convert a string input to date time format yyyy-MM-dd in Calendar form. + * + * @param string user input string + * @return calendar date time in yyyy-MM-dd in Calendar form + * @exception ParseException exception thrown when valid date and time is not inputted + */ + public Calendar convertStringToCalendarByDate(String string) throws ParseException { + logger.log(Level.INFO, "converting string to calendar"); + SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd"); + Calendar calendar = Calendar.getInstance(); + + Date date = sdf.parse(string); + calendar.setTime(date); + + return calendar; + } + + /** + * Convert a Calendar form in date time format yyyy-MM-dd HHmm to String. + * + * @param calendar date time input in Calendar form + * @return calendar date time input in String form + */ + public String convertCalendarToString(Calendar calendar) { + logger.log(Level.INFO, "converting calendar to string"); + SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HHmm"); + + return sdf.format(calendar.getTime()); + } + + /** + * Add day suffix to date time string. + * + * @param calendar date time in calendar form + * @return date time string with day suffix + */ + public String obtainFormattedDateTimeString(Calendar calendar) { + logger.log(Level.INFO, "converting to MMM yyyy, hh:mma format"); + SimpleDateFormat sdf = new SimpleDateFormat("MMM yyyy, hh:mma"); + int dayOfMonth = calendar.get(Calendar.DAY_OF_MONTH); + logger.log(Level.INFO, "getting day suffix"); + String dayOfMonthString = dayOfMonth + getDayNumberSuffix(dayOfMonth); + String monthAndYearString = sdf.format(calendar.getTime()); + + return dayOfMonthString + " " + monthAndYearString; + } + + //@@author durianpancakes + /** + * Convert date time in Calendar form to dd-MM in String form. + * + * @param calendar date time in Calendar form + * @return dd-MM in String form + */ + public String obtainFormattedDayAndMonthString(Calendar calendar) { + logger.log(Level.INFO, "converting to dd-MM format"); + SimpleDateFormat sdf = new SimpleDateFormat("dd-MM"); + + return sdf.format(calendar.getTime()); + } + + //@@author Aliciaho + /** + * Check if two dates are equal. + * + * @param listInput date time input from List + * @param userInput date time input by user + * @return true if both dates are equal + * @throws DateTimeParseException if valid datetime is not inputted + */ + public boolean isDateEqual(Calendar listInput, Calendar userInput) throws DateTimeParseException { + logger.log(Level.INFO, "checking if dates are equal"); + int listDay = listInput.get(Calendar.DAY_OF_MONTH); + int userDay = userInput.get(Calendar.DAY_OF_MONTH); + int listMonth = listInput.get(Calendar.MONTH); + int userMonth = userInput.get(Calendar.MONTH); + int listYear = listInput.get(Calendar.YEAR); + int userYear = userInput.get(Calendar.YEAR); + return (listDay == userDay) + && (listMonth == userMonth) + && (listYear == userYear); + } + + /** + * Get the dates for this week. + * + * @return dateCalendars ArrayList containing the dates for this week + */ + public ArrayListClass class
+ * Contains details of contact. + */ +public class Contact { + private final String subject; + private final String name; + private final String phoneNumber; + private final String email; + + public Contact(String subject, String name, String phoneNumber, String email) { + this.subject = subject; + this.name = name; + this.phoneNumber = phoneNumber; + this.email = email; + } + + public String getSubject() { + return subject; + } + + public String getName() { + return name; + } + + public String getPhoneNumber() { + return phoneNumber; + } + + public String getEmail() { + return email; + } + + @Override + public String toString() { + return subject + " teacher: " + name + + "\nPhone number: " + phoneNumber + + "\nemail address: " + email + "\n"; + } + + public String convertToData() { + return subject + "|" + name + "|" + phoneNumber + "|" + email; + } +} diff --git a/src/main/java/seedu/duke/model/contact/ContactInteractable.java b/src/main/java/seedu/duke/model/contact/ContactInteractable.java new file mode 100644 index 0000000000..27e18270c0 --- /dev/null +++ b/src/main/java/seedu/duke/model/contact/ContactInteractable.java @@ -0,0 +1,23 @@ +package seedu.duke.model.contact; + +import seedu.duke.exception.MissingParameterException; +import seedu.duke.model.Interactable; + +//@@author AndreWongZH +/** + * Represents the public api methods for ContactManager that the controller can call. + */ +public interface ContactInteractable extends Interactable { + /** + * List all contacts in ContactManager. + */ + void list(); + + /** + * Find a list of contacts that matches with the keyword. + * + * @param userInput The input entered by the user. + * @throws MissingParameterException If keyword is missing from the command. + */ + void find(String userInput) throws MissingParameterException; +} diff --git a/src/main/java/seedu/duke/model/contact/ContactManager.java b/src/main/java/seedu/duke/model/contact/ContactManager.java new file mode 100644 index 0000000000..3f9db6746c --- /dev/null +++ b/src/main/java/seedu/duke/model/contact/ContactManager.java @@ -0,0 +1,212 @@ +package seedu.duke.model.contact; + +import seedu.duke.common.LogManager; +import seedu.duke.common.Messages; +import seedu.duke.exception.EmptyParameterException; +import seedu.duke.exception.MissingParameterException; +import seedu.duke.exception.SwappedParameterException; +import seedu.duke.model.ModelManager; +import seedu.duke.ui.UserInterface; + +import java.util.ArrayList; +import java.util.logging.Level; +import java.util.logging.Logger; + +public class ContactManager extends ModelManager implements ContactInteractable { + public static final int BEGIN_INDEX = 0; + public static final int END_INDEX = 1; + private static final int USER_INPUT_OFFSET = 12; + private static final int EMPTY_SIZE = 0; + private static final String INPUT_SPACE = " "; + private static final int S_INDEX = 1; + private static final int N_INDEX = 2; + private static final int P_INDEX = 3; + private static final int E_INDEX = 4; + private static final String S_PREFIX = "s"; + private static final String N_PREFIX = "n"; + private static final String P_PREFIX = "p"; + private static final String E_PREFIX = "e"; + private final ArrayListClass class
+ * Contains constructors, getters, toString and equals methods. + * + * @see EventClass#toString() + * @see EventClass#equals(Object) + */ +public class EventClass extends Event { + public static final String CLASS_ICON = "[CLASS]"; + + public EventClass(String description, Calendar start, Calendar end) { + super(description, start, end); + } + + public EventClass(String description, boolean isDone, Calendar start, Calendar end) { + super(description, start, end, isDone); + } + + @Override + public String getIcon() { + return CLASS_ICON; + } + + @Override + public String toString() { + String result; + DateTimeParser dateTimeParser = new DateTimeParser(); + result = CLASS_ICON + " " + super.toString() + " from " + + dateTimeParser.obtainFormattedDateTimeString(this.getStart()) + + " to " + dateTimeParser.obtainFormattedDateTimeString(this.getEnd()); + return result; + } + + @Override + public boolean equals(Object obj) { + EventClass otherEventClass = (EventClass) obj; + + return super.equals(obj) + && this.getStart().equals(otherEventClass.getStart()) + && this.getEnd().equals(otherEventClass.getEnd()); + } +} \ No newline at end of file diff --git a/src/main/java/seedu/duke/model/event/classlesson/EventClassManager.java b/src/main/java/seedu/duke/model/event/classlesson/EventClassManager.java new file mode 100644 index 0000000000..0860a98195 --- /dev/null +++ b/src/main/java/seedu/duke/model/event/classlesson/EventClassManager.java @@ -0,0 +1,243 @@ +package seedu.duke.model.event.classlesson; + +import java.text.ParseException; +import java.time.format.DateTimeParseException; +import java.util.ArrayList; +import java.util.Calendar; +import java.util.Collections; +import java.util.logging.Level; +import java.util.logging.Logger; + +import seedu.duke.controller.parser.DateTimeParser; +import seedu.duke.exception.EmptyParameterException; +import seedu.duke.exception.InvalidDateException; +import seedu.duke.exception.MissingParameterException; +import seedu.duke.exception.SwappedParameterException; +import seedu.duke.model.event.Event; +import seedu.duke.common.LogManager; +import seedu.duke.common.Messages; +import seedu.duke.model.event.EventDataManager; +import seedu.duke.model.event.EventManager; +import seedu.duke.ui.UserInterface; + +//@@author elizabethcwt + +/** + *ClassManager class
+ * Stores user's classes in an ArrayList of Event class, named classes. + *+ * Contains methods which allow: + *
-
+ *
- Attaining class list size + *
- Adding new classes into ArrayList + *
- Deleting classes from ArrayList + *
getClassListSize()
+ * Attains the size of the user's classes ArrayList. + * + * @return int - Classes ArrayList size + */ + public int getClassListSize() { + // Assertion to test assumption that ArrayList is not null + assert classes != null : "classes ArrayList should not be null"; + return classes.size(); + } + + /** + *addClass()
+ * Adds new class to classes ArrayList. + * + * @param userInput To take in the String consisting of the class name, start date-time and end date-time. + * @throws MissingParameterException if user input does not meet the requirements. + */ + @Override + public void add(String userInput) throws MissingParameterException, EmptyParameterException, + SwappedParameterException { + logger.log(Level.INFO, "initialising adding of a class"); + + // Checks if user input contains the 3 required parameters (/n, /s and /e) + if ((!userInput.contains("/n")) || (!userInput.contains("/s")) || (!userInput.contains("/e"))) { + logger.log(Level.WARNING, "either class description, start date-time or end date-time parameter is" + + " missing"); + throw new MissingParameterException("'/n', '/s' and '/e'"); + } + + // Splitting /n, /s and /e info. via a String array called classDetails + final String[] classDetails = userInput.trim().split("/"); + + validateSwappedParameters(classDetails); + + logger.log(Level.INFO, "splitting the user input into class description, start date-time and end " + + "date-time"); + String classDescription = classDetails[1].substring(1).trim().replaceAll("\\s+", " "); + String classStartDate = classDetails[2].substring(1).trim(); + String classEndDate = classDetails[3].substring(1).trim(); + + // Checking if any of the 3 required parameters are empty + if (classDescription.equals("") || classStartDate.equals("") || classEndDate.equals("")) { + logger.log(Level.WARNING, "either class description, start date-time or end date-time is" + + " missing"); + throw new EmptyParameterException(); + } + + try { + DateTimeParser dateTimeParser = new DateTimeParser(); + Calendar startCalendar = dateTimeParser.convertStringToCalendar(classStartDate); + Calendar endCalendar = dateTimeParser.convertStringToCalendar(classEndDate); + EventClass eventClass = new EventClass(classDescription, startCalendar, endCalendar); + + eventManager.checkValidTimeGiven(eventClass); + + // Checking if there are any events that clashes + ArrayListdeleteClass()
+ * Deletes a class from the classes ArrayList. + * + * @param userInputs To take in the class index of the classes to be deleted. + */ + @Override + public void delete(String[] userInputs) { + try { + // Tries to convert classIndex user input into an integer + int classIndex = Integer.parseInt(userInputs[2]); + + // Just to test if class index is valid - for exception use only + classes.get(classIndex - 1); + + userInterface.showToUser(Messages.MESSAGE_CLASS_DELETE_SUCCESS, + classes.get(classIndex - 1).toString()); + + // Deletes class from classes ArrayList + Event eventClass = classes.get(classIndex - 1); + classes.remove(classIndex - 1); + logger.log(Level.INFO, "deletion of class from ArrayList"); + getClassStatement(eventClass); + } catch (ArrayIndexOutOfBoundsException e) { + userInterface.showToUser(Messages.MESSAGE_CLASS_DELETE_ERROR_NO_NUMBER_GIVEN); + logger.log(Level.WARNING, "absence of class index for deletion"); + } catch (IndexOutOfBoundsException e) { + userInterface.showToUser(Messages.MESSAGE_INVALID_CLASS_INDEX); + logger.log(Level.WARNING, "invalid class index entered for deletion"); + } catch (NumberFormatException e) { + userInterface.showToUser(Messages.MESSAGE_CLASS_DELETE_ERROR_NON_NUMBER); + logger.log(Level.WARNING, "non-integer class index entered for deletion"); + } + } + + /** + *getClassStatement()
+ * Prints statement to update the user once class has been added or deleted. + */ + private void getClassStatement(Event event) { + String classStatement = getClassListSize() == 1 ? " class" : " classes"; + userInterface.showToUser("Now you have " + getClassListSize() + classStatement + " in the list."); + userInterface.showToUser(Messages.MESSAGE_TIME_LEFT_HEADER + eventManager.getTimeLeft(event)); + } + + /** + *setClassDone()
+ * Sets class as done. + * + * @param userInputs To take in the class index of the class to be set as done. + * @throws IndexOutOfBoundsException when user input is an invalid class index integer. + * @Deprecated This method should not be used, as the done feature has been removed from our application. + */ + @Override + public void setDone(String[] userInputs) throws IndexOutOfBoundsException { + int classNumber; + logger.log(Level.INFO, "initialising setting class as done"); + + try { + // Trying to convert user's input into an integer + classNumber = Integer.parseInt(userInputs[2]); + } catch (NumberFormatException e) { + logger.log(Level.WARNING, "wrong number format entered"); + userInterface.showToUser(Messages.MESSAGE_CLASS_DONE_ERROR_NON_NUMBER); + return; + } catch (ArrayIndexOutOfBoundsException e) { + userInterface.showToUser(Messages.MESSAGE_CLASS_DONE_ERROR_NO_NUMBER_GIVEN); + return; + } + + // Checking if user's input is a valid class index integer + if ((classNumber <= 0) || (classNumber > getClassListSize())) { + logger.log(Level.WARNING, "index entered is out of bounds"); + throw new IndexOutOfBoundsException(); + } + + // Sets class as done + final Event eventClass = classes.get(classNumber - 1); + classes.get(classNumber - 1).setDone(); + logger.log(Level.INFO, "set class as done from ArrayList"); + + userInterface.showToUser(Messages.MESSAGE_CLASS_DONE_SUCCESS, + " " + classes.get(classNumber - 1)); + + getClassStatement(eventClass); + } + + private void sortList() { + Collections.sort(classes); + } +} + diff --git a/src/main/java/seedu/duke/model/event/test/EventTest.java b/src/main/java/seedu/duke/model/event/test/EventTest.java new file mode 100644 index 0000000000..1f8c2e4d28 --- /dev/null +++ b/src/main/java/seedu/duke/model/event/test/EventTest.java @@ -0,0 +1,55 @@ +package seedu.duke.model.event.test; + +import seedu.duke.model.event.Event; +import seedu.duke.controller.parser.DateTimeParser; + +import java.util.Calendar; + +//@@author Aliciaho +/** + *Class EventTest
+ * Contains constructors, getters, toString and equals methods. + * + * @see EventTest#toString() + * @see EventTest#equals(Object) + */ +public class EventTest extends Event { + public static final String TEST_ICON = "[TEST]"; + + public EventTest(String description, Calendar start, Calendar end) { + super(description, start, end); + } + + public EventTest(String description, boolean isDone, Calendar start, Calendar end) { + super(description, start, end, isDone); + } + + @Override + public String getIcon() { + return TEST_ICON; + } + + /** + * Convert event to readable format for user in form of icon + description + converted date time. + * + * @return converted string + */ + @Override + public String toString() { + String result; + DateTimeParser dateTimeParser = new DateTimeParser(); + result = TEST_ICON + " " + super.toString() + " from " + + dateTimeParser.obtainFormattedDateTimeString(this.getStart()) + + " to " + dateTimeParser.obtainFormattedDateTimeString(this.getEnd()); + return result; + } + + @Override + public boolean equals(Object obj) { + EventTest otherEventTest = (EventTest) obj; + + return super.equals(obj) + && this.getStart().equals(otherEventTest.getStart()) + && this.getEnd().equals(otherEventTest.getEnd()); + } +} diff --git a/src/main/java/seedu/duke/model/event/test/EventTestManager.java b/src/main/java/seedu/duke/model/event/test/EventTestManager.java new file mode 100644 index 0000000000..c47fd57ab8 --- /dev/null +++ b/src/main/java/seedu/duke/model/event/test/EventTestManager.java @@ -0,0 +1,238 @@ +package seedu.duke.model.event.test; + +import seedu.duke.controller.parser.DateTimeParser; +import seedu.duke.exception.EmptyParameterException; +import seedu.duke.exception.InvalidDateException; +import seedu.duke.exception.MissingParameterException; +import seedu.duke.exception.SwappedParameterException; +import seedu.duke.model.event.Event; +import seedu.duke.common.LogManager; +import seedu.duke.common.Messages; +import seedu.duke.model.event.EventDataManager; +import seedu.duke.model.event.EventManager; +import seedu.duke.ui.UserInterface; + +import java.text.ParseException; +import java.time.format.DateTimeParseException; +import java.util.ArrayList; +import java.util.Calendar; +import java.util.Collections; +import java.util.logging.Level; +import java.util.logging.Logger; + +//@@author Aliciaho +/** + *TestManager test
+ * Stores user's tests in an ArrayList of Event Test, named tests. + *+ * Contains methods which allow: + *
-
+ *
- Attaining test list size + *
- Adding new tests into ArrayList + *
- Deleting tests from ArrayList + *
- Setting tests as {@code DONE} + *
getTestListSize()
+ * Attains the size of the user's tests ArrayList. + * @return int - tests ArrayList size + */ + public int getTestListSize() { + assert tests != null; + return tests.size(); + } + + /** + *addTest()
+ * Adds new test to tests ArrayList. + * @param userInput To take in the String consisting of the test name, start date-time and end date-time. + * @exception MissingParameterException exception thrown when parameter not entered + * @exception EmptyParameterException exception thrown when description is empty + */ + @Override + public void add(String userInput) throws EmptyParameterException, MissingParameterException, + SwappedParameterException { + logger.log(Level.INFO, "initialising adding of a test"); + + if ((!userInput.contains("/n")) || (!userInput.contains("/s")) + || (!userInput.contains("/e"))) { + logger.log(Level.WARNING, "no param is entered"); + throw new MissingParameterException("'/n', '/s' and '/e'"); + } + + userInput.replaceAll("\\s+",""); + final String[] testDetails = userInput.trim().split("/"); + + validateSwappedParameters(testDetails); + + logger.log(Level.INFO, "splitting user input into description, start date and end date"); + String testDescription = testDetails[1].substring(1).trim().replaceAll("\\s+"," "); + String testStartDate = testDetails[2].substring(1).trim(); + String testEndDate = testDetails[3].substring(1).trim(); + + if (testDescription.equals("") || testStartDate.equals("") + || testEndDate.equals("")) { + logger.log(Level.WARNING, "description/start date/end date is empty"); + throw new EmptyParameterException(); + } + + try { + DateTimeParser dateTimeParser = new DateTimeParser(); + Calendar startCalendar = dateTimeParser.convertStringToCalendar(testStartDate); + Calendar endCalendar = dateTimeParser.convertStringToCalendar(testEndDate); + + EventTest eventTest = new EventTest(testDescription, startCalendar, endCalendar); + + eventManager.checkValidTimeGiven(eventTest); + + // Checking if there are any events that clashes + ArrayListdeleteTest()
+ * Deletes a test from the tests ArrayList. + * @param userInputs To take in the test index of the test to be deleted. + * @exception IndexOutOfBoundsException exception thrown for invalid index + * @exception NumberFormatException exception thrown for wrong number format + * @exception ArrayIndexOutOfBoundsException exception thrown for empty description + */ + @Override + public void delete(String[] userInputs) throws IndexOutOfBoundsException { + int testNumber; + logger.log(Level.INFO, "initialising deleting of a test"); + + try { + testNumber = Integer.parseInt(userInputs[2]); + + userInterface.showToUser(Messages.MESSAGE_TEST_DELETE_SUCCESS, + tests.get(testNumber - 1).toString()); + Event eventTest = tests.get(testNumber - 1); + tests.remove(testNumber - 1); + logger.log(Level.INFO, "deleted test from ArrayList"); + + getTestStatement(eventTest); + } catch (NumberFormatException e) { + logger.log(Level.WARNING, "wrong number format entered"); + userInterface.showToUser(Messages.MESSAGE_TEST_DELETE_ERROR_NON_NUMBER); + } catch (ArrayIndexOutOfBoundsException e) { + logger.log(Level.WARNING, "no number was given"); + userInterface.showToUser(Messages.MESSAGE_TEST_DELETE_ERROR_NO_NUMBER_GIVEN); + } catch (IndexOutOfBoundsException e) { + logger.log(Level.WARNING, "wrong index inputted"); + userInterface.showToUser(Messages.MESSAGE_INVALID_TEST_INDEX); + } + } + + /** + *getTaskStatement()
+ * Prints statement to update the user once test has been added or deleted. + */ + private void getTestStatement(Event event) { + if ((getTestListSize() - 1 == 0) || (getTestListSize() == 0)) { + userInterface.showToUser("Now you have " + getTestListSize() + " test in the list."); + } else { + userInterface.showToUser("Now you have " + getTestListSize() + " tests in the list."); + } + userInterface.showToUser(Messages.MESSAGE_TIME_LEFT_HEADER + eventManager.getTimeLeft(event)); + } + + /** + *setTestDone()
+ * Sets test as done. + * @param userInputs To take in the test index of the test to be set as done. + * @exception IndexOutOfBoundsException when user input is an invalid test index integer. + * @exception NumberFormatException exception thrown for wrong number format + * @exception ArrayIndexOutOfBoundsException exception thrown for empty description + */ + @Override + public void setDone(String[] userInputs) throws IndexOutOfBoundsException { + int testNumber; + logger.log(Level.INFO, "initialising setting test as done"); + + try { + testNumber = Integer.parseInt(userInputs[2]); + } catch (NumberFormatException e) { + logger.log(Level.WARNING, "wrong number format entered"); + userInterface.showToUser(Messages.MESSAGE_TEST_DONE_ERROR_NON_NUMBER); + return; + } catch (ArrayIndexOutOfBoundsException e) { + logger.log(Level.WARNING, "no number was given"); + userInterface.showToUser(Messages.MESSAGE_TEST_DONE_ERROR_NO_NUMBER_GIVEN); + return; + } + + if ((testNumber <= 0) || (testNumber > getTestListSize())) { + logger.log(Level.WARNING, "index entered is out of bounds"); + throw new IndexOutOfBoundsException(); + } + + final Event eventTest = tests.get(testNumber - 1); + tests.get(testNumber - 1).setDone(); + logger.log(Level.INFO, "set test as done from ArrayList"); + + userInterface.showToUser(Messages.MESSAGE_TEST_DONE_SUCCESS, + " " + tests.get(testNumber - 1)); + + getTestStatement(eventTest); + } + + private void sortList() { + Collections.sort(tests); + } +} \ No newline at end of file diff --git a/src/main/java/seedu/duke/model/event/tuition/EventTuition.java b/src/main/java/seedu/duke/model/event/tuition/EventTuition.java new file mode 100644 index 0000000000..8542b504b6 --- /dev/null +++ b/src/main/java/seedu/duke/model/event/tuition/EventTuition.java @@ -0,0 +1,74 @@ +package seedu.duke.model.event.tuition; + +import seedu.duke.model.event.Event; + +import seedu.duke.controller.parser.DateTimeParser; + +import java.util.Calendar; + +//@@author durianpancakes +/** + * Class EventTuition. + * Contains constructors, getters, toString and equals methods. + */ +public class EventTuition extends Event { + public static final String TUITION_ICON = "[TUITION]"; + private final String location; + + /** + * Constructs a EventTuition with a default NOT DONE status. + * + * @param description String containing description of the EventTuition. + * @param start Calendar containing the start time of the EventTuition. + * @param end Calendar containing the end time of the EventTuition. + * @param location String containing the location of the EventTuition. + */ + public EventTuition(String description, Calendar start, Calendar end, String location) { + super(description, start, end); + this.location = location; + } + + /** + * Constructs a EventTuition with a given NOT DONE/DONE status. + * + * @param description String containing description of the EventTuition. + * @param isDone boolean containing the done status of the EventTuition. + * @param start Calendar containing the start time of the EventTuition. + * @param end Calendar containing the end time of the EventTuition. + * @param location String containing the location of the EventTuition. + */ + public EventTuition(String description, boolean isDone, Calendar start, Calendar end, String location) { + super(description, start, end, isDone); + this.location = location; + } + + @Override + public String getIcon() { + return TUITION_ICON; + } + + public String getLocation() { + return location; + } + + @Override + public String toString() { + String result; + DateTimeParser dateTimeParser = new DateTimeParser(); + result = TUITION_ICON + " " + super.toString() + " from " + + dateTimeParser.obtainFormattedDateTimeString(this.getStart()) + + " to " + dateTimeParser.obtainFormattedDateTimeString(this.getEnd()) + + " at " + this.location; + return result; + } + + @Override + public boolean equals(Object obj) { + EventTuition otherEventTuition = (EventTuition) obj; + + return super.equals(obj) + && this.getStart().equals(otherEventTuition.getStart()) + && this.getEnd().equals(otherEventTuition.getEnd()) + && this.location.equals(otherEventTuition.getLocation()); + } +} diff --git a/src/main/java/seedu/duke/model/event/tuition/EventTuitionManager.java b/src/main/java/seedu/duke/model/event/tuition/EventTuitionManager.java new file mode 100644 index 0000000000..9ecad0aaf9 --- /dev/null +++ b/src/main/java/seedu/duke/model/event/tuition/EventTuitionManager.java @@ -0,0 +1,260 @@ +package seedu.duke.model.event.tuition; + +import seedu.duke.controller.parser.DateTimeParser; +import seedu.duke.exception.EmptyParameterException; +import seedu.duke.exception.InvalidDateException; +import seedu.duke.exception.MissingParameterException; +import seedu.duke.exception.SwappedParameterException; +import seedu.duke.model.event.Event; +import seedu.duke.common.LogManager; +import seedu.duke.common.Messages; +import seedu.duke.model.event.EventDataManager; +import seedu.duke.model.event.EventManager; +import seedu.duke.ui.UserInterface; + +import java.text.ParseException; +import java.time.format.DateTimeParseException; +import java.util.ArrayList; +import java.util.Calendar; +import java.util.Collections; +import java.util.logging.Level; +import java.util.logging.Logger; + +//@@author durianpancakes +/** + * Manager class to manage EventTuition. + * + *+ * Contain methods which allow: + *
-
+ *
- Obtaining EventTuition list size + *
- Adding new EventTuition into ArrayList + *
- Deleting EventTuition from ArrayList + *
printQuizQuestion() Method
+ * Prints the quiz question for the user to answer. + * + * @return String - quiz question in given format. + */ + public String printQuizQuestion() { + return question + "\n\n" + + "(1) " + option1 + "\n" + + "(2) " + option2 + "\n" + + "(3) " + option3 + "\n" + + "(4) " + option4 + "\n\n"; + } + + /** + *printPostQuizQuestion() Method
+ * This method first checks if the relevant quiz question has an explanation in the quiz list text file. + *+ * Explanation absent - Prints: + *
-
+ *
- Quiz question + *
- Correctness logo of the question (correct or wrong) + *
- Question options + *
- User's answer (correct or wrong) + *
- Correct answer + *
+ * Explanation present - Prints: + *
-
+ *
- Quiz question + *
- Correctness logo of the question (correct or wrong) + *
- Question options + *
- User's answer (correct or wrong) + *
- Correct answer + *
- Explanation for the question + *
checkQuizSizeValidity() Method
+ * Checks if the number of questions in the quiz list is a valid integer (at least 1). + *+ * If quiz size is 0, displays message stating quiz list is empty. + *
+ * If the quiz size is a valid integer above 0, the takeQuiz() method is called. + *
+ * Catches ArrayIndexOutOfBoundsException when number of questions user wants to take in the quiz is too little + * (less than 1) or too much (more than quiz list size). + * + * @param separatedInputs To take in the number of questions the user would like to take for the quiz. + * @see QuizManager#takeQuiz(String[]) + */ + public void checkQuizSizeValidity(String[] separatedInputs) { + try { + noOfQues = Integer.parseInt(separatedInputs[1]); + assert noOfQues != 0 : "noOfQues should not be 0"; + + if (getQuizListSize() == 0) { + + // If user attempts to take a quiz, but the quiz list is empty + userInterface.showToUser(Messages.MESSAGE_EMPTY_QUIZ_LIST); + } else { + + // If user attempts to take a quiz, and the quiz list has at least 1 quiz question + takeQuiz(separatedInputs); + } + } catch (ArrayIndexOutOfBoundsException e) { + // To check the validity of user input before taking a quiz. + userInterface.showToUser(Messages.MESSAGE_INVALID_QUIZ_COMMAND); + } + } + + /** + *
takeQuiz() Method
+ * First checks if the user's input of the number of questions they want to take is valid. + *+ * If this value is invalid, calls the handleInvalidNumOfQuestions() method. + *
+ * If this value is valid, calls the handleValidNumOfQuestions() method, then increments the QUIZ_ATTEMPTS variable + * by 1. + * + * @param separatedInputs To take in the number of questions the user would like to take for the quiz. + * @see QuizManager#handleInvalidNumOfQuestions() + * @see QuizManager#handleValidNumOfQuestions() + */ + private void takeQuiz(String[] separatedInputs) { + + if (!((noOfQues > 0) && (noOfQues <= getQuizListSize()))) { + + // If user inputs an invalid number of questions to be attempted (NOT within range of 1 to quiz size) + handleInvalidNumOfQuestions(); + } else { + + // If user inputs a valid number of quiz questions (within range of 1 to quiz size) + handleValidNumOfQuestions(); + QUIZ_ATTEMPTS++; + } + } + + /** + *
handleValidNumOfQuestions() Method
+ * This method first calls the initialisingShufflingOfQuestions() method, which shuffles ALL the questions in the\ + * current quiz list. + *+ * Initialises a counter for counting the number of questions to be taken (questionCounter, which acts as a + * variable). + *
+ * Calls the testForValidInput() method until questionCounter is incremented to the value of the number of questions + * the user wants to take for the quiz. + *
+ * Initialises a counter to count the number of questions answered correctly by the user in the quiz. + *
+ * Clears or empties the ArrayLists: lastIncorrectQuizzes and lastIncorrectAnswers to refresh the arrayList for a + * new quiz attempt. + *
+ * Calls the storeCorrectnessOfQuizAnswer) method. + *
+ * Prints out the review of the questions, which consists of: + *
-
+ *
- Questions in the same order as the user has taken them in + *
- Correctness logo next to the start of each question (correct or wrong) + *
- User's answers (correct or wrong) + *
- Correct answer + *
- (Optional) Explanation to the question + *
- The total score the user has attained at the bottom of all the questions + *
+ * Lastly, this method empties the userAnswers and correctness ArrayLists + * + * @see QuizManager#initialisingShufflingOfQuestions() + * @see QuizManager#testForValidInput(int) + * @see QuizManager#storeCorrectnessOfQuizAnswer(int) + */ + private void handleValidNumOfQuestions() { + + // Assert that noOfQues is within a valid range + assert ((noOfQues > 0) && (noOfQues <= getQuizListSize())) : "noOfQues should be of a valid value, but" + + "it is invalid"; + + initialisingShufflingOfQuestions(); + + int questionCounter = 0; + + // Assert that questionCounter is less than noOfQues + assert (questionCounter < noOfQues) : "questionCounter should not be more than noOfQues"; + + while (questionCounter < noOfQues) { + + questionCounter = testForValidInput(questionCounter); + } + + // Initialising counter for correctly answered questions + int correctCounter = 0; + + // Clear arraylist to store incorrect quizzes + lastIncorrectQuizzes.clear(); + lastIncorrectAnswers.clear(); + + // Compare and note if students' answers are correct + correctCounter = storeCorrectnessOfQuizAnswer(correctCounter); + + for (int l = 0; l < noOfQues; l++) { + + // Assigning the correctness logo to be printed with questions post-quiz + assignCorrectnessLogo(l); + + // Print out all quiz questions, user's answers, correctness, correct answers and explanations + userInterface.showToUser("Question " + (l + INDEX_OFFSET) + ": ", + quizzes.get(quizIndexes.get(l)).printPostQuizQuestion(userAnswerManager + .getUserAnswers().get(l), correctnessLogo)); + } + + // Print out quiz score + userInterface.showToUser(Messages.print_quiz_score(correctCounter, noOfQues)); + + // Empty userAnswers ArrayList and correctness ArrayList + userAnswerManager.getUserAnswers().clear(); + userAnswerManager.getCorrectness().clear(); + } + + /** + *
assignCorrectnessLogo() Method
+ * Checks if user's answers for the quiz question matches the correct quiz answer for the same question stored in + * the quiz list text file. + * + * @param l A variable representing the index of relevant the quiz question at that point of time. + */ + private void assignCorrectnessLogo(int l) { + + // Assert that the correctness of the user's input is true in this if loop + assert ((userAnswerManager.getCorrectness().get(l).equals(true)) + || (userAnswerManager.getCorrectness().get(l).equals(false))) : "User's answer should either be correct" + + "or false for this question"; + + if (userAnswerManager.getCorrectness().get(l).equals(true)) { + + correctnessLogo = " [CORRECT ☺︎]"; + } else { + + // Assert that the correctness of the user's input is false in this else loop + assert (userAnswerManager.getCorrectness().get(l).equals(false)) : "User's answer should be" + + " incorrect for this question"; + + correctnessLogo = " [WRONG ☹︎]"; + } + } + + /** + *storeCorrectnessOfQuizAnswer() Method
+ * Stores whether the user's answers are correct or wrong for each question, in the getCorrectness ArrayList. + *+ * If the user's answer is correct, increment the correctCounter variable by 1. + * + * @param correctCounter The counter responsible for counting the number of correct answers by the user. + * @return correctCounter - For the purpose of calculating the user's quiz score. + */ + private int storeCorrectnessOfQuizAnswer(int correctCounter) { + for (int k = 0; k < noOfQues; k++) { + if (userAnswerManager.getUserAnswers().get(k).equals(quizzes.get(quizIndexes + .get(k)).getAnswer())) { + userAnswerManager.getCorrectness().add(true); + correctCounter++; + } else { + userAnswerManager.getCorrectness().add(false); + lastIncorrectQuizzes.add(quizzes.get(quizIndexes.get(k))); + lastIncorrectAnswers.add(userAnswerManager.getUserAnswers().get(k)); + } + quizzes.get(quizIndexes.get(k)).updateLastAccessed(); + } + return correctCounter; + } + + /** + *
initialisingShufflingOfQuestions() Method
+ * Shuffles ALL the quiz questions in the quiz list. + * + * @see Collections#shuffle(List) + */ + private void initialisingShufflingOfQuestions() { + // Create a new list of the question indexes + quizIndexes = new ArrayList<>(); + for (int i = 0; i < quizzes.size(); i++) { + quizIndexes.add(i); + } + + // Shuffle the question indexes + Collections.shuffle(quizIndexes); + } + + /** + *handleInvalidNumOfQuestions() Method
+ * Displays message corresponding to an invalid number of questions to take in a quiz. + */ + private void handleInvalidNumOfQuestions() { + + // Assert that noOfQues is NOT an acceptable value + assert (!((noOfQues > 0) && (noOfQues <= getQuizListSize()))) : "noOfQues should not be of a valid" + + " value, but it is"; + + // If user inputs an invalid number of quiz questions (not within range of 1 to quiz size) + userInterface.showToUser(Messages.invalid_number_of_quiz_questions_message(quizzes.size())); + } + + /** + *testForValidInput() Method
+ * This method first prints the first question to the user. + *+ * It then scans the user's answer. + *
+ * If the user's answer is: + *
-
+ *
- Empty - Displays message corresponding to a missing quiz question answer + *
- + * Not empty but invalid (such as a non-integer, or an integer that is not 1, 2, 3 or 4) - Displays message + * corresponding to an invalid quiz question answer + * + *
- Valid - Adds the user's answer to the getUserAnswers ArrayList, then increments the question counter + * variable by 1, to print the next question in the quiz + *
UserAnswerManager Class
+ * Contains userAnswers, which is an ArrayList of the user's integer answers. + *+ * Also contains correctness, another ArrayList of the boolean values of the user's answers for each question. + */ +public class UserAnswerManager { + private final ArrayList