[CS2103T-T10-3] ChopChop

.github/workflows/gradle.yml

@@ -33,10 +33,10 @@ jobs:
         uses: actions/setup-java@v1
         with:
           java-version: '11'
-          java-package: jdk+fx
+          java-package: jdk
 
       - name: Build and check with Gradle
-        run: ./gradlew check coverage
+        run: ./gradlew headless check coverage
 
       - uses: codecov/codecov-action@v1
         if: runner.os == 'Linux'

.gitignore

@@ -20,3 +20,7 @@ src/test/data/sandbox/
 # MacOS custom attributes files created by Finder
 .DS_Store
 docs/_site/
+
+*.code-workspace
+all.sh
+test.sh

README.md

@@ -1,14 +1,25 @@
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+# ChopChop
+
+[![CI Status](https://github.com/AY2021S1-CS2103T-T10-3/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2021S1-CS2103T-T10-3/tp/actions)
+[![codecov](https://codecov.io/gh/AY2021S1-CS2103T-T10-3/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2021S1-CS2103T-T10-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.
+
+This project is a food recipe management system that aims to make it easier for people to manage their recipes and ingredients. Potential users include:
+- NUS students living on campus aiming to cook more to save money
+- Home cooks trying to cook a wider variety of meals
+
+The project is implemented in Java with a command-oriented interface in a GUI context. It is written to be modular, making it easier for multiple people to contribute to the project at once.
+
+User guides and developer guides are also provided for users and developers to quickly get up to speed on the project.
+
+The name “ChopChop” comes from a Cantonese phrase that means to “hurry up”, reflecting the speed in which users can use our application to manage their recipes. It’s also related to the act of chopping, a common action in the kitchen.
+
+For the detailed documentation of this project, see the <a href="https://ay2021s1-cs2103t-t10-3.github.io/tp/"><b>Product Website</b></a>.
+
+## License
+
+This project is licensed under the MIT license. It is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+
+Libraries used: JavaFX, JUnit, Jackson, Jfoenix

build.gradle

@@ -6,7 +6,7 @@ plugins {
     id 'jacoco'
 }
 
-mainClassName = 'seedu.address.Main'
+mainClassName = 'chopchop.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11
@@ -21,8 +21,42 @@ checkstyle {
 }
 
 test {
+    systemProperty 'testfx.setup.timeout', '60000'
+
     useJUnitPlatform()
     finalizedBy jacocoTestReport
+
+    // exclude '**/*ui*'
+
+    testLogging {
+        // showStandardStreams = true
+        exceptionFormat "full"
+    }
+}
+
+task headless {
+    doFirst {
+        println 'Setting headless mode properties.'
+        test {
+            systemProperties = [
+                    'java.awt.headless': 'true',
+                    'testfx.headless': 'true',
+                    'testfx.robot': 'glass',
+                    'glass.platform': 'monocle',
+                    'monocle.platform': 'headless',
+                    'prism.order': 'sw',
+                    'prism.text': 't2k',
+                    'prism.verbose': 'true'
+            ]
+        }
+    }
+}
+
+test.mustRunAfter headless
+
+tasks.withType(JavaCompile) {
+    options.compilerArgs << "-Xdiags:verbose"
+    options.compilerArgs << "-Xlint:unchecked"
 }
 
 task coverage(type: JacocoReport) {
@@ -41,6 +75,7 @@ task coverage(type: JacocoReport) {
 }
 
 dependencies {
+    String testFxVersion = '4.0.16-alpha'
     String jUnitVersion = '5.4.0'
     String javaFxVersion = '11'
 
@@ -60,13 +95,22 @@ dependencies {
     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'
 
+    testImplementation group: 'org.testfx', name: 'testfx-core', version: testFxVersion
+
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
+    testRuntimeOnly group: 'org.testfx', name: 'openjfx-monocle', version: 'jdk-11+26'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+
+    compile group: 'com.jfoenix', name: 'jfoenix', version: '9.0.10'
 }
 
 shadowJar {
-    archiveName = 'addressbook.jar'
+    archiveFileName = 'chopchop.jar'
+}
+
+run {
+    enableAssertions = true
 }
 
-defaultTasks 'clean', 'test'
+defaultTasks 'clean', 'headless', 'test'

config/checkstyle/checkstyle.xml

@@ -115,6 +115,7 @@
       <metadata name="altname" value="StaticVariableName"/>
       <property name="format" value="^[a-z][a-zA-Z0-9]*_?$"/>
       <property name="severity" value="warning"/>
+      <property name="applyToPrivate" value="false"/>
     </module>
 
     <module name="MemberName">

config/checkstyle/suppressions.xml

@@ -7,4 +7,12 @@
 <suppressions>
   <suppress checks="JavadocType" files=".*Test\.java"/>
   <suppress checks="MissingJavadocMethodCheck" files=".*Test\.java"/>
+  <suppress checks="CustomImportOrder" files="[\\/]chopchop[\\/]logic[\\/]parser"/>
+  <suppress checks="CustomImportOrder" files="[\\/]chopchop[\\/]model[\\/]attributes"/>
+  <suppress checks="CustomImportOrder" files="[\\/]chopchop[\\/]commons[\\/]util"/>
+  <suppress checks="CustomImportOrder" files="[\\/]src[\\/]test"/>
+  <suppress checks="SingleSpaceSeparator" files="[\\/]chopchop[\\/]logic[\\/]parser"/>
+  <suppress checks="SingleSpaceSeparator" files="[\\/]chopchop[\\/]model[\\/]attributes"/>
+  <suppress checks="SingleSpaceSeparator" files="[\\/]chopchop[\\/]commons[\\/]util"/>
+  <suppress checks="SingleSpaceSeparator" files="[\\/]src[\\/]test"/>
 </suppressions>

docs/AboutUs.md

@@ -9,51 +9,52 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Ng Zhia Yang
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/zhiayang.png" width="200px">
 
-[[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/zhiayang)]
+[[portfolio](team/zhiayang.md)]
 
-* Role: Project Advisor
+* Role: Technical Lead
+* Responsibilities: Command Parser and Code Integration
 
-### Jane Doe
+### Seow Alex
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/seowalex.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/seowalex)]
+[[portfolio](team/seowalex.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Code Quality / Integration
+* Responsibilities: Undo and Redo Feature
 
-### Johnny Doe
+### Travis Toh
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/trav1st.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/trav1st)]
+[[portfolio](team/trav1st.md)]
 
-* Role: Developer
-* Responsibilities: Data
+* Role: Testing / Deliverables and Deadlines
+* Responsibilities: Statistics and Storage
 
-### Jean Doe
+### Teh Xue Yong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/fall9x.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/fall9x)]
+[[portfolio](team/fall9x.md)]
 
-* Role: Developer
-* Responsibilities: Dev Ops + Threading
+* Role: Testing / Documentation
+* Responsibilities: GUI
 
-### James Doe
+### He Jialei
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/hjl99.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/hjl99)]
+[[portfolio](team/hjl99.md)]
 
-* Role: Developer
-* Responsibilities: UI
+* Role: Deliverables and Deadlines / Scheduling and Tracking
+* Responsibilities: Filter Feature and Recipe Model

docs/DevOps.md

@@ -30,7 +30,9 @@ Given below are how to use Gradle for some important project tasks.
 
 * **`test`**: Runs all tests.<
   * `./gradlew test` — Runs all tests
+  * `./gradlew headless test` — Runs all tests in headless mode
   * `./gradlew clean test` — Cleans the project and runs tests
+  * `./gradlew clean headless test` — Cleans the project and runs all tests in headless mode
 
 --------------------------------------------------------------------------------------------------------------------
 
@@ -44,7 +46,7 @@ As part of CI, this project uses Codecov to generate coverage reports. Here are
 
 1. Sign up with Codecov using your GitHub account [here](https://codecov.io/signup).
 1. Once you are inside Codecov web app, add your fork to CodeCov.
-1. Get the Markdown code for the Codecov badge provided in `Settings > Badges` and update the `docs/index.md` of your repo with it so that the badge [![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3) in that page reflects the coverage of your project.
+1. Get the Markdown code for the Codecov badge provided in `Settings > Badges` and update the `docs/index.md` of your repo with it so that the badge [![codecov](https://codecov.io/gh/AY2021S1-CS2103T-T10-3/tp/branch/master/graph/badge.svg)](https://codecov.io/gh/AY2021S1-CS2103T-T10-3/tp) in that page reflects the coverage of your project.
 
 ### Repository-wide checks
 
@@ -73,7 +75,7 @@ Any warnings or errors will be printed out to the console.
 
 Here are the steps to create a new release.
 
-1. Update the version number in [`MainApp.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java).
+1. Update the version number in [`MainApp.java`](https://github.com/AY2021S1-CS2103T-T10-3/tp/tree/master/src/main/java/chopchop/MainApp.java).
 1. Generate a fat JAR file using Gradle (i.e., `gradlew shadow`).
 1. Tag the repo with the version number. e.g. `v0.1`
 1. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/). Upload the JAR file you created.