[v1.1][T09-B3] ProgressChecker

README.adoc

@@ -1,10 +1,10 @@
 = Address Book (Level 4)
 ifdef::env-github,env-browser[:relfileprefix: docs/]
 
-https://travis-ci.org/se-edu/addressbook-level4[image:https://travis-ci.org/se-edu/addressbook-level4.svg?branch=master[Build Status]]
+https://travis-ci.org/CS2103JAN2018-T09-B3/addressbook-level4[image:https://travis-ci.org/CS2103JAN2018-T09-B3/addressbook-level4.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/se-edu/addressbook-level4?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level4/badge.svg?branch=master[Coverage Status]]
-https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_medium=referral&utm_content=se-edu/addressbook-level4&utm_campaign=Badge_Grade[image:https://api.codacy.com/project/badge/Grade/fc0b7775cf7f4fdeaf08776f3d8e364a[Codacy Badge]]
+https://coveralls.io/github/CS2103JAN2018-T09-B3/addressbook-level4?branch=master[image:https://coveralls.io/repos/github/CS2103JAN2018-T09-B3/addressbook-level4/badge.svg?branch=master[Coverage Status]]
+https://www.codacy.com/app/damith/addressbook-level4?utm_source=github.com&utm_medium=referral&utm_content=CS2103JAN2018-T09-B3/addressbook-level4&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]]
 
 ifdef::env-github[]

docs/DeveloperGuide.adoc

@@ -10,9 +10,9 @@ ifdef::env-github[]
 :tip-caption: :bulb:
 :note-caption: :information_source:
 endif::[]
-:repoURL: https://github.com/se-edu/addressbook-level4/tree/master
+:repoURL: https://github.com/CS2103JAN2018-T09-B3/addressbook-level4/tree/master
 
-By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
+By: `Team T09-B3`      Since: `Jun 2016`      Licence: `MIT`
 
 == Setting up
 
@@ -782,13 +782,23 @@ See this https://github.com/se-edu/addressbook-level4/pull/599[PR] for the step-
 
 *Target user profile*:
 
+* is taking CS2103/CS2103T in NUS
+* wants to keep track on his/her learning progress
+* is willing to have good team management
 * has a need to manage a significant number of contacts
-* prefer desktop apps over other types
+* prefers desktop apps over other types
 * can type fast
 * prefers typing over mouse input
 * is reasonably comfortable using CLI apps
 
-*Value proposition*: manage contacts faster than a typical mouse/GUI driven app
+*Value proposition*:
+
+* never miss LOs hidden in the nested collapsible list
+* keep track of your own progress on a week by week basis
+* keep track of your teammates' completion of TO-DO list(at most 20 tasks per day) and learning progress (providing proof for peer evaluation)
+* view the teammates' weekly plan in phase B (to know the upcoming updates even before they send any pull requests to github repo)
+* save your answers(no more than 200 words) for the exercises (as proof of completion and for future revision)
+* easily search for information based on key words (which is hard to achieve in the module website with nested collapsible lists)
 
 [appendix]
 == User Stories
@@ -800,11 +810,35 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un
 |Priority |As a ... |I want to ... |So that I can...
 |`* * *` |new user |see usage instructions |refer to instructions when I forget how to use the App
 
-|`* * *` |user |add a new person |
+|`* * *` |new user |register and account with NUS net ID |join the module community
+
+|`* * *` |new user |fill in my full name and phone number (strictly 8 numbers) |provide necessary information for the platform maintenance
+
+|`* * *` |new user |fill in optional fiels such as faculty, year of study etc |help my classmates know be better
+
+|`* * *` |user |add contacts |have more classmates to communicate with
 
 |`* * *` |user |delete a person |remove entries that I no longer need
 
-|`* * *` |user |find a person by name |locate details of persons without having to go through the entire list
+|`* * *` |user |find a person by NUS NET ID |locate details of persons without having to go through the entire list
+
+|`* * *` |user |search information in our module website based on keywords |nevigate and find the information I need quickly
+
+|`* * *` |user |view my TO-DO list |know all the my tasks easily
+
+|`* * *` |user |tick an item in the TO-DO list upon completion |focus on the tasks I have not done
+
+|`* * *` |user |save my answers of the exercises |show to tutor as proof of my learning outcome and revise before exams
+
+|`* * *` |user |update information of certain field(s) |keep my information up-to-date
+
+|`* * *` |user |see the timeline showing the learning progress of me and my teammates |make sure everyone is on track
+
+|`* * *` |user |see the weekly plan of my teammates (phase B) |to know the upcoming updates even before they send any pull requests to github repo
+
+|`* * *` |user |post my weekly plan (phase B) |to inform my teammates of upcoming updates even before I send any pull requests to github repo
+
+|`* *` |user |upload a profile picture (not larger than 3MB) |help others to recognize me
 
 |`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident
 
@@ -844,6 +878,92 @@ Use case ends.
 +
 Use case resumes at step 2.
 
+[discrete]
+=== Use case: Add a to-do
+
+*MSS*
+
+1.  User requests to view tasks in a specific week
+2.  AddressBook shows tasks in the specified week
+3.  User requests to add a new task in a specific week
+4.  AddressBook adds a new task to the existing list
++
+Use case ends.
+
+*Extensions*
+
+* 1a. Specified week does not exist.
++
+[none]
+** 1a1. AddressBook shows an error message.
++
+Use case resumes at step 2.
+
+[discrete]
+=== Use case: Mark a to-do as complete
+
+*MSS*
+
+1.  User requests to view tasks in a specific week
+2.  AddressBook shows tasks in the specified week
+3.  User requests to complete a task in a specific week
+4.  AddressBook marks specified task as complete
++
+Use case ends.
+
+*Extensions*
+
+* 1a. Specified week does not exist.
++
+[none]
+** 1a1. AddressBook shows an error message.
++
+Use case resumes at step 2.
+
+[none]
+* 2a. The tasks list is empty.
++
+Use case resumes at step 2.
+
+* 3a. The specified task does not exist
++
+[none]
+** 3a1. AddressBook shows an error message.
++
+Use case ends.
+
+[discrete]
+=== Use case: Answer a question and save
+
+*MSS*
+
+1.  User requests to view a specific week
+2.  AddressBook shows content of the specified week
+3.  User requests to key in and save an answer to a question
+4.  AddressBook takes in input and saves
++
+Use case ends.
+
+*Extensions*
+
+* 1a. Specified week does not exist.
++
+[none]
+** 1a1. AddressBook shows an error message.
++
+Use case resumes at step 2.
+
+[none]
+* 2a. There is no content to be shown.
++
+Use case ends.
+
+* 3a. The question index does not exist.
+[none]
+** 3a1. AddressBook shows an error message.
++
+Use case ends.
+
 _{More to be added}_
 
 [appendix]
@@ -852,6 +972,10 @@ _{More to be added}_
 .  Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `1.8.0_60` or higher installed.
 .  Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage.
 .  A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.
+.  The product may need 3-5 minutes to build up for the first time.
+.  The data cannot be retrieved from outside
+.  User need to log in with their unique ID and corresponding password
+.  User can only view the information of their teammates
 
 _{More to be added}_
 
@@ -864,6 +988,18 @@ Windows, Linux, Unix, OS-X
 [[private-contact-detail]] Private contact detail::
 A contact detail that is not meant to be shared with others
 
+[[GUI]] GUI::
+Graphical User Interface
+
+[[sequence-diagram]] Sequence Diagram::
+A sequence diagram shows object interactions shown in time sequence.
+
+[[Build-Automation]] Build Automation::
+Build automation is the process of automating the creation of a software build and the associated processes including: compiling computer source code into binary code, packaging binary code, and running automated tests.
+
+[[Gradle]] Gradle::
+Gradle is an open-source build automation system.
+
 [appendix]
 == Product Survey
 

docs/UserGuide.adoc

@@ -11,9 +11,9 @@ ifdef::env-github[]
 :tip-caption: :bulb:
 :note-caption: :information_source:
 endif::[]
-:repoURL: https://github.com/se-edu/addressbook-level4
+:repoURL: https://github.com/CS2103JAN2018-T09-B3/addressbook-level4
 
-By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
+By: `Team T09-B3`      Since: `Jun 2016`      Licence: `MIT`
 
 == Introduction
 

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
-#Mon Mar 21 13:28:19 SGT 2016
+#Wed Mar 07 06:08:43 CST 2018
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-2.12-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-2.12-bin.zip

src/main/java/seedu/address/storage/AddressBookStorage.java

@@ -41,4 +41,8 @@ public interface AddressBookStorage {
      */
     void saveAddressBook(ReadOnlyAddressBook addressBook, String filePath) throws IOException;
 
+    //@@author EdwardKSG-reused
+    //Reused from https://github.com/se-edu/addressbook-level4/pull/594
+    void backupAddressBook(ReadOnlyAddressBook addressBook) throws IOException;
+    //@@author
 }

src/main/java/seedu/address/storage/StorageManager.java

@@ -77,6 +77,13 @@ public void saveAddressBook(ReadOnlyAddressBook addressBook, String filePath) th
         addressBookStorage.saveAddressBook(addressBook, filePath);
     }
 
+    //@@author EdwardKSG-reused
+    //Reused from https://github.com/se-edu/addressbook-level4/pull/594
+    @Override
+    public void backupAddressBook(ReadOnlyAddressBook addressBook) throws IOException {
+        addressBookStorage.backupAddressBook(addressBook);
+    }
+    //@@author
 
     @Override
     @Subscribe

src/main/java/seedu/address/storage/XmlAddressBookStorage.java

@@ -61,6 +61,14 @@ public Optional<ReadOnlyAddressBook> readAddressBook(String filePath) throws Dat
         }
     }
 
+    //@@author EdwardKSG-reused
+    //Reused from https://github.com/se-edu/addressbook-level4/pull/594
+    @Override
+    public void backupAddressBook(ReadOnlyAddressBook addressBook) throws IOException {
+        saveAddressBook(addressBook, filePath + ".backup");
+    }
+    //@@author
+
     @Override
     public void saveAddressBook(ReadOnlyAddressBook addressBook) throws IOException {
         saveAddressBook(addressBook, filePath);

src/main/java/seedu/address/ui/PersonCard.java

@@ -13,6 +13,8 @@
 public class PersonCard extends UiPart<Region> {
 
     private static final String FXML = "PersonListCard.fxml";
+    private static final String[] TAG_COLORS =
+        { "red", "orange", "yellow", "green", "blue", "purple" };
 
     /**
      * Note: Certain keywords such as "location" and "resources" are reserved keywords in JavaFX.
@@ -47,7 +49,30 @@ public PersonCard(Person person, int displayedIndex) {
         phone.setText(person.getPhone().value);
         address.setText(person.getAddress().value);
         email.setText(person.getEmail().value);
-        person.getTags().forEach(tag -> tags.getChildren().add(new Label(tag.tagName)));
+        person.getTags().forEach(tag -> {
+            Label label = new Label(tag.tagName);
+            label.getStyleClass().add(getTagColor(tag.tagName));
+            tags.getChildren().add(label);
+        });
+    }
+
+    /**
+     * Get a deterministic tag color based off tag's name value.
+     */
+    private String getTagColor(String tagName) {
+        int index = getValueOfString(tagName) % TAG_COLORS.length;
+        return TAG_COLORS[index];
+    }
+
+    /**
+     * Adds each letter of given string into an integer.
+     */
+    private int getValueOfString(String tagName) {
+        int sum = 0;
+        for (char c : tagName.toCharArray()) {
+            sum += c;
+        }
+        return sum;
     }
 
     @Override

src/main/resources/view/DarkTheme.css

@@ -349,3 +349,27 @@
     -fx-background-radius: 2;
     -fx-font-size: 11;
 }
+
+#tags .red {
+    -fx-background-color: #fc6d5f;
+}
+
+#tags .orange {
+    -fx-background-color: #ff9e2b;
+}
+
+#tags .yellow {
+    -fx-background-color: #ffc225;
+}
+
+#tags .green {
+    -fx-background-color: #31b282;
+}
+
+#tags .blue {
+    -fx-background-color: #00b7ee;
+}
+
+#tags .purple {
+    -fx-background-color: #8064a7;
+}

src/test/java/guitests/guihandles/PersonCardHandle.java

@@ -68,4 +68,8 @@ public List<String> getTags() {
                 .map(Label::getText)
                 .collect(Collectors.toList());
     }
+
+    public List<Label> getTagLabels() {
+        return tagLabels;
+    }
 }

src/test/java/seedu/address/ui/testutil/GuiTestAssert.java

@@ -8,6 +8,7 @@
 import guitests.guihandles.PersonCardHandle;
 import guitests.guihandles.PersonListPanelHandle;
 import guitests.guihandles.ResultDisplayHandle;
+import javafx.collections.ObservableList;
 import seedu.address.model.person.Person;
 
 /**
@@ -36,6 +37,14 @@ public static void assertCardDisplaysPerson(Person expectedPerson, PersonCardHan
         assertEquals(expectedPerson.getAddress().value, actualCard.getAddress());
         assertEquals(expectedPerson.getTags().stream().map(tag -> tag.tagName).collect(Collectors.toList()),
                 actualCard.getTags());
+
+        if (!actualCard.getTagLabels().isEmpty()) {
+            ObservableList<String> classes = actualCard.getTagLabels().get(0).getStyleClass();
+            String tagColor = classes.toString().split("\\s+")[1];
+            List<String> expectedClasses = expectedPerson.getTags().stream().map(tag -> tag.tagName)
+                .collect(Collectors.toList());
+            assertEquals(getTagColor(expectedClasses.get(0)), tagColor);
+        }
     }
 
     /**
@@ -70,4 +79,23 @@ public static void assertListSize(PersonListPanelHandle personListPanelHandle, i
     public static void assertResultMessage(ResultDisplayHandle resultDisplayHandle, String expected) {
         assertEquals(expected, resultDisplayHandle.getText());
     }
+
+    public static String getTagColor(String tagName) {
+        switch(tagName) {
+        case "friends":
+        case "husband":
+            return "green";
+        case "colleagues":
+        case "neighbours":
+        case "classmates":
+            return "blue";
+        case "family":
+        case "owesMoney":
+            return "red";
+        case "friend":
+            return "yellow";
+        default:
+            return null;
+        }
+    }
 }