[CS2103T-T17-1] My Projects

.gitignore

@@ -14,6 +14,8 @@ src/main/resources/docs/
 /preferences.json
 /*.log.*
 
+budgets/budgets.xls
+
 # Test sandbox files
 src/test/data/sandbox/
 

README.adoc

@@ -1,11 +1,12 @@
 = Address Book (Level 3)
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
-https://travis-ci.org/se-edu/addressbook-level3[image:https://travis-ci.org/se-edu/addressbook-level3.svg?branch=master[Build Status]]
-https://ci.appveyor.com/project/damithc/addressbook-level3[image:https://ci.appveyor.com/api/projects/status/3boko2x2vr5cc3w2?svg=true[Build status]]
-https://coveralls.io/github/se-edu/addressbook-level3?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level3/badge.svg?branch=master[Coverage Status]]
-https://www.codacy.com/app/damith/addressbook-level3?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level3&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
-https://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
+https://travis-ci.org/AY1920S1-CS2103T-T17-1/main[image:https://travis-ci.org/AY1920S1-CS2103T-T17-1/main.svg?branch=master[Build Status]]
+https://coveralls.io/github/AY1920S1-CS2103T-T17-1/main?branch=master[image:https://coveralls.io/repos/github/AY1920S1-CS2103T-T17-1/main/badge.svg?branch=master[Coverage Status]]
+
+Too overwhelmed by the amount of group projects? Don't worry! MyProject is here to help. With our vast array of functionality, you would soon be managing your projects with ease.
+
+MyProject is a desktop Project Management application. It has a GUI to display various useful information but most of the user interactions happen using a CLI (Command Line Interface).
 
 ifdef::env-github[]
 image::docs/images/Ui.png[width="600"]
@@ -15,15 +16,11 @@ ifndef::env-github[]
 image::images/Ui.png[width="600"]
 endif::[]
 
-* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
-* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
-* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC)than what students usually write in beginner-level SE modules.
 
 == Site Map
 
 * <<UserGuide#, User Guide>>
 * <<DeveloperGuide#, Developer Guide>>
-* <<LearningOutcomes#, Learning Outcomes>>
 * <<AboutUs#, About Us>>
 * <<ContactUs#, Contact Us>>
 
@@ -32,5 +29,6 @@ endif::[]
 * 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://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
+* Original source code of AddressBook-Level3 project created by SE-EDU initiative at https://se-education.org
 
 == Licence : link:LICENSE[MIT]

build.gradle

@@ -57,13 +57,19 @@ 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("commons-io:commons-io:2.6")
 
     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.junit.jupiter', name: 'junit-jupiter-api', version: jUnitVersion
 
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: jUnitVersion
+
+    compile fileTree(include: ['*.jar'], dir: 'lib')
+    compile files('lib/javax.activation.jar')
+    compile group: 'org.apache.poi', name: 'poi', version: '3.9'
+
 }
 
 shadowJar {

config/checkstyle/checkstyle.xml

@@ -43,25 +43,6 @@
       <property name="checkFormat" value="$1"/>
     </module>
 
-    <!--
-    IMPORT CHECKS
-    -->
-
-    <!-- Checks the ordering of import statements follow the rules that the default Eclipse formatter uses.
-    The order rule "STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE" consists of:
-      1. STATIC: static imports
-      2. STANDARD_JAVA_PACKAGE: standard java/javax imports
-      3. SPECIAL_IMPORTS: defined as org imports
-      4. THIRD_PARTY_PACKAGE: defined as com imports
-    -->
-    <module name="CustomImportOrder">
-        <property name="customImportOrderRules"
-            value="STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE"/>
-        <property name="specialImportsRegExp" value="^org\."/>
-        <property name="thirdPartyPackageRegExp" value="^com\."/>
-        <property name="sortImportsInGroupAlphabetically" value="true"/>
-    </module>
-
     <!-- Checks for redundant import statements.
     An import statement is redundant if:
       * It is a duplicate of another import. This is, when a class is imported more than once.
@@ -76,8 +57,6 @@
     -->
     <module name="UnusedImports"/>
 
-    <module name="AvoidStarImport"/>
-
     <!--
     NAMING CHECKS
     -->
@@ -158,11 +137,6 @@
     <!-- Checks if a catch block is empty and does not contain any comments. -->
     <module name="EmptyCatchBlock"/>
 
-    <module name="LineLength">
-      <!-- Checks if a line is too long. -->
-      <property name="max" value="120"/>
-    </module>
-
     <module name="LeftCurly">
       <!-- Checks for placement of the left curly brace ('{'). -->
       <property name="severity" value="warning"/>
@@ -232,33 +206,6 @@
       <property name="ignoreAnnotationCanonicalNames" value="RegisterExtension, TempDir"/>
     </module>
 
-    <!--
-    ORDER CHECKS
-    -->
-
-    <!-- Checks that the order of at-clauses follows the tagOrder default property value order.
-         @author, @version, @param, @return, @throws, @exception, @see, @since, @serial, @serialField, @serialData, @deprecated
-    -->
-    <module name="AtclauseOrder"/>
-
-    <!-- Checks if the Class and Interface declarations is organized in this order
-      1. Class (static) variables. Order: public, protected, package level (no access modifier), private.
-      2. Instance variables. Order: public, protected, package level (no access modifier), private.
-      3. Constructors
-      4. Methods
-    -->
-    <module name ="DeclarationOrder"/>
-
-    <module name="ModifierOrder">
-      <!-- Warn if modifier order is inconsistent with JLS3 8.1.1, 8.3.1, and
-           8.4.3.  The prescribed order is:
-           public, protected, private, abstract, static, final, transient, volatile,
-           synchronized, native, strictfp
-        -->
-    </module>
-
-    <module name="OverloadMethodsDeclarationOrder"/>
-
     <!--
     WHITESPACE CHECKS
     -->
@@ -302,13 +249,6 @@
       <property name="allowLineBreaks" value="true"/>
     </module>
 
-    <!-- No trailing whitespace -->
-    <module name="Regexp">
-      <property name="format" value="[ \t]+$"/>
-      <property name="illegalPattern" value="true"/>
-      <property name="message" value="Trailing whitespace"/>
-    </module>
-
     <module name="OperatorWrap">
       <!-- Checks that the non-assignment type operator is at the next line in a line wrap.
            This includes "?", ":", "==", "!=", "/", "+", "-", "*", "%", ">>", ">>>",
@@ -375,50 +315,5 @@
       -->
       <property name="validateComments" value="true"/>
     </module>
-
-    <!--
-    JAVADOC CHECKS
-    -->
-
-    <!-- Checks that every class, enumeration and interface have a header comment. -->
-    <module name="JavadocType">
-      <property name="allowMissingParamTags" value="true"/>
-    </module>
-
-    <!-- Checks that every public method (excluding getters, setters and constructors) has a header comment. -->
-    <module name="JavadocMethod">
-      <!-- Checks public methods that have more than 1 line of code.
-        Single line of code methods are often due to refactor for readability.
-      -->
-      <property name="minLineCount" value="1"/>
-      <property name="allowedAnnotations" value="Override, Test, BeforeAll, BeforeEach, AfterAll, AfterEach, Subscribe"/>
-      <property name="scope" value="public"/>
-      <property name="allowUndeclaredRTE" value="true"/>
-      <property name="allowThrowsTagsForSubclasses" value="true"/>
-      <property name="allowMissingParamTags" value="true"/>
-      <property name="allowMissingThrowsTags" value="true"/>
-      <property name="allowMissingReturnTag" value="true"/>
-      <property name="allowMissingPropertyJavadoc" value="true"/>
-      <property name="ignoreMethodNamesRegex" value="(set.*|get.*)"/>
-      <property name="tokens" value="METHOD_DEF, ANNOTATION_FIELD_DEF"/>
-    </module>
-    <!-- Checks that every non-trivial private method (excluding getters, setters and constructors) has a header comment. -->
-    <module name="JavadocMethod">
-      <!-- Checks private methods that have more than 3 lines of code.
-        We define methods that have more than 3 lines of code as non-trivial.
-      -->
-      <property name="minLineCount" value="3"/>
-      <property name="allowedAnnotations" value="Override, Test, BeforeAll, BeforeEach, AfterAll, AfterEach, Subscribe"/>
-      <property name="scope" value="private"/>
-      <property name="allowUndeclaredRTE" value="true"/>
-      <property name="allowThrowsTagsForSubclasses" value="true"/>
-      <property name="allowMissingParamTags" value="true"/>
-      <property name="allowMissingThrowsTags" value="true"/>
-      <property name="allowMissingReturnTag" value="true"/>
-      <property name="allowMissingPropertyJavadoc" value="true"/>
-      <property name="ignoreMethodNamesRegex" value="(set.*|get.*)"/>
-      <property name="tokens" value="METHOD_DEF, ANNOTATION_FIELD_DEF"/>
-    </module>
-
   </module>
 </module>

docs/AboutUs.adoc

@@ -4,53 +4,51 @@
 :imagesDir: images
 :stylesDir: stylesheets
 
-AddressBook - Level 3 was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
-_{The dummy content given below serves as a placeholder to be used by future forks of the project.}_ +
+*_MyProject_* was built on top of AddressBook - Level 3, which  was developed by the https://se-edu.github.io/docs/Team.html[se-edu] team. +
 {empty} +
 We are a team based in the http://www.comp.nus.edu.sg[School of Computing, National University of Singapore].
 
 == Project Team
 
-=== John Doe
-image::damithc.jpg[width="150", align="left"]
-{empty}[http://www.comp.nus.edu.sg/~damithch[homepage]] [https://github.com/damithc[github]] [<<johndoe#, portfolio>>]
+=== Chong Chee Yuan
+image::ccyccyccy.png[width="150", align="left"]
+{empty}[http://chongcheeyuan.me/[homepage]] [https://github.com/ccyccyccy[github]]
+{empty}[https://github.com/AY1920S1-CS2103T-T17-1/main/blob/master/docs/team/ccyccyccy.adoc[portforlio]]
 
-Role: Project Advisor
+Role: Member
 
 '''
 
-=== John Roe
-image::lejolly.jpg[width="150", align="left"]
-{empty}[http://github.com/lejolly[github]] [<<johndoe#, portfolio>>]
+=== Philip Alexander Boediman
+image::philipalexanderb.png[width="150", align="left"]
+{empty}[https://github.com/philipalexanderb[github]]
+{empty}[https://github.com/AY1920S1-CS2103T-T17-1/main/blob/master/docs/team/philipalexanderb.adoc[portfolio]]
 
-Role: Team Lead +
-Responsibilities: UI
+Role: Member
 
 '''
 
-=== Johnny Doe
-image::yijinl.jpg[width="150", align="left"]
-{empty}[http://github.com/yijinl[github]] [<<johndoe#, portfolio>>]
+=== Kwong Chung Yue Jerry
+image::jerryk1997.png[width="150", align="left"]
+{empty}[https://github.com/jerryk1997[github]]
+{empty}[https://github.com/AY1920S1-CS2103T-T17-1/main/blob/master/docs/team/jerryk1997.adoc[portfolio]]
 
-Role: Developer +
-Responsibilities: Data
+Role: Member
 
 '''
 
-=== Johnny Roe
-image::m133225.jpg[width="150", align="left"]
-{empty}[http://github.com/m133225[github]] [<<johndoe#, portfolio>>]
+=== Wang Runding
+image::R-D-D-D.png[width="150", align="left"]
+{empty}[https://github.com/r-d-d-d[github]]
+{empty}[https://github.com/AY1920S1-CS2103T-T17-1/main/blob/master/docs/team/r-d-d-d.adoc[portfolio]]
 
-Role: Developer +
-Responsibilities: Dev Ops + Threading
+Role: Member
 
 '''
 
-=== Benson Meier
-image::yl_coder.jpg[width="150", align="left"]
-{empty}[http://github.com/yl-coder[github]] [<<johndoe#, portfolio>>]
+=== Sng Jia Ming Fadi Faris
+image::fadisng.png[width="150", align="left"]
+{empty}[https://github.com/fadisng[github]]
+{empty}[https://github.com/AY1920S1-CS2103T-T17-1/main/blob/master/docs/team/fadisng.adoc[portfolio]]
 
-Role: Developer +
-Responsibilities: UI
-
-'''
+Role: Member

docs/ChangeUiDisplayActivityDiagram.puml

@@ -0,0 +1,43 @@
+@startuml
+start
+:User executes a command;
+
+if () then ([is help command])
+:MainWindow executes\nhandleHelp method;
+
+else ([is not help command])
+
+if () then ([is exit command])
+:MainWindow executes\nhandleExit method;
+
+else ([is not exit command])
+
+if () then ([is back command])
+:handleBack;
+
+if () then ([current state is PROJECT_LIST])
+:Throw CommandException\ncan't go back any further;
+
+else([current state is not PROJECT_LIST])
+:get previous UiEvent from the stack;
+:changeUiDisplay method is called\nto go back to the UiEvent's state;
+:remove working project if the\nprevious state does not have one;
+endif
+
+else([is not back command])
+
+if () then ([change in Ui display needed])
+:get the next state base on the command;
+:generate an UiEvent with the param\nnext state and the current working project;
+:changeUiDisplay method is called to go to next state;
+
+else ([change in Ui display is not needed])
+:changeUiDisplay method is called\nto refresh the current state;
+endif
+endif
+endif
+endif
+
+
+stop
+@enduml

docs/ContactUs.adoc

@@ -2,6 +2,5 @@
 :site-section: ContactUs
 :stylesDir: stylesheets
 
-* *Bug reports, Suggestions* : Post in our https://github.com/se-edu/addressbook-level3/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
+* *Bug reports, Suggestions* : Post in our https://github.com/AY1920S1-CS2103T-T17-1/main/issues[issue tracker] if you noticed bugs or have suggestions on how to improve.
 * *Contributing* : We welcome pull requests. Follow the process described https://github.com/oss-generic/process[here]
-* *Email us* : You can also reach us at `damith [at] comp.nus.edu.sg`

docs/DevOps.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-CS2103T-T17-1/main/tree/master
 
 == Build Automation