[CS2113-F12-2] EquipmentManager

.github/workflows/gradle.yml

@@ -32,19 +32,4 @@ jobs:
 
       - name: Build and check with Gradle
         run: ./gradlew check
-
-      - name: Perform IO redirection test (*NIX)
-        if: runner.os == 'Linux'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        run: ./runtest.sh
-
-      - name: Perform IO redirection test (MacOS)
-        if: always() && runner.os == 'macOS'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        run: ./runtest.sh
-
-      - name: Perform IO redirection test (Windows)
-        if: always() && runner.os == 'Windows'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        shell: cmd
-        run: runtest.bat
+

.gitignore

@@ -15,3 +15,6 @@ bin/
 
 /text-ui-test/ACTUAL.txt
 text-ui-test/EXPECTED-UNIX.TXT
+META-INF/MANIFEST.MF
+src/main/java/META-INF/MANIFEST.MF
+/equipments.json

build.gradle

@@ -12,6 +12,7 @@ repositories {
 dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.0'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.5.0'
+    implementation 'com.google.code.gson:gson:2.9.0'
 }
 
 test {
@@ -43,4 +44,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -1,9 +1,7 @@
 # About us
 
-Display | Name | Github Profile | Portfolio 
---------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+Display |     Name     |             Github Profile              | Portfolio
+--------|:------------:|:---------------------------------------:|:---------:
+![](https://via.placeholder.com/100.png?text=Photo) | Bryan Christopher | [Github](https://github.com/Bryan-BC) | [Portfolio](docs/team/bryanchristopher.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Bai Shun Yao | [Github](https://github.com/shunyao643) | [Portfolio](docs/team/shunyao.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Yu Hao | [Github](https://github.com/yuhaochua) | [Portfolio](docs/team/yuhao.md)

docs/DeveloperGuide.md

@@ -1,14 +1,123 @@
-# Developer Guide
+# Table of Content
+
+- [Acknowledgements](#acknowledgements)
+- [Design and Implementation](#design-and-implementation)
+  - [Architecture](#architecture)
+  - [Parser](#parser)
+  - [Update feature](#update-feature)
+  - [EquipmentManager](#equipmentmanager)
+- [Product scope](#product-scope)
+  - [Target user profile](#target-user-profile)
+  - [Value proposition](#value-proposition)
+- [User stories](#user-stories)
+- [NonFunctional requirements](#nonfunctional-requirements)
+- [Glossary](#glossary)
+- [Instructions for manual testing](#instructions-for-manual-testing)
 
 ## Acknowledgements
 
 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
 
-## Design & implementation
+Our project could not have been possible without the prior work of the following:
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+- [SE-EDU project team](https://se-education.org/docs/team.html) for their work on [AddressBook Level 3](https://github.com/se-edu/addressbook-level3), for which we referenced ideas as well as code snippets.
+- Google's [GSON Java library](https://github.com/google/gson) for which we used to load and save our data files.
+- Members of the [AY2122S2-CS2113-F10-2 team](https://github.com/nus-cs2113-AY2122S2) for pointing out the possibility of and requesting permission to make use of the above GSON library.  
 
+--------------------------------------------------------------------------------------------------------------------
+## **Design and Implementation**
 
+This section describes some noteworthy details on how certain features are designed and implemented.
+
+### Architecture
+
+Our design draws significant inspiration from the implementation of AddressBook Level 3 (henceforth AddressBook). 
+As the program was initially conceptualised to be a text-based command-line interface, heavy consideration was given
+to the design and user interactions when it came to the text input to be parsed by the user. 
+As such, we referenced AddressBook to segment the program into **`Parser`**, **`Command`** and **`Equipment`** classes.
+
+**Main components of the architecture**
+
+- **`Duke`** is the Main class and entry-point for the program. 
+- **`Parser`** serves as the first filter to split raw text input and pass in arguments to the **`Command`** for further processing.
+- **`Command`**, together with its various subclasses serve as specific implementations to pass the arguments taken in to the various methods of the **`EquipmentManager`** class.
+- **`EquipmentManager`** keeps track of actual **`Equipment`** instances created by our program.
+- **`Storage`** performs File I/O functions.
+
+### Parser
+
+**`Parser`** is the first filter for text inputs read to the user. 
+As alluded to prior, one major consideration was to build it in a manner that can parse text input as effectively as possible. In considering text input, we divided the parsing into the following segments:
+
+#### `commandWord` `argumentTag/argumentValue` `argumentTag/argumentValue` `...`
+
+To dispatch `argumentTag/argumentValue` strings to the correct **`Command`** class, the following logic is employed throughout **`Parser`** by **`parseCommand`**.
+
+**1. Parse the correct Command Word**
+
+**`splitCommandTerm`** splits the input string upon the first space. 
+The first substring is used to decide which **`Command`** to dispatch while the second is used for its arguments.
+In the case where a second substring is not required, as in the case of **`help`** and **`list`**, a null String is used.
+
+**2. Split Arguments**
+
+For simpler command words such as **`delete`** and **`check`**, only one pair of **`argumentType`** and **`argumentValue`** were required. 
+As such, these will be passed in directly to their **`Command`** classes without a **`argumentType`** pair.
+
+More complex command words such as **`add`** and **`update`** necessitated multiple arguments.
+To implement this while ensuring that multi-word strings are acceptable input, **`extractArguments`** was implemented. 
+Without specifically explaining the main regular expression ([details here](https://regex101.com/r/gwjHWD/3)), the approach sought to match **`argumentTag/argumentValue`** pairs with a positive lookahead. 
+The final argument pair will then be extracted using a separate regex. 
+Together, this ensured that all argument pairs can be effectively parsed and dispatched to each **`Command`** class.
+
+Throughout the `Parser` implementation, exceptions were used to return `IncorrectCommand` classes that can be used to pass error messages to the user. These will be discussed in the following segments.
+
+### Update feature
+
+#### Current Design and Implementation
+
+The update feature is facilitated by `UpdateCommand`. It extends `ModificationCommand` and implements the following operations:
+
+* `UpdateCommand#generateUpdatePairs()` — Generates pairs of attributes and their update values.
+* `VersionedAddressBook#generateUpdateString()` — Generates sString with details of the update executed.
+
+Given below is an example usage scenario and how the update feature behaves at each step.
+
+Step 1. The user adds an equipment to the system with the help of the `add` command. The added equipment has the following attributes shown below.
+
+![equipment0](images/equipment0.png)
+
+Step 2. The user executes `update s/S1404115ASF n/SpeakerC c/2000 pd/2022-01-29` to update equipment with serial number S1404115ASF. `Parser#parseCommand` is called from `Duke` to parse the user's input.
+
+Step 3. The parser recognises that an `UpdateCommand` is required, and the UpdateCommand is prepared to return to `Duke`. In the constructor of `UpdateCommand`, `prepareModification` is called to set the values of the attributes to be updated. The other attributes are set to null by default.
+
+Step 4. `UpdateCommand#execute` is run to process the update. If the serialNumber attribute is null, a `CommandResult` with a `MISSING_SERIAL_NUMBER` output string will be returned. Otherwise, `EquipmentManager#updateEquipment` is called.
+
+Step 5. If the update was successful, a `CommandResult` with success message will be returned, else a `CommandResult` with `UPDATE_FAILURE_MESSAGE` will be returned. Upon successful update, the object should be updated with the new attributes as shown in the diagram below.
+
+![equipment1](images/equipment1.png)
+
+The *Sequence Diagram* below shows how the objects/classes interact with each other in the case of an update command being issued by the user.
+
+![sequenceDiagram](images/sequenceDiagram.png)
+
+Step 6. It is not shown in the sequence diagram but ultimately when the CommandResult is returned to `Duke`, the output of the `CommandResult` gets printed out and displayed to the user.
+
+### EquipmentManager
+
+The **`EquipmentManager`**, as the name suggests, manages all the equipment that the user has.
+When initialised, it creates a HashMap called **`equipmentList`** which is used to save the equipment with their serial numbers as their keys.
+The **`EquipmentManager`** has several methods which allow manipulation to said HashMap such as **`addEquipment`**, **`checkEquipment`**, **`listEquipment`**, **`updateEquipment`**, and **`deleteEquipment`**.
+These methods are used during the execution of each of the **`Command`** class.
+* **`addEquipment`** — Adds an **`Equipment`** to the **`equipmentList`**.
+* **`checkEquipment`** — Returns the **`Equipment`** in **`equipmentList`** that has the given **`itemName`**.
+* **`listEquipment`** — Returns an ArrayList of all the **`Equipment`** in **`equipmentList`**.
+* **`updateEquipment`** — Updates the specified **`Equipment`** with the corresponding updates given in the ArrayList of pairs.
+* **`deleteEquipment`** — Deletes the specified **`Equipment`**.
+
+The **`EquipmentManager`** is implemented as the main storage unit of all the equipments during the execution of the program.
+
+--------------------------------------------------------------------------------------------------------------------
 ## Product scope
 ### Target user profile
 
@@ -18,21 +127,25 @@
 
 {Describe the value proposition: what problem does it solve?}
 
+--------------------------------------------------------------------------------------------------------------------
 ## User Stories
 
 |Version| As a ... | I want to ... | So that I can ...|
 |--------|----------|---------------|------------------|
 |v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
 |v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
 
-## Non-Functional Requirements
+--------------------------------------------------------------------------------------------------------------------
+## NonFunctional Requirements
 
 {Give non-functional requirements}
 
+--------------------------------------------------------------------------------------------------------------------
 ## Glossary
 
 * *glossary item* - Definition
 
+--------------------------------------------------------------------------------------------------------------------
 ## Instructions for manual testing
 
 {Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}

docs/UserGuide.md

@@ -2,41 +2,164 @@
 
 ## Introduction
 
-{Give a product intro}
+EquipmentManager is a Command Line Interface application to help with keeping track of equipment details (e.g. current user, quantity, cost, warranty duration, purchase date) for an AV club. It provides a clean and fast way to manage the inventory as compared to “traditional” methods such as an Excel spreadsheet.
 
 ## Quick Start
 
-{Give steps to get started quickly}
-
 1. Ensure that you have Java 11 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+2. Download the latest version of `EquipmentManager` from [here](https://github.com/AY2122S2-CS2113-F12-2/tp/releases).
+3. Copy the file to the folder you want to use as the _home folder_ for your `EquipmentManager` application.
+4. Double-click the file to start the app. 
+5. Type `help` to see the list of available commands.
 
 ## Features 
 
-{Give detailed description of each feature}
+- [Introduction](#Introduction)
+- [Adding an equipment: `add`](#adding-an-equipment-add)
+- [Checking an equipment: `check`](#checking-an-equipment-check)
+- [Listing equipment: `list`](#listing-equipment-list)
+- [Updating an equipment: `update`](#updating-an-equipment-update)
+- [Deleting an equipment: `delete`](#deleting-an-equipment-delete)
+- [Saving application state: `save`](#saving-application-state-save)
+- [Getting help: `help`](#getting-help-help)
+- [Exiting the application: `bye`](#exiting-the-application-bye)
+
+
+### Introduction
+
+* Words in `UPPER_CASE` are the parameters to be supplied by the user. Spaces are acceptable. <br>
+  e.g. in `check n/ITEM_NAME`, `ITEM_NAME` is a parameter which can be used as `check n/SM-57`.
+
+* Items in square brackets are optional. <br>
+  e.g. `s/SERIAL_NUMBER [n/ITEM_NAME] [t/TYPE] ...` can be used as `s/SM57-1 n/SM57 t/MICROPHONE...` or as `s/SM57-1 t/MICROPHONE...`.
+
+* After the command word (e.g. `add`, `update`), parameters can be in any order.<br>
+  e.g. if the command specifies `... s/SERIAL_NUMBER n/ITEM_NAME...`, `n/ITEM_NAME s/SERIAL_NUMBER` is also acceptable.
+
+* Only one attribute/value can be saved per parameter. Where multiple inputs are supplied, the last parameter will be taken instead of the first one. <br>
+  e.g. `... n/ITEM_NAME_1 n/ITEM_NAME_2` will be interpreted as `... n/ITEM_NAME_2`, omitting `n/ITEM_NAME_1` entirely.
+
+* Extraneous parameters for commands that do not take in parameters (such as `help`, `bye` and `save`) will be ignored.<br>
+  e.g. if the command specifies `help 123`, it will be interpreted as `help`.
+
+### Adding an equipment: `add`
+Adds new Equipment to the list of Equipment.
+
+Format: `add n/ITEM_NAME s/SERIAL_NUMBER t/TYPE c/COST pf/PURCHASED_FROM pd/PURCHASED_DATE`
+
+* The `TYPE` must be one of the following types: MICROPHONE, SPEAKER, STAND, CABLE.
+* The `COST` cannot contain any symbols.  
+
+Example of usage and output: 
+
+`add n/SpeakerB s/S1404115ASF t/Speaker c/1000 pf/Loud_Technologies pd/2022-02-23`
+
+output: `Equipment successfully added: SpeakerB, serial number S1404115ASF`
+
+### Checking an equipment: `check`
+Check the details of the equipment that has the name specified.
+
+Format: `check n/ITEM_NAME`
+
+* Only the `ITEM_NAME` can be used to check for a piece of equipment.
+
+Example of usage and output:
+
+`check n/SpeakerB`
+
+output: 
+
+`Here are the equipment matching to 'SpeakerB':`
+
+`1. serialNumber=S1404115ASF,itemName=SpeakerB,type=SPEAKER,cost=1000.0,purchasedFrom=Loud_Technologies,purchasedDate=2022-02-23`
+
+### Listing equipment: `list`
+Print a list of all equipment in the inventory. If a parameter is supplied, only the equipment matching to the parameter will be printed.
+
+Format: `list [PARAMETER_NAME]`
+
+* `PARAMETER_NAME` can only take on values of `SPEAKER`, `MICROPHONE`, `STAND`, `CABLE`.
+
+Example of usage and output:
+
+`list`
+
+output:
+
+`TOTAL QUANTITY OF EQUIPMENT: 2`
+
+`1. serialNumber=S89347971ASF,itemName=MicrophoneC,type=MICROPHONE,cost=2000.0,purchasedFrom=Loud_Technologies,purchasedDate=2022-01-21`
+
+`2. serialNumber=S1404115ASF,itemName=SpeakerB,type=SPEAKER,cost=1000.0,purchasedFrom=Loud_Technologies,purchasedDate=2022-02-23`
+
+Example of usage and output:
+
+`list microphone`
+
+output:
+
+`TOTAL QUANTITY OF EQUIPMENT: 1`
+
+`1. serialNumber=S89347971ASF,itemName=MicrophoneC,type=MICROPHONE,cost=2000.0,purchasedFrom=Loud_Technologies,purchasedDate=2022-01-21`
+
+### Updating an equipment: `update`
+
+Equipment can be updated with new information. Every parameter except serial number can be updated. 
+
+Format: `update s/SERIAL_NUMBER [n/ITEM_NAME] [t/TYPE] [c/COST] [pf/PURCHASED_FROM] [pd/PURCHASED_DATE]`
+
+* The `TYPE` must be one of the following types: MICROPHONE, SPEAKER, STAND, CABLE.
+* The `COST` cannot contain any symbols.
+
+Example of usage and output:
+
+`update s/S14115ASF c/1200 pf/AVLFX`
+
+output: 
+
+`Equipment successfully updated for serial number S14115ASF,`<br>
+`Updated details are:`<br>
+`New cost: 1200.0`<br>
+`New purchased from: AVLFX`<br>
+
+### Deleting an equipment: `delete`
+
+Removes an Equipment entry from the list of Equipment entirely. This is irreversible after the file is saved.
+
+Format: `update s/SERIAL_NUMBER [n/ITEM_NAME] [t/TYPE] [c/COST] [pf/PURCHASED_FROM] [pd/PURCHASED_DATE]`
+
+* The `TYPE` must be one of the following types: MICROPHONE, SPEAKER, STAND, CABLE.
+* The `COST` cannot contain any symbols.
+
+Example of usage and output:
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+`delete s/S14115ASF`
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+output:
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+`Equipment successfully deleted: SpeakerB, serial number S14115ASF`
 
-Example of usage: 
+### Saving application state: `save`
 
-`todo n/Write the rest of the User Guide d/next week`
+### Getting help: `help`
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+### Exiting the application: `bye`
 
 ## FAQ
 
 **Q**: How do I transfer my data to another computer? 
 
-**A**: {your answer here}
+**A**: Copy the data folder from the old computer into the other computer, in the same directory as the JAR file.
 
 ## Command Summary
 
-{Give a 'cheat sheet' of commands here}
+'Cheat Sheet' of commands here
 
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+* Add equipment `todo n/TODO_NAME d/DEADLINE`
+* Listing equipment: `list`
+* Listing equipment by type: `list MICROPHONE`
+* Updating an equipment: `update s/S14115ASF c/1200 pf/AVLFX`
+* Deleting an equipment: `delete s/S14115ASF`
+* Saving application state: ADD ON HERE
+* Getting help: ADD ON HERE
+* Exiting the application: ADD ON HERE

docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-slate