[CS2103T-W16-3] Fine$$e

.github/check-eof-newline.sh

@@ -1,5 +1,6 @@
 #!/bin/sh
 # Checks that all text files end with a newline.
+echo "Checking for newline at EOF..."
 
 ret=0
 

.github/check-line-endings.sh

@@ -1,6 +1,7 @@
 #!/bin/sh
 # Checks for prohibited line endings.
 # Prohibited line endings: \r\n
+echo "Checking for prohibited line endings..."
 
 git grep --cached -I -n --no-color -P '\r$' -- ':/' |
 awk '

.github/check-trailing-whitespace.sh

@@ -1,5 +1,6 @@
 #!/bin/sh
 # Checks for trailing whitespace
+echo "Checking for trailing whitespace..."
 
 git grep --cached -I -n --no-color -P '[ \t]+$' -- ':/' |
 awk '
@@ -9,16 +10,8 @@ awk '
         ret = 0
     }
     {
-        # Only warn for markdown files (*.md) to accomodate text editors
-        # which do not properly handle trailing whitespace.
-        # (e.g. GitHub web editor)
-        if ($1 ~ /\.md$/) {
-            severity = "WARN"
-        } else {
-            severity = "ERROR"
-            ret = 1
-        }
-        print severity, $1, $2, " trailing whitespace."
+        ret = 1
+        print "ERROR", $1, $2, " trailing whitespace."
     }
     END {
         exit ret

.github/run-checks.sh

@@ -1,6 +1,7 @@
 #!/bin/sh
 # Runs all check-* scripts, and returns a non-zero exit code if any of them fail.
 
+echo "Running formatting checks..."
 dir=$(CDPATH= cd -- "$(dirname -- "$0")" && pwd) &&
 ret=0 &&
 for checkscript in "$dir"/check-*; do

.github/workflows/build-jekyll.yml

@@ -0,0 +1,49 @@
+name: Build and Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+
+defaults:
+  run:
+    working-directory: docs
+
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      # Set up Ruby
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+
+      # Cache dependencies on server
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+
+      # Install dependencies
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      # Build Jekyll site
+      - name: Build
+        env:
+          JEKYLL_ENV: production
+        run: bundle exec jekyll build --baseurl /${{ github.event.repository.name }} # Set the repo name as the base URL
+
+      # Deploy to GitHub Pages
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/_site

.github/workflows/gradle.yml

@@ -43,3 +43,41 @@ jobs:
         with:
           file: ${{ github.workspace }}/build/reports/jacoco/coverage/coverage.xml
           fail_ci_if_error: true
+
+  pitest:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Set up repository
+        uses: actions/checkout@master
+
+      - name: Set up repository
+        uses: actions/checkout@master
+        with:
+          ref: master
+
+      - name: Merge to master
+        run: git checkout --progress --force ${{ github.sha }}
+
+      - name: Run repository-wide tests
+        if: runner.os == 'Linux'
+        working-directory:  ${{ github.workspace }}/.github
+        run: ./run-checks.sh
+
+      - name: Validate Gradle Wrapper
+        uses: gradle/wrapper-validation-action@v1
+
+      - name: Setup JDK 11
+        uses: actions/setup-java@v1
+        with:
+          java-version: '11'
+          java-package: jdk+fx
+
+      - name: Run Pitest
+        run: ./gradlew pitest
+
+      - name: Upload Pitest report
+        uses: actions/upload-artifact@v2
+        with:
+          name: pitest
+          path: build/reports/pitest/

.gitignore

@@ -7,6 +7,7 @@ src/main/resources/docs/
 /.idea/
 /out/
 /*.iml
+src/main/main.iml
 
 # Storage/log files
 /data/
@@ -20,3 +21,4 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+docs/.sass-cache/

README.md

@@ -1,14 +1,26 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![CI Status](https://github.com/AY2021S1-CS2103T-W16-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103T-W16-3/tp/actions)
+[![codecov](https://codecov.io/gh/AY2021S1-CS2103T-W16-3/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2021S1-CS2103T-W16-3/tp)
 
 ![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.
+* Fine$$e is a desktop app for **managing finances, 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, Fine\$\$e can track and help you cultivate good financial habits faster than traditional GUI apps.
+
+Site Map
+==
+
+* [User Guide](https://ay2021s1-cs2103t-w16-3.github.io/tp/UserGuide.html)
+* [Developer Guide](https://ay2021s1-cs2103t-w16-3.github.io/tp/DeveloperGuide.html)
+* [About Us](https://ay2021s1-cs2103t-w16-3.github.io/tp/AboutUs.html)
+
+Acknowledgments
+==
+
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+* Libraries used:
+  * [Git Hooks Gradle Plugin](https://plugins.gradle.org/plugin/com.github.jakemarsden.git-hooks) *(licensed under the [MIT License](https://github.com/jakemarsden/git-hooks-gradle-plugin/blob/master/LICENSE))*
+  * [Gradle plugin for PIT Mutation Testing](https://plugins.gradle.org/plugin/info.solidsoft.pitest)
+  * [JavaFX](https://openjfx.io/)
+  * [Jackson](https://github.com/FasterXML/jackson)
+  * [Jekyll Spaceship](https://rubygems.org/gems/jekyll-spaceship) *(licensed under the [MIT License](https://github.com/jakemarsden/git-hooks-gradle-plugin/blob/master/LICENSE))*
+  * [JUnit5](https://github.com/junit-team/junit5)
+  * [PlantUML](https://plantuml.com/)

build.gradle

@@ -4,9 +4,11 @@ plugins {
     id 'com.github.johnrengelman.shadow' version '4.0.4'
     id 'application'
     id 'jacoco'
+    id 'info.solidsoft.pitest' version '1.5.2'
+    id 'com.github.jakemarsden.git-hooks' version '0.0.2'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'ay2021s1_cs2103_w16_3.finesse.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -30,16 +32,32 @@ task coverage(type: JacocoReport) {
     classDirectories.from files(sourceSets.main.output)
     executionData.from files(jacocoTestReport.executionData)
     afterEvaluate {
-        classDirectories.from files(classDirectories.files.collect {
-            fileTree(dir: it, exclude: ['**/*.jar'])
-        })
+        classDirectories.setFrom(files(classDirectories.files.collect {
+            fileTree(dir: it, exclude: ['ay2021s1_cs2103_w16_3/finesse/ui/**/*', '**/*.jar'])
+        }))
     }
     reports {
         html.enabled = true
         xml.enabled = true
     }
 }
 
+pitest {
+    targetClasses = ['ay2021s1_cs2103_w16_3.finesse.*']
+    junit5PluginVersion = '0.12'
+    threads = 4
+    excludedClasses = ['ay2021s1_cs2103_w16_3.finesse.ui.*']
+}
+
+gitHooks {
+    hooksDirectory = file('.git/hooks')
+    gradleCommand = './gradlew'
+    hooks = [
+        // Git hooks run in a bash environment regardless of OS.
+        'pre-push': 'clean check && .github/run-checks.sh'
+    ]
+}
+
 dependencies {
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '11'
@@ -56,6 +74,12 @@ dependencies {
     implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'win'
     implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'mac'
     implementation group: 'org.openjfx', name: 'javafx-graphics', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-media', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-web', version: javaFxVersion, classifier: 'linux'
 
     implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
     implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
@@ -66,7 +90,11 @@ dependencies {
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveFileName = 'finesse.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
 defaultTasks 'clean', 'test'

config/checkstyle/checkstyle.xml

@@ -91,7 +91,7 @@
 
     <module name="PackageName">
       <!-- Validates identifiers for package names against the supplied expression. -->
-      <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]{1,})*$"/>
+      <property name="format" value="^[a-z0-9_]+(\.[a-z][a-z0-9]{1,})*$"/>
       <property name="severity" value="warning"/>
     </module>