Add DOB field and associated documents & tests

.gitignore

@@ -1,5 +1,7 @@
 build/
 .gradle/
+.checkstyle
+.settings/
 .idea/
 lib/*
 *.iml
@@ -14,3 +16,5 @@ preferences.json
 classes/
 /data/
 /bin/
+src/main/resources/docs/
+out/

.travis.yml

@@ -2,12 +2,28 @@ language: java
 matrix:
   include:
     - jdk: oraclejdk8
-script: travis_retry ./gradlew clean headless allTests coverage coveralls -i
-before_install:
-          - "export DISPLAY=:99.0"
-          - "sh -e /etc/init.d/xvfb start"
+
+script: >-
+    ./config/travis/run-checks.sh &&
+    travis_retry ./gradlew clean checkstyleMain checkstyleTest headless allTests coverage coveralls asciidoctor
+
+deploy:
+  skip_cleanup: true
+  provider: script
+  script: ./config/travis/deploy_github_pages.sh
+  on:
+    branch: master
 
 addons:
   apt:
     packages:
       - oracle-java8-installer
+
+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/

README.adoc

@@ -0,0 +1,38 @@
+= LISA: Levels Integrated Secretarial Agent
+ifdef::env-github,env-browser[:relfileprefix: docs/]
+ifdef::env-github,env-browser[:outfilesuffix: .adoc]
+
+https://travis-ci.org/CS2103AUG2017-T13-B1/main[image:https://travis-ci.org/CS2103AUG2017-T13-B1/main.svg?branch=master[Build Status]]
+https://ci.appveyor.com/project/damithc/addressbook-level4[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
+https://coveralls.io/github/CS2103AUG2017-T13-B1/main?branch=master/badge.svg?branch=master[image:https://coveralls.io/repos/github/CS2103AUG2017-T13-B1/main/badge.svg?branch=master[Coverage Status]]
+
+ifdef::env-github[]
+image::docs/images/Ui.png[width="600"]
+endif::[]
+
+ifndef::env-github[]
+image::images/Ui.png[width="600"]
+endif::[]
+
+* LISA is a desktop contacts managerial application. She has a GUI but most user interactions happen using a CLI (Command Line Interface).
+* She is a intended to assist Insurance Agents in managing their contacts as well as insurance policies.
+* She is *written in OOP fashion* with around 6 KLoC, adapted and improved from [https://github.com/se-edu/addressbook-level4[Addressbook-level4]].
+* New and Added features:
+** Improved Tag management.
+** Greater flexibility in creating a contact (Only a name is required).
+** Support for _Build Automation_ using Gradle and for _Continuous Integration_ using Travis CI.
+
+== Site Map
+
+* <<UserGuide#, User Guide>>
+* <<DeveloperGuide#, Developer Guide>>
+* <<LearningOutcomes#, Learning Outcomes>>
+* <<AboutUs#, About Us>>
+* <<ContactUs#, Contact Us>>
+
+== Acknowledgements
+
+* 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_.
+
+== Licence : link:LICENSE[MIT]

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

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:
+    - appveyor-retry gradlew.bat --no-daemon headless allTests
+
+environment:
+    JAVA_HOME: C:\Program Files\Java\jdk1.8.0  # Use 64-bit Java
+
+# Files/folders to preserve between builds to speed them up
+cache:
+    - C:\Users\appveyor\.gradle

build.gradle

@@ -4,16 +4,23 @@
  * For more details take a look at the Java Quickstart chapter in the Gradle
  * user guide available at http://gradle.org/docs/2.2.1/userguide/tutorial_java_projects.html
  */
- 
+
 plugins {
     id "com.github.kt3k.coveralls" version "2.4.0"
     id "com.github.johnrengelman.shadow" version '1.2.3'
+    id 'org.asciidoctor.convert' version '1.5.3'
+    id 'application'
 }
 
+// Specifies the entry point of the application
+mainClassName = 'seedu.address.MainApp'
+
 allprojects {
     apply plugin: 'idea'
     apply plugin: 'java'
     apply plugin: 'jacoco'
+    apply plugin: 'checkstyle'
+
 
     sourceCompatibility = JavaVersion.VERSION_1_8
     targetCompatibility = JavaVersion.VERSION_1_8
@@ -33,12 +40,17 @@ allprojects {
         jacksonVersion = '2.7.0'
         jacksonDataTypeVersion = '2.7.4'
         junitVersion = '4.12'
-        testFxVersion = '4.0.+'
+        testFxVersion = '4.0.7-alpha'
         monocleVersion = '1.8.0_20'
+        checkstyleVersion = '8.1'
 
         libDir = 'lib'
     }
 
+    checkstyle {
+        toolVersion = "$checkstyleVersion"
+    }
+
     jacocoTestReport {
         reports {
             xml.enabled false
@@ -48,6 +60,7 @@ allprojects {
     }
 
     dependencies {
+        compile group: 'org.fxmisc.easybind', name: 'easybind', version: '1.0.3'
         compile "org.controlsfx:controlsfx:$controlsFxVersion"
         compile "com.fasterxml.jackson.core:jackson-databind:$jacksonVersion"
         compile "com.fasterxml.jackson.datatype:jackson-datatype-jsr310:$jacksonDataTypeVersion"
@@ -61,7 +74,7 @@ allprojects {
         }
         testCompile "org.testfx:openjfx-monocle:$monocleVersion"
     }
-    
+
     sourceSets {
         main {
             java {
@@ -72,14 +85,10 @@ allprojects {
             }
         }
     }
-    
+
     shadowJar {
         archiveName = "addressbook.jar"
 
-        manifest {
-            attributes "Main-Class": "seedu.address.MainApp"
-        }
-
         destinationDir = file("${buildDir}/jar/")
     }
 }
@@ -117,6 +126,17 @@ class AddressBookTest extends Test {
     public AddressBookTest() {
     	  forkEvery = 1
         systemProperty 'testfx.setup.timeout', '60000'
+
+        /*
+         * 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') {
+            beforeTest { descriptor ->
+                logger.lifecycle('Running test: ' + descriptor)
+            }
+        }
     }
 
     public void setHeadless() {
@@ -130,6 +150,8 @@ class AddressBookTest extends Test {
 
 task guiTests(type: AddressBookTest) {
     include 'guitests/**'
+    include 'systemtests/**'
+    include 'seedu/address/ui/**'
 
     jacoco {
         destinationFile = new File("${buildDir}/jacoco/test.exec")
@@ -139,6 +161,7 @@ task guiTests(type: AddressBookTest) {
 
 task nonGuiTests(type: AddressBookTest) {
     include 'seedu/address/**'
+    exclude 'seedu/address/ui/**'
 
     jacoco {
         destinationFile = new File("${buildDir}/jacoco/test.exec")
@@ -164,4 +187,43 @@ nonGuiTests.mustRunAfter headless
 guiTests.mustRunAfter headless
 allTests.mustRunAfter headless
 
-defaultTasks 'clean', 'headless', 'allTests', 'coverage'
+asciidoctor {
+    backends 'html5'
+    sourceDir 'docs'
+    outputDir "${buildDir}/docs"
+
+    attributes linkcss: true,
+               stylesheet: 'gh-pages.css',
+               'source-highlighter': 'coderay',
+               icons: 'font',
+               experimental: true,
+               sectlinks: true,
+               idprefix: '',  // for compatibility with GitHub preview
+               idseparator: '-'
+}
+
+/*
+ * Copies stylesheets into the directory containing generated HTML files as
+ * Asciidoctor does not copy linked CSS files to the output directory when rendering.
+ * This is needed for linked stylesheets and embedded stylesheets which import other files.
+ */
+task copyStylesheets(type: Copy) {
+    from "${asciidoctor.sourceDir}/stylesheets"
+    into "${asciidoctor.outputDir}/html5/stylesheets"
+}
+asciidoctor.dependsOn copyStylesheets
+
+task deployOfflineDocs(type: Copy) {
+    into('src/main/resources/docs')
+
+    from ("${asciidoctor.outputDir}/html5") {
+        include 'stylesheets/*'
+        include 'images/*'
+        include 'UserGuide.html'
+    }
+}
+
+deployOfflineDocs.dependsOn asciidoctor
+processResources.dependsOn deployOfflineDocs
+
+defaultTasks 'clean', 'headless', 'allTests', 'coverage', 'asciidoctor'