+
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](https://github.com/zhongfu)]
+[[portfolio](team/zhongfu.md)]
-* Role: Project Advisor
+### Hong Yi En, Ian
-### Jane Doe
+
-
+[[github](http://github.com/ian-from-dover)]
+[[portfolio](team/ian-from-dover.md)]
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+### Wrik Karmakar
-* Role: Team Lead
-* Responsibilities: UI
+
-### Johnny Doe
+[[github](http://github.com/thewrik)] [[portfolio](team/thewrik.md)]
-
+### Elliot Lim Zhi Yong
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+
-* Role: Developer
-* Responsibilities: Data
+[[github](http://github.com/spyobird)]
+[[portfolio](team/spyobird.md)]
-### Jean Doe
-
+### Elumalai Oviya Dharshini
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+[[github](http://github.com/ovidharshini)]
+[[portfolio](team/ovidharshini.md)]
-### James Doe
-
-
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Developer
-* Responsibilities: UI
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
index 46eae8ee565..641bc05e738 100644
--- a/docs/DeveloperGuide.md
+++ b/docs/DeveloperGuide.md
@@ -2,47 +2,61 @@
layout: page
title: Developer Guide
---
+
+## Introduction
+
+PeopleSoft is a desktop app for **calculating the salary for shift-based contractors**, optimized for use via a **Command Line Interface (CLI)**. If you are a **HR manager** and you can type fast, PeopleSoft can get your payroll tasks done **much faster** than traditional GUI apps.
+
+**PeopleSoft helps to:**
+* Simplify the management of data
+* Reduce menial labour
+* Reduce mistakes due to human error in calculation / accidental edits
+* Help employees be assured that their hours and pay are registered correctly in the system
+
+--------------------------------------------------------------------------------------------------------------------
+
* Table of Contents
{:toc}
--------------------------------------------------------------------------------------------------------------------
-## **Acknowledgements**
+## Acknowledgements
+* Project adapted from [addressbook-level3](https://se-education.org/addressbook-level3/DeveloperGuide.html#product-scope)
+* Layout of user stories adapted from [TAB](https://ay2122s1-cs2103t-f13-3.github.io/tp/DeveloperGuide.html#user-stories)
* {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
--------------------------------------------------------------------------------------------------------------------
-## **Setting up, getting started**
+## Setting up, getting started
Refer to the guide [_Setting up and getting started_](SettingUp.md).
--------------------------------------------------------------------------------------------------------------------
-## **Design**
+## Design
-The ***Architecture Diagram*** given above explains the high-level design of the App.
+*Figure 1. Architecture diagram of the high-level design of PeopleSoft*
Given below is a quick overview of main components and how they interact with each other.
**Main components of the architecture**
-**`Main`** has two classes called [`Main`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/Main.java) and [`MainApp`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java). It is responsible for,
-* At app launch: Initializes the components in the correct sequence, and connects them up with each other.
-* At shut down: Shuts down the components and invokes cleanup methods where necessary.
+**`Main`** has two classes called [`Main`](https://github.com/AY2122S2-CS2103T-T11-4/tp/blob/master/src/main/java/peoplesoft/Main.java) and [`MainApp`](https://github.com/AY2122S2-CS2103T-T11-4/tp/blob/master/src/main/java/peoplesoft/MainApp.java). It is responsible for,
+* At app launch: Initializing the components in the correct sequence, and connecting them up with each other.
+* At shut down: Shutting down the components and invoking cleanup methods where necessary.
[**`Commons`**](#common-classes) represents a collection of classes used by multiple other components.
-The rest of the App consists of four components.
+The rest of the application consists of four components.
* [**`UI`**](#ui-component): The UI of the App.
* [**`Logic`**](#logic-component): The command executor.
@@ -52,108 +66,239 @@ The rest of the App consists of four components.
**How the architecture components interact with each other**
-The *Sequence Diagram* below shows how the components interact with each other for the scenario where the user issues the command `delete 1`.
-
+*Figure 2. Sequence diagram showing component interactions when the user enters the command `persondelete 1`*
+
Each of the four main components (also shown in the diagram above),
-* defines its *API* in an `interface` with the same name as the Component.
-* implements its functionality using a concrete `{Component Name}Manager` class (which follows the corresponding API `interface` mentioned in the previous point.
+* defines its *API* in an `interface` with the same name as the component.
+* implements its functionality using a concrete `{Component Name}Manager` class (which follows the corresponding API `interface` mentioned in the previous point).
For example, the `Logic` component defines its API in the `Logic.java` interface and implements its functionality using the `LogicManager.java` class which follows the `Logic` interface. Other components interact with a given component through its interface rather than the concrete class (reason: to prevent outside component's being coupled to the implementation of a component), as illustrated in the (partial) class diagram below.
+*Figure 3. Partial class diagram of the interaction of components*
+
The sections below give more details of each component.
### UI component
-The **API** of this component is specified in [`Ui.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/Ui.java)
+The **API** of this component is specified in the [`Ui.java`](https://github.com/AY2122S2-CS2103T-T11-4/tp/blob/master/src/main/java/peoplesoft/ui/Ui.java) interface.
+*Figure 4. Class diagram of GUI*
-The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `PersonListPanel`, `StatusBarFooter` etc. All these, including the `MainWindow`, inherit from the abstract `UiPart` class which captures the commonalities between classes that represent parts of the visible GUI.
+The UI consists of a `MainWindow` that is made up of parts e.g.`SideBar`, `CommandBox`, `ResultDisplay`, `OverviewPage`, etc. All these, including the `MainWindow`, inherit from the abstract `UiPart` class which captures the commonalities between classes that represent parts of the visible GUI.
-The `UI` component uses the JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the [`MainWindow`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/MainWindow.java) is specified in [`MainWindow.fxml`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/resources/view/MainWindow.fxml)
+The `UI` component uses the JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the [`MainWindow`](https://github.com/AY2122S2-CS2103T-T11-4/tp/blob/master/src/main/java/peoplesoft/ui/MainWindow.java) is specified in [`MainWindow.fxml`](https://github.com/AY2122S2-CS2103T-T11-4/tp/blob/master/src/main/resources/view/MainWindow.fxml)
The `UI` component,
* executes user commands using the `Logic` component.
* listens for changes to `Model` data so that the UI can be updated with the modified data.
* keeps a reference to the `Logic` component, because the `UI` relies on the `Logic` to execute commands.
-* depends on some classes in the `Model` component, as it displays `Person` object residing in the `Model`.
+* depends on some classes in the `Model` component, as it displays the `Person` and `Job` objects residing in the `Model`.
### Logic component
-**API** : [`Logic.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/logic/Logic.java)
+The **API** of this component is specified in the [`Logic.java`](https://github.com/AY2122S2-CS2103T-T11-4/tp/blob/master/src/main/java/peoplesoft/logic/Logic.java) interface.
Here's a (partial) class diagram of the `Logic` component:
+*Figure 5. Partial class diagram of the `Logic` component*
+
How the `Logic` component works:
1. When `Logic` is called upon to execute a command, it uses the `AddressBookParser` class to parse the user command.
-1. This results in a `Command` object (more precisely, an object of one of its subclasses e.g., `AddCommand`) which is executed by the `LogicManager`.
-1. The command can communicate with the `Model` when it is executed (e.g. to add a person).
-1. The result of the command execution is encapsulated as a `CommandResult` object which is returned back from `Logic`.
-
-The Sequence Diagram below illustrates the interactions within the `Logic` component for the `execute("delete 1")` API call.
+2. This results in a `Command` object (more precisely, an object of one of its subclasses e.g., `JobAddCommand`) which is executed by the `LogicManager`.
+3. The command can communicate with the `Model` when it is executed (e.g. to add a person).
+4. The result of the command execution is encapsulated as a `CommandResult` object which is returned back from `Logic`.
-
+*Figure 7. Class diagram of the Parser component, a subcomponent of the Logic component*
+
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.
+* 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., `JobAddCommandParser`) which uses the other classes shown above to parse the user command and create a `XYZCommand` object (e.g., `JobAddCommand`) which the `AddressBookParser` returns back as a `Command` object.
+* All `XYZCommandParser` classes (e.g., `JobAddCommandParser`, `JobDeleteCommandParser`, ...) inherit from the `Parser` interface so that they can be treated similarly where possible e.g, during testing.
### Model component
-**API** : [`Model.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/model/Model.java)
+The **API** of this component is specified in the [`Model.java`](https://github.com/AY2122S2-CS2103T-T11-4/tp/blob/master/src/main/java/peoplesoft/model/Model.java) interface.
+*Figure 8. Class diagram of the `Model` component*
The `Model` component,
-* stores the address book data i.e., all `Person` objects (which are contained in a `UniquePersonList` object).
+* stores the address book data - i.e. all `Person` objects (which are contained in a `UniquePersonList` object), all `Job` objects (which are contained in a `UniqueJobList` object), and auxiliary classes `Employment`, `PaymentHandler` etc.
+* allows for the automatic serialization and deserialization of `AddressBook` objects (and any component objects, e.g. `Person`, `Email`, etc) to and from JSON.
* 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- -
+A more detailed model of `Person` and `Job` is given below. Notice the association class `Employment` between `Person` and `Job`.
-
+*Figure 10. Class diagram of the Storage component*
+
The `Storage` component,
-* can save both address book data and user preference data in json format, and read them back into corresponding objects.
+* 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`)
### Common classes
-Classes used by multiple components are in the `seedu.addressbook.commons` package.
+Classes used by multiple components are in the `peoplesoft.commons` package.
--------------------------------------------------------------------------------------------------------------------
-## **Implementation**
+## Implementation
This section describes some noteworthy details on how certain features are implemented.
+### JSON serialization and deserialization
+
+The serialization and deserialization of model objects (e.g. `AddressBook`, `UniquePersonList`, `Person`, `Job`, `Tag`) is handled by custom serializers and deserializers, implemented as nested class within each model class.
+
+These serializers and deserializers are automatically used by Jackson during serialization and deserialization.
+
+The serializer and deserializer for each class determine how the objects are to be serialized and deserialized, including but not limited to:
+* which fields are to be stored,
+* how each field should be (de)serialized, e.g. by directly converting it to/from a JSON type, or by delegating it to Jackson (which will use the serializer/deserializer for the field type), and
+* how the fields and current object are to be represented as (or parsed from) JSON values, e.g. objects, strings, numbers.
+
+This architecture has some advantages:
+* The serdes implementations are kept together with the related classes; developers adding new model classes will not have to modify files in other packages.
+ * The previous implementation (with `JsonAdaptedPerson` etc.) requires that developers update the `JsonAdapted` classes belonging in the `Storage` component; this may not be immediately evident to developers.
+* Developers adding new model classes can incorporate existing types (that already have corresponding serializers/deserializers) without needing to duplicate the serdes code, unlike with the previous implementation.
+* Developers will also not need to (practically) duplicate classes, e.g. `Job` -> `JsonAdaptedJob` (with the `@JsonCreator` annotation), just so that Jackson has something to serialize from/deserialize to.
+
+However, it also has some drawbacks:
+* It can be rather verbose, since each serializer/deserializer class contains a portion of boilerplate code
+* Developers writing serializers/deserializers will need to have basic knowledge of JSON, e.g. the types that are available, the structure of JSON objects and arrays, etc
+* Some knowledge of Jackson components (e.g. `JsonParser`, `JsonGenerator`, `ObjectNode`) is also required, as developers will need to use them to write values to/read values from the internal Jackson representation of a JSON value/object.
+
+### The `Find` command
+
+The `Find` command is an enhancement of the `Find` feature provided in AB3.
+It is structured using an object of `PersonContainsKeywordPredicate`, adapted from `NameContainsKeywordPredicate`. It
+has the following attributes:
+* `static final String COMMAND_WORD` initialised to `'find'`
+* `static final String MESSAGE_USAGE` initialised to the relevant message.
+* `PersonContainsKeywordPredicate predicate` used to find `Person` objects that match with the given keyword.
+
+Applying this filter to the entire list means that only `Persons` that match **ALL** the keywords would be retained in
+the filtered list.
+
+#### The `PersonContainsKeywordPredicate` class
+
+The **match** itself is defined as follows (within the `PersonContainsKeywordPredicate` class which implements the
+`Predicate` interface):
+If a `Person` contains **ALL** the keywords passed in the query, either in their `name` field or as equivalent to an
+element in their `tags` set of `Tag` objects, then, passed as a parameter to `test()`,
+it is a valid match.
+
+The implementation is achieved through using stream manipulations to iterate through each person object,
+and for any such object, iterating through each keyword passed in the query. The keyword is then checked if it is
+contained within the name or among the tags.
+
+One motivation behind using streams rather than iteration was that streams can be better optimized, given the need or
+bandwith arising later.
+
+### The `JobList` interface and `UniqueJobList` class
+
+The `JobList` is an interface for the list of jobs, that implements the `Iterable` interface and supports minimal list
+operations.
+
+The `UniqueJobList` class implements the `JobList` interface to that enforces uniqueness between its elements and does
+not allow nulls.
+Furthermore, it has the following attributes, to interact with `java.fx` effectively.
+* `ObservableList+ 1. Re-launch the app by double-clicking the jar file.
Expected: The most recent window size and location is retained. -1. _{ more test cases … }_ +### Adding an employee + +Adding an employee while employees are being shown + +Prerequisites: List all employees using the `list` command. Multiple employees in the list. + +- Test case: `personadd n/Nicole Tan p/99338558 e/nicole@stffhub.org a/1 Tech Drive, S138572 r/37.50 t/Hardware t/Senior`
Expected: An employee with the corresponding details will be added to the end of the employee list. Details of the added employee will be shown in the status message. +- Test case: `personadd p/99338558 e/nicole@stffhub.org a/1 Tech Drive, S138572 r/37.50 t/Hardware t/Senior`
Expected: No employee is added. The expected format of the `personadd` command will be shown in the status message. +- Test case: `personadd n/Nicole p/9 e/nicole@stffhub.org a/1 Tech Drive, S138572 r/37.50 t/Hardware t/Senior`
+ Expected: No employee is added. The expected format of `Phone` will be shown in the status message. + +Other incorrect `personadd` commands to try: `personadd`, `personadd n/Nicole`, `...`
+Expected: Similar to previous. -### Deleting a person +### Deleting an employee -1. Deleting a person while all persons are being shown +1. Deleting an employee while all employees are being shown - 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. + 1. Prerequisites: List all employees using the `list` command. Multiple employees 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: `delete 1`
+ Expected: First employee is deleted from the list. Details of the deleted employee shown in the status message. - 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: `delete 0`
+ Expected: No employee is deleted. Error details shown in the status message. Status bar remains the same. - 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 delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. -1. _{ more test cases … }_ +2. Deleting an employee after a find command is executed -### Saving data + 1. Prerequisites: List all persons using the `list` command. Multiple persons in the list. -1. Dealing with missing/corrupted data files + 2. Test case: `delete 1`
+ Expected: First contact is deleted from the observable list. Details of the deleted contact shown in the status message. Entering the `list` command shows that the employee that was originally in the first index is not deleted (unless the position of the employee was the same after the `find` command). - 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ + 3. Test case: `delete 0`
+ Expected: No person is deleted. Error details shown in the status message. Status bar remains the same. -1. _{ more test cases … }_ + 4. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
+ Expected: Similar to previous. diff --git a/docs/SettingUp.md b/docs/SettingUp.md index 275445bd551..6fa6da4f6b8 100644 --- a/docs/SettingUp.md +++ b/docs/SettingUp.md @@ -11,7 +11,7 @@ title: Setting up and getting started ## Setting up the project in your computer -
:exclamation: Note: Importing a Gradle project is slightly different from importing a normal Java project. 1. **Verify the setup**: - 1. Run the `seedu.address.Main` and try a few commands. + 1. Run the `peoplesoft.Main` and try a few commands. 1. [Run the tests](Testing.md) to ensure they all pass. -------------------------------------------------------------------------------------------------------------------- @@ -34,7 +34,7 @@ If you plan to use Intellij IDEA (highly recommended): If using IDEA, follow the guide [_[se-edu/guides] IDEA: Configuring the code style_](https://se-education.org/guides/tutorials/intellijCodeStyle.html) to set up IDEA's coding style to match ours. -
- e.g. `seedu.address.commons.StringUtilTest` + e.g. `peoplesoft.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` + e.g. `peoplesoft.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. `peoplesoft.logic.LogicManagerTest` diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 3716f3ca8a4..f73cc7cdd1c 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -2,191 +2,837 @@ layout: page title: User Guide --- +Welcome to PeopleSoft! -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. +PeopleSoft is a desktop application for **calculating the salary for shift-based contractors**, optimized for use via a **command-line interface (CLI)**. If you are a **HR manager** and you can type fast, PeopleSoft can get your payroll tasks done **much faster** than traditional graphical user interface (GUI) applications. -* Table of Contents -{:toc} +You can input your employees' data and the jobs that you want to keep track of. +Then, you can assign the employees to the jobs that they are working on. +After the job is completed, you can mark the job as paid, and PeopleSoft will calculate how much each employee is to be paid based on their hourly rates. +You can also generate a payslip in comma-separated values (CSV) format for you and your employees to refer to. + +PeopleSoft simulates a real life workflow: + * The company receives a new job. + * The HR manager `add`s the job to PeopleSoft, and `assign`s employees to work on it. + * The employees start working. + * When the employees complete the job, the HR manager `mark`s the job as completed. + * Once it is time to pay the employees, `pay` out the job and `export` the payslips for the employees. + +## How to use this guide + +If this is your first time using PeopleSoft, we recommend that you read the user guide in order. If you come across unfamiliar terms used in this user guide, their definitions may be found in the [glossary](#glossary). + +If you are searching for information about specific features, you might find the [command summary section](#command-summary) useful in providing a brief overview of all commands. Alternatively, you may choose to navigate to the relevant sections of the user guide from the [table of contents](#toc) for more detailed explanations of features. +| Syntax | Purpose | +|------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| +| `words in monospace font` | Commands to be typed into PeopleSoft | +|
+ +
+ +#### Assign employee to a job + +PeopleSoft allows you to indicate which employees are in-charge of a certain job with the `assign` command. The `assign` command requires 1 job *index*, and at least 1 employee *index* (each prefixed by `i/`). These indexes can be found under the `#` column in both lists. + +1. Type `assign 1 i/1` in the command box. + + The first number in the command (`1`) refers to the *index* of the job. In this case, it refers to the first job in the list of jobs, which is the aircon repair job created earlier. + + The prefix `i/` denotes the index of the employee to be assigned to the job. In this case, it references the first employee in the list of employees, which is "Nicole Tan". Additional employees can also be assigned to this job by adding additional `i/` attributes. + +2. Hit **Enter** to run the command. + + A message should appear, indicating that the job "Repair aircon" is assigned to "Nicole Tan". + +  + +
+ +
+ +#### Find employees who are qualified + +1. Type `personfind aircon` in the command box. + + This command searches for "aircon" in the names or tags of employees. Search terms are not case-sensitive. + +2. Hit **Enter** to run the command. + + There should be two employees listed: "Nicole Tan", and "Arjun Khatau". Notice that the list of employees now only shows employees with the "Aircon" tag. + +  + +
+ +3. Type `assign 1 i/2` in the command box. + + This assigns the second employee in the list (Arjun Khatau) to the first job. Notice that the employee index (2) now refers to the second employee in the current list (Arjun Khatau), instead of in the original list (Kavya Singh). + +4. Hit **Enter** to run the command. + + A message should appear, indicating that the job "Repair aircon" is assigned to "Arjun Khatau". + +#### Complete a job and pay employees + +A key feature of PeopleSoft is tracking the state of job completion and whether its payment has been processed; this can be done with the `mark` and `pay` commands, respectively. + +1. Type `mark 1` in the command box. + + This command marks the first job as completed. + +2. Hit **Enter** to run the command. -1. Download the latest `addressbook.jar` from [here](https://github.com/se-edu/addressbook-level3/releases). + The job "Repair aircon" should be marked as completed, and a checkmark  should appear under the *Done* column. -1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook. +Marking a job as completed creates pending payments for the job. The amounts pending payment are reflected in the *Unpaid* column in the employees list. -1. Double-click the file to start the app. The GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
-  +Now that the "Repair aircon" job has been marked as completed, "Nicole Tan" and "Arjun Khatau" should have non-zero values under the *Unpaid* column. -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: +This value reflects the amount of money that is pending payment to the employees. It is calculated from the employee's base rate and the job's duration. - * **`list`** : Lists all contacts. +1. Type `pay 1 y/` in the command box. - * **`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. + The prefix `y/` is a safeguard against accidental misuse of this command. This command finalizes payments for the given job, and is **irreversible**. After the job is finalized, it cannot be further modified, so do make sure that you intend to run this command before running it. - * **`delete`**`3` : Deletes the 3rd contact shown in the current list. +2. Hit **Enter** to run the command. - * **`clear`** : Deletes all contacts. + The payments for the job is now finalized, indicating that the employees have been paid for the job. This is also reflected in the checkmark  under the *Paid* column. - * **`exit`** : Exits the app. +  -1. Refer to the [Features](#features) below for details of each command. +
+ +#### Export employee payslips + +PeopleSoft also allows users to export a payslip for each employee as a comma-separated values (CSV) spreadsheet. + +1. Type `export 1` in the command box. + + This command exports the payslip for the first employee (Nicole Tan) to a CSV spreadsheet. + +2. Hit **Enter** to run the command. + + The payslip beginning with the employee's name is now saved in the PeopleSoft `data` folder. + + + +
-* 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`. +* Words in `UPPERCASE` are the attributes to be replaced with values provided by you.
+ e.g. in `personadd n/NAME`, `NAME` can be replaced with an actual name like in `personadd n/John Doe`. + +* Attributes can be in any order.
+ e.g. if the command asks for `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also fine. + +* If an attribute is expected only once but is used multiple times, only the last occurrence of the attribute will be taken.
+ e.g. if you specify `n/Jake n/Jason`, only `n/Jason` will be taken. + +* For commands that do not need attributes (like `help`, `list`, `exit` and `clear`), anything typed after the command word will be ignored.
+ e.g. `help 123` will be interpreted as `help`. * 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`. + e.g. `n/NAME [t/TAG]` can be specified as `n/John Doe t/friend` or `n/John Doe`. + +* Items with ellipses (`...`) after them indicate that the items can be repeated any number of times.
+ e.g. `[t/TAG]...` can be interpreted as `[t/TAG]`, `[t/TAG] [t/TAG]`, and so on. + +
| Parameter | +Prefix | +Constraints | +
|---|---|---|
| Name | +n/ |
+
+ Contains only alphanumeric characters and spaces. +Should not be empty. + |
+
| Phone number | +p/ |
+
+ Contains only numbers. +Should be at least three digits long. + |
+
e/ |
+
+ Should be of the format
|
+ |
| Address | +a/ |
+
+ Should not be empty. + |
+
| Rate | +r/ |
+
+ Should be a number consisting of only digits Should not be negative. +Should not have more than two decimal places. +Should not be larger than |
+
| Tag | +t/ |
+
+ Contains only alphanumeric characters. +Should not be empty. + |
+
| Duration | +d/ |
+
+ Should be a number consisting of only digits Should be positive. +Should not be larger than Should not be empty. + |
+
| Employee to assign | +i/ |
+
+ Contains only digits Should be a valid index of an employee in the employee list. +Should not be empty. + |
+
| JOB_INDEX | +N.A. | +
+ Contains only digits Should be a valid index of a job in the job list. +Should not be empty. + |
+
| EMPLOYEE_INDEX | +N.A. | +
+ Contains only digits Should be a valid index of an employee in the employee list. +Should not be empty. + |
+
- e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc. +Rate refers to the hourly pay of the employee. + +Format: `personadd n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS r/RATE [t/TAG]...` + +Examples: + +* `personadd n/Nicole Tan p/99338558 e/nicole@stffhub.org a/1 Tech Drive, S138572 r/37.50 t/Hardware t/Senior` will create a new employee with name "Nicole Tan", phone number "99338558", email "nicole@stffhub.org", address "1 Tech Drive, S138572", an hourly rate of $37.50, and with tags "Hardware" and "Senior". +* `personadd n/Jennifer Tan p/88473219 e/jennifer@stffhub.org a/13 Tech Drive, S182562 r/25` will create a new employee with name "Jennifer Tan", phone number "88473219", email "jennifer@stffhub.org", address "13 Tech Drive, S182562", an hourly rate of $25. No tags will be added since no tag attributes were provided. + + + +
- e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable. +**:information_source: Note:**
-* If a parameter is expected only once in the command but you specified it multiple times, only the last occurrence of the parameter will be taken.
- e.g. if you specify `p/12341234 p/56785678`, only `p/56785678` will be taken. +* Attributes containing `/` are not accepted. Replace `/` with another character (e.g. `-`) if any attribute contains `/`. -* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
- e.g. if the command specifies `help 123`, it will be interpreted as `help`. + For example: Use `Ravi s-o Veegan` instead of `Ravi s/o Veegan`, and `3-5 Jalan Trus` instead of `3/5 Jalan Trus`. + +* The maximum value for the hourly rate of an employee is $1,000,000.
+* Attributes containing `/` are not accepted. Replace `/` with another character (e.g. `-`) if any attribute contains `/`. -### Adding a person: `add` + For example: Use `Ravi s-o Veegan` instead of `Ravi s/o Veegan`, and `3-5 Jalan Trus` instead of `3/5 Jalan Trus`. -Adds a person to the address book. +* The maximum value for the hourly rate of an employee is $1,000,000. -Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…` +* When editing tags, new tags will **not** be added to the existing tags. Instead, all existing tags will be replaced by new tags. + +* To clear all tags, add `t/` to the command without specifying any other tags. -
+ +
+ +This is irreversible. + +
+ +This command updates the job list to show all jobs assigned to that employee. + +
+ +* The maximum value for the duration of a job is 1,000,000 hours. + +* Multiple jobs of the same name can be added. These jobs can then be differentiated by their internal ID, the order in which they were added, and/or the employees that were assigned to it, although it can easily result in confusion. It is thus recommended that a user differentiates jobs through naming to avoid any confusion. + +
-  -### Deleting a person : `delete` +* `find paint` finds all jobs with "paint" in their names. +* `find paint istana` finds all jobs with "paint" **and** "istana" in their names. + + + +
+ +This is irreversible. + +
+ +A job that has been [marked](#mark-mark-or-unmark-a-job-as-done) as completed cannot be assigned. If a job is completed, it makes little sense to assign more employees to it. In the event more employees need to be assigned to a job, unmark the job first before assigning them. + +
-Deletes the specified person from the address book. +The hourly rate(s) paid out to each employee for a job is fixed once the job is marked as done; further changes to any employee's rate will not cause the payout amounts to change. -Format: `delete INDEX` +To update the payout amounts to reflect the new hourly rates, unmark and mark the job again. -* Deletes the person at the specified `INDEX`. -* The index refers to the index number shown in the displayed person list. -* The index **must be a positive integer** 1, 2, 3, … +
+ +This is irreversible. The finalized job cannot be modified in any way, and can only be removed with [`clear`](#clear-clear-all-peoplesoft-data). + +
+ +This is irreversible; deleted data cannot be recovered afterwards without a backup. + +
-**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. +**Q**: I'm using macOS and I can't double-click on the `peoplesoft.jar` file to open it. What should I do? + +**A**: Follow the steps [here](https://github.com/nus-cs2103-AY2122S1/forum/issues/353) to open your `jar` file. + +
+ +**Q**: What are the `addressbook.log.0`, `config.json`, `preferences.json` files in the same folder as `peoplesoft.jar`? + +**A**: PeopleSoft uses the settings inside those files to run. For instance, the height and width of PeopleSoft is stored in those files. Do not remove or edit those files. + +
+ +**Q**: How do I save my data? + +**A**: PeopleSoft automatically saves application data to the folder that it was started from after every command. There is no need to save manually. + +
+ +**Q**: How can I edit PeopleSoft data manually? + +**A**: PeopleSoft data is saved as a JSON file under `data/peoplesoft.json` in the folder that it was started from. It is possible (although not recommended) to modify application data by editing that file. + +
+ +Do not edit the data directly unless you know what you are doing. If your changes cause the data file to become invalid, PeopleSoft will discard all data and start with an empty data file the next time it is started. + +
+ +**Q**: Can I get back the initial sample data? + +**A**: Deleting the `data/peoplesoft.json` file and restarting PeopleSoft will cause the sample data to be reloaded. + +
+ +**Q**: How do I transfer my data to another computer? + +**A**: Install PeopleSoft on the other computer and overwrite the `data/peoplesoft.json` file it creates with your existing `data/peoplesoft.json` file. + +
+ +**Q**: How do I report a bug? How do I suggest a feature? + +**A**: You may report a bug or suggest a new feature on the [PeopleSoft issue tracker](https://github.com/AY2122S2-CS2103T-T11-4/tp/issues). + +[Return to the Table of Contents](#toc) -------------------------------------------------------------------------------------------------------------------- -## Command summary +## Glossary + +**CLI**: Command-line interface. A primarily text-based interface, which is typically operated with text commands. + +**CSV**: Comma-separated values. A common file format for storing tabular data, similar to a spreadsheet. + +**GUI**: Graphical user interface. A primarily visual interface, which is typically operated by a pointing device. + +**Index**: The item's number that is displayed in its respective list, e.g. the second employee in the list has an `INDEX` of 2. + +**JAR**: Java ARchive. A file format used to collate Java class files and their resources for distribution. Java applications are commonly distributed as `.jar` files. + +**JSON**: JavaScript Object Notation. A structured file format used to store arbitrary text data. This is the file format used by PeopleSoft to store data and settings. + +**Keyword**: A word to search for in a set of data, e.g. in the list of employees or jobs. -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` +[Return to the Table of Contents](#toc) diff --git a/docs/_config.yml b/docs/_config.yml index 6bd245d8f4e..e92b4ba8b75 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,5 +1,5 @@ -title: "AB-3" -theme: minima +title: "PeopleSoft" +theme: jekyll-theme-cayman header_pages: - UserGuide.md @@ -8,7 +8,7 @@ header_pages: markdown: kramdown -repository: "se-edu/addressbook-level3" +repository: "AY2122S2-CS2103T-T11-4/tp" github_icon: "images/github-icon.png" plugins: diff --git a/docs/_sass/minima/_base.scss b/docs/_sass/minima/_base.scss index 0d3f6e80ced..0083697fefb 100644 --- a/docs/_sass/minima/_base.scss +++ b/docs/_sass/minima/_base.scss @@ -288,7 +288,7 @@ table { text-align: center; } .site-header:before { - content: "AB-3"; + content: "PeopleSoft"; font-size: 32px; } } diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss index b5ec6976efa..440f5469825 100644 --- a/docs/assets/css/style.scss +++ b/docs/assets/css/style.scss @@ -10,3 +10,7 @@ height: 21px; width: 21px } + +figcaption { + padding-bottom: 16px; +} diff --git a/docs/diagrams/ArchitectureDiagram.puml b/docs/diagrams/ArchitectureDiagram.puml index 4c5cf58212e..7fb4c5d1050 100644 --- a/docs/diagrams/ArchitectureDiagram.puml +++ b/docs/diagrams/ArchitectureDiagram.puml @@ -27,7 +27,7 @@ Main -[#grey]-> Storage Main -up[#grey]-> Model Main -down[hidden]-> Commons -Storage -up[STORAGE_COLOR].> Model -Storage .right[STORAGE_COLOR].>File +Storage -up[STORAGE_COLOR_T3].> Model +Storage .right[STORAGE_COLOR_T3].>File User ..> UI @enduml diff --git a/docs/diagrams/ArchitectureSequenceDiagram.puml b/docs/diagrams/ArchitectureSequenceDiagram.puml index ef81d18c337..b978d10a268 100644 --- a/docs/diagrams/ArchitectureSequenceDiagram.puml +++ b/docs/diagrams/ArchitectureSequenceDiagram.puml @@ -7,10 +7,10 @@ Participant ":Logic" as logic LOGIC_COLOR Participant ":Model" as model MODEL_COLOR Participant ":Storage" as storage STORAGE_COLOR -user -[USER_COLOR]> ui : "delete 1" +user -[USER_COLOR]> ui : "persondelete 1" activate ui UI_COLOR -ui -[UI_COLOR]> logic : execute("delete 1") +ui -[UI_COLOR_T2]> logic : execute("persondelete 1") activate logic LOGIC_COLOR logic -[LOGIC_COLOR]> model : deletePerson(p) @@ -22,17 +22,17 @@ deactivate model logic -[LOGIC_COLOR]> storage : saveAddressBook(addressBook) activate storage STORAGE_COLOR -storage -[STORAGE_COLOR]> storage : Save to file +storage -[STORAGE_COLOR_T3]> storage : Save to file activate storage STORAGE_COLOR_T1 -storage --[STORAGE_COLOR]> storage +storage --[STORAGE_COLOR_T3]> storage deactivate storage -storage --[STORAGE_COLOR]> logic +storage --[STORAGE_COLOR_T3]> logic deactivate storage logic --[LOGIC_COLOR]> ui deactivate logic -ui--[UI_COLOR]> user +ui--[UI_COLOR_T2]> user deactivate ui @enduml diff --git a/docs/diagrams/BetterModelClassDiagram.puml b/docs/diagrams/BetterModelClassDiagram.puml index 5731f9cbaa1..e9cc0033d32 100644 --- a/docs/diagrams/BetterModelClassDiagram.puml +++ b/docs/diagrams/BetterModelClassDiagram.puml @@ -1,21 +1,28 @@ @startuml !include style.puml skinparam arrowThickness 1.1 -skinparam arrowColor MODEL_COLOR +skinparam arrowColor MODEL_COLOR_T4 skinparam classBackgroundColor MODEL_COLOR -AddressBook *-right-> "1" UniquePersonList -AddressBook *-right-> "1" UniqueTagList -UniqueTagList -[hidden]down- UniquePersonList -UniqueTagList -[hidden]down- UniquePersonList +AddressBook *-left-> "1" UniquePersonList +AddressBook *-right-> "1" UniqueJobList -UniqueTagList *-right-> "*" Tag -UniquePersonList -right-> Person +UniqueJobList *--> Job +UniquePersonList --> Person -Person -up-> "*" Tag +Person - Job +(Person, Job) .. Employment +Person *--> PersonID Person *--> Name Person *--> Phone Person *--> Email Person *--> Address +Person *--> Rate +Person *--> "List
+* **New Feature**: Added the ability to open the User Guide directly in the web browser. (Pull Request(PR) [\#77](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/77)) + * **What it does**: Allows the user to open the User Guide directly in the web browser. + * **Justification**: This feature improves the product because it significantly reduces the number of steps a user needs to do to search for help. It also follows Jakob Nielsen's Revised Usability Heuristic H2-10: Help and documentation. + * Credits: [Dave from StackOverflow](https://stackoverflow.com/questions/5226212/how-to-open-the-default-webbrowser-using-java/54869038#54869038) for opening the browser across OSes +
+ +* **New Feature**: Added the sidebar and allowed the user to navigate between pages either using it, or using commands. (PR [\#222](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/222)) + * **What it does**: Gives the user multiple ways to change between pages (through both GUI and CLI) + * **Justification**: This feature improves the product because it allows those unfamiliar with CLIs to easily navigate the app, and also provides an accelerator for experienced users (through typing) to navigate to their desired page. It also follows Jakob Nielsen's Revised Usability Heuristic H2-7: Flexibility & Efficiency. + * **Highlights**: The implementation required the use of an association class. Comments left will guide a new collaborator in adding additional pages. +
+ +* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2122s2.github.io/tp-dashboard/?search=ian-from-dover&sort=groupTitle&sortWithin=title&since=2022-02-18&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&tabOpen=true&tabType=authorship&zFR=false&tabAuthor=ian-from-dover&tabRepo=AY2122S2-CS2103T-T11-4%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false) +
+ +* **Team tasks**: + * Reviewed [44 PRs](https://github.com/AY2122S2-CS2103T-T11-4/tp/pulls?q=is%3Apr+is%3Aclosed+reviewed-by%3Aian-from-dover+) and offered non-trivial comments. (Eg. PR [\#235](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/235), [\#52](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/52), [\#218](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/218)) + * Ensured that issues and internal milestones were on schedule + * Drafted meeting agendas and facilitated meeting discussion + * Regularly updated tP deliverables document and served as point of contact with tutor + * Made the release `v1.3.0` on GitHub +
+ +* **Enhancements to existing features**: + * Beautified the GUI and DG color schemes (PR [\#61](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/61), [\#221](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/221)) + * Implemented the displaying of almost all the features, including and not limited to: + * `assign`ing people to jobs (PR [\#216](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/216)) + * Making the ResultDisplay language HR-manager friendly (PR [\#214](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/214)) + * Create new fields belonging to `People` such as `basePay` (PR [\#205](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/205)) + * Created the `JobListCards` and `JobListPanel` to display all the job information (PR [\#61](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/61) and [\#125](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/125)) + * Fixed bugs relating to all of the above. +
+ +* **Documentation**: + * User Guide: + * Added the `How to use this guide` section + * Added documentation for the features `job` `joblist`, `jobdelete` and `assign` (PR [\#86](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/86/files)) + * Added the `Glossary` section (PR [\#86](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/86/files) also) + * Updated the command summary with the new job commands + * Did cosmetic tweaks to existing documentation for the `mark` feature: (PR [\#118](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/118/)) + * Extensively researched 20 previous UGs to consolidate best practices for the team. (PR [\#203](https://github.com/AY2122S2-CS2103T-T11-4/tp/issues/203)) + * Developer Guide: + * All changes are in PR [\#221](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/221): + * Added introduction, target user profile and value proposition to the front + * Added implementation details of the GUI under the [UI component section](https://ay2122s2-cs2103t-t11-4.github.io/tp/DeveloperGuide.html). +  + * Tweaked User Stories + * README: + * Added animated GIF preview and crafted the write-up for skimming. (PR [\#36](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/36) and [\#222](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/222)) +
+ +* **Community**: + * Contributed to [3 forum discussions](https://github.com/nus-cs2103-AY2122S2/forum/issues?q=is%3Aissue+author%3Aian-from-dover) + * Reported [10 bugs and suggestions for other teams](https://github.com/ian-from-dover/ped/issues) in the class during Practical Exam Dry run (PE-D) +
+ +* **Tools**: + * Implemented a UI Kit found in Figma by emulating its design using JavaFX + * Touched up all icons and images in Adobe Photoshop + * Brainstormed multiple user interfaces by drawing wireframe sketches before chancing upon the UI Kit + diff --git a/docs/team/ovidharshini.md b/docs/team/ovidharshini.md new file mode 100644 index 00000000000..d0806edca0d --- /dev/null +++ b/docs/team/ovidharshini.md @@ -0,0 +1,42 @@ +--- +layout: page + +title: Oviya's Project Portfolio Page +--- + +### Project: PeopleSoft + +PeopleSoft is a CLI-based payroll management app for companies handling contractor-based services. + +Given below are my contributions to the project. + +* **New Feature**: Display of an overview of commands on the HelpWindow page + * What it does: Allow for the display of messages from all command classes on a singular UI component. + * Justification: In previous iterations, the HelpWindow contained a button that linked to the user guide on Github. While this technically fits the wording of the `help` command provided in the user guide, displaying the commands directly would be more user-friendly. + * Highlights: A previous implementation was considered following the implementation for `Person` with similar `CommandHelpMessageCard` and `CommandHelpMessageListPanel` classes. TableView was selectively chosen over this implementation given its relative ease of use. + * Credits: [Amos Chepchieng from Medium](https://medium.com/@keeptoo/adding-data-to-javafx-tableview-stepwise-df582acbae4f) for populating TableView with data programmatically + +* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2122s2.github.io/tp-dashboard/?search=ovidharshini&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2022-02-18) + +* **Team tasks**: + * Reviewed [16 PRs](https://github.com/AY2122S2-CS2103T-T11-4/tp/pulls?q=type%3Apr+reviewed-by%3Aovidharshini+) and offered non-trivial comments. (Eg. PR [\#225](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/225)) + +* **Enhancements to existing features**: + * Added checks for input validation of `Rate` and `Duration` [\#79](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/79) + * Handle the addition of duplicate employees(PR [\#217](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/217)) + +* **Documentation**: + * User Guide: + * Updated command names after refactoring code + * Fixed error with command summary display + * Developer Guide: + * Added user stories [\#233](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/233), [\#37](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/37) + * Added proposed feature of pay multipliers [\#237](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/237) + * Made cosmetic edits of various parts of DG, and adapted parts of AB-3 to better fit PeopleSoft. [\#233](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/233) + * Added use cases + +* **Community**: + * Submitted [16 bugs](https://github.com/AY2122S2-CS2103T-T09-2/tp/issues?q=ovidharshini) during the PE dry-run + +* **Tools**: + * Sketched a [mockup](images/oviya_gui.png) of a possible graphical user interface in one of the first few weeks. diff --git a/docs/team/spyobird.md b/docs/team/spyobird.md new file mode 100644 index 00000000000..5df1719c07b --- /dev/null +++ b/docs/team/spyobird.md @@ -0,0 +1,76 @@ +--- +layout: page +title: Elliot's Project Portfolio Page +--- + +## Project: PeopleSoft + +PeopleSoft is a payroll management app for companies handling contractor-based services. + +### Summary of Contributions + +Here are some ways I have contributed to this project. + +* **New Feature**: Added basic create and delete functionality for jobs. [\#81](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/81) + * Details: Added `add` and `delete` commands which allows the user to create and delete new jobs + respectively. + * Justification: These are basic features which are necessary for a payroll management application. +* **New Feature**: Added basic search functionality for jobs. [\#109](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/109) + * Details: Added `list` which allows users to see all the jobs that have been stored. Also added `find` to + allow users to search for jobs by keyword queries. + * Justification: As much of the application relies on the state of the jobs being displayed on the UI, these + features were necessary to help the user search through jobs to be able to use other features of the + application more efficiently. +* **New Feature**: Added the functionality of marking jobs as completed. [\#81](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/81) + * Details: Added `mark` which allows users to mark a job as completed. + * Justification: As a payroll management application, the state of the completion of a job needs to be + tracked. This feature models how there can be synchronous state change of jobs when they are completed + in the real-world. However, the ability to reverse the completed state is also available in the event of + user errors. +* **New Feature**: Added the functionality of assigning jobs to persons. [\#81](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/81) + * Details: Added `assign` which allows users to assign a job to one or more persons. + * Justification: As a payroll management application, the association between jobs and persons is important. + It was necessary to include this association which models the real-world where one or more persons can + take on jobs. +* **New Feature**: Added the functionality of finalizing payments for jobs. [\#128](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/128) + * Details: Added `pay` which allows users to finalize payments for a job. + * Justification: As a payroll management application, one defining feature to have is the ability to track + payments. As this application is created to simplify the process of managing and calculating pay, it was + necessary to add this feature to fulfill the product specifications of payroll management software. +* **New Implementation**: Added base implementation for jobs. [\#46](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/46) + * Details: Adds a simple abstraction for a job, including its related attributes, encapsulated within + the `Job` class. + * Justification: As the application is a payroll management application built off a basic address book + design, it was initially missing an implementation for jobs. It was necessary to add a base + implementation for jobs in order to fulfill the basic product specifications of payroll management + software, which includes managing jobs. +* **New Implementation**: Added associations for jobs and persons. [\#81](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/81), [\#106](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/106) + * Details: Adds an abstraction for the association between jobs and persons, encapsulated within the + `Employment` class. + * Justification: Similar to how people can take on jobs in the real-world, the role of `Employment` is to + model this same association that people can have with taking on jobs. This is the framework for which + certain functionality such as `assign` are built upon. +* **Enhancement**: Added implementation for the generation of job IDs. [\#81](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/81) + * Details: Job IDs play the role of uniquely identifying jobs internally. This allows for the assignment of + unique job IDs in the creation of new jobs. +* **Enhancement**: Added logic for the creation and management of payment objects. [\#128](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/128) + * Details: As `Payment` objects are used internally to calculate the actual payment of a person, some logic + was required in the creation and management of these `Payment` objects. +* **Enhancement**: Supported in adding internal JSON serialization/deserialization sub-classes for + job-related classes. [\#81](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/81) + * Details: As PeopleSoft creates local data to store the state of the application, some implementations + were added to handle JSON serialization/deserialization of some classes. +* **Enhancement**: Added some tests for automated testing of new features. (e.g. [\#109](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/109)) + * Details: Some tests were added to increase the test coverage of new features, including but not limited to + those mentioned above. The tests give some assurance of correctness in the main functionality and error + handling, and helps to manage regressions caused by new changes. +* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2122s2.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2022-02-18&tabOpen=true&tabType=authorship&tabAuthor=Spyobird&tabRepo=AY2122S2-CS2103T-T11-4%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code&authorshipIsBinaryFileTypeChecked=false) +* **Project management**: Managed Continuous Integration (CI) of team repository. +* **Team tasks**: + * Reviewed [23 pull requests](https://github.com/AY2122S2-CS2103T-T11-4/tp/pulls?q=type%3Apr+reviewed-by%3Aspyobird) for the team repository. +* **Documentation**: + * User Guide: Contributed to the Quick Start tutorial and minor changes. [\#234](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/234) + * Developer Guide: Contributed to the `Logic` and `Model` components. [\#240](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/240) +* **Community**: + * Participated in [14 forum posts](https://github.com/nus-cs2103-AY2122S2/forum/issues?q=commenter%3Aspyobird) for the module. + * Reported [11 issues](https://github.com/Spyobird/ped/issues) for other team projects during practical exam dry-run. diff --git a/docs/team/thewrik.md b/docs/team/thewrik.md new file mode 100644 index 00000000000..f5d95b74784 --- /dev/null +++ b/docs/team/thewrik.md @@ -0,0 +1,43 @@ +--- +layout: page +title: Wrik's Project Portfolio Page +--- +### Project: PeopleSoft + +PeopleSoft is a Payroll management app for companies handling contractor-based services. + +### Summary of Contributions + +* **Role in team**: Developer, Documentation, Testing + +* **New Feature**: Added the export feature for payslips. + * **What it does**: Gives the user ability to view exact earnings and job assignments. + * **Justification**: Helps contractors keep track of their earnings transparently. + +* **New Feature**: Created the job list interface and a skeletal implementation + * **What it does**: Core functionality of the product. + * **Justification**: Helps contractors keep track of their earnings transparently. + +* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2122s2.github.io/tp-dashboard/?search=thewrik) + +* **Enhancements to existing features**: + * Find Functionality + * **Originally** no wildcard support + * After development, finds all people by a certain name and/or tag. If multiple keywords are queried, only entries + that match **all** tags are returned. + * The motivation behind this logic is that users want to increasingly narrow down the number + of persons they see in the outlay. + * Feature was later extended to similar behaviour on jobs as well. + +* **Documentation**: + * User Guide: + * Set up the original draft adapting from the meeting notes. + * Detailed relevant features, specifically elaborated on `find`, `list`, and `export` functionalities. + +* **Testing** + * Wrote the testing suite for Payments. + * Wrote tests for `personfind` and `joblist`. + +* **Community**: + * Reported [6 bugs and suggestions for other teams](https://github.com/thewrik/ped/issues) in the class during Practical Exam Dry run (PE-D) + diff --git a/docs/team/zhongfu.md b/docs/team/zhongfu.md new file mode 100644 index 00000000000..2debdd0bdf8 --- /dev/null +++ b/docs/team/zhongfu.md @@ -0,0 +1,52 @@ +--- +layout: page +title: Zhongfu's Project Portfolio Page +--- + +### Project: PeopleSoft + +PeopleSoft is a CLI-based contractor payroll management app. It helps companies which offer contractor services with managing how much each contractor is paid. You can: + +- manage contractors +- manage jobs +- calculate monthly salary + +Given below are my contributions to the project. + +* **New Feature**: Reusable styled table component for tables in app (part of [\#215](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/215)) + * What it does: Implements a reusable JavaFX control component that provides a table styled according to the intended design of the app. + * Justification: At the moment, there are three tables used in the app, all of which have practically the same styling. However, each of them are implemented separately, which results in redundant code and inconsistencies when adjusting table styling, etc. + * Highlights: Some workarounds had to be used in order to allow for the component to be easily used and instantiated in FXML files. Additionally, a significant amount of time had to be allocated to testing in multiple environments to ensure that the control appears as expected in all scenarios. +
+* **New Feature**: New model classes and supporting code required to support planned features (e.g. Payments, IDs) + * What it does: Allow some new entities to be represented as objects, and allow for relationships not easily represented with objects + * Justification: These model classes are required for supporting new features. Additionally, the planned features require many entity relationships for which having multiple references to the same object(s) would be troublesome, compounded by the fact that new objects are created when editing existing entities. + * Highlights: Some care had to be taken when deciding where IDs were to be used, as overzealous use may negate some of the benefits of OOP. +
+* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2122s2.github.io/tp-dashboard/?search=zhongfu) +
+* **Team tasks**: + * Handled initial triage for PE-D issues, and followed up on PRs and old issues + * Reviewed [24 pull requests](https://github.com/AY2122S2-CS2103T-T11-4/tp/pulls?q=reviewed-by%3Azhongfu) +
+* **Enhancements to existing feature**: + * New serializer/deserializer architecture for model classes [\#65](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/65), [\#88](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/88) + * What it does: (De)serialize model classes to/from JSON with custom (de)serializers (bundled together with the model classes, as nested classes). + * Justification: The previous (de)serialization mechanism is not as intuitive for new developers, as the relevant classes are spread across multiple packages and types reused in multiple classes cannot be automatically (de)serialized. It also makes implementing novel features (e.g. backward-compatibility) more difficult. This enhancement aims to alleviate some of those issues by allowing for increased flexibility, and by bundling the deser classes with the associated object classes. + * Highlights: Deciding on an architecture that serves all our existing needs (and allows for easy extensibility) was somewhat complicated, as Jackson is a complex library that (as a result) presents many ways to perform any given task. + * GUI bug fixes: Allow window size to increase/decrease w/ elements resizing to fit [#218](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/218), tag wrapping [#209](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/209) + * Quality-of-life bug fixes (e.g. email regex changes [#69](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/69), `Desktop.browse()` hanging on Linux [#208](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/208)) +
+* **Documentation**: + * User Guide: + * Changes to reflect feature changes and fix breakages (e.g. [\#200](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/200)) + * Developer Guide: + * Explain serdes architecture and write tutorials on writing new serdes classes [\#87](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/87), [\#89](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/89) +
+* **Community**: + * Participated in [13 forum discussions](https://github.com/nus-cs2103-AY2122S2/forum/issues?q=commenter%3Azhongfu) + * Submitted [11 bugs](https://github.com/AY2122S2-CS2103T-T13-2/tp/issues?q=zhongfu) during the PE dry-run, 10 of which were accepted as-is (except for a [very-low severity bug](https://github.com/AY2122S2-CS2103T-T13-2/tp/issues/169) eventually marked as a documentation bug) +
+* **Tools**: + * Added git pre-commit hooks that enforce correct style and all tests passing, as well as fix common issues (e.g. incorrect FXML versions caused by SceneBuilder [\#212](https://github.com/AY2122S2-CS2103T-T11-4/tp/pull/212)) + * Set up the official GitHub Telegram notification bot to post notifications of repo comments/new PRs/new commits to the team group chat diff --git a/docs/tutorials/AddRemark.md b/docs/tutorials/AddRemark.md index 880c701042f..6df033d4a28 100644 --- a/docs/tutorials/AddRemark.md +++ b/docs/tutorials/AddRemark.md @@ -16,16 +16,16 @@ We’ll assume that you have already set up the development environment as outli Looking in the `logic.command` package, you will notice that each existing command have their own class. All the commands inherit from the abstract class `Command` which means that they must override `execute()`. Each `Command` returns an instance of `CommandResult` upon success and `CommandResult#feedbackToUser` is printed to the `ResultDisplay`. -Let’s start by creating a new `RemarkCommand` class in the `src/main/java/seedu/address/logic/command` directory. +Let’s start by creating a new `RemarkCommand` class in the `src/main/java/peoplesoft/logic/command` directory. For now, let’s keep `RemarkCommand` as simple as possible and print some output. We accomplish that by returning a `CommandResult` with an accompanying message. **`RemarkCommand.java`:** ``` java -package seedu.address.logic.commands; +package peoplesoft.logic.commands; -import seedu.address.model.Model; +import peoplesoft.model.Model; /** * Changes the remark of an existing person in the address book. @@ -68,7 +68,7 @@ Following the convention in other commands, we add relevant messages as constant + ": Edits the remark of the person identified " + "by the index number used in the last person listing. " + "Existing remark will be overwritten by the input.\n" - + "Parameters: INDEX (must be a positive integer) " + + "Format: INDEX (must be a positive integer) " + "r/ [REMARK]\n" + "Example: " + COMMAND_WORD + " 1 " + "r/ Likes to swim."; @@ -91,7 +91,7 @@ Let’s change `RemarkCommand` to parse input from the user. We start by modifying the constructor of `RemarkCommand` to accept an `Index` and a `String`. While we are at it, let’s change the error message to echo the values. While this is not a replacement for tests, it is an obvious way to tell if our code is functioning as intended. ``` java -import static seedu.address.commons.util.CollectionUtil.requireAllNonNull; +import static peoplesoft.commons.util.CollectionUtil.requireAllNonNull; //... public class RemarkCommand extends Command { //... @@ -142,7 +142,7 @@ Your code should look something like [this](https://github.com/se-edu/addressboo Now let’s move on to writing a parser that will extract the index and remark from the input provided by the user. -Create a `RemarkCommandParser` class in the `seedu.address.logic.parser` package. The class must extend the `Parser` interface. +Create a `RemarkCommandParser` class in the `peoplesoft.logic.parser` package. The class must extend the `Parser` interface.  @@ -229,7 +229,7 @@ Now that we have all the information that we need, let’s lay the groundwork fo ### 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 `peoplesoft.model.person`. 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. @@ -242,7 +242,7 @@ Let’s change `RemarkCommand` and `RemarkCommandParser` to use the new `Remark` 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. -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 [`peoplesoft.ui.regions.PersonCard`](https://github.com/se-edu/addressbook-level3/commit/850b78879582f38accb05dd20c245963c65ea599#diff-639834f1e05afe2276a86372adf0fe5f69314642c2d93cfa543d614ce5a76688). **`PersonCard.java`:** diff --git a/docs/tutorials/RemovingFields.md b/docs/tutorials/RemovingFields.md index f29169bc924..105f02c0896 100644 --- a/docs/tutorials/RemovingFields.md +++ b/docs/tutorials/RemovingFields.md @@ -28,7 +28,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 `address` field in `Person` is actually an instance of the `peoplesoft.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. * :bulb: To make things simpler, you can unselect the options `Search in comments and strings` and `Search for text occurrences`  diff --git a/docs/tutorials/TracingCode.md b/docs/tutorials/TracingCode.md index 4fb62a83ef6..14452a3cff7 100644 --- a/docs/tutorials/TracingCode.md +++ b/docs/tutorials/TracingCode.md @@ -39,7 +39,7 @@ In our case, we would want to begin the tracing at the very point where the App
-According to the sequence diagram you saw earlier (and repeated above for reference), the `UI` component yields control to the `Logic` component through a method named `execute`. Searching through the code base for an `execute()` method that belongs to the `Logic` component yields a promising candidate in `seedu.address.logic.Logic`.
+According to the sequence diagram you saw earlier (and repeated above for reference), the `UI` component yields control to the `Logic` component through a method named `execute`. Searching through the code base for an `execute()` method that belongs to the `Logic` component yields a promising candidate in `peoplesoft.logic.Logic`.
@@ -48,7 +48,7 @@ According to the sequence diagram you saw earlier (and repeated above for refere
: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`.
+ * Returns null if there are no matches
+ *
+ */
+ private Level getLoggingLevel(String loggingLevelString) {
+ return Level.parse(loggingLevelString);
+ }
+
+ @Override
+ public Class extends VBox {
+ @FXML
+ private TableView table;
+
+ @FXML
+ private Label label;
+ /**
+ * Instantiates a new instance of {@code PeoplesoftTable}.
+ */
+ public PeoplesoftTablePane() {
+ FXMLLoader fxmlLoader = new FXMLLoader(PeoplesoftTablePane.class.getResource("/view/PeoplesoftTablePane.fxml"));
+ fxmlLoader.setRoot(this);
+ fxmlLoader.setController(this);
+
+ try {
+ fxmlLoader.load();
+ } catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+
+ table.setSelectionModel(new TableNoSelectionModel<>(table));
+ table.setFocusModel(new TableViewFocusModel<>(table));
+ }
+
+ public final void setItems(ObservableList items) {
+ table.setItems(items);
+ }
+
+ public final TableView getTable() {
+ return table;
+ }
+
+ public final void setLabel(String text) {
+ label.setText(text);
+ }
+
+ public final String getLabel() {
+ return label.getText();
+ }
+}
diff --git a/src/main/java/seedu/address/ui/CommandBox.java b/src/main/java/peoplesoft/ui/regions/CommandBox.java
similarity index 88%
rename from src/main/java/seedu/address/ui/CommandBox.java
rename to src/main/java/peoplesoft/ui/regions/CommandBox.java
index 9e75478664b..45278e9eae0 100644
--- a/src/main/java/seedu/address/ui/CommandBox.java
+++ b/src/main/java/peoplesoft/ui/regions/CommandBox.java
@@ -1,12 +1,13 @@
-package seedu.address.ui;
+package peoplesoft.ui.regions;
import javafx.collections.ObservableList;
import javafx.fxml.FXML;
import javafx.scene.control.TextField;
import javafx.scene.layout.Region;
-import seedu.address.logic.commands.CommandResult;
-import seedu.address.logic.commands.exceptions.CommandException;
-import seedu.address.logic.parser.exceptions.ParseException;
+import peoplesoft.logic.commands.CommandResult;
+import peoplesoft.logic.commands.exceptions.CommandException;
+import peoplesoft.logic.parser.exceptions.ParseException;
+import peoplesoft.ui.UiPart;
/**
* The UI component that is responsible for receiving user command inputs.
@@ -77,7 +78,7 @@ public interface CommandExecutor {
/**
* Executes the command and returns the result.
*
- * @see seedu.address.logic.Logic#execute(String)
+ * @see peoplesoft.logic.Logic#execute(String)
*/
CommandResult execute(String commandText) throws CommandException, ParseException;
}
diff --git a/src/main/java/peoplesoft/ui/regions/JobCard.java b/src/main/java/peoplesoft/ui/regions/JobCard.java
new file mode 100644
index 00000000000..a64f0600db6
--- /dev/null
+++ b/src/main/java/peoplesoft/ui/regions/JobCard.java
@@ -0,0 +1,119 @@
+package peoplesoft.ui.regions;
+
+import java.util.List;
+import java.util.Objects;
+
+import javafx.beans.property.ReadOnlyDoubleProperty;
+import javafx.collections.ObservableList;
+import javafx.fxml.FXML;
+import javafx.scene.Node;
+import javafx.scene.control.Label;
+import javafx.scene.image.Image;
+import javafx.scene.image.ImageView;
+import javafx.scene.layout.FlowPane;
+import javafx.scene.layout.HBox;
+import javafx.scene.layout.Region;
+import javafx.scene.layout.StackPane;
+import javafx.scene.text.TextAlignment;
+import peoplesoft.model.job.Job;
+import peoplesoft.model.person.Person;
+import peoplesoft.ui.UiPart;
+
+/**
+ * A UI component that displays information of a {@code Job}.
+ */
+public class JobCard extends UiPart