+### Tham You Wei
+
+
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/tyouwei)]
+[[portfolio](team/tyouwei.md)]
-* Role: Project Advisor
+* Role: Developer
+* Responsibilities: Logic and Model
-### Jane Doe
+### Zheng Yu
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/zhengyup)]
+[[portfolio](team/zhengyup.md)]
-* Role: Team Lead
-* Responsibilities: UI
+* **Role**:
+ * Developer
+* **Responsibilities**:
+ * UI and Model
-### Johnny Doe
+### Timothy Putra Prasetio
-
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](https://github.com/tim-pipi)]
+[[portfolio](team/tim-pipi.md)]
-* Role: Developer
-* Responsibilities: Data
+* **Role**:
+ * Project Manager
+* **Responsibilities**:
+ * Meeting Organization
+ * Deadline Management and Tracking
+ * Innovation and Feature Enhancement
+ * GitHub Repository Management
-### Jean Doe
+### Aprup Kale
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/aprupkale)]
+[[portfolio](team/aprupkale.md)]
* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Responsibilities: Testing, Logic and Model, UML diagrams
-### James Doe
+### Zhi Sheng
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/zsh-eng)]
+[[portfolio](team/zsh-eng.md)]
* Role: Developer
-* Responsibilities: UI
+* Responsibilities: Testing, Developer Guide
diff --git a/docs/Configuration.md b/docs/Configuration.md
index 13cf0faea16..a7650e36685 100644
--- a/docs/Configuration.md
+++ b/docs/Configuration.md
@@ -1,6 +1,8 @@
---
-layout: page
-title: Configuration guide
+ layout: default.md
+ title: "Configuration Guide"
---
+# Configuration Guide
+
Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: `config.json`).
diff --git a/docs/DevOps.md b/docs/DevOps.md
index d2fd91a6001..217927ea2dd 100644
--- a/docs/DevOps.md
+++ b/docs/DevOps.md
@@ -1,12 +1,15 @@
---
-layout: page
-title: DevOps guide
+ layout: default.md
+ title: "DevOps Guide"
+ pageNav: 3
---
-* Table of Contents
-{:toc}
+# DevOps Guide
---------------------------------------------------------------------------------------------------------------------
+
+
+
+
+
+{{ page.alt_title | escape }}
-
- {{ content }}
-
-
-
- {{ content }}
-
- 
+* Can save both intern tracker data and user preference data in [JSON](#glossary) format
+* Read data from [JSON](#glossary) files and convert them into corresponding objects within
+ the application.
+* Inherits from both `InternTrackerStorage` and `UserPrefStorage`, which allows
+ it to be used as either one, depending on the functionality needed.
+* Depends on some classes in the `Model` component (because the `Storage`
+ component's job is to save/retrieve objects that belong to the `Model`).
-How the parsing works:
-* When called upon to parse a user command, the `AddressBookParser` class creates an `XYZCommandParser` (`XYZ` is a placeholder for the specific command name e.g., `AddCommandParser`) which uses the other classes shown above to parse the user command and create a `XYZCommand` object (e.g., `AddCommand`) which the `AddressBookParser` returns back as a `Command` object.
-* All `XYZCommandParser` classes (e.g., `AddCommandParser`, `DeleteCommandParser`, ...) inherit from the `Parser` interface so that they can be treated similarly where possible e.g, during testing.
+### Common Classes
-### Model component
-**API** : [`Model.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/model/Model.java)
+Classes that are used across multiple components are located within the
+`seedu.letsgethired.commons` package.
+These common classes served as shared utilities and functionalities that
+contribute to the application's overall functionality.
-
+For example, the `seedu.letsgethired.commons.util.StringUtil` class provides
+commonly used string manipulation methods.
+[Back to top](#developer-guide)
-The `Model` component,
+--------------------------------------------------------------------------------------------------------------------
-* stores the address book data i.e., all `Person` objects (which are contained in a `UniquePersonList` object).
-* stores the currently 'selected' `Person` objects (e.g., results of a search query) as a separate _filtered_ list which is exposed to outsiders as an unmodifiable `ObservableList:information_source: **Note:** An alternative (arguably, a more OOP) model is given below. It has a `Tag` list in the `AddressBook`, which `Person` references. This allows `AddressBook` to only require one `Tag` object per unique tag, instead of each `Person` needing their own `Tag` objects.
+## **Noteworthy Feature Implementations** -
+This section describes some noteworthy details on how certain features are
+implemented.
-
+### Add Command
+The `add` [command](#glossary) enables users to add new internship application into the
+Intern Tracker.
-### Storage component
+#### Implementation
-**API** : [`Storage.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/storage/Storage.java)
+Adding a new internship application involves executing the `AddCommand`.
-+## **Noteworthy Feature Implementations** -
+This section describes some noteworthy details on how certain features are
+implemented.
-
+* The `AddCommand` is parsed by the `AddCommandParser`.
+* `AddCommandParser#parse()` parses the user input and returns an `AddCommand`
+ object for execution.
-The `Storage` component,
-* can save both address book data and user preference data in JSON format, and read them back into corresponding objects.
-* inherits from both `AddressBookStorage` and `UserPrefStorage`, which means it can be treated as either one (if only the functionality of only one is needed).
-* depends on some classes in the `Model` component (because the `Storage` component's job is to save/retrieve objects that belong to the `Model`)
+Given below is an example usage scenario outlining how the `add` [command](#glossary)
+behaves at each step.
-### Common classes
+**Step 1.** The user executes
-Classes used by multiple components are in the `seedu.addressbook.commons` package.
+```shell
+add n/Jane Street r/Full Stack Developer c/Summer 2024
+```
---------------------------------------------------------------------------------------------------------------------
+This [command](#glossary) adds a new `InternApplication` into the `InternTracker`.
-## **Implementation**
+:information_source: **Note:** If a command fails its execution, it will not call `Model#commitAddressBook()`, so the address book state will not be saved into the `addressBookStateList`.
+**Aspect:** Criteria for a identifying duplicate internship application entry:
-
+* **Alternative 1 (current choice):** The combination of
+ (`COMPANY_NAME`, `ROLE` and `CYCLE`) must be unique.
+ * Pros: Allow users to add an internship application to the same company for
+ different roles or during different cycles.
+ * Cons: Users are required to input additional compulsory fields.
+* **Alternative 2:** Enforce uniqueness based only on `COMPANY_NAME`
+ * Pros: Allow users to add a new internship application quickly.
+ * Cons: It restricts users to having only 1 internship application with a
+ given company.
-Step 4. The user now decides that adding the person was a mistake, and decides to undo that action by executing the `undo` command. The `undo` command will call `Model#undoAddressBook()`, which will shift the `currentStatePointer` once to the left, pointing it to the previous address book state, and restores the address book to that state.
+### Find Command
-
+The `find` [command](#glossary) enables the users to search internship applications by
+looking up a keyword in any of the fields associated with
+an internship application.
-:information_source: **Note:** If the `currentStatePointer` is at index 0, pointing to the initial AddressBook state, then there are no previous AddressBook states to restore. The `undo` command uses `Model#canUndoAddressBook()` to check if this is the case. If so, it will return an error to the user rather
-than attempting to perform the undo.
+#### Implementation
-
+Performing a `Find` operation involves executing the `FindCommand`.
-The following sequence diagram shows how the undo operation works:
+* The `FindCommand` is parsed by the `FindCommandParser`.
+* `FindCommandParser#parse()` parses the user input to return a `FindCommand`
+ object that will be executed.
+
+Given below is an example usage scenario and how the mechanism behaves at each
+step.
+
+**Step 1.** The user keys in the [command](#glossary) word to find an internship
+application, `find`.
+
+```shell
+find n/Jane c/Summer
+```
+
+:information_source: **Note:** The lifeline for `UndoCommand` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
+3. **Update existing methods**:
+ * `Model#getFilteredInternApplicationList()` is updated to return
+ the filtered and/or sorted intern application list.
-
+:information_source: **Note:** If the `currentStatePointer` is at index `addressBookStateList.size() - 1`, pointing to the latest address book state, then there are no undone AddressBook states to restore. The `redo` command uses `Model#canRedoAddressBook()` to check if this is the case. If so, it will return an error to the user rather than attempting to perform the redo.
+
-
-Step 5. The user then decides to execute the command `list`. Commands that do not modify the address book, such as `list`, will usually not call `Model#commitAddressBook()`, `Model#undoAddressBook()` or `Model#redoAddressBook()`. Thus, the `addressBookStateList` remains unchanged.
+To understand how these changes are integrated into the application, refer to
+the sequence diagram below:
-
+
+#### Design Considerations
+
+**Aspect: How sorting is done**
+
+* **Alternative 1 (current choice):** Wrap the existing `FilteredList` in
+ a `SortedList`.
+ * Pros: More flexible, as we can both sort and filter without modifying the
+ original `UniqueApplicationList`.
+* **Alternative 2:** Sort the applications in the `UniqueApplicationList` in
+ the `InternTracker`.
+ * Cons: Requires us to revert the sorting done by
+ the `UniqueApplicationList` before saving the data to
+ preserve the initial order in which the intern applications are added.
+
+**Aspect: Comparator**
+
+* **Alternative 1:** Use a `Comparator:information_source: **Note:** These instructions only provide a starting point for testers to work on;
+
+
+**Note:** These instructions only provide a starting point for testers to work
+on;
testers are expected to do more *exploratory* testing.
-
++ Expected: The `InternApplication` is added to the list. + The added internship application is displayed in the select view. + +1. Test case: `add n/Jump Trading r/Quantitative Researcher c/Summer 2024 s/Deleted`
+ Expected: No `InternApplication` is added to the list. Error message is displayed. + +1. Other incorrect `add` commands to try: `add`, `add ...`, where (`...` are parameters with invalid values or + missing required parameters)
+ Expected: Similar to previous. + +### Editing an `InternApplication` + +1. Prerequisites: List all `InternApplication`s using the `list` command. + Multiple `InternApplication`s in the list. + +1. Test case: `edit 1 r/Software Engineer c/Summer 2024`
+ Expected: The first `InternApplication` in the list is edited and the `Role` is set to `Software Engineer` and + the `Cycle` is set to `Summer 2024`. The edited internship application is displayed in the select view. + +1. Test case: `edit 0`
+ Expected: No `InternApplication` is edited. Error message is displayed. + +1. Test case: `edit s/Deleted`
+ Expected: No `InternApplication` is edited. Error message is displayed. + +1. Other incorrect `edit` commands to try: `edit`, `edit ...`, `edit x` where (`...` are parameters with invalid values + and `x` is larger than the list size)
+ Expected: Similar to previous. + +### Adding a `note` in an `InternApplication` + +1. Prerequisites: List all `InternApplication`s using the `list` command. + Multiple `InternApplication`s in the list. + +1. Test case: `note 1 i/Prepare for behavioural questions`
+ Expected: A new `Note` is added to the first `InternApplication` in the list. + The internship application with the new note is displayed in the select view. + +1. Test case: `note 0 i/Prepare for machine learning questions`
+ Expected: No `Note` is added to any `InternApplication`. Error message is displayed. - 1. Download the jar file and copy into an empty folder +1. Other incorrect `note` commands to try: `note`, `note x i/Prepare for behavioural questions` where + (`x` is larger than the list size)
+ Expected: Similar to previous. - 1. Double-click the jar file Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum. +### Deleting a `note` from an `InternApplication` -1. Saving window preferences +1. Prerequisites: List all `InternApplication`s using the `list` command. + Multiple `InternApplication`s in the list. - 1. Resize the window to an optimum size. Move the window to a different location. Close the window. +1. Test case: `note 1 o/1`
+ Expected: The first `Note` from the first `InternApplication` in the list is deleted. + The internship application with the deleted note is displayed in the select view. - 1. Re-launch the app by double-clicking the jar file.
- Expected: The most recent window size and location is retained. +1. Test case: `note 0 o/1`
+ Expected: No `Note` is deleted from any `InternApplication`. Error message is displayed. -1. _{ more test cases … }_ +1. Test case: `note 1 o/0`
+ Expected: No `Note` is deleted from any `InternApplication`. Error message is displayed. -### Deleting a person +1. Other incorrect `note` commands to try: `note`, `note x o/1`, `note 1 o/y` where (`y` is larger than the number + of notes in the first `InternApplication` in the list and `x` is larger than the list size)
+ Expected: Similar to previous. -1. Deleting a person while all persons are being shown +### Viewing an `InternApplication` - 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. +1. Prerequisites: List all `InternApplication`s using the `list` command. + Multiple `InternApplication`s in the list. - 1. Test case: `delete 1`
- Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated. +1. Test case: `view 1`
+ Expected: The first `InternApplication` in the list is displayed in the select view. - 1. Test case: `delete 0`
- Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. +1. Test case: `view 0`
+ Expected: No `InternApplication` is displayed in the select view. Error message is displayed. - 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
- Expected: Similar to previous. +1. Other incorrect `view` commands to try: `view`, `view x` (where `x` is larger than the list size)
+ Expected: Similar to previous. -1. _{ more test cases … }_ +### Searching for an `InternApplication` + +1. Prerequisites: List all `InternApplication`s using the `list` command. + Multiple `InternApplication`s in the list. + +1. Test case: `find n/Jane Street c/Summer 2024 r/Software Engineer`
+ Expected: All the `InternApplication`s with either the `Company` name containing `Jane Street` *and* `Role` + containing `Software Engineer` *and* `Cycle` containing `Summer 2024` are displayed in the list view. + +1. Test case: `find`
+ Expected: All `InternApplication`s are displayed in the list view. Error message is displayed. + +### Sorting the `InternApplication`s + +1. Prerequisites: List all `InternApplication`s using the `list` command. + Multiple `InternApplication`s in the list. + +1. Test case: `sort n/a`
+ Expected: All the `InternApplication`s are displayed in the list view in sorted order by `Company` in ascending order. + +1. Test case: `sort s/d`
+ Expected: All the `InternApplication`s are displayed in the list view in sorted order by `Status` in descending order. + +1. Test case: `sort c/n`
+ Expected: All the `InternApplication`s are displayed in the list view. Error message is displayed. + +1. Other incorrect `sort` commands to try: `sort`, `sort ...`, where (`...` are parameters with invalid values + or more than one parameter)
+ Expected: Similar to previous. + +### Deleting an `InternApplication` + +1. Prerequisites: List all `InternApplication`s using the `list` command. + Multiple `InternApplication`s in the list. + +1. Test case: `delete 1`
+ Expected: First `InternApplication` is deleted from the list. + Details of the deleted internship application shown in the status message. + +1. Test case: `delete 0`
+ Expected: No `InternApplication` is deleted. Error message is displayed. + +1. Other incorrect `delete` commands to try: `delete`, `delete x` (where `x` is larger than the list size)
+ Expected: Similar to previous. + +### Undoing a command + +1. Prerequisites: Execute some command that modifies any `InternApplication` - `add`, `edit`, `note` or `delete`, + or modifies the list of internship applications - `find`. + +1. Test case: `undo`
+ Expected: Undoes the modification to the `InternApplication` and the list of internship applications. + +1. Test case: `undo`, without any command being executed before the `undo`
+ Expected: No change to any `InternApplication` or the list of internship applications. ### Saving data -1. Dealing with missing/corrupted data files +LetsGetHired saves your data locally after any command you execute. + +Dealing with a **missing data folder** + +1. Prerequisites: On app launch, if no data folder is detected within the same directory as the jar file. + +1. Test case: Run any command and a new data folder containing a `letsgethired.json` file will be generated. + +1. Test case: If you do not run any command and quit the app, no data folder or file will be generated. + +Dealing with a **missing data file** (`letsgethired.json`) + +1. Prerequisites: On app launch, if there is an empty data folder within the same directory as the jar file. + +1. Test case: Run any command and a `letsgethired.json` file will be generated within the data folder. + +1. Test case: If you do not run any command and quit the app, no data file will be generated. + +Dealing with a **corrupted data file** (`letsgethired.json`) + +1. Prerequisites: On app launch, if the `letsgethired.json` file in the data folder within the same directory as the jar file is corrupted. + +1. Test case: Run any command and the contents of the `letsgethired.json` file will be overwritten to a json file with no data. + +[Back to top](#developer-guide) + +-------------------------------------------------------------------------------------------------------------------- + + + +## **Appendix: Effort** + +In crafting LetsGetHired, a lot of thought was put into delivering a +user-centric application that +simplifies internship application tracking. We prioritized user experience with +a revamped [GUI](#glossary) and enhanced +internship application organization through features like sort and find. We also +provided users the +flexibility to attach helpful information to entries, through the introduction +of notes. + +### Designing Organisation Features + +Designing organizational features in LetsGetHired, such as the Find and Sort +[commands](#glossary), presented a notable +advancement beyond the capabilities of AB3. While AB3 exclusively features a +basic Find function that +searches for entries based on matching keywords to names in the address book, in +LetsGetHired, the Find +[command](#glossary) empowers users to conduct searches across various fields associated with +internship applications +simultaneously. Additionally, we took it one step further, enhancing the Find +[command](#glossary) in LetsGetHired +to accommodate partial matches, giving our users more flexibility and freedom. + +The introduction of the Sort [command](#glossary) in LetsGetHired stands as another milestone +in organizational design. +LetsGetHired enables users to sort their internship applications in ascending or +descending +order based on any field. This functionality provides users with the ability to +customize the +organization of their application. + +### Developing a Better User Interface + +We undertook a substantial overhaul of the [GUI](#glossary) in LetsGetHired, distinguishing +it from the interface of +AB3. LetsGetHired embraces a visually appealing [GUI](#glossary) that facilitates in-depth +exploration of application +details through a select view. This transition required intricate design +decisions to seamlessly integrate +additional functionalities for detailed application viewing and adding of notes +that demand larger screen +real estate. In our commitment to user experience, we also interactivity with +the [GUI](#glossary) through an ability +to view applications from the list view by clicking on the corresponding card. + +### Designing Notes Functionality + +Notes play an integral part in LetsGetHired, allowing users to add many pieces +of information associated +with an internship application. We deliberated on how notes should be created, +viewed, deleted and integrated +into LetsGetHired's existing and future functionalities, such as searching for +an application by notes. +This addition allowed us to introduce another dimension to LetsGetHired, adding +depth and nuance to the +application management experience. + +[Back to top](#developer-guide) + +-------------------------------------------------------------------------------------------------------------------- + + + +## **Appendix: Planned Enhancements** + +### Improved Command Error Feedback - 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ +**Current Implementation**: In the current version of our application, when a +user inputs a [command](#glossary) with missing compulsory fields, the application responds +with a generic error message: `Invalid Command Format!`. This is followed by the +correct usage of the [command](#glossary). While this approach informs the user of an error, +it lacks specificity in identifying the exact cause of the error, particularly +which compulsory field(s) are missing. + +**Planned Enhancement**: We aim to improve user experience and error feedback by +implementing a more detailed error reporting system. This enhancement will +enable the application to not only detect that an invalid [command](#glossary) has been +entered but also identify and highlight the specific missing compulsory fields. + +**Proposed Changes**: + +* **Error Detection Algorithm**: Modify the [command](#glossary) parsing algorithm to include + checks for each compulsory field. This will enable the system to pinpoint + which field(s) the user failed to provide. + +* **User Feedback Enhancement**: When a [command](#glossary) is identified as invalid due to + missing fields, the application will generate a tailored error message. This + message will specifically list the missing compulsory field(s), guiding the + user to correct the specific mistake. For example, if a user forgets to input + the `CYCLE` field in a [command](#glossary), the error message would + be: `Invalid Command Format! Missing field: CYCLE`. This message will be + followed by the correct usage of the [command](#glossary). + +**Expected Benefits**: + +* **Improved User Experience**: By providing specific feedback on missing + fields, users can more easily understand and rectify their mistakes, leading + to a smoother interaction with the application. +* **Increased Efficiency**: This enhancement reduces the time and effort users + spend in deciphering generic error messages and figuring out what went wrong. +* **Enhanced Usability**: Tailored error messages make the application more + user-friendly, especially for new users who are still familiarizing themselves + with the [command](#glossary) syntax. + +### Improved Unknown Command Error Feedback + +**Current Implementation**: In the current version of our application, when a +user inputs an unrecognized [command](#glossary), the system simply displays a +message: `Unknown Command`. This response, while accurate, does not assist the +user in understanding why the [command](#glossary) was unrecognized or how to correct it. -1. _{ more test cases … }_ +**Planned Enhancement**: We plan to introduce a more intuitive error handling +mechanism for unknown [commands](#glossary), akin to the approach used in Git. This +enhancement will involve suggesting [commands](#glossary) similar to the user's input, which +can be particularly useful in cases where the user has made a typing error. + +**Proposed Changes**: + +* **Command Suggestion Algorithm**: Implement an algorithm that detects and + suggests similar [commands](#glossary) when an unknown [command](#glossary) is entered. For example, if + a user mistakenly types `ad` instead of `add`, the system will suggest the + correct [command](#glossary): `Unknown Command: 'ad'. Did you mean 'add'?`. + +* **Synonym Recognition**: Enhance the [command](#glossary) parsing logic to recognize + synonyms or commonly used alternatives for certain [commands](#glossary). For instance, if + a user types `search` or `filter` instead of `find`, the application could + respond with a suggestion: `Unknown Command: 'search'. Do you mean 'find'?`. + +**Expected Benefits**: + +* **Enhanced User Assistance**: By providing relevant [command](#glossary) suggestions, users + can quickly rectify typing errors or understand alternative terminology used + within the application. +* **Increased Efficiency**: This enhancement reduces the time and effort users + spend in deciphering generic error messages and figuring out what went wrong. +* **Improved Usability for New Users**: New users, unfamiliar with specific + [command](#glossary) syntax, will find the application more approachable with these + intuitive prompts and suggestions. + +### Improved Visibility of Newly Added Internship Applications + +**Current Implementation**: In the current version of our application, when a +new internship application is added to our list, it is placed at the bottom. +This positioning often renders the new entry outside the user's current view, +requiring them to manually scroll down to locate the latest addition. + +**Planned Enhancement**: We are planning to enhance the user experience by +changing how newly added internship applications are displayed. The key +improvement will be automatically scrolling the list to bring the newly added +application into view immediately. Additionally, we are considering placing new +entries at the top of the list rather than at the bottom. + +**Proposed Changes**: + +* **Automatic Scrolling**: Modify the list view functionality to automatically + scroll to the position of the newly added internship application. This ensures + that the latest entry is immediately visible to the user without requiring + manual navigation. + +* **List Ordering Modification**: Change the default order of the list to + display new applications at the top. This approach aligns with common user + expectations, where the most recent items are readily accessible. + +**Expected Benefits**: + +* **Improved Visibility of New Applications**: By immediately showcasing new + applications, users can immediately see and interact with the most recent + entries, improving workflow efficiency. +* **Adaptation to User Preferences**: Adjusting the list order to display new + items at the top aligns with common user behavior and expectations, thereby + improving usability. +* **Enhanced User Experience**: Automatically scrolling to new entries saves + time and improves the overall user experience, making the application more + intuitive and efficient. + +### Sorting by Multiple Fields + +**Current Implementation**: In the current version of our application, the +application only allows sorting of internship applications by +ONE field at a time using parameters such as `c/a` for sorting by cycles in +ascending order or `n/d` for sorting by company names in descending order. + +**Planned Enhancement**: Enable sorting by multiple fields to enhance the +flexibility of data organization. This improvement addresses the limitation of +the current sorting functionality, allowing users to sort data by more than one +criterion at a time. For example, users should be able to sort first by cycle in +ascending order and then by company name in ascending order using the following +command: + +```shell +sort c/a n/a +``` + +This means that if 2 internship applications have the same cycle, for example +`Summer 2024`, they will be sorted by company name in ascending order +(`Apple` before `Google`). + +**Proposed Changes**: + +
:exclamation: **Caution:**
+
+**Caution:**
Follow the steps in the following guide precisely. Things will not work out if you deviate in some steps.
-
+
First, **fork** this repo, and **clone** the fork into your computer.
If you plan to use Intellij IDEA (highly recommended):
1. **Configure the JDK**: Follow the guide [_[se-edu/guides] IDEA: Configuring the JDK_](https://se-education.org/guides/tutorials/intellijJdk.html) to to ensure Intellij is configured to use **JDK 11**.
-1. **Import the project as a Gradle project**: Follow the guide [_[se-edu/guides] IDEA: Importing a Gradle project_](https://se-education.org/guides/tutorials/intellijImportGradleProject.html) to import the project into IDEA.- :exclamation: Note: Importing a Gradle project is slightly different from importing a normal Java project. +1. **Import the project as a Gradle project**: Follow the guide [_[se-edu/guides] IDEA: Importing a Gradle project_](https://se-education.org/guides/tutorials/intellijImportGradleProject.html) to import the project into IDEA. +
:bulb: **Tip:**
+
+ **Tip:**
Optionally, you can follow the guide [_[se-edu/guides] Using Checkstyle_](https://se-education.org/guides/tutorials/checkstyle.html) to find how to use the CheckStyle within IDEA e.g., to report problems _as_ you write code.
-
+
1. **Set up CI**
diff --git a/docs/Testing.md b/docs/Testing.md
index 8a99e82438a..befc2735cb7 100644
--- a/docs/Testing.md
+++ b/docs/Testing.md
@@ -1,12 +1,15 @@
---
-layout: page
-title: Testing guide
+ layout: default.md
+ title: "Testing Guide"
+ pageNav: 3
---
-* Table of Contents
-{:toc}
+# Testing Guide
---------------------------------------------------------------------------------------------------------------------
+
+:link: **Link**: Read [this Gradle Tutorial from the se-edu/guides](https://se-education.org/guides/tutorials/gradle.html) to learn more about using Gradle.
-
+- e.g. `seedu.address.commons.StringUtilTest` -1. *Integration tests* that are checking the integration of multiple code units (those code units are assumed to be working).
- e.g. `seedu.address.storage.StorageManagerTest` -1. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.
- e.g. `seedu.address.logic.LogicManagerTest` + e.g. `seedu.letsgethired.commons.StringUtilTest` +2. *Integration tests* that are checking the integration of multiple code units (those code units are assumed to be working).
+ e.g. `seedu.letsgethired.storage.StorageManagerTest` +3. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.
+ e.g. `seedu.letsgethired.logic.LogicManagerTest` diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 57437026c7b..f022326dc43 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -1,197 +1,1438 @@ --- -layout: page -title: User Guide +layout: default.md +title: "User Guide" +pageNav: 3 --- -AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps. +# **User Guide** -* Table of Contents -{:toc} +
- A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
-  +- **Swift Viewing**: Swiftly view your internship applications and monitor their + status. +- **Status Updates**: Stay updated on the progress of each application, from + application sent to interview stages. +- **Organization**: Organize your internship applications according to your + needs for better clarity. +- **Notes**: Add personalized notes to each internship application, ensuring you + never forget key details. +- **Deadlines**: Set and track deadlines for your internship applications, so + you never miss an opportunity. -1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
- Some example commands you can try: +In addition to these capabilities, we recognize the importance of **speed and +efficiency**. Thus, _LetsGetHired_ is +**optimized for use via a [Command Line Interface (CLI)](#glossary)**, +but you still enjoy the advantages of a [Graphical User Interface (GUI)](#glossary). +If you are a swift typist, _LetsGetHired_ can streamline your internship +tracking **faster than many standard +GUI-based tools available.** - * `list` : Lists all contacts. +**_LetsGetHired_ is perfect for you if you are a Computer Science undergraduate +student.** - * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book. +#### Purpose - * `delete 3` : Deletes the 3rd contact shown in the current list. +This User Guide is designed to help you **get started with _LetsGetHired_**, a +powerful tool for managing your internship applications. +Whether you are seeking you first internship or have prior experience, this +guide will be your trusty companion in using LetsGetHired to manage your +internship applications. - * `clear` : Deletes all contacts. +#### Prerequisite Knowledge - * `exit` : Exits the app. +While this guide is accessible to a broad audience, we assume that you have a +basic understanding of the internship-finding process. +If you are new to this journey, don't worry! We've got you covered. Feel free to +check out +these [helpful resources](https://www.techinterviewhandbook.org/software-engineering-interview-guide/) +or refer to the [_Glossary_ section of the **User Guide**](#glossary) for +additional information to get you up to speed. -1. Refer to the [Features](#features) below for details of each command. +Our goal is to make your internship application experience as smooth and +successful as possible, regardless of your level of experience. +Let's embark on this journey together and make your internship goals a reality. --------------------------------------------------------------------------------------------------------------------- +[Back to top](#user-guide) -## Features +__________________________________________________________________________________________________________________ -
+
-**:information_source: Notes about the command format:**
+## **Navigating the User Guide** -* Words in `UPPER_CASE` are the parameters to be supplied by the user.
- e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. +This section will explain the different elements used in this User Guide and +what they mean. -* Items in square brackets are optional.
- e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. +#### Page Navigation -* Items with `…` after them can be used multiple times including zero times.
- e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. +For quick navigation to the different sections in the User Guide, you could use +the **Page Navigation** on the +right side of the page. -* Parameters can be in any order.
- e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. + -* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
+If you are using a smaller screen size, the **Page Navigation** will be hidden +by default. To show it, click on the +three-dot icon on the top right corner of the page. + + + +#### Code + +`A code in the User Guide will be displayed in this format.` + +#### Code Blocks + +``` +Sometimes, larger blocks of +code can be displayed in this +way too! +``` + +#### Links + +What are hyperlinks? [Click here to find out!](#glossary) + +[Hyperlinks will be displayed in this format.](#links) + +[**Sometimes it can also be bolded.**](#links) + +[_Or italicized._](#links) + +[**Or** a _mix_ of _**both!**_](#links) + +#### Boxes + +
+
+This is a box. Some information may be put here.
+
+There are three types of boxes used in this User Guide:
+
+* [Additional Information](#additional-information)
+* [Warning](#warning)
+* [Tips](#tips)
+
+
+#### Additional Information
+
+
+
+This is additional information.
+
+
+
+
+This is also additional information.
+
+
+
+
+This is also additional information.
+
+
+#### Warning
+
+
+
+This is a warning. Watch out for these!
+
+
+
+
+This is also a warning. Watch out for these too!
+
+
+
+
+This is also a warning. Watch out for these too!
+
+
+
+#### Tips
+
+
+
+These are some helpful tips. Skip these if you are in a hurry!
+
+
+
+
+
+These are also some helpful tips. Skip these if you are in a hurry!
+
+
+
+
+
+These are also some helpful tips. Skip these if you are in a hurry!
+
+
+
+Now that you are familiar with the User Guide, let's get right into it!
+
+[Back to top](#user-guide)
+
+__________________________________________________________________________________________________________________
+
+
+
+## **Getting Started**
+
+Welcome to the **_LetsGetHired_ User Guide**! This guide will walk you through
+the basics of [**setting up**](#installation) and **[using the
+application](#tutorial-managing-your-first-internship-application)** to manage
+your internship applications.
+
+
+
+* How to install **_LetsGetHired_**
+* How to **add** your internship applications
+* How to **edit** your internship applications
+* How to **add notes** to your internship applications
+
+
+
+
+
+If you are already an advanced user, feel free to jump to the
+[_Commands_ section of the **User Guide**](#commands)
+
+
+
+__________________________________________________________________________________________________________________
+
+### Installation
+
+1. Ensure that you have **Java 11 or above** installed in your Computer
+
+
+ You can download it
+ from [Java SE 11 Downloads](https://www.oracle.com/sg/java/technologies/javase/jdk11-archive-downloads.html)
+ if you do not have it already.
+
+
+1. Download the **latest** `letsgethired.jar` from
+ [**our GitHub Releases**](https://github.com/AY2324S1-CS2103T-W17-2/tp/releases).
+
+ 
+
+1. Locate the `letsgethired.jar` file
+ * After downloading, find the `letsgethired.jar` file on your computer. It might be in your `Downloads` folder or wherever you chose to save it.
+
+1. Choose Your **Home Folder**
+ * Decide on a folder where you want all your **_LetsGetHired_** data to
+ reside. This can be an existing folder or you can create a new one
+ specifically for **_LetsGetHired_**.
+
+1. Copying the File:
+ * Right-click on the `letsgethired.jar` file and select `Copy`.
+ * Navigate to your chosen home folder.
+ * Right-click on an empty space inside the folder and select `Paste`.
+
+1. Verify the File Location:
+ * Ensure that the `letsgethired.jar` file is now present in your chosen home
+ folder.
+
+
+
+**Bookmark** or **create a shortcut** to this folder for easy access in the
+future!
+
+
+
+__________________________________________________________________________________________________________________
+
+### Launching _LetsGetHired_
+
+1. Open your **[Command Terminal](#glossary)**.
+ * On _Windows_: Press `Windows + R` keys simultaneously, type `cmd` and press `Enter`.
+ * Alternatively, press `Windows` key, type `Terminal` and press `Enter`.
+ * On _macOS_: Press `Command + Space` to open Spotlight search, type `Terminal`, and press `Enter`.
+
+1. `cd` into your chosen home folder, and type in the following command:
+ ```
+ java -jar letsgethired.jar
+ ```
+
+
+ If you are unfamiliar with the commands in the [Command Terminal](#glossary), we suggest reading [this](https://www.digitalcitizen.life/command-prompt-how-use-basic-commands/).
+
+
+
+1. You should now see a [graphical user interface (GUI)](#glossary) pop up on your screen (as shown in the picture below).
+
+
+
+Please note that the app comes preloaded with some **[sample data](#glossary)**.
+This is to help you get a feel for how the app works and how your entries will appear. + +
+
+ + + +| Components | Description | +|-----------------------------|---------------------------------------------------------------| +| Command Box | You can type commands here and press `Enter` to execute them. | +| Result Display Box | Displays the result of executing a command. | +| List View | Displays a list of your internship applications. | +| Internship Application Card | Displays the fields related to your internship application. | +| Select View | Displays more details related to your internship application. | + +Now that you are familiar with the user interface of _LetsGetHired_, let's jump +right into managing your +internship applications in this +[**Tutorial**](#tutorial-managing-your-first-internship-application). + +[Back to top](#user-guide) + +__________________________________________________________________________________________________________________ + + + +## **Tutorial - Managing Your First Internship Application** + +In this tutorial, we will walk you through a typical [workflow](#glossary) for using _LetsGetHired_ to manage your internship applications.
+ +##### **Step 1: Adding Your Internship Application** + +**Context:** You are starting your internship application journey, and you want +to add a new internship application. + +Imagine that you have applied for a **Software Engineering Internship** at **Google** for the **Summer of 2024**. + +To **add your internship application**, go to the _Command Box_ and type the +following command: + +``` +add n/Google r/Software Engineering c/Summer 2024 +``` + + + +This command specifies the company (_Google_), the role (_Software +Engineering_), and the cycle (_Summer 2024_) for the internship that you have +applied for. + +After hitting `Enter`, your new internship application will appear in the _List +View_ of **_LetsGetHired_**, +allowing you to keep track of your application details effortlessly. Details of +your internship application will appear +in the _Select View_ of **_LetsGetHired_**. + + + +##### **Step 2: Editing Your Internship Application** + +**Context:** You realize that you made a mistake in your internship application +and need to correct it. + +Imagine that you want to change the company name to "**Google Inc**" instead. + +To **edit your internship application**, go to the _Command Box_ and type +the `edit` command, +followed by the index of the internship application to be edited (in this case, +it's 21) and the corrected company name: + +``` +edit 21 n/Google Inc +``` + + + +After hitting `Enter`, your internship application will be updated with "_Google +Inc_" as the new company name. + + + +
+
+**Always ensure your application details are accurate to avoid confusion in the
+future.**
+
+
+
+##### **Step 3: Updating Status**
+
+**Context:** You have submitted your application, and you want to update the
+application status.
+
+Imagine that your internship application to **Google Inc** was a success, and
+you received an **offer**.
+
+To **update the status of your internship application**, use the `edit` command,
+followed by the index of the internship application to be edited (in this case,
+it's 21) and the updated status:
+
+```
+edit 21 s/Offered
+```
+
+
+
+After hitting `Enter`, your internship application status will be updated to "
+_Offered_".
+
+
+
+
+
+**Keeping your application status up-to-date helps you to stay organized and
+informed.**
+
+
+
+##### Step 4: Adding Notes
+
+**Context:** You want to keep track of additional information about the
+internship, such as job requirements.
+
+Imagine that you want to **write a note about the starting date** of your
+internship at Google Inc.
+
+To **add notes to your internship application**, use the `note` command,
+followed by the index of the internship application
+(in this case, it's 21) and your additional notes:
+
+```
+note 21 i/Starting date is 1 June 2024.
+```
+
+
+
+After hitting `Enter`, you have successfully included supplementary information
+which you need to remember about the
+internship, making it a valuable resource when preparing for interviews or
+follow-ups.
+
+
+
+##### Step 5: Start Using _LetsGetHired_
+
+**Congratulations**! You have successfully managed your first internship
+application using **_LetsGetHired_**.
+These steps demonstrate the core functions of the application, helping you stay
+organized and informed throughout your internship application journey.
+
+
+
+For other commands, please refer to the
+[_Commands_ section of the **User Guide**](#commands) below.
+
+
+
+[Back to top](#user-guide)
+
+__________________________________________________________________________________________________________________
+
+
+
+## **Commands**
+
+This section explains the detailed list of the commands (and its usages) which
+are available for you to use.
+
+
+
+If you have been using **_LetsGetHired_** and just need a **quick refresher** on
+the commands available, you can jump to
+the [_Command Summary_ section of the **User Guide**](#command-summary) below.
+
+
+
+
+
+**Notes about the command format:**
+ +* All commands are case-sensitive. For example, `sort` is a valid command, but `SORT` or `SoRt` are invalid commands.
+ +* All prefixes are case-sensitive. For example, `s/` (the prefix for status) and `S/` (no attached meaning) are considered different. + +* Words in `UPPER_CASE` are **parameters** which you will type in.
+ ``` + add n/COMPANY_NAME r/ROLE c/CYCLE + ``` + For example, you can replace `COMPANY_NAME`, `ROLE` and `CYCLE` as follows: + ``` + add n/Google r/Software Engineering c/Summer 2024 + ``` + +* All parameters should be preceded by its respective **prefix**.
+ ``` + add n/COMPANY_NAME r/ROLE c/CYCLE + ``` + For example, `n/` is the prefix for the `COMPANY_NAME` parameter. `r/` is the + prefix for `ROLE` and `c/` is the prefix for `CYCLE`. + +
+
+ **Exception**: The `INDEX` parameter does not require any prefix.
+
+
+* Words in `[square brackets]` are **optional parameters**.
+ ``` + add n/COMPANY_NAME r/ROLE c/CYCLE [s/STATUS] [d/DEADLINE] + ``` + For example, you can use the above command as: + ``` + add n/Google r/Software Engineering c/Summer 2024 + ``` + OR + ``` + add n/Google r/Software Engineering c/Summer 2024 s/Offered + ``` + OR + ``` + add n/Google r/Software Engineering c/Summer 2024 d/25 Oct 2023 + ``` + OR + ``` + add n/Google r/Software Engineering c/Summer 2024 s/Offered d/25 Oct 2023 + ``` + +* You can type parameters in **any order**.
+ e.g. if the command specifies `c/CYCLE r/ROLE`, typing `r/ROLE c/CYCLE` is + also acceptable. + +* **Irrelevant parameters** for commands that do not take in parameters (such + as `help` and `list`) **will be ignored**.
e.g. if the command specifies `help 123`, it will be interpreted as `help`. -* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. -
+
+
++## **Navigating the User Guide** -* Words in `UPPER_CASE` are the parameters to be supplied by the user.
- e.g. in `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. +This section will explain the different elements used in this User Guide and +what they mean. -* Items in square brackets are optional.
- e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`. +#### Page Navigation -* Items with `…` after them can be used multiple times including zero times.
- e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. +For quick navigation to the different sections in the User Guide, you could use +the **Page Navigation** on the +right side of the page. -* Parameters can be in any order.
- e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. + -* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
+If you are using a smaller screen size, the **Page Navigation** will be hidden +by default. To show it, click on the +three-dot icon on the top right corner of the page. + + + +#### Code + +`A code in the User Guide will be displayed in this format.` + +#### Code Blocks + +``` +Sometimes, larger blocks of +code can be displayed in this +way too! +``` + +#### Links + +What are hyperlinks? [Click here to find out!](#glossary) + +[Hyperlinks will be displayed in this format.](#links) + +[**Sometimes it can also be bolded.**](#links) + +[_Or italicized._](#links) + +[**Or** a _mix_ of _**both!**_](#links) + +#### Boxes + +
+This is to help you get a feel for how the app works and how your entries will appear. + +
+ + + +| Components | Description | +|-----------------------------|---------------------------------------------------------------| +| Command Box | You can type commands here and press `Enter` to execute them. | +| Result Display Box | Displays the result of executing a command. | +| List View | Displays a list of your internship applications. | +| Internship Application Card | Displays the fields related to your internship application. | +| Select View | Displays more details related to your internship application. | + +Now that you are familiar with the user interface of _LetsGetHired_, let's jump +right into managing your +internship applications in this +[**Tutorial**](#tutorial-managing-your-first-internship-application). + +[Back to top](#user-guide) + +__________________________________________________________________________________________________________________ + + + +## **Tutorial - Managing Your First Internship Application** + +In this tutorial, we will walk you through a typical [workflow](#glossary) for using _LetsGetHired_ to manage your internship applications.
+ +##### **Step 1: Adding Your Internship Application** + +**Context:** You are starting your internship application journey, and you want +to add a new internship application. + +Imagine that you have applied for a **Software Engineering Internship** at **Google** for the **Summer of 2024**. + +To **add your internship application**, go to the _Command Box_ and type the +following command: + +``` +add n/Google r/Software Engineering c/Summer 2024 +``` + + + +This command specifies the company (_Google_), the role (_Software +Engineering_), and the cycle (_Summer 2024_) for the internship that you have +applied for. + +After hitting `Enter`, your new internship application will appear in the _List +View_ of **_LetsGetHired_**, +allowing you to keep track of your application details effortlessly. Details of +your internship application will appear +in the _Select View_ of **_LetsGetHired_**. + + + +##### **Step 2: Editing Your Internship Application** + +**Context:** You realize that you made a mistake in your internship application +and need to correct it. + +Imagine that you want to change the company name to "**Google Inc**" instead. + +To **edit your internship application**, go to the _Command Box_ and type +the `edit` command, +followed by the index of the internship application to be edited (in this case, +it's 21) and the corrected company name: + +``` +edit 21 n/Google Inc +``` + + + +After hitting `Enter`, your internship application will be updated with "_Google +Inc_" as the new company name. + + + +
+ +* All commands are case-sensitive. For example, `sort` is a valid command, but `SORT` or `SoRt` are invalid commands.
+ +* All prefixes are case-sensitive. For example, `s/` (the prefix for status) and `S/` (no attached meaning) are considered different. + +* Words in `UPPER_CASE` are **parameters** which you will type in.
+ ``` + add n/COMPANY_NAME r/ROLE c/CYCLE + ``` + For example, you can replace `COMPANY_NAME`, `ROLE` and `CYCLE` as follows: + ``` + add n/Google r/Software Engineering c/Summer 2024 + ``` + +* All parameters should be preceded by its respective **prefix**.
+ ``` + add n/COMPANY_NAME r/ROLE c/CYCLE + ``` + For example, `n/` is the prefix for the `COMPANY_NAME` parameter. `r/` is the + prefix for `ROLE` and `c/` is the prefix for `CYCLE`. + +
+ ``` + add n/COMPANY_NAME r/ROLE c/CYCLE [s/STATUS] [d/DEADLINE] + ``` + For example, you can use the above command as: + ``` + add n/Google r/Software Engineering c/Summer 2024 + ``` + OR + ``` + add n/Google r/Software Engineering c/Summer 2024 s/Offered + ``` + OR + ``` + add n/Google r/Software Engineering c/Summer 2024 d/25 Oct 2023 + ``` + OR + ``` + add n/Google r/Software Engineering c/Summer 2024 s/Offered d/25 Oct 2023 + ``` + +* You can type parameters in **any order**.
+ e.g. if the command specifies `c/CYCLE r/ROLE`, typing `r/ROLE c/CYCLE` is + also acceptable. + +* **Irrelevant parameters** for commands that do not take in parameters (such + as `help` and `list`) **will be ignored**.
e.g. if the command specifies `help 123`, it will be interpreted as `help`. -* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. -
:bulb: **Tip:**
-A person can have any number of tags (including 0)
-
+-  +1. **INDEX**: Represents the position of the internship application in your list + that you wish to update. +
:exclamation: **Caution:**
-If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
-
+#### **Adding a note:**
-### Archiving data files `[coming in v2.0]`
+As you progress through your application process, there might be specific
+information, feedback, or reminders
+you'd like to attach to an application for future reference. The `note` command
+allows you to effortlessly do just that.
-_Details coming soon ..._
+##### Command Usage
---------------------------------------------------------------------------------------------------------------------
+**Command**:
-## FAQ
+```
+note INDEX i/NOTE
+```
+
+##### Parameters:
+
+1. **INDEX**: Represents the position of the internship application in your list
+ to which you wish to attach a note.
+ `note INDEX [o/NOTE_INDEX]` (to delete a note) | `note 1 i/Interview on 26 Oct`
`note 1 o/1` | +| **[Delete](#deleting-your-internship-application-delete)** | `delete INDEX` | `delete 1` | +| **[Undo](#reverting-your-mistake-undo)** | `undo` | `undo` | +| **[View](#viewing-your-internship-application-view)** | `view INDEX` | `view 1` | +| **[Find](#searching-your-internship-application-find)** | `find [n/COMPANY_NAME] [r/ROLE] [c/CYCLE] [s/STATUS] [d/DEADLINE] [i/NOTE]` | `find n/Google` | +| **[Sort](#sorting-your-internship-applications-sort)** | `sort [n/ORDER] [r/ORDER] [c/ORDER] [s/ORDER] [d/ORDER]` | `sort n/a` | +| **[Clear](#clearing-your-internship-applications-clear)** | `clear` | `clear` | +| **[Exit](#exiting-letsgethired-exit)** | `exit` | `exit` | + +This table provides a quick and clear reference to the commands available in +**_LetsGetHired_**. +You can use it to efficiently navigate through the program and manage your +internship applications. + +[Back to top](#user-guide) + +__________________________________________________________________________________________________________________ + + + +## **FAQ** + +**Q**: How do I know my Java version?
+**A**: Open your [command terminal](#glossary) and enter the following command:
+``` +java -version +``` **Q**: How do I transfer my data to another Computer?
-**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder. +**A**: Install _LetsGetHired_ in the other computer and overwrite the empty data +file it creates with the file that +contains the data from your previous _LetsGetHired_ home folder. + +__________________________________________________________________________________________________________________ + +## **Known issues** + +* **When using multiple screens**, if you move the application to a secondary + screen, and later switch to using only the + primary screen, the GUI will open off-screen. The remedy is to delete + the `preferences.json` file created by the application + before running the application again. + +[Back to top](#user-guide) --------------------------------------------------------------------------------------------------------------------- +__________________________________________________________________________________________________________________ -## Known issues + -1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again. +## **Glossary** --------------------------------------------------------------------------------------------------------------------- +Here are the definitions of some terms which is used throughout the User Guide and Developer Guide. -## Command summary +| Term | Definition | +|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Command Line Interface (CLI)** | A type of user interface in which the user interacts with a system by typing commands into a terminal or console. | +| **Graphical User Interface (GUI)** | A type of user interface that allows users to interact with a system through graphical icons and visual indicators. | +| **Hyperlink (link)** | A reference in the webpage that allows users to directly access another location or file within the same or a different webpage. | +| **Command Terminal** | A software-based interface that provides an environment for users to interact with a computer's operating system or software by typing textual commands and receiving text-based output. | +| **Sample Data** | Pre-populated data used for demonstration purposes, enabling new users to see how the application functions with realistic examples. | +| **Workflow** | A systematic and repeatable pattern of activity that a user follows to accomplish a specific task. | +| **Command** | An input from the user that tells _LetsGetHired_ which action to perform. | +| **Parameter** | A placeholder used in a command to represent a piece of information that needs to be provided when that command is executed. | +| **JSON (JavaScript Object Notation)** | A lightweight data-interchange format that is easy for humans to read and write and easy for machines to parse and generate. | -Action | Format, Examples ---------|------------------ -**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague` -**Clear** | `clear` -**Delete** | `delete INDEX`
e.g., `delete 3` -**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` -**Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` -**List** | `list` -**Help** | `help` +[Back to top](#user-guide) diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index 6bd245d8f4e..00000000000 --- a/docs/_config.yml +++ /dev/null @@ -1,15 +0,0 @@ -title: "AB-3" -theme: minima - -header_pages: - - UserGuide.md - - DeveloperGuide.md - - AboutUs.md - -markdown: kramdown - -repository: "se-edu/addressbook-level3" -github_icon: "images/github-icon.png" - -plugins: - - jemoji diff --git a/docs/_data/projects.yml b/docs/_data/projects.yml deleted file mode 100644 index 8f3e50cb601..00000000000 --- a/docs/_data/projects.yml +++ /dev/null @@ -1,23 +0,0 @@ -- name: "AB-1" - url: https://se-edu.github.io/addressbook-level1 - -- name: "AB-2" - url: https://se-edu.github.io/addressbook-level2 - -- name: "AB-3" - url: https://se-edu.github.io/addressbook-level3 - -- name: "AB-4" - url: https://se-edu.github.io/addressbook-level4 - -- name: "Duke" - url: https://se-edu.github.io/duke - -- name: "Collate" - url: https://se-edu.github.io/collate - -- name: "Book" - url: https://se-edu.github.io/se-book - -- name: "Resources" - url: https://se-edu.github.io/resources diff --git a/docs/_includes/custom-head.html b/docs/_includes/custom-head.html deleted file mode 100644 index 8559a67ffad..00000000000 --- a/docs/_includes/custom-head.html +++ /dev/null @@ -1,6 +0,0 @@ -{% comment %} - Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons: - - 1. Head over to https://realfavicongenerator.net/ to add your own favicons. - 2. Customize default _includes/custom-head.html in your source directory and insert the given code snippet. -{% endcomment %} diff --git a/docs/_includes/head.html b/docs/_includes/head.html deleted file mode 100644 index 83ac5326933..00000000000 --- a/docs/_includes/head.html +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - {%- include custom-head.html -%} - -
- {%- assign default_paths = site.pages | map: "path" -%}
- {%- assign page_paths = site.header_pages | default: default_paths -%}
- {%- assign titles_size = site.pages | map: 'title' | join: '' | size -%}
- {{ site.title | escape }}
-
- {%- if titles_size > 0 -%}
-
- {%- endif -%}
-
-{{ page.title | escape }}
-
- {{ content }}
-
-
-
+
+
+
+
diff --git a/docs/_markbind/variables.json b/docs/_markbind/variables.json
new file mode 100644
index 00000000000..9d89eb0358b
--- /dev/null
+++ b/docs/_markbind/variables.json
@@ -0,0 +1,3 @@
+{
+ "jsonVariableExample": "Your variables can be defined here as well"
+}
diff --git a/docs/_markbind/variables.md b/docs/_markbind/variables.md
new file mode 100644
index 00000000000..89ae5318fa4
--- /dev/null
+++ b/docs/_markbind/variables.md
@@ -0,0 +1,4 @@
+
+ {{ content }}
+
+
+
+
-:information_source: Don’t forget to update `AddressBookParser` to use our new `RemarkCommandParser`!
+Don’t forget to update `AddressBookParser` to use our new `RemarkCommandParser`!
-
+
If you are stuck, check out the sample
[here](https://github.com/se-edu/addressbook-level3/commit/dc6d5139d08f6403da0ec624ea32bd79a2ae0cbf#diff-8bf239e8e9529369b577701303ddd96af93178b4ed6735f91c2d8488b20c6b4a).
## Add `Remark` to the model
-Now that we have all the information that we need, let’s lay the groundwork for propagating the remarks added into the in-memory storage of person data. We achieve that by working with the `Person` model. Each field in a Person is implemented as a separate class (e.g. a `Name` object represents the person’s name). That means we should add a `Remark` class so that we can use a `Remark` object to represent a remark given to a person.
+Now that we have all the information that we need, let’s lay the groundwork for propagating the remarks added into the in-memory storage of internApplication data. We achieve that by working with the `Person` model. Each field in a Person is implemented as a separate class (e.g. a `Company` object represents the internApplication’s company). That means we should add a `Remark` class so that we can use a `Remark` object to represent a remark given to a internApplication.
### Add a new `Remark` class
-Create a new `Remark` in `seedu.address.model.person`. Since a `Remark` is a field that is similar to `Address`, we can reuse a significant bit of code.
+Create a new `Remark` in `seedu.status.model.application`. Since a `Remark` is a field that is similar to `Address`, we can reuse a significant bit of code.
A copy-paste and search-replace later, you should have something like [this](https://github.com/se-edu/addressbook-level3/commit/4516e099699baa9e2d51801bd26f016d812dedcc#diff-41bb13c581e280c686198251ad6cc337cd5e27032772f06ed9bf7f1440995ece). Note how `Remark` has no constrains and thus does not require input
validation.
@@ -238,13 +241,13 @@ Let’s change `RemarkCommand` and `RemarkCommandParser` to use the new `Remark`
## Add a placeholder element for remark to the UI
-Without getting too deep into `fxml`, let’s go on a 5 minute adventure to get some placeholder text to show up for each person.
+Without getting too deep into `fxml`, let’s go on a 5 minute adventure to get some placeholder text to show up for each internApplication.
-Simply add the following to [`seedu.address.ui.PersonCard`](https://github.com/se-edu/addressbook-level3/commit/850b78879582f38accb05dd20c245963c65ea599#diff-639834f1e05afe2276a86372adf0fe5f69314642c2d93cfa543d614ce5a76688).
+Simply add the following to [`seedu.status.ui.PersonCard`](https://github.com/se-edu/addressbook-level3/commit/850b78879582f38accb05dd20c245963c65ea599#diff-639834f1e05afe2276a86372adf0fe5f69314642c2d93cfa543d614ce5a76688).
**`PersonCard.java`:**
-``` java
+```java
@FXML
private Label remark;
```
@@ -276,11 +279,11 @@ We change the constructor of `Person` to take a `Remark`. We will also need to d
Unfortunately, a change to `Person` will cause other commands to break, you will have to modify these commands to use the updated `Person`!
-
+
-:bulb: Use the `Find Usages` feature in IntelliJ IDEA on the `Person` class to find these commands.
+Use the `Find Usages` feature in IntelliJ IDEA on the `Person` class to find these commands.
-
+
Refer to [this commit](https://github.com/se-edu/addressbook-level3/commit/ce998c37e65b92d35c91d28c7822cd139c2c0a5c) and check that you have got everything in order!
@@ -291,11 +294,11 @@ AddressBook stores data by serializing `JsonAdaptedPerson` into `json` with the
While the changes to code may be minimal, the test data will have to be updated as well.
-
+
-:exclamation: You must delete AddressBook’s storage file located at `/data/addressbook.json` before running it! Not doing so will cause AddressBook to default to an empty address book!
+You must delete AddressBook’s storage file located at `/data/addressbook.json` before running it! Not doing so will cause AddressBook to default to an empty status book!
-
+
Check out [this commit](https://github.com/se-edu/addressbook-level3/commit/556cbd0e03ff224d7a68afba171ad2eb0ce56bbf)
to see what the changes entail.
@@ -308,10 +311,10 @@ Just add [this one line of code!](https://github.com/se-edu/addressbook-level3/c
**`PersonCard.java`:**
-``` java
-public PersonCard(Person person, int displayedIndex) {
+```java
+public PersonCard(Person internApplication, int displayedIndex) {
//...
- remark.setText(person.getRemark().value);
+ remark.setText(internApplication.getRemark().value);
}
```
@@ -328,7 +331,7 @@ save it with `Model#setPerson()`.
**`RemarkCommand.java`:**
-``` java
+```java
//...
public static final String MESSAGE_ADD_REMARK_SUCCESS = "Added remark to Person: %1$s";
public static final String MESSAGE_DELETE_REMARK_SUCCESS = "Removed remark from Person: %1$s";
@@ -341,25 +344,25 @@ save it with `Model#setPerson()`.
throw new CommandException(Messages.MESSAGE_INVALID_PERSON_DISPLAYED_INDEX);
}
- Person personToEdit = lastShownList.get(index.getZeroBased());
- Person editedPerson = new Person(
- personToEdit.getName(), personToEdit.getPhone(), personToEdit.getEmail(),
- personToEdit.getAddress(), remark, personToEdit.getTags());
+ Person internApplicationToEdit = lastShownList.get(index.getZeroBased());
+ Person editedInternApplication = new Person(
+ internApplicationToEdit.getName(), internApplicationToEdit.getPhone(), internApplicationToEdit.getCycle(),
+ internApplicationToEdit.getAddress(), remark, internApplicationToEdit.getTags());
- model.setPerson(personToEdit, editedPerson);
+ model.setPerson(internApplicationToEdit, editedInternApplication);
model.updateFilteredPersonList(PREDICATE_SHOW_ALL_PERSONS);
- return new CommandResult(generateSuccessMessage(editedPerson));
+ return new CommandResult(generateSuccessMessage(editedInternApplication));
}
/**
* Generates a command execution success message based on whether
* the remark is added to or removed from
- * {@code personToEdit}.
+ * {@code internApplicationToEdit}.
*/
- private String generateSuccessMessage(Person personToEdit) {
+ private String generateSuccessMessage(Person internApplicationToEdit) {
String message = !remark.value.isEmpty() ? MESSAGE_ADD_REMARK_SUCCESS : MESSAGE_DELETE_REMARK_SUCCESS;
- return String.format(message, personToEdit);
+ return String.format(message, internApplicationToEdit);
}
```
diff --git a/docs/tutorials/RemovingFields.md b/docs/tutorials/RemovingFields.md
index f29169bc924..3b3caa9f0cd 100644
--- a/docs/tutorials/RemovingFields.md
+++ b/docs/tutorials/RemovingFields.md
@@ -1,26 +1,29 @@
---
-layout: page
-title: "Tutorial: Removing Fields"
+ layout: default.md
+ title: "Tutorial: Removing Fields"
+ pageNav: 3
---
+# Tutorial: Removing Fields
+
> Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away.
>
> — Antoine de Saint-Exupery
When working on an existing code base, you will most likely find that some features that are no longer necessary.
-This tutorial aims to give you some practice on such a code 'removal' activity by removing the `address` field from `Person` class.
+This tutorial aims to give you some practice on such a code 'removal' activity by removing the `status` field from `Person` class.
-
+
-**If you have done the [Add `remark` command tutorial](AddRemark.html) already**, you should know where the code had to be updated to add the field `remark`. From that experience, you can deduce where the code needs to be changed to _remove_ that field too. The removing of the `address` field can be done similarly.
+**If you have done the [Add `remark` command tutorial](AddRemark.html) already**, you should know where the code had to be updated to add the field `remark`. From that experience, you can deduce where the code needs to be changed to _remove_ that field too. The removing of the `status` field can be done similarly.
However, if you have no such prior knowledge, removing a field can take a quite a bit of detective work. This tutorial takes you through that process. **At least have a read even if you don't actually do the steps yourself.** -
+
-* Table of Contents
-{:toc}
+
+
## Safely deleting `Address`
@@ -28,7 +31,7 @@ IntelliJ IDEA provides a refactoring tool that can identify *most* parts of a re
### Assisted refactoring
-The `address` field in `Person` is actually an instance of the `seedu.address.model.person.Address` class. Since removing the `Address` class will break the application, we start by identifying `Address`'s usages. This allows us to see code that depends on `Address` to function properly and edit them on a case-by-case basis. Right-click the `Address` class and select `Refactor` \> `Safe Delete` through the menu.
+The `status` field in `Person` is actually an instance of the `seedu.letsgethired.model.application.Status class. Since removing the `Address` class will break the application, we start by identifying `Address`'s usages. This allows us to see code that depends on `Address` to function properly and edit them on a case-by-case basis. Right-click the `Address` class and select `Refactor` \> `Safe Delete` through the menu.
* :bulb: To make things simpler, you can unselect the options `Search in comments and strings` and `Search for text occurrences`
@@ -41,19 +44,19 @@ Remove usages of `Address` by performing `Safe Delete`s on each entry i.e., doub
Let’s try removing references to `Address` in `EditPersonDescriptor`.
-1. Safe delete the field `address` in `EditPersonDescriptor`.
+1. Safe delete the field `status` in `EditPersonDescriptor`.
1. Select `Yes` when prompted to remove getters and setters.
1. Select `View Usages` again.However, if you have no such prior knowledge, removing a field can take a quite a bit of detective work. This tutorial takes you through that process. **At least have a read even if you don't actually do the steps yourself.** -
 -1. Remove the usages of `address` and select `Do refactor` when you are done. +1. Remove the usages of `status` and select `Do refactor` when you are done. -
+
- :bulb: **Tip:** Removing usages may result in errors. Exercise discretion and fix them. For example, removing the `address` field from the `Person` class will require you to modify its constructor.
-
+ **Tip:** Removing usages may result in errors. Exercise discretion and fix them. For example, removing the `status` field from the `Person` class will require you to modify its constructor.
+
1. Repeat the steps for the remaining usages of `Address`
@@ -61,20 +64,20 @@ After you are done, verify that the application still works by compiling and run
### Manual refactoring
-Unfortunately, there are usages of `Address` that IntelliJ IDEA cannot identify. You can find them by searching for instances of the word `address` in your code (`Edit` \> `Find` \> `Find in path`).
+Unfortunately, there are usages of `Address` that IntelliJ IDEA cannot identify. You can find them by searching for instances of the word `status` in your code (`Edit` \> `Find` \> `Find in path`).
-Places of interest to look out for would be resources used by the application. `main/resources` contains images and `fxml` files used by the application and `test/resources` contains test data. For example, there is a `$address` in each `PersonCard` that has not been removed nor identified.
+Places of interest to look out for would be resources used by the application. `main/resources` contains images and `fxml` files used by the application and `test/resources` contains test data. For example, there is a `$status` in each `PersonCard` that has not been removed nor identified.
-
+
A quick look at the `PersonCard` class and its `fxml` file quickly reveals why it slipped past the automated refactoring.
**`PersonCard.java`**
-``` java
+```java
...
@FXML
-private Label address;
+private Label status;
...
```
@@ -83,8 +86,8 @@ private Label address;
``` xml
...
-
-
+
+
...
```
@@ -94,19 +97,19 @@ After removing the `Label`, we can proceed to formally test our code. If everyth
At this point, your application is working as intended and all your tests are passing. What’s left to do is to clean up references to `Address` in test data and documentation.
-In `src/test/data/`, data meant for testing purposes are stored. While keeping the `address` field in the json files does not cause the tests to fail, it is not good practice to let cruft from old features accumulate.
+In `src/test/data/`, data meant for testing purposes are stored. While keeping the `status` field in the json files does not cause the tests to fail, it is not good practice to let cruft from old features accumulate.
**`invalidPersonAddressBook.json`:**
```json
{
- "persons": [ {
- "name": "Person with invalid name field: Ha!ns Mu@ster",
+ "internApplications": [ {
+ "company": "Person with invalid company field: J@ne Str3et",
"phone": "9482424",
- "email": "hans@example.com",
- "address": "4th street"
+ "cycle": "hans@example.com",
+ "status": "4th street"
} ]
}
```
-You can go through each individual `json` file and manually remove the `address` field.
+You can go through each individual `json` file and manually remove the `status` field.
diff --git a/docs/tutorials/TracingCode.md b/docs/tutorials/TracingCode.md
index 4fb62a83ef6..dac82e11fc4 100644
--- a/docs/tutorials/TracingCode.md
+++ b/docs/tutorials/TracingCode.md
@@ -1,26 +1,30 @@
---
-layout: page
-title: "Tutorial: Tracing code"
+ layout: default.md
+ title: "Tutorial: Tracing code"
+ pageNav: 3
---
+# Tutorial: Tracing code
+
+
> Indeed, the ratio of time spent reading versus writing is well over 10 to 1. We are constantly reading old code as part of the effort to write new code. …\[Therefore,\] making it easy to read makes it easier to write.
>
> — Robert C. Martin Clean Code: A Handbook of Agile Software Craftsmanship
When trying to understand an unfamiliar code base, one common strategy used is to trace some representative execution path through the code base. One easy way to trace an execution path is to use a debugger to step through the code. In this tutorial, you will be using the IntelliJ IDEA’s debugger to trace the execution path of a specific user command.
-* Table of Contents
-{:toc}
+
+
## Before we start
Before we jump into the code, it is useful to get an idea of the overall structure and the high-level behavior of the application. This is provided in the 'Architecture' section of the developer guide. In particular, the architecture diagram (reproduced below), tells us that the App consists of several components.
-
+
+
+
-
+
-:bulb: **Intellij Tip:** The ['**Search Everywhere**' feature](https://www.jetbrains.com/help/idea/searching-everywhere.html) can be used here. In particular, the '**Find Symbol**' ('Symbol' here refers to methods, variables, classes etc.) variant of that feature is quite useful here as we are looking for a _method_ named `execute`, not simply the text `execute`.
-
+**Intellij Tip:** The ['**Search Everywhere**' feature](https://www.jetbrains.com/help/idea/searching-everywhere.html) can be used here. In particular, the '**Find Symbol**' ('Symbol' here refers to methods, variables, classes etc.) variant of that feature is quite useful here as we are looking for a _method_ named `execute`, not simply the text `execute`.
+
-A quick look at the `seedu.address.logic.Logic` (an extract given below) confirms that this indeed might be what we’re looking for.
+A quick look at the `seedu.status.logic.Logic` (an extract given below) confirms that this indeed might be what we’re looking for.
```java
public interface Logic {
@@ -67,14 +71,14 @@ public interface Logic {
But apparently, this is an interface, not a concrete implementation.
That should be fine because the [Architecture section of the Developer Guide](../DeveloperGuide.html#architecture) tells us that components interact through interfaces. Here's the relevant diagram:
-
+
+
-:bulb: **Intellij Tip:** The ['**Find Usages**' feature](https://www.jetbrains.com/help/idea/find-highlight-usages.html#find-usages) can find from which parts of the code a class/method/variable is being used.
-
+**Intellij Tip:** The ['**Find Usages**' feature](https://www.jetbrains.com/help/idea/find-highlight-usages.html#find-usages) can find from which parts of the code a class/method/variable is being used.
+
@@ -87,10 +91,10 @@ Now let’s set the breakpoint. First, double-click the item to reach the corres
Recall from the User Guide that the `edit` command has the format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…` For this tutorial we will be issuing the command `edit 1 n/Alice Yeoh`.
-
+
-:bulb: **Tip:** Over the course of the debugging session, you will encounter every major component in the application. Try to keep track of what happens inside the component and where the execution transfers to another component.
-
+**Tip:** Over the course of the debugging session, you will encounter every major component in the application. Try to keep track of what happens inside the component and where the execution transfers to another component.
+
1. To start the debugging session, simply `Run` \> `Debug Main`
@@ -110,7 +114,7 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [
**LogicManager\#execute().**
- ``` java
+ ```java
@Override
public CommandResult execute(String commandText)
throws CommandException, ParseException {
@@ -142,7 +146,7 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [
1. _Step into_ the line where user input in parsed from a String to a Command, which should bring you to the `AddressBookParser#parseCommand()` method (partial code given below):
- ``` java
+ ```java
public Command parseCommand(String userInput) throws ParseException {
...
final String commandWord = matcher.group("commandWord");
@@ -157,7 +161,7 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [
1. Stepping through the `switch` block, we end up at a call to `EditCommandParser().parse()` as expected (because the command we typed is an edit command).
- ``` java
+ ```java
...
case EditCommand.COMMAND_WORD:
return new EditCommandParser().parse(arguments);
@@ -166,8 +170,10 @@ Recall from the User Guide that the `edit` command has the format: `edit INDEX [
1. Let’s see what `EditCommandParser#parse()` does by stepping into it. You might have to click the 'step into' button multiple times here because there are two method calls in that statement: `EditCommandParser()` and `parse()`.
- :bulb: **Intellij Tip:** Sometimes, you might end up stepping into functions that are not of interest. Simply use the `step out` button to get out of them!
-
+ 
+ -  +
- FYI, The 'filtered list' is the list of persons resulting from the most recent operation that will be shown to the user immediately after. For the `edit` command, we populate it with all the persons so that the user can see the edited person along with all other persons. If this was a `find` command, we would be setting that list to contain the search results instead.
- To provide some context, given below is the class diagram of the `Model` component. See if you can figure out where the 'filtered list' of persons is being tracked. -
+ * it uses the `setPerson()` method (defined in the interface `Model` and implemented in `ModelManager` as per the usual pattern) to update the internApplication data. + * it uses the `updateFilteredPersonList` method to ask the `Model` to populate the 'filtered list' with _all_ internApplications.
+ FYI, The 'filtered list' is the list of internApplications resulting from the most recent operation that will be shown to the user immediately after. For the `edit` command, we populate it with all the internApplications so that the user can see the edited internApplication along with all other internApplications. If this was a `find` command, we would be setting that list to contain the search results instead.
+ To provide some context, given below is the class diagram of the `Model` component. See if you can figure out where the 'filtered list' of internApplications is being tracked. +
* :bulb: This may be a good time to read through the [`Model` component section of the DG](../DeveloperGuide.html#model-component) 1. As you step through the rest of the statements in the `EditCommand#execute()` method, you'll see that it creates a `CommandResult` object (containing information about the result of the execution) and returns it.
Advancing the debugger by one more step should take you back to the middle of the `LogicManager#execute()` method.
1. Given that you have already seen quite a few classes in the `Logic` component in action, see if you can identify in this partial class diagram some of the classes you've encountered so far, and see how they fit into the class structure of the `Logic` component: -
+ :bulb: **Intellij Tip:** When trying to step into a statement such as `storage.saveAddressBook(model.getAddressBook())` which contains multiple method calls, Intellij will let you choose (by clicking) which one you want to step into.
-
+ -
+ - * The data from the sample address book will be used instead if {@code storage}'s address book is not found, - * or an empty address book will be used instead if errors occur when reading {@code storage}'s address book. + * Returns a {@code ModelManager} with the data from {@code storage}'s intern tracker and {@code userPrefs}.
+ * The data from the sample intern tracker will be used instead if {@code storage}'s intern tracker is not found, + * or an empty intern tracker will be used instead if errors occur when reading {@code storage}'s intern tracker. */ private Model initModelManager(Storage storage, ReadOnlyUserPrefs userPrefs) { - logger.info("Using data file : " + storage.getAddressBookFilePath()); + logger.info("Using data file : " + storage.getInternTrackerFilePath()); - Optional
- * - the returned {@link CommandResult} matches {@code expectedCommandResult}
- * - the {@code actualModel} matches {@code expectedModel} - */ - public static void assertCommandSuccess(Command command, Model actualModel, CommandResult expectedCommandResult, - Model expectedModel) { - try { - CommandResult result = command.execute(actualModel); - assertEquals(expectedCommandResult, result); - assertEquals(expectedModel, actualModel); - } catch (CommandException ce) { - throw new AssertionError("Execution of command should not fail.", ce); - } - } - - /** - * Convenience wrapper to {@link #assertCommandSuccess(Command, Model, CommandResult, Model)} - * that takes a string {@code expectedMessage}. - */ - public static void assertCommandSuccess(Command command, Model actualModel, String expectedMessage, - Model expectedModel) { - CommandResult expectedCommandResult = new CommandResult(expectedMessage); - assertCommandSuccess(command, actualModel, expectedCommandResult, expectedModel); - } - - /** - * Executes the given {@code command}, confirms that
- * - a {@code CommandException} is thrown
- * - the CommandException message matches {@code expectedMessage}
- * - the address book, filtered person list and selected person in {@code actualModel} remain unchanged - */ - public static void assertCommandFailure(Command command, Model actualModel, String expectedMessage) { - // we are unable to defensively copy the model for comparison later, so we can - // only do so by copying its components. - AddressBook expectedAddressBook = new AddressBook(actualModel.getAddressBook()); - List
- * {@code AddressBook ab = new AddressBookBuilder().withPerson("John", "Doe").build();} - */ -public class AddressBookBuilder { - - private AddressBook addressBook; - - public AddressBookBuilder() { - addressBook = new AddressBook(); - } - - public AddressBookBuilder(AddressBook addressBook) { - this.addressBook = addressBook; - } - - /** - * Adds a new {@code Person} to the {@code AddressBook} that we are building. - */ - public AddressBookBuilder withPerson(Person person) { - addressBook.addPerson(person); - return this; - } - - public AddressBook build() { - return addressBook; - } -} diff --git a/src/test/java/seedu/address/testutil/EditPersonDescriptorBuilder.java b/src/test/java/seedu/address/testutil/EditPersonDescriptorBuilder.java deleted file mode 100644 index 4584bd5044e..00000000000 --- a/src/test/java/seedu/address/testutil/EditPersonDescriptorBuilder.java +++ /dev/null @@ -1,87 +0,0 @@ -package seedu.address.testutil; - -import java.util.Set; -import java.util.stream.Collectors; -import java.util.stream.Stream; - -import seedu.address.logic.commands.EditCommand.EditPersonDescriptor; -import seedu.address.model.person.Address; -import seedu.address.model.person.Email; -import seedu.address.model.person.Name; -import seedu.address.model.person.Person; -import seedu.address.model.person.Phone; -import seedu.address.model.tag.Tag; - -/** - * A utility class to help with building EditPersonDescriptor objects. - */ -public class EditPersonDescriptorBuilder { - - private EditPersonDescriptor descriptor; - - public EditPersonDescriptorBuilder() { - descriptor = new EditPersonDescriptor(); - } - - public EditPersonDescriptorBuilder(EditPersonDescriptor descriptor) { - this.descriptor = new EditPersonDescriptor(descriptor); - } - - /** - * Returns an {@code EditPersonDescriptor} with fields containing {@code person}'s details - */ - public EditPersonDescriptorBuilder(Person person) { - descriptor = new EditPersonDescriptor(); - descriptor.setName(person.getName()); - descriptor.setPhone(person.getPhone()); - descriptor.setEmail(person.getEmail()); - descriptor.setAddress(person.getAddress()); - descriptor.setTags(person.getTags()); - } - - /** - * Sets the {@code Name} of the {@code EditPersonDescriptor} that we are building. - */ - public EditPersonDescriptorBuilder withName(String name) { - descriptor.setName(new Name(name)); - return this; - } - - /** - * Sets the {@code Phone} of the {@code EditPersonDescriptor} that we are building. - */ - public EditPersonDescriptorBuilder withPhone(String phone) { - descriptor.setPhone(new Phone(phone)); - return this; - } - - /** - * Sets the {@code Email} of the {@code EditPersonDescriptor} that we are building. - */ - public EditPersonDescriptorBuilder withEmail(String email) { - descriptor.setEmail(new Email(email)); - return this; - } - - /** - * Sets the {@code Address} of the {@code EditPersonDescriptor} that we are building. - */ - public EditPersonDescriptorBuilder withAddress(String address) { - descriptor.setAddress(new Address(address)); - return this; - } - - /** - * Parses the {@code tags} into a {@code Set
* - the feedback message is equal to {@code expectedMessage}
* - the internal model manager state is the same as that in {@code expectedModel}
+ * * @see #assertCommandFailure(String, Class, String, Model) */ - private void assertCommandSuccess(String inputCommand, String expectedMessage, - Model expectedModel) throws CommandException, ParseException { + private void assertCommandSuccess(String inputCommand, String expectedMessage, Model expectedModel) + throws CommandException, ParseException { CommandResult result = logic.execute(inputCommand); assertEquals(expectedMessage, result.getFeedbackToUser()); assertEquals(expectedModel, model); @@ -103,6 +104,7 @@ private void assertCommandSuccess(String inputCommand, String expectedMessage, /** * Executes the command, confirms that a ParseException is thrown and that the result message is correct. + * * @see #assertCommandFailure(String, Class, String, Model) */ private void assertParseException(String inputCommand, String expectedMessage) { @@ -111,6 +113,7 @@ private void assertParseException(String inputCommand, String expectedMessage) { /** * Executes the command, confirms that a CommandException is thrown and that the result message is correct. + * * @see #assertCommandFailure(String, Class, String, Model) */ private void assertCommandException(String inputCommand, String expectedMessage) { @@ -119,11 +122,12 @@ private void assertCommandException(String inputCommand, String expectedMessage) /** * Executes the command, confirms that the exception is thrown and that the result message is correct. + * * @see #assertCommandFailure(String, Class, String, Model) */ private void assertCommandFailure(String inputCommand, Class expectedException, - String expectedMessage) { - Model expectedModel = new ModelManager(model.getAddressBook(), new UserPrefs()); + String expectedMessage) { + Model expectedModel = new ModelManager(logic.getInternTracker(), new UserPrefs()); assertCommandFailure(inputCommand, expectedException, expectedMessage, expectedModel); } @@ -132,10 +136,11 @@ private void assertCommandFailure(String inputCommand, Class * - the resulting error message is equal to {@code expectedMessage}
* - the internal model manager state is the same as that in {@code expectedModel}
+ * * @see #assertCommandSuccess(String, String, Model) */ private void assertCommandFailure(String inputCommand, Class expectedException, - String expectedMessage, Model expectedModel) { + String expectedMessage, Model expectedModel) { assertThrows(expectedException, expectedMessage, () -> logic.execute(inputCommand)); assertEquals(expectedModel, model); } @@ -143,33 +148,35 @@ private void assertCommandFailure(String inputCommand, Class new AddCommand(null)); + } + + @Test + public void execute_internApplicationAcceptedByModel_addSuccessful() throws Exception { + ModelStubAcceptingInternApplicationAdded modelStub = new ModelStubAcceptingInternApplicationAdded(); + InternApplication validInternApplication = new InternApplicationBuilder().build(); + + CommandResult commandResult = new AddCommand(validInternApplication).execute(modelStub); + + assertEquals(String.format(AddCommand.MESSAGE_SUCCESS, validInternApplication), + commandResult.getFeedbackToUser()); + assertEquals(Arrays.asList(validInternApplication), modelStub.internApplicationAdded); + } + + @Test + public void execute_duplicateInternApplication_throwsCommandException() { + InternApplication validInternApplication = new InternApplicationBuilder().build(); + AddCommand addCommand = new AddCommand(validInternApplication); + ModelStub modelStub = new ModelStubWithInternApplication(validInternApplication); + + assertThrows(CommandException.class, + AddCommand.MESSAGE_DUPLICATE_INTERN_APPLICATION, () -> addCommand.execute(modelStub)); + } + + @Test + public void equals() { + InternApplication janeStreet = new InternApplicationBuilder().withCompany("Jane Street").build(); + InternApplication byteDance = new InternApplicationBuilder().withCompany("ByteDance").build(); + AddCommand addACommand = new AddCommand(janeStreet); + AddCommand addBCommand = new AddCommand(byteDance); + + // same object -> returns true + assertTrue(addACommand.equals(addACommand)); + + // same values -> returns true + AddCommand addACommandCopy = new AddCommand(janeStreet); + assertTrue(addACommand.equals(addACommandCopy)); + + // different types -> returns false + assertFalse(addACommand.equals(1)); + + // null -> returns false + assertFalse(addACommand.equals(null)); + + // different intern application -> returns false + assertFalse(addACommand.equals(addBCommand)); + } + + @Test + public void toStringMethod() { + AddCommand addCommand = new AddCommand(JANE_STREET); + String expected = AddCommand.class.getCanonicalName() + "{toAdd=" + JANE_STREET + "}"; + assertEquals(expected, addCommand.toString()); + } + + /** + * A default model stub that have all the methods failing. + */ + private class ModelStub implements Model { + @Override + public void setUserPrefs(ReadOnlyUserPrefs userPrefs) { + throw new AssertionError("This method should not be called."); + } + + @Override + public ReadOnlyUserPrefs getUserPrefs() { + throw new AssertionError("This method should not be called."); + } + + @Override + public GuiSettings getGuiSettings() { + throw new AssertionError("This method should not be called."); + } + + @Override + public void setGuiSettings(GuiSettings guiSettings) { + throw new AssertionError("This method should not be called."); + } + + @Override + public Path getInternTrackerFilePath() { + throw new AssertionError("This method should not be called."); + } + + @Override + public void setInternTrackerFilePath(Path internBookFilePath) { + throw new AssertionError("This method should not be called."); + } + + @Override + public void addInternApplication(InternApplication internApplication) { + throw new AssertionError("This method should not be called."); + } + + @Override + public void setInternTracker(ReadOnlyInternTracker newData) { + throw new AssertionError("This method should not be called."); + } + + @Override + public ReadOnlyInternTracker getInternTracker() { + throw new AssertionError("This method should not be called."); + } + + @Override + public boolean hasInternApplication(InternApplication internApplication) { + throw new AssertionError("This method should not be called."); + } + + @Override + public void deleteInternApplication(InternApplication target) { + throw new AssertionError("This method should not be called."); + } + + @Override + public void setInternApplication(InternApplication target, InternApplication editedInternApplication) { + throw new AssertionError("This method should not be called."); + } + + @Override + public ObservableList
+ * - the returned {@link CommandResult} matches {@code expectedCommandResult}
+ * - the {@code actualModel} matches {@code expectedModel} + */ + public static void assertCommandSuccess(Command command, Model actualModel, CommandResult expectedCommandResult, + Model expectedModel) { + try { + CommandResult result = command.execute(actualModel); + assertEquals(expectedCommandResult, result); + assertEquals(expectedModel, actualModel); + } catch (CommandException ce) { + throw new AssertionError("Execution of command should not fail.", ce); + } + } + + /** + * Convenience wrapper to {@link #assertCommandSuccess(Command, Model, CommandResult, Model)} + * that takes a string {@code expectedMessage}. + */ + public static void assertCommandSuccess(Command command, Model actualModel, String expectedMessage, + Model expectedModel) { + CommandResult expectedCommandResult = new CommandResult(expectedMessage); + assertCommandSuccess(command, actualModel, expectedCommandResult, expectedModel); + } + + /** + * Convenience wrapper to {@link #assertCommandSuccess(Command, Model, CommandResult, Model)} + * that takes a string {@code expectedMessage}. + */ + public static void assertCommandSuccess(Command command, Model actualModel, String expectedMessage, + InternApplication expectedApplication, Model expectedModel) { + CommandResult expectedCommandResult = new CommandResult(expectedMessage, expectedApplication); + assertCommandSuccess(command, actualModel, expectedCommandResult, expectedModel); + } + + /** + * Executes the given {@code command}, confirms that
+ * - a {@code CommandException} is thrown
+ * - the CommandException message matches {@code expectedMessage}
+ * - the intern tracker, filtered intern application list and + * selected intern application in {@code actualModel} remain unchanged + */ + public static void assertCommandFailure(Command command, Model actualModel, String expectedMessage) { + // we are unable to defensively copy the model for comparison later, so we can + // only do so by copying its components. + InternTracker expectedInternTracker = new InternTracker(actualModel.getInternTracker()); + List