[CS2103T-T11-4] PeopleSoft

.githooks/pre-commit

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+trap fail ERR
+
+TYPE="$(basename $0)"
+TYPE_UPPER="${TYPE^}"
+
+function fail() {
+    if [ -n "${filename:-}" ]; then
+        echo -e '\033[1;91m### '"$TYPE_UPPER"' script '"$filename"' failed!\033[0m'
+    else
+        echo -e '\033[1;91m### '"$TYPE_UPPER"' hooks failed for an unknown reason!\033[0m'
+    fi
+    exit 1
+}
+
+# assume we're in repo root
+
+if [[ -d .git/hooks/${TYPE}.d ]]; then
+    for script in .git/hooks/${TYPE}.d/*; do
+        if [[ -f "$script" && -x "$script" ]]; then
+            filename="$(basename "$script")"
+            echo -e '\033[1;96m### Running '"$TYPE"' script '"$filename"'\033[0m'
+            bash $script
+            echo -e '\033[1;96m### Finished running '"$TYPE"' script '"$filename"'\033[0m\n'
+        fi
+    done
+fi

.githooks/pre-commit.d/fix-fxml-versions

@@ -0,0 +1,29 @@
+#!/bin/bash
+set -euo pipefail
+JAVAFX_VER=11
+
+# only care about staged changes for files ending in .fxml
+git diff --cached --name-only | { grep -E "src/main/.*\.fxml$" || test $? == 1; } | while read fn; do
+    # suppress only exit code 1; let set -e catch everything else
+    javafx_lines="$(git show ":$fn" | { grep -E -o 'http://javafx.com/javafx/[^"]+' || test $? == 1; })"
+
+    # sanity check: only one line
+    javafx_num_lines=$(wc -l <<< "$javafx_lines")
+    if [[ $javafx_num_lines -ne 1 ]]; then
+        >&2 echo "error: staged file $fn doesn't have exactly 1 line with javafx xmlns url (got: $javafx_num_lines)"
+        exit 1
+    fi
+
+    javafx_cur_ver=$(grep -E -o "[0-9]+" <<< "$javafx_lines")
+
+    if [[ $javafx_cur_ver -ne $JAVAFX_VER ]]; then
+        echo "staged file $fn has incorrect javafx ver $javafx_cur_ver; changing to ver $JAVAFX_VER in working tree and index"
+        # working tree, hopefully it breaks nothing
+        sed -i "s|http://javafx.com/javafx/$javafx_cur_ver|http://javafx.com/javafx/$JAVAFX_VER|" "$fn" || test $? == 1
+
+        # index (i.e. staged)
+        partial_patch="$(git show ":$fn" | sed "s|http://javafx.com/javafx/$javafx_cur_ver|http://javafx.com/javafx/$JAVAFX_VER|" | { diff -u <(git show ":$fn") - || test $? == 1; } | tail -n +3)"
+        patch="--- a/$fn"$'\n'"+++ b/$fn"$'\n'"$partial_patch"
+        git apply --cached <<< "$patch"
+    fi
+done

.githooks/pre-commit.d/gradle-checks

@@ -0,0 +1,20 @@
+#!/bin/bash
+set -euo pipefail
+
+# https://stackoverflow.com/a/3466183/1675299
+
+unameOut="$(uname -s)"
+case "${unameOut}" in
+    Linux*)     machine=Linux;;
+    Darwin*)    machine=Mac;;
+    CYGWIN*)    machine=Cygwin;;
+    MINGW*)     machine=MinGw;;
+    *)          machine="UNKNOWN:${unameOut}"
+esac
+
+if [[ "$machine" == "Cygwin" || "$machine" == "MinGw" ]]; then
+    ./gradlew.bat check
+else
+    # assume *nix, I guess
+    ./gradlew check
+fi

.github/workflows/gradle.yml

@@ -38,7 +38,7 @@ jobs:
       - name: Build and check with Gradle
         run: ./gradlew check coverage
 
-      - uses: codecov/codecov-action@v1
+      - uses: codecov/codecov-action@v2
         if: runner.os == 'Linux'
         with:
           file: ${{ github.workspace }}/build/reports/jacoco/coverage/coverage.xml

.gitignore

@@ -3,20 +3,26 @@
 /build/
 src/main/resources/docs/
 
-# IDEA files
+# IDEA and other IDE files
 /.idea/
 /out/
 /*.iml
+/.vscode/
+
+# Misc build files
+/bin/
 
 # Storage/log files
-/data/
+/data/ Change the sample details
 /config.json
 /preferences.json
 /*.log.*
+/data/
 
 # Test sandbox files
 src/test/data/sandbox/
 
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+gradle/wrapper/gradle-wrapper.properties

README.md

@@ -1,14 +1,16 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
-
-![Ui](docs/images/Ui.png)
-
-* This is **a sample project for Software Engineering (SE) students**.<br>
-  Example usages:
-  * as a starting point of a course project (as opposed to writing everything from scratch)
-  * as a case study
-* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
-  * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big.
-  * It comes with a **reasonable level of user and developer documentation**.
-* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...).
-* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
-* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info.
+[![CI Status](https://github.com/AY2122S2-CS2103T-T11-4/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2122S2-CS2103T-T11-4/tp/actions/workflows/gradle.yml)
+[![Codecov](https://codecov.io/gh/AY2122S2-CS2103T-T11-4/tp/branch/master/graph/badge.svg?token=Z0PQIQXY29)](https://codecov.io/gh/AY2122S2-CS2103T-T11-4/tp)
+
+![Ui](docs/images/Ui.gif)
+
+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
+
+It is written with the OOP paradigm in mind and has ~11 KLoC.
+View the User Guide and Developer Guide on our **[Website](https://ay2122s2-cs2103t-t11-4.github.io/tp/)**.
+## Credits
+Inter Font from https://github.com/rsms/inter
+
+This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'peoplesoft.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -20,11 +20,6 @@ checkstyle {
     toolVersion = '8.29'
 }
 
-test {
-    useJUnitPlatform()
-    finalizedBy jacocoTestReport
-}
-
 task coverage(type: JacocoReport) {
     sourceDirectories.from files(sourceSets.main.allSource.srcDirs)
     classDirectories.from files(sourceSets.main.output)
@@ -40,8 +35,13 @@ task coverage(type: JacocoReport) {
     }
 }
 
+test {
+    useJUnitPlatform()
+    finalizedBy coverage
+}
+
 dependencies {
-    String jUnitVersion = '5.4.0'
+    String jUnitVersion = '5.8.2'
     String javaFxVersion = '11'
 
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
@@ -66,7 +66,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveName = 'peoplesoft.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

config/checkstyle/checkstyle.xml

@@ -340,6 +340,20 @@
 
     <module name="Indentation">
       <property name="caseIndent" value="0" />
+      <property name="lineWrappingIndentation" value="8" />
+      <!-- note: forceStrictCondition not used because we might want to have more than 8 spaces
+           e.g.:
+
+           blah.blah()
+                   .blah()
+                   .blah()
+                   .blah()
+                   .blag(Abc.def()
+                           .efg());
+
+           forceStrictCondition doesn't take this into account, and forces the last line
+           to be at 8 indentation
+      -->
     </module>
 
     <module name="NoWhitespaceBefore">

data.example/addressbook.json

@@ -0,0 +1,62 @@
+{
+  "persons" : [ {
+    "id" : "1",
+    "name" : "Nicole Tan",
+    "phone" : "99338558",
+    "email" : "nicole@stffhub.org",
+    "address" : "1 Tech Drive, S138572",
+    "rate" : {
+      "amount" : "30.000000",
+      "duration" : "PT1H"
+    },
+    "tagged" : [ "Intern", "Aircon" ]
+  }, {
+    "id" : "2",
+    "name" : "Kavya Singh",
+    "phone" : "96736637",
+    "email" : "kavya@stffhub.org",
+    "address" : "2 Orchard Turn, S238801",
+    "rate" : {
+      "amount" : "40.000000",
+      "duration" : "PT1H"
+    },
+    "tagged" : [ "Senior", "Electrician" ]
+  }, {
+    "id" : "3",
+    "name" : "Ethan Lee",
+    "phone" : "91031282",
+    "email" : "ethan@stffhub.org",
+    "address" : "10 Anson Road, S079903",
+    "rate" : {
+      "amount" : "20.000000",
+      "duration" : "PT1H"
+    },
+    "tagged" : [ "Appliances" ]
+  }, {
+    "id" : "4",
+    "name" : "Irfan Ibrahim",
+    "phone" : "92492021",
+    "email" : "irfan@stffhub.org",
+    "address" : "Blk 47 Tampines Street 20, #17-35",
+    "rate" : {
+      "amount" : "48.000000",
+      "duration" : "PT1H"
+    },
+    "tagged" : [ "Painting" ]
+  }, {
+    "id" : "5",
+    "name" : "Arjun Khatau",
+    "phone" : "80445044",
+    "email" : "arjun@stffhub.org",
+    "address" : "50 Collyer Quay, S049321",
+    "rate" : {
+      "amount" : "33.000000",
+      "duration" : "PT1H"
+    },
+    "tagged" : [ "Contract", "Aircon" ]
+  } ],
+  "jobs" : [ ],
+  "employment" : { },
+  "jobIdState" : 0,
+  "personIdState" : 5
+}

docs/AboutUs.md

@@ -5,55 +5,41 @@ title: About Us
 
 We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
 
-You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Li Zhong Fu
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/zhongfu.png" width="200px">
 
-[[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
+<img src="images/ian-from-dover.png" width="200px">
 
-<img src="images/johndoe.png" width="200px">
+[[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
+<img src="images/thewrik.png" width="200px">
 
-### Johnny Doe
+[[github](http://github.com/thewrik)] [[portfolio](team/thewrik.md)]
 
-<img src="images/johndoe.png" width="200px">
+### Elliot Lim Zhi Yong
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+<img src="images/spyobird.png" width="200px">
 
-* Role: Developer
-* Responsibilities: Data
+[[github](http://github.com/spyobird)]
+[[portfolio](team/spyobird.md)]
 
-### Jean Doe
 
-<img src="images/johndoe.png" width="200px">
+### Elumalai Oviya Dharshini
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+<img src="images/ovidharshini.png" width="200px">
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+[[github](http://github.com/ovidharshini)]
+[[portfolio](team/ovidharshini.md)]
 
-### James Doe
-
-<img src="images/johndoe.png" width="200px">
-
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
-
-* Role: Developer
-* Responsibilities: UI