From f8efa12fed760d6133a46a71990258f65cab818e Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 22:02:31 +0800 Subject: [PATCH 1/4] Rotate logic image --- docs/DeveloperGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 97133ff7393..cee509dbc36 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -220,7 +220,7 @@ How the `Logic` component works: The Sequence Diagram below illustrates the interactions within the `Logic` component for the `execute("delete_order 1")` API call.

- +
Figure 6: Delete Sequence Diagram (Deleting Order)

From a84000f09a4a9344f94e60e288b6d80fe8b20e20 Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 22:12:25 +0800 Subject: [PATCH 2/4] Rotate logic image back Break sequence diagram class --- docs/DeveloperGuide.md | 2 +- docs/diagrams/DeleteSequenceDiagram.puml | 6 +- docs/images/DeleteSequenceDiagram.svg | 376 +++++++++++------------ 3 files changed, 186 insertions(+), 198 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index cee509dbc36..97133ff7393 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -220,7 +220,7 @@ How the `Logic` component works: The Sequence Diagram below illustrates the interactions within the `Logic` component for the `execute("delete_order 1")` API call.

- +
Figure 6: Delete Sequence Diagram (Deleting Order)

diff --git a/docs/diagrams/DeleteSequenceDiagram.puml b/docs/diagrams/DeleteSequenceDiagram.puml index 3fdbb7f835c..e1aebaf7c15 100644 --- a/docs/diagrams/DeleteSequenceDiagram.puml +++ b/docs/diagrams/DeleteSequenceDiagram.puml @@ -4,8 +4,8 @@ box Logic LOGIC_COLOR_T1 participant ":LogicManager" as LogicManager LOGIC_COLOR participant ":TrackrParser" as TrackrParser LOGIC_COLOR -participant ":DeleteOrderCommandParser" as DeleteOrderCommandParser LOGIC_COLOR -participant "d:DeleteOrderCommand" as DeleteOrderCommand LOGIC_COLOR +participant ":DeleteOrder\nCommandParser" as DeleteOrderCommandParser LOGIC_COLOR +participant "d:DeleteOrder\nCommand" as DeleteOrderCommand LOGIC_COLOR participant ":CommandResult" as CommandResult LOGIC_COLOR end box @@ -48,7 +48,7 @@ deactivate TrackrParser LogicManager -> DeleteOrderCommand : execute() activate DeleteOrderCommand -DeleteOrderCommand -> Model : deleteItem(1, ModelEnum.ORDER) +DeleteOrderCommand -> Model : deleteItem(1,\nModelEnum.ORDER) activate Model Model --> DeleteOrderCommand diff --git a/docs/images/DeleteSequenceDiagram.svg b/docs/images/DeleteSequenceDiagram.svg index 3eabbb81293..b57e61622e7 100644 --- a/docs/images/DeleteSequenceDiagram.svg +++ b/docs/images/DeleteSequenceDiagram.svg @@ -1,194 +1,182 @@ -LogicModel:LogicManager:TrackrParser:Modelexecute("delete_order 1")parseCommand("delete_order 1"):DeleteOrderCommandParserparse("1")d:DeleteOrderCommanddddexecute()deleteItem(1, ModelEnum.ORDER):CommandResultresult + + + + + + Logic + + + Model + + + + + + + + + + + + + + + + + :LogicManager + + + :TrackrParser + + + :Model + + + + + + + + + + + + execute("delete_order 1") + + + + parseCommand("delete_order 1") + + + + + :DeleteOrder + + CommandParser + + + + + + parse("1") + + + + + d:DeleteOrder + + Command + + + + d + + + + d + + + + + + d + + + + execute() + + + + deleteItem(1, + + ModelEnum.ORDER) + + + + + + + :CommandResult + + + + + + result + + + + + From 28c276774570fa41e8275af0107b3106664f7836 Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 22:29:37 +0800 Subject: [PATCH 3/4] Update DG --- docs/DevOps.md | 2 +- docs/DeveloperGuide.md | 20 +++++++++++--------- docs/Documentation.md | 2 +- docs/SettingUp.md | 2 +- docs/Testing.md | 4 ++-- 5 files changed, 16 insertions(+), 14 deletions(-) diff --git a/docs/DevOps.md b/docs/DevOps.md index d2fd91a6001..c8033acae4a 100644 --- a/docs/DevOps.md +++ b/docs/DevOps.md @@ -73,7 +73,7 @@ Any warnings or errors will be printed out to the console. Here are the steps to create a new release. -1. Update the version number in [`MainApp.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java). +1. Update the version number in [`MainApp.java`](https://github.com/AY2223S2-CS2103T-W15-2/tp/blob/master/src/main/java/trackr/MainApp.java). 1. Generate a fat JAR file using Gradle (i.e., `gradlew shadowJar`). 1. Tag the repo with the version number. e.g. `v0.1` 1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you created. diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 97133ff7393..2ca532f0675 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -11,7 +11,7 @@ Trackr is a desktop application catered towards home businesses to track their _ :bulb: **Tip** -Texts that are in _italics_ are further explained in the [Glossary section](#glossary). +Texts that are in _italics_ are further explained in the [Glossary section](#46-glossary). @@ -65,7 +65,7 @@ You can click on the respective links below to read up on the relevant sections. * [4.5 Non-Functional Requirements](#45-non-functional-requirements) * [4.6 Glossary](#46-glossary) * [4.7 Planned Enhancements](#47-planned-enhancements) - * [4.7 Instructions for manual testing](#47-instructions-for-manual-testing) + * [4.8 Instructions for manual testing](#48-instructions-for-manual-testing) * [Launch and shutdown](#launch-and-shutdown) * [Adding a supplier](#adding-a-supplier) * [Adding a task](#adding-a-task) @@ -142,19 +142,19 @@ Given below is a quick overview of main components and how they interact with ea ### 2.1.1 Main components of the architecture -**`Main`** has two classes called [`Main`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/Main.java) and [`MainApp`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java). It is responsible for, +**`Main`** has two classes called [`Main`](https://github.com/AY2223S2-CS2103T-W15-2/tp/blob/master/src/main/java/trackr/Main.java) and [`MainApp`](https://github.com/AY2223S2-CS2103T-W15-2/tp/blob/master/src/main/java/trackr/MainApp.java). It is responsible for, * At app launch: Initializing the components in the correct sequence, and connecting them up with each other. * At shut down: Shutting down the components and invoking cleanup methods where necessary. -[**`Commons`**](#common-classes) represents a collection of classes used by multiple other components. +[**`Commons`**](#26-common-classes) represents a collection of classes used by multiple other components. The rest of the App consists of four components. -* [**`UI`**](#ui-component): The UI of the App. -* [**`Logic`**](#logic-component): The command executor. -* [**`Model`**](#model-component): Holds the data of the App in memory. -* [**`Storage`**](#storage-component): Reads data from, and writes data to, the hard disk. +* [**`UI`**](#22-ui-component): The UI of the App. +* [**`Logic`**](#23-logic-component): The command executor. +* [**`Model`**](#24-model-component): Holds the data of the App in memory. +* [**`Storage`**](#25-storage-component): Reads data from, and writes data to, the hard disk. ### 2.1.2 How the architecture components interact with each other @@ -529,6 +529,8 @@ The following activity diagram summarizes what happens when the user executes th The `ListXYZCommand` is an improved version of the original _AB3_ `ListCommand` by implementing into an abstract class - `ListItemCommand`. This reduces repeated lines of code and improves ease of implementation for future commands that require listing all item of the same data type. +
+ ## 3.6 SortXYZCommand
@@ -998,7 +1000,7 @@ we plan to simply tweak the implementation of `Deadline::isValidDeadline` for st -------------------------------------------------------------------------------------------------------------------- -## 4.7 Instructions for manual testing +## 4.8 Instructions for manual testing Given below are instructions to test the app manually. diff --git a/docs/Documentation.md b/docs/Documentation.md index 3e68ea364e7..599a0f24487 100644 --- a/docs/Documentation.md +++ b/docs/Documentation.md @@ -22,7 +22,7 @@ title: Documentation guide **Diagrams:** -* See the [_[se-edu/guides] **Using PlantUML**_](https://se-education.org/guides/tutorials/plantUml.html) +* See the guide [_[se-edu/guides] **Using PlantUML**_](https://se-education.org/guides/tutorials/plantUml.html) **Converting a document to the PDF format:** diff --git a/docs/SettingUp.md b/docs/SettingUp.md index a9541e291fd..ae0f3848737 100644 --- a/docs/SettingUp.md +++ b/docs/SettingUp.md @@ -45,4 +45,4 @@ If you plan to use Intellij IDEA (highly recommended): 1. **Learn the design** - When you are ready to start coding, we recommend that you get some sense of the overall design by reading about [Trackr’s architecture](DeveloperGuide.md#architecture). + When you are ready to start coding, we recommend that you get some sense of the overall design by reading about [Trackr’s architecture](DeveloperGuide.md#21-architecture). diff --git a/docs/Testing.md b/docs/Testing.md index 2c814e57045..c5c8b249e62 100644 --- a/docs/Testing.md +++ b/docs/Testing.md @@ -29,8 +29,8 @@ There are two ways to run tests. This project has three types of tests: 1. *Unit tests* targeting the lowest level methods/classes.
- e.g. `seedu.address.commons.StringUtilTest` + e.g. `trackr.commons.StringUtilTest` 1. *Integration tests* that are checking the integration of multiple code units (those code units are assumed to be working).
e.g. `trackr.storage.StorageManagerTest` -1. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.
+1. Hybrids of unit and integration tests. These test are checking multiple code units as well as how they are connected together.
e.g. `trackr.logic.LogicManagerTest` From 2531571a379921d02635ec37c859cc10d418df9a Mon Sep 17 00:00:00 2001 From: Liu Muchen Date: Mon, 10 Apr 2023 22:58:32 +0800 Subject: [PATCH 4/4] Update DG --- docs/DeveloperGuide.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 2ca532f0675..75659575557 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -998,6 +998,11 @@ Therefore, we plan to improve on this by only allowing users to key in deadlines Since both `OrderDeadline` and `TaskDeadline` extends the common class `Deadline` and `Deadline::isValidDeadline` is used to check the validity of both parameters, we plan to simply tweak the implementation of `Deadline::isValidDeadline` for stricter checks on deadlines entered. +**6.** Fix error in `find_order`. +Currently, `find_order` only works on the last field that is typed into the command. Hence, it is ignoring the other fields. +We plan to improve this feature to match `find_task` command where it would match the multiple fields if they are present in an `AND` format. +Specifically, `find_order q/2 d/01/01/2024` would list all orders that have quantity of `2` and a deadline of `01/01/2024`. + -------------------------------------------------------------------------------------------------------------------- ## 4.8 Instructions for manual testing