Merge pull request #131 from leowyh/master

fixed bug where txt file could not be found in jar

Author: leowyh

build.gradle

@@ -11,7 +11,7 @@ checkstyle {
 }
 
 shadowJar {
-    archiveBaseName = "AlphaNUS"
+    archiveBaseName = "alphanus"
     archiveVersion = "0.1.3"
     archiveClassifier = null
     archiveAppendix = null
@@ -45,4 +45,12 @@ test {
 javafx {
     version = "11.0.2"
     modules = [ 'javafx.controls', 'javafx.fxml' ]
+}
+
+sourceSets {
+    main {
+        resources {
+            srcDirs = ['src/main/java/']
+        }
+    }
 }

data/duke.txt

@@ -0,0 +1,99 @@
+
+delete payee p/payee   | 24-10-2019 22:51:48
+add project pr/RAG  | 25-10-2019 10:11:29
+goto project pr/RAG  | 25-10-2019 10:11:52
+delete project pr/RAG  | 25-10-2019 10:12:09
+add project pr/RAG  | 25-10-2019 10:20:32
+add project pr/FLAG  | 25-10-2019 10:20:57
+goto project pr/RAG  | 25-10-2019 10:21:13
+add project pr/RAG  | 25-10-2019 10:23:11
+add project pr/flag  | 25-10-2019 10:23:26
+add project pr/rag  | 25-10-2019 10:25:05
+add project pr/flag  | 25-10-2019 10:25:13
+add payee p/payeename e/email m/matricnum ph/999  | 25-10-2019 10:28:51
+add payment p/payeename i/itemname c/9.99 v/invoice d/deadline  | 25-10-2019 10:29:34
+add project pr/rag  | 27-10-2019 21:35:12
+add project pr/flag  | 27-10-2019 21:35:18
+add project pr/rag  | 27-10-2019 21:48:37
+add project pr/flag  | 27-10-2019 21:49:40
+delete project pr/rag  | 27-10-2019 21:49:56
+add project pr/rag  | 27-10-2019 21:50:04
+add project pr/rag  | 27-10-2019 21:57:10
+add project flag  | 27-10-2019 21:57:14
+add project pr/rag  | 27-10-2019 21:57:35
+add project pr/flag  | 27-10-2019 21:57:39
+delete project pr/rag  | 27-10-2019 21:58:01
+set fund am/200  | 28-10-2019 16:55:00
+set fund am/200  | 28-10-2019 16:56:13
+set fund am/200  | 28-10-2019 16:57:40
+add fund add/400  | 28-10-2019 16:57:47
+add project pr/  | 28-10-2019 00:28:47
+add project   | 28-10-2019 00:41:24
+add project pr/  | 28-10-2019 00:41:43
+delete project  | 28-10-2019 00:44:48
+add project pr/   | 28-10-2019 00:48:01
+add project pr/   | 28-10-2019 00:49:33
+add project pr/ rqew   | 28-10-2019 00:49:43
+add project pr/rag  | 28-10-2019 00:57:56
+add project pr/rag  | 28-10-2019 00:58:01
+add project pr/rag  | 28-10-2019 01:13:17
+add project pr/rag  | 28-10-2019 01:13:21
+add project pr/RAG  | 28-10-2019 01:13:29
+add project pr/   | 28-10-2019 01:13:43
+add project pr/asd   | 28-10-2019 01:13:53
+delete project pr/   | 28-10-2019 01:14:04
+delete project pr/ flag  | 28-10-2019 01:14:18
+delete project pr/ rag  | 28-10-2019 01:14:28
+goto project pr/rag  | 28-10-2019 01:18:50
+add project pr/rag  | 28-10-2019 01:23:04
+add project pr/flag  | 28-10-2019 01:23:11
+goto project pr/rag  | 28-10-2019 01:23:19
+goto project pr/flag  | 28-10-2019 01:27:26
+goto project pr/   | 28-10-2019 01:27:51
+goto project pr/ flag  | 28-10-2019 01:27:59
+goto project pr/ flag  | 28-10-2019 01:30:07
+add project pr/ rag  | 28-10-2019 01:31:43
+goto project pr/   | 28-10-2019 01:31:48
+goto project pr/ rg  | 28-10-2019 01:31:58
+add project pr/rag  | 29-10-2019 17:21:21
+add project pr/flag  | 29-10-2019 17:21:26
+goto project pr/rag  | 29-10-2019 17:21:44
+goto project pr/flag  | 29-10-2019 17:21:49
+delete project pr/rag  | 29-10-2019 17:22:10
+add project pr/rag  | 29-10-2019 17:46:53
+add project pr/flag  | 29-10-2019 17:46:56
+goto project pr/rag  | 29-10-2019 17:47:10
+add payment p/yh i/toy c/10000.00 v/a102312  | 29-10-2019 17:47:20
+add payee p/yh e/e013021@qweqcc m/A123012 ph/1929929  | 29-10-2019 17:48:04
+add payment p/yh i/toy c/10000.00 v/a102312  | 29-10-2019 17:48:12
+goto project pr/flag  | 29-10-2019 17:48:34
+goto project pr/rag  | 29-10-2019 17:48:41
+add project pr/trial  | 29-10-2019 01:25:07
+set fund am/200  | 29-10-2019 01:25:37
+add fund add/200  | 29-10-2019 01:26:07
+assign fund p/trial am/300  | 29-10-2019 01:26:27
+
+
+add project pr/PROJECT_NAME ~ 31-10-2019 15:35:44
+add project pr/ag ~ 31-10-2019 15:35:49
+goto project pr/PROJECT_NAME ~ 31-10-2019 15:36:01
+assign fund p/trial am/300  | 29-10-2019 01:26:27 ~ 31-10-2019 16:05:10
+assign fund p/trial am/300  ~ 31-10-2019 16:05:21
+add project pr/Rag ~ 31-10-2019 16:06:34
+assign fund p/Rag am/300 ~ 31-10-2019 16:06:58
+add project pr/rag ~ 31-10-2019 16:29:35
+add payee p/yh e/lqwe@asda m/a100203 ph/0999123 ~ 31-10-2019 16:30:08
+add payee p/yh e/lqwe@asda m/a100203 ph/0999123 ~ 31-10-2019 16:30:29
+goto project pr/rag ~ 31-10-2019 16:31:02
+add payee p/yh e/lqwe@asda m/a100203 ph/0999123 ~ 31-10-2019 16:31:09
+list ~ 31-10-2019 16:31:28
+add payment p/yh i/toy c/10000.00 v/a102312 ~ 31-10-2019 16:34:13
+add payee p/yh e/e013021@qweqcc m/A123012 ph/1929929 ~ 31-10-2019 16:34:19
+add project pr/rag ~ 31-10-2019 16:36:17
+add payee p/yh e/e013021@qweqcc m/A123012 ph/1929929 ~ 31-10-2019 16:36:24
+add payment p/yh i/toy c/10000.00 v/a102312 ~ 31-10-2019 16:36:29
+
+
+assign fund p/Rag am/300 ~ 31-10-2019 16:40:14
+add project pr/PROJECT_NAME ~ 31-10-2019 16:40:32
+assign fund p/PROJECT_NAME am/300 ~ 31-10-2019 16:40:48

docs/DeveloperGuide.adoc

@@ -12,7 +12,7 @@ ifdef::env-github[]
 :note-caption: :information_source:
 :warning-caption: :warning:
 endif::[]
-:repoURL: https://github.com/se-edu/addressbook-level3/tree/master
+:repoURL: https://github.com/AY1920S1-CS2113T-F10-3/main/blob/master
 
 By: `AY1920S1-CS2113T-F10-3` Since: `Aug 2019` Licence: `NUS`
 
@@ -298,7 +298,23 @@ Step 4: The user exit AlphaNUS through `bye` command. When he relaunch the appli
 
 == Dev Ops
 
-{To be added}
+=== Build Automation
+
+See <<UsingGradle#, UsingGradle.adoc>> to learn how to use Gradle for build automation.
+
+=== Continuous Integration
+
+We use https://travis-ci.org/[Travis CI] to perform _Continuous Integration_ on our projects. See <<UsingTravis#, UsingTravis.adoc>> for more details.
+
+=== Making a Release
+
+Here are the steps to create a new release.
+
+.  Update the version number in link:{repoURL}/build.gradle[`build.gradle`].
+.  Generate a JAR file <<UsingGradle#creating-the-jar-file, using Gradle>>.
+.  Tag the repo with the version number. e.g. `v0.1`
+.  https://help.github.com/articles/creating-releases/[Create a new release using GitHub] and upload the JAR file you created.
+
 
 [appendix]
 == Product Scope

docs/UserGuide.adoc

@@ -32,9 +32,9 @@ may find it a chore to keep up to date with their finances.
 
 .  Some example commands you can try:
 
-* *`list`* : lists all submission deadlines
-* **`delete`**`3` : deletes the 3rd task shown in the current list
-* *`bye`* : exits the app
+* `add project pr/rag` : Adds a project called `rag` to the record.
+* `list projects`: Lists all projects in the record.
+* `bye` : exits the app
 
 .  Refer to <<Features>> for details of each command.
 
@@ -52,6 +52,14 @@ may find it a chore to keep up to date with their finances.
 
 ====
 
+=== Command Help: `help`
+Lists all available commands of AlphaNUS. +
+Format: `help`
+
+Examples:
+
+* `help`
+
 === Adding a project: `add project`
 Adds a project called `PROJECT_NAME` to the record. +
 Format: `add project pr/PROJECT_NAME`
@@ -149,8 +157,8 @@ You may not add a new `PAYEE` if a payee named `PAYEE` already exists.
 
 Examples:
 
-* GOOD: `payments p/John Doe i/Welcome Tea c/12.00 v/INV-001`
-* BAD: `payments p/John Doe i/Welcome Tea c/*$*12.00 v/INV-001`
+* GOOD: `add payee p/John Doe e/johndoe@u.nus.edu m/A0112301A ph/999`
+* BAD: `add payee pR/John Doe e/johndoe@u.nus.edu m/A0112301A ph/999`
 
 === Adding a new payment: `add payment`
 
@@ -164,8 +172,8 @@ You may use more than one word for all fields except `COST`.
 
 Examples:
 
-* GOOD: `payments p/John Doe i/Welcome Tea c/12.00 v/INV-001`
-* BAD: `payments p/John Doe i/Welcome Tea c/*$*12.00 v/INV-001`
+* GOOD: `add payment p/John Doe i/Welcome Tea c/12.00 v/INV-001`
+* BAD: `add payment p/John Doe i/Welcome Tea c/*$*12.00 v/INV-001`
 
 
 === Edit the payment details: `edit`
@@ -340,4 +348,26 @@ There is no need to save manually.
 
 == Command Summary
 
-// this part will be done later when all features are finalized
+
+* *Command Help*: `help`
+* *Add Project*: `add project pr/PROJECT_NAME`
+* *Delete Project*: `delete project pr/PROJECT_NAME`
+* *Go to Project*: `goto project pr/PROJECT_NAME`
+* *List Projects*: `list projects`
+* *Add Payee*: `add payee p/PAYEE e/EMAIL m/MATRICNUM ph/PHONENUM`
+* *Add Payment*: `add payment p/PAYEE i/ITEM c/COST v/INVOICE`
+* *list*: `list`
+* *deadline*: `deadline d/DESCRIPTION`
+* *invoice*: `invoice ID i/INVOICE_number`
+* *reminder*: `reminder`
+* *edit* : `edit ID d/NEW_DESCRIPTION`
+* *snooze*: `snooze ID`
+* *payments* : `payments d/DESCRIPTION [p/PAYMENT_DETAIL]...`
+* *redetail*: `redetail ID [d/PAYMENT_DETAIL]...`
+* *find* : `find d/DESCRIPTION`
+* *view* : `view t/DATE`
+* *delete* : `delete ID`
+* *approve*: `approve ID [m/MESSAGE]`
+* *exit*: `bye`
+
+

docs/UsingGradle.adoc

@@ -0,0 +1,99 @@
+= Using Gradle
+:site-section: DeveloperGuide
+:imagesDir: images
+:stylesDir: stylesheets
+:experimental:
+ifdef::env-github[]
+:tip-caption: :bulb:
+:note-caption: :information_source:
+endif::[]
+
+https://gradle.org/[Gradle] is a build automation tool. It can automate build-related tasks such as
+
+* Running tests
+* Managing library dependencies
+* Analyzing code for style compliance
+
+The gradle configuration for this project is defined in the _build script_ link:../build.gradle[`build.gradle`].
+
+[NOTE]
+To learn more about gradle build scripts, refer https://docs.gradle.org/current/userguide/tutorial_using_tasks.html[Build Scripts Basics].
+
+== Running Gradle Commands
+
+To run a Gradle command, open a command window on the project folder and enter the Gradle command. Gradle commands look like this:
+
+* On Windows: `gradlew <task1> <task2> ...` e.g. `gradlew clean test`
+* On Mac/Linux: `./gradlew <task1> <task2>...` e.g.
+`./gradlew clean test`
+
+[NOTE]
+If you do not specify any tasks, Gradlew will run the default tasks `clean` `test` `coverage`
+
+== Cleaning the Project
+
+* *`clean`* +
+Deletes the files created during the previous build tasks (e.g. files in the `build` folder). e.g. `./gradlew clean`
+
+[TIP]
+*`clean` to force Gradle to execute a task*: +
+When running a Gradle task, Gradle will try to figure out if the task needs running at all. If Gradle determines that the output of the task will be same as the previous time, it will not run the task. For example, it will not build the JAR file again if the relevant source files have not changed since the last time the JAR file was built. If we want to force Gradle to run a task, we can combine that task with `clean`. Once the build files have been `clean` ed, Gradle has no way to determine if the output will be same as before, so it will be forced to execute the task.
+
+== Creating the JAR file
+
+* *`shadowJar`* +
+Creates the `addressbook.jar` file in the `build/jar` folder, _if the current file is outdated_. +
+e.g. `./gradlew shadowJar`
+
+****
+To force Gradle to create the JAR file even if the current one is up-to-date, you can '`clean`' first. +
+e.g. `./gradlew clean shadowJar`
+****
+
+[NOTE]
+*Why do we create a fat JAR?* If we package only our own class files into the JAR file, it will not work properly unless the user has all the other JAR files (i.e. third party libraries) our classes depend on, which is rather inconvenient. Therefore, we package all dependencies into a single JAR files, creating what is also known as a _fat_ JAR file. To create a fat JAR file, we use the Gradle plugin https://github.com/johnrengelman/shadow[shadow jar].
+
+== Rendering AsciiDoc files
+
+* **`asciidoctor`** +
+Converts AsciiDoc files in `docs` to HTML format. Generated HTML files can be found in `build/docs`.
+* **`deployOfflineDocs`** +
+Updates the offline user guide, and its associated files, used by the Help window in the application. Deployed HTML files and images can be found in `src/main/resources/docs`.
+
+== Running the application
+
+* *`run`* +
+Builds and runs the application.
+* *`runShadow`* +
+Builds the application as a fat JAR, and then runs it.
+
+== Running code style checks
+
+* **`checkstyleMain`** +
+Runs the code style check for the main code base
+* **`checkstyleTest`** +
+Runs the code style check for the test code base
+
+The set of code style rules implemented can be found in `config/checkstyle/checkstyle.xml`. To enable _exceptions_ to code styles, add in the comment `//CODESTYLE.OFF: RuleName` at the start of the section and `//CODESTYLE.ON: RuleName` at the end of the section.
+
+== Running Tests
+
+* **`test`** +
+Runs all tests.
+
+Here are some examples:
+
+* `./gradlew test` -- Runs all tests
+* `./gradlew clean test` -- Cleans the project and runs tests
+
+== Updating Dependencies
+
+There is no need to run these Gradle tasks manually as they are called automatically by other relevant Gradle tasks.
+
+* **`compileJava`** +
+Checks whether the project has the required dependencies to compile and run the main program, and download any missing dependencies before compiling the classes. +
+See `build.gradle` ->
+`allprojects` -> `dependencies` -> `compile` for the list of dependencies required.
+* **`compileTestJava`** +
+Checks whether the project has the required dependencies to perform testing, and download any missing dependencies before compiling the test classes. +
+See `build.gradle` -> `allprojects` -> `dependencies` -> `testCompile` for the list of dependencies required.