forked from AY2324S2-CS2113T-T09-1/tp
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into docs-dg-ppp
# Conflicts: # docs/DeveloperGuide.md
- Loading branch information
Showing
17 changed files
with
370 additions
and
135 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| @startuml | ||
| 'https://plantuml.com/sequence-diagram | ||
| actor User | ||
|
|
||
| participant "<<class>>\n :DailyMedicationManager" as DailyMedicationManager | ||
| participant "period:Period" as Period | ||
| participant "medication:Medication" as Medication | ||
|
|
||
| User -> DailyMedicationManager: addToSublists(medication) | ||
| activate DailyMedicationManager | ||
| loop all periods | ||
| DailyMedicationManager -> Period: gePeriod() | ||
| activate Period | ||
| return period | ||
| deactivate Period | ||
| DailyMedicationManager -> Medication: getDosage(), getName() | ||
| activate Medication | ||
| return dosage, name | ||
| deactivate Medication | ||
| DailyMedicationManager -> "dailyMedication:DailyMedication" as DailyMeds ** : new DailyMedication(name, dosage, period) | ||
| activate DailyMeds | ||
| return dailyMedication | ||
| deactivate DailyMeds | ||
| DailyMedicationManager -> DailyMedicationManager: addDailyMedication(dailyMedication) | ||
| activate DailyMedicationManager | ||
| return | ||
| participant "<<class>>\n :FileReaderWriter" as FileReaderWriter | ||
| DailyMedicationManager -> FileReaderWriter: saveDailyMedicationData(null) | ||
| activate FileReaderWriter | ||
| return true | ||
| end | ||
| DailyMedicationManager --> User | ||
| deactivate DailyMedicationManager | ||
| @enduml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| @startuml | ||
| 'https://plantuml.com/sequence-diagram | ||
|
|
||
| actor User | ||
|
|
||
| participant ":ListCommand" as LC | ||
| participant "ARGUMENT_LIST:ArgumentList" as AL | ||
|
|
||
| User -> LC ** : new \nListCommand\n(argument) | ||
| activate LC | ||
| LC -> AL: parse(argument) | ||
| activate AL | ||
| AL -> "parsedArguments:ArgumentParser" as AP ** : new ArgumentParser(argument) | ||
| activate AP | ||
| return argumentParser.parsedArguments | ||
| return parsedArguments | ||
| deactivate AP | ||
| deactivate AL | ||
|
|
||
| participant ":ArgumentName" as AN | ||
| participant "<<class>>\n :MedicationManager" as MM | ||
| participant "<<class>>\n :DailyMedicationManager" as DM | ||
| participant "<<class>>\n :Ui" as UI | ||
| LC -> AN: parsedArguments.get() | ||
| return listTypeString | ||
| LC -> LC: execute() | ||
| activate LC | ||
| alt listTypeString.equals("all") | ||
| LC -> MM: printAllMeds() | ||
| activate MM | ||
| return | ||
| deactivate MM | ||
| else listTypeString.equals("today") | ||
| LC -> DM: printTodayMeds() | ||
| activate DM | ||
| return | ||
| deactivate DM | ||
| else else | ||
| LC -> UI: showErrorMessage("Unknown list type") | ||
| activate UI | ||
| return | ||
| deactivate UI | ||
| end | ||
| LC --> LC | ||
| deactivate LC | ||
| LC --> User | ||
| deactivate LC | ||
| @enduml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,52 +1,53 @@ | ||
| @startuml | ||
|
|
||
| actor User | ||
| actor User #e67678 | ||
| title View Command Sequence Diagram | ||
| participant ":ViewCommand" as ViewCommand | ||
| participant ":ArgumentList" as ArgumentList | ||
| participant "ARGUMENT_LIST:ArgumentList" as ArgumentList | ||
| participant ":ArgumentParser" as ArgumentParser | ||
| participant ":ArgumentName" as ArgumentName | ||
| participant "<<class>>\n MedicationManager" as MedicationManager | ||
| participant "<<class>>\n Ui" as Ui | ||
|
|
||
| User --> ViewCommand: new ViewCommand(args) | ||
| User --> ViewCommand ** : new ViewCommand(argument) | ||
| activate ViewCommand | ||
| ViewCommand -> ArgumentList: parse(args) | ||
|
|
||
| activate ArgumentList | ||
| ArgumentList -> ArgumentParser: parse(args) | ||
| deactivate ArgumentList | ||
|
|
||
| activate ArgumentParser | ||
| ArgumentParser --> ViewCommand: return parsedArgs | ||
| ViewCommand -> ArgumentList: parse(argument) | ||
| activate ArgumentList #e67678 | ||
| ArgumentList -> ArgumentParser ** : New ArgumentParser(argument) | ||
| activate ArgumentParser #a67671 | ||
| ArgumentParser --[#red]> ArgumentList: parsedArguments | ||
| deactivate ArgumentParser | ||
| ArgumentList --[#red]> ViewCommand: parsedArguments | ||
| deactivate ArgumentList | ||
|
|
||
| alt #transparent oneParsedArgs | ||
| ViewCommand -> ViewCommand: execute(medication) | ||
| activate ViewCommand #65c2a6 | ||
| ViewCommand -> ViewCommand: <font color=blue> execute(medication) | ||
| activate ViewCommand #65c2a6 | ||
|
|
||
| ViewCommand -> MedicationManager: printSpecificMedication(medication) | ||
| activate MedicationManager #d192d0 | ||
| MedicationManager -> MedicationManager: getMedication(medication) | ||
| alt oneParsedArgument | ||
| ViewCommand -> MedicationManager: printSpecificMedication(medication) | ||
| activate MedicationManager #d192d0 | ||
| MedicationManager -> MedicationManager: getMedication(medication) | ||
|
|
||
| MedicationManager -> Ui: printSpecificMed(medicationDetails) | ||
| activate Ui #c6d67e | ||
| Ui --[#red]> MedicationManager: <font color=red><b>return | ||
| MedicationManager --[#red]> ViewCommand: <font color=red><b>return | ||
| deactivate MedicationManager | ||
| MedicationManager -> Ui: <font color=blue> printSpecificMed(medicationDetails) | ||
| activate Ui #c6d67e | ||
| Ui --[#red]> MedicationManager: <font color=red> | ||
| MedicationManager --[#red]> ViewCommand: <font color=red> | ||
| deactivate MedicationManager | ||
|
|
||
| ViewCommand -> Ui: showSuccessMessage("Medication details has been retrieved") | ||
| Ui --[#red]> ViewCommand: <font color=red><b>return | ||
| deactivate Ui | ||
| ViewCommand -> Ui: showSuccessMessage("Medication details has been retrieved") | ||
| Ui --[#red]> ViewCommand: <font color=red> | ||
| deactivate Ui | ||
|
|
||
| else #transparent more\nThanOne\nParsed\nArgs | ||
| ViewCommand -> Ui: showErrorMessage("You can only have one flag!") | ||
| activate Ui #c6d67e | ||
| Ui --[#blue]> ViewCommand: <font color=blue><b>return | ||
| deactivate Ui | ||
| end | ||
| else #transparent more\nThanOne\nParsed\nArgs | ||
| ViewCommand -> Ui: showErrorMessage("You can only have one flag!") | ||
| activate Ui #c6d67e | ||
| Ui --[#red]> ViewCommand: <font color=red> | ||
| deactivate Ui | ||
| end | ||
|
|
||
| ViewCommand --[#blue]> ViewCommand | ||
| deactivate ViewCommand | ||
| User <-- ViewCommand | ||
| User <[#red]-- ViewCommand | ||
| deactivate ViewCommand | ||
|
|
||
| @enduml |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,101 @@ | ||
| # Eric Sim Chong Li - Project Portfolio Page | ||
|
|
||
| ## MediTracker | ||
|
|
||
| ## Overview | ||
| The following contains my contribution summary and pull request reviews. | ||
| The following contains my contribution summary and pull request reviews on our product, MediTracker. | ||
| MediTracker is a command-line interface application where it allows users to keep track of their | ||
| daily medications and get reminded of low quantity and nearing expiry medications.<br> | ||
|
|
||
| <!-- TOC --> | ||
| * [Overview](#overview) | ||
| * [Summary of Contributions](#summary-of-contributions) | ||
| * [Code Contributed](#code-contributed) | ||
| * [Enhancements implemented](#enhancements-implemented) | ||
| * [Developer Guide Contributions](#developer-guide-contributions) | ||
| * [User Guide Contributions](#user-guide-contributions) | ||
| * [Review/mentoring contributions](#reviewmentoring-contributions) | ||
| * [Team-based tasks and contributions beyond the project team](#team-based-tasks-and-contributions-beyond-the-project-team) | ||
| <!-- TOC --> | ||
|
|
||
| <br> | ||
|
|
||
| <div style="page-break-after: always;"></div> | ||
|
|
||
| ### Summary of Contributions | ||
| - Created relevant milestones labels | ||
| - Map some of the user stories to issues | ||
| - Reviewed multiple pull requests (PR) | ||
| - Added guide on how to improve on ListCommand in the developer guide | ||
| - Issue #49: list all medications from 'MedicationManager' | ||
| - Issue #15: Show detailed view of a medication | ||
| - Issue #162: Update view feature to have more supported flags | ||
| - Issue #175: Fix `IndexOutOfBoundsException` for `view` command (Related issues: #171, #169, #165, #152) | ||
| - Issue #153: Fix `NumberFormatException` for `view` command | ||
| - Issue #181: Fix unaligned medication list output (Related issue: #166) | ||
| - Issue #214: Fix User Guide to explicitly state the requirements for every flag | ||
| - Issue #202: Fix Expiry date issues (Related Issued: #192, #188, #187, #186, #161) | ||
| - Created relevant tags and milestones. | ||
| - Map some of the user stories to issues. | ||
| - Reviewed multiple pull requests (PR). | ||
| - Added guide on how to improve on ListCommand and ViewCommand in the developer guide. | ||
| - [PR #49:](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/49) List all medications from 'MedicationManager'. | ||
| - [PR #15:](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/127) Show detailed view of a medication. | ||
| - [PR #206](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/206) | ||
| - Update view feature to have more supported flags. | ||
| - Fix `IndexOutOfBoundsException` for `view` command <br> | ||
| (Related issues: #171, #169, #165, #152). | ||
| - Fix `NumberFormatException` for `view` command. | ||
| - Fix unaligned medication list output (Related issue: #166). | ||
| - [PR #214:](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/214) | ||
| Fix User Guide to explicitly state the requirements for every flag. | ||
| - [PR #202:](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/220) | ||
| Fix Expiry date issues (Related Issues: #192, #188, #187, #186, #161).<br> | ||
|
|
||
| ### Code Contributed | ||
| Here is the [RepoSense link](https://nus-cs2113-ay2324s2.github.io/tp-dashboard/?search=e0958902&breakdown=true) | ||
| of my code contributions.<br> | ||
|
|
||
| ### Enhancements implemented | ||
| - Implemented the ListCommand to query relevant fields in the Medication Manager | ||
| containing the medication list. e.g `list -t all`. | ||
| - Implemented the ViewCommand to display all relevant fields of a medication, | ||
| where it supports different flags with its argument. e.g `view -e 2025`. | ||
| - Performed JUnit tests on the methods used in List and View Commands. | ||
| - Ensured that the User Guide is consistent across all commands/features.<br> | ||
|
|
||
| ### Developer Guide Contributions | ||
| - Information on how ListCommand works and how to use it. | ||
| - Relevant user stories done in milestone v1.0 | ||
| - Information on how ListCommand and ViewCommand works, and how to use it. | ||
| - Included relevant diagrams to illustrate how ListCommand and ViewCommand works. | ||
| - Relevant user stories done in milestones.<br> | ||
|
|
||
| ### User Guide Contributions | ||
| - Updated user guide to include listing of all medications | ||
| - Updated user guide to include viewing of specific medications | ||
| - Ensured that the formatting, alignment, and consistency is in place across all pages | ||
| - Updated user guide to include listing of all medications. | ||
| - Updated user guide to include viewing of specific medications. | ||
| - Ensured that the formatting, alignment, and consistency is in place across all pages. | ||
|
|
||
| ### PR Reviews | ||
| #9, #18, #20, #23, #53, #73, #75, #84, #88, | ||
| #89, #90, #95, #98, #115, #116, #126, #127, | ||
| #129, #134, #139, #210, #212, #213, #238, | ||
| #239, #243 | ||
| <br> | ||
|
|
||
| ### Team-based tasks | ||
| - Created relevant tags and milestones. | ||
| <div style="page-break-after: always;"></div> | ||
|
|
||
| ### Review/mentoring contributions | ||
| - [#9](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/17) Add JavaDoc and other documentation to Ui. | ||
| - [#18](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/18) Created class to test for searching medication from external database. | ||
| - [#20](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/20) feat: Mark medication taken. | ||
| - [#23](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/23) Misc: change package name and update PR Template. | ||
| - [#53](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/53) Add medication info into daily. | ||
| - [#73](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/73) refactor: Modify Ui to be static. | ||
| - [#75](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/75) feat: More flags for Add command, Exception Handling and Double casting | ||
| - [#84](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/84) Separate daily medications to sub lists. | ||
| - [#88](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/88) Update list all medication. | ||
| - [#89](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/89) DG: Adds DG from Lin Htet. | ||
| - [#90](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/90) DG: Add DG by kyuichyi. | ||
| - [#95](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/95) feat: Add take untake enhancements. | ||
| - [#98](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/98) Update style: styling update. | ||
| - [#115](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/115) test: add tests for search command functionality | ||
| - [#116](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/116) Obj for each sub list. | ||
| - [#126](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/126) refactor: Remove prompt from Argument classes. | ||
| - [#127](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/127) Query specific medication. | ||
| - [#129](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/129) fix(bug): ModifyCommand handle erroneous data and fix AddCommand error handling. | ||
| - [#134](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/134) Updates UG: Lin Htet. | ||
| - [#139](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/139) docs: Update DG for Add command with sequence diagram. | ||
| - [#210](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/210) fix: Fix Add Command PE-D issues. | ||
| - [#212](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/212) docs: Update Dev Guide based on comments. | ||
| - [#213](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/213) Improve logging: Song Xuan. | ||
| - [#238](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/238) docs: Update search in UG. | ||
| - [#239](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/239) style: fix style. | ||
| - [#243](https://github.com/AY2324S2-CS2113T-T09-1/tp/pull/243) test: Add modify tests. | ||
|
|
||
| ### Team-based tasks and contributions beyond the project team | ||
| - Created relevant tags and milestones to have a soft and hard deadline. | ||
| - Answered some questions in the forum and encouraged others to join and verify. | ||
| - Ensured that assertions is enabled in Gradle. | ||
| - Polish up the consistency of sections in User . | ||
| - Polish up the consistency of sections in the User Guide.<br> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.