[AY1920S1-CS2113T-W13-3] SGTravel

.gitignore

@@ -12,3 +12,15 @@ src/main/resources/docs/
 .DS_Store
 *.iml
 bin/
+
+# CS2113 stuff
+tasks.txt
+tasks1.txt
+/events.txt
+/data/events.txt
+events.txt
+/profile.txt
+/routes.txt
+/data/recommendations.txt
+/favourite.txt
+/itineraries.txt

.travis.yml

@@ -0,0 +1,23 @@
+language: java
+matrix:
+  include:
+    - jdk: openjdk11
+
+script: >-
+    ./config/travis/run-checks.sh &&
+    ./gradlew clean checkstyleMain checkstyleTest headless allTests coverage coveralls
+#deploy:
+#  skip_cleanup: true
+#  provider: script
+#  script: ./config/travis/deploy_github_pages.sh
+#  on:
+#    branch: master
+
+before_cache:
+  - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
+  - rm -fr $HOME/.gradle/caches/*/plugin-resolution/
+
+cache:
+  directories:
+    - $HOME/.gradle/caches/
+    - $HOME/.gradle/wrapper/

CONTRIBUTORS.md

@@ -1,6 +1,6 @@
 # Contributors
 
-Display | Name | Github Profile | Homepage
+Display | Name | Github Profile | Homepage |
 ---|:---:|:---:|:---:
 ![](https://avatars0.githubusercontent.com/u/22460123?s=100) | Jeffry Lum | [Github](https://github.com/j-lum/) | [Homepage](https://se.kasugano.moe)
 ![](https://avatars0.githubusercontent.com/u/1673303?s=100) | Damith C. Rajapakse | [Github](https://github.com/damithc/) | [Homepage](https://www.comp.nus.edu.sg/~damithch/)

README.adoc

@@ -0,0 +1,40 @@
+= SGTravel
+ifdef::env-github,env-browser[:relfileprefix: docs/]
+
+https://travis-ci.org/AY1920S1-CS2113T-W13-3/main[image:https://travis-ci.org/AY1920S1-CS2113T-W13-3/main.svg?branch=master[Build Status]]
+https://ci.appveyor.com/project/Jefferson111/main/branch/master[image:https://ci.appveyor.com/api/projects/status/4mjh6mbu4s7uy36n/branch/master?svg=true[Build status]]
+https://coveralls.io/github/AY1920S1-CS2113T-W13-3/main?branch=master[image:https://coveralls.io/repos/github/AY1920S1-CS2113T-W13-3/main/badge.svg?branch=master[Coverage Status]]
+https://www.codacy.com/manual/Jefferson111/main?utm_source=github.com&utm_medium=referral&utm_content=AY1920S1-CS2113T-W13-3/main&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/d553600e4c394c78989c71999eb35dcc[Codacy Badge]]
+https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
+
+ifdef::env-github[]
+[.center]
+image:docs/images/sader_thonk.png[width="64" height="64" align="center"]
+endif::[]
+
+ifdef::env-github[]
+image::docs/images/Ui.png[width="600" height="400"]
+endif::[]
+
+* The project aims to build a product named `SGTravel`, a Personal Assistant Travel Planning application for Singapore Tourists!
+* This app has route planning, profile page, edit location and recommended itineraries feature up and running.
+* The latest release, version 1.4 was completed on 11/11/2019
+* The project showcases what we have learnt from our OOP and Software Engineering module and was made in the AY19/20 Semester 1 iteration of CS2113/T
+* This project was originally expanded on the Duke Chatbot project.
+* Project by - Daniel, Hong Chuan, Sukrut and Jefferson!
+
+== Site Map
+
+* <<UserGuide#, User Guide>>
+* <<DeveloperGuide#, Developer Guide>>
+* <<AboutUs#, About Us>>
+* <<ContactUs#, Contact Us>>
+
+== Acknowledgements
+
+* Most parts of this sample application came from https://github.com/j-lum/duke[Duke] by someone.
+* Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by
+_Marco Jakob_.
+* Libraries used: https://github.com/TestFX/TestFX[TestFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5], https://github.com/google/gson[GSON], https://github.com/apache/commons-lang[Apache]
+
+== Licence : link:LICENSE[MIT]

README.md

@@ -1,5 +1,11 @@
 # Setting up
 
+[![Coverage Status](https://coveralls.io/repos/github/AY1920S1-CS2113T-W13-3/main/badge.svg?branch=master)](https://coveralls.io/github/AY1920S1-CS2113T-W13-3/main?branch=master)
+[![Build Status](https://travis-ci.org/AY1920S1-CS2113T-W13-3/main.svg?branch=master)](https://travis-ci.org/AY1920S1-CS2113T-W13-3/main)
+[![Build status](https://ci.appveyor.com/api/projects/status/4mjh6mbu4s7uy36n/branch/master?svg=true)](https://ci.appveyor.com/project/Jefferson111/main/branch/master)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d553600e4c394c78989c71999eb35dcc)](https://www.codacy.com/manual/Jefferson111/main?utm_source=github.com&utm_medium=referral&utm_content=AY1920S1-CS2113T-W13-3/main&utm_campaign=Badge_Grade)
+[![Gitter chat](https://badges.gitter.im/se-edu/Lobby.svg)](https://gitter.im/se-edu/Lobby)
+
 **Prerequisites**
 
 * JDK 11
@@ -20,7 +26,11 @@
 1. Ensure that your src folder is checked. Keep clicking `Next`.
 1. Click `Finish`.
 
-# Tutorials 
+# Developer Guide
+
+https://docs.google.com/document/d/1jau7lCh6TdFEZnxJQyfkELXFryA56I4-Jf6dzDFwSI0/edit?usp=sharing
+
+# Tutorials
 
 Duke Increment | Tutorial
 ---------------|---------------
@@ -35,5 +45,5 @@ Duke Increment | Tutorial
 
 # Feedback, Bug Reports
 
-* If you have feedback or bug reports, please post in [se-edu/duke issue tracker](https://github.com/se-edu/duke/issues).
-* We welcome pull requests too.
+* If you have feedback or bug reports, please post in [se-edu/sgtravel issue tracker](https://github.com/se-edu/duke/issues).
+* We welcome pull requests too.

appveyor.yml

@@ -0,0 +1,18 @@
+# AppVeyor configuration file
+# For more details see https://www.appveyor.com/docs/build-configuration/
+
+# Call on gradle to build and run tests
+# --no-daemon: Prevent the daemon from launching to prevent file-in-use errors
+#     when we cache the ~/.gradle directory
+build_script:
+    - gradlew.bat --no-daemon assemble checkstyleMain checkstyleTest
+
+test_script:
+    - gradlew.bat --no-daemon headless allTests
+
+environment:
+    JAVA_HOME: C:\Program Files\Java\jdk11  # Use 64-bit Java
+
+# Files/folders to preserve between builds to speed them up
+cache:
+    - C:\Users\appveyor\.gradle

build.gradle

@@ -0,0 +1,192 @@
+import org.gradle.api.tasks.testing.logging.TestLogEvent
+
+plugins {
+    id 'java'
+    id 'jacoco'
+    id 'checkstyle'
+    id 'org.openjfx.javafxplugin' version '0.0.7'
+    id 'com.github.kt3k.coveralls' version '2.8.4'
+    id 'com.github.johnrengelman.shadow' version '5.1.0'
+    id 'org.asciidoctor.jvm.convert' version '2.3.0'
+    id 'application'
+}
+
+// Specifies the entry point of the application
+mainClassName = 'sgtravel.Launcher'
+
+sourceCompatibility = JavaVersion.VERSION_11
+targetCompatibility = JavaVersion.VERSION_11
+
+javafx {
+    version = "11.0.2"
+    modules = [
+            'javafx.controls'
+            , 'javafx.base'
+            , 'javafx.graphics'
+            , 'javafx.fxml'
+            , 'javafx.web'
+    ]
+}
+
+repositories {
+    mavenCentral()
+    maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
+}
+
+checkstyle {
+    toolVersion = '8.23'
+}
+
+jacocoTestReport {
+    reports {
+        xml.enabled = true
+        html.enabled = true
+    }
+}
+
+task coverage(type: JacocoReport) {
+    sourceDirectories.from files(sourceSets.main.allSource.srcDirs)
+    classDirectories.from files(sourceSets.main.output)
+    executionData.from files(jacocoTestReport.executionData)
+    afterEvaluate {
+        classDirectories.from files(classDirectories.files.collect {
+            fileTree(dir: it, exclude: ['**/*.jar'])
+        })
+    }
+    reports {
+        html.enabled = true
+        xml.enabled = true
+    }
+}
+
+coveralls {
+    sourceDirs = sourceSets.main.allSource.srcDirs.absolutePath
+    jacocoReportPath = "${buildDir}/reports/jacoco/coverage/coverage.xml"
+}
+
+tasks.coveralls {
+    dependsOn coverage
+}
+
+test {
+    useJUnitPlatform()
+}
+
+dependencies {
+    String testFxVersion = '4.0.15-alpha'
+    String jUnitVersion = '5.5.0'
+    String javaFxVersion = '11'
+
+    implementation group: 'com.google.code.gson', name: 'gson', version: '2.8.5'
+    implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.9'
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-controls', version: javaFxVersion, classifier: 'linux'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'win'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'mac'
+    implementation group: 'org.openjfx', name: 'javafx-fxml', version: javaFxVersion, classifier: 'linux'
+    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.9.9.3'
+    implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.9.9'
+
+    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
+}
+
+shadowJar {
+    archiveBaseName = "SGTravel"
+    archiveVersion = "1.4"
+    archiveClassifier = null
+    archiveAppendix = null
+}
+
+task(guiTests)
+task(nonGuiTests)
+
+// Run `test` task if `guiTests` or `nonGuiTests` is specified
+guiTests.dependsOn test
+nonGuiTests.dependsOn test
+
+task(allTests)
+
+// `allTests` implies both `guiTests` and `nonGuiTests`
+allTests.dependsOn guiTests
+allTests.dependsOn nonGuiTests
+
+test {
+    systemProperty 'testfx.setup.timeout', '60000'
+
+    testLogging {
+        events TestLogEvent.FAILED, TestLogEvent.SKIPPED
+
+        // Prints the currently running test's name in the CI's build log,
+        // so that we can check if tests are being silently skipped or
+        // stalling the build.
+        if (System.env.'CI') {
+            events << TestLogEvent.STARTED
+        }
+    }
+
+    jacoco {
+        destinationFile = new File("${buildDir}/jacoco/test.exec")
+    }
+
+    doFirst {
+        boolean runGuiTests = gradle.taskGraph.hasTask(guiTests)
+        boolean runNonGuiTests = gradle.taskGraph.hasTask(nonGuiTests)
+
+        if (!runGuiTests && !runNonGuiTests) {
+            runGuiTests = true
+            runNonGuiTests = true
+        }
+
+        if (runNonGuiTests) {
+            test.include 'sgtravel/**'
+        }
+
+        if (runGuiTests) {
+        }
+
+        if (!runGuiTests) {
+        }
+    }
+}
+
+task headless {
+    doLast {
+        println 'Setting headless mode properties.'
+        test {
+            systemProperties = [
+                    'testfx.robot': 'glass',
+                    'testfx.headless': 'true',
+                    'prism.order': 'sw',
+                    'prism.text': 't2k',
+            ]
+        }
+    }
+}
+
+// Makes sure that headless properties are set before running tests
+test.mustRunAfter headless
+
+defaultTasks 'clean', 'headless', 'allTests', 'coverage', 'coveralls'
+
+run {
+    enableAssertions = true
+}