[v1.5][T09-B2] CollegeZone

README.adoc

@@ -1,9 +1,9 @@
 = 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-B2/main[image:https://travis-ci.org/CS2103JAN2018-T09-B2/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/se-edu/addressbook-level4?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level4/badge.svg?branch=master[Coverage Status]]
+https://coveralls.io/github/CS2103JAN2018-T09-B2/main?branch=master[image:https://coveralls.io/repos/github/CS2103JAN2018-T09-B2/main/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://gitter.im/se-edu/Lobby[image:https://badges.gitter.im/se-edu/Lobby.svg[Gitter chat]]
 

build.gradle

@@ -46,6 +46,7 @@ dependencies {
     compile group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.7.0'
     compile group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.7.4'
     compile group: 'com.google.guava', name: 'guava', version: '19.0'
+    compile group: 'com.joestelmach', name: 'natty', version: '0.12'
 
     testCompile group: 'junit', name: 'junit', version: '4.12'
     testCompile group: 'org.testfx', name: 'testfx-core', version: testFxVersion

docs/DeveloperGuide.adoc

@@ -10,7 +10,7 @@ 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-B2/main
 
 By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
 
@@ -782,6 +782,7 @@ See this https://github.com/se-edu/addressbook-level4/pull/599[PR] for the step-
 
 *Target user profile*:
 
+* NUS Students living in RC
 * has a need to manage a significant number of contacts
 * prefer desktop apps over other types
 * can type fast
@@ -800,33 +801,60 @@ 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 |
+|`* * *` |RC student |add a new person |
 
-|`* * *` |user |delete a person |remove entries that I no longer need
+|`* * *` |RC student |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
+|`* * *` |RC student |find a person by name |locate details of persons without having to go through the entire list
+
+|`* * *` |RC student |find a person by tags |locate a particular group of people without having to go through the entire list
+
+|`* * *` |RC student |edit a detail I added |
+
+|`* * *` |user |set a level of friendship with a specific person |maintain my friendships depending on a priority system set by myself
+
+|`* * *` |user |edit details of my contacts |stay updated with the current details of my friends
+
+|`* * *` |forgetful RC student |to add persistent reminders |periodically remind myself to do something.
+
+|`* * *` |forgetful RC student |add other RC friends name, birthday, hall CCAs and tags into CollegeZone |
+
+|`* *` |careless RC student |undo a command I entered |undo a wrong command that I entered
+
+|`* *` |careless RC student |redo a command I entered |redo when I want to undo my "undo" command
+
+|`* *` |user |note down appointments with my friends in a calendar |make my schedule schedule more organised
+
+|`* *` |user |write down a short reflection of how an appointment went |remember precious moments easier in the future
+
+|`* *` |user |list down all past appointments with a particular friend |reminisce past memories with a particular friend
 
 |`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident
 
+|`* *` |RC student | be reminded on when my campus fees are due | pay it on time
+
 |`*` |user with many persons in the address book |sort persons by name |locate a person easily
+
+|`*` |user with many persons with the same in the address book |set a display picture of each contact|differentiate persons with the same name
+
 |=======================================================================
 
 _{More to be added}_
 
 [appendix]
 == Use Cases
 
-(For all use cases below, the *System* is the `AddressBook` and the *Actor* is the `user`, unless specified otherwise)
+(For all use cases below, the *System* is the `CollegeZone` and the *Actor* is the `user`, unless specified otherwise)
 
 [discrete]
 === Use case: Delete person
 
 *MSS*
 
 1.  User requests to list persons
-2.  AddressBook shows a list of persons
+2.  CollegeZone shows a list of persons
 3.  User requests to delete a specific person in the list
-4.  AddressBook deletes the person
+4.  CollegeZone deletes the person
 +
 Use case ends.
 
@@ -840,7 +868,36 @@ Use case ends.
 * 3a. The given index is invalid.
 +
 [none]
-** 3a1. AddressBook shows an error message.
+** 3a1. CollegeZone shows an error message.
++
+Use case resumes at step 2.
+
+[discrete]
+=== Use case: Edit person
+1.  User requests to list persons
+2.  CollegeZone shows a list of persons
+3.  User requests to edit a detail or multiple details of a person in the list
+4. CollegeZone edits the detail or details of the person
++
+Use case ends.
+
+*Extensions*
+
+[none]
+* 2a. The list is empty.
++
+Use case ends.
+
+* 3a. The given index is invalid.
++
+[none]
+** 3a1. CollegeZone shows an error message.
++
+
+* 3b. The given detail format is invalid.
++
+[none]
+** 3b1. CollegeZone shows an error message.
 +
 Use case resumes at step 2.
 
@@ -852,6 +909,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.
+.  Should be able to deal with invalid command inputs.
+.  Should be intuitive to use for users who are not tech-savvy.
+.  The system should respond within 2 seconds.
+.  Should work on 32-bit and 64-bit environment.
 
 _{More to be added}_
 
@@ -864,6 +925,9 @@ Windows, Linux, Unix, OS-X
 [[private-contact-detail]] Private contact detail::
 A contact detail that is not meant to be shared with others
 
+[[RC]] Residential College::
+A campus living area at NUS U-Town for NUS undergraduate students, which includes Cinnamon College (USP), College of Alice & Peter Tan, Residential College 4 and Tembusu College
+
 [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-B2/main
 
-By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
+By: `Team T09-B2`      Since: `Jun 2016`      Licence: `MIT`
 
 == Introduction
 

src/main/java/seedu/address/MainApp.java

@@ -34,6 +34,7 @@
 import seedu.address.storage.XmlAddressBookStorage;
 import seedu.address.ui.Ui;
 import seedu.address.ui.UiManager;
+//import com.joestelmach.natty.*;
 
 /**
  * The main entry point to the application.

src/main/java/seedu/address/logic/commands/AddCommand.java

@@ -17,6 +17,7 @@
 public class AddCommand extends UndoableCommand {
 
     public static final String COMMAND_WORD = "add";
+    public static final String COMMAND_ALIAS = "a";
 
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a person to the address book. "
             + "Parameters: "

src/main/java/seedu/address/logic/commands/ClearCommand.java

@@ -10,6 +10,7 @@
 public class ClearCommand extends UndoableCommand {
 
     public static final String COMMAND_WORD = "clear";
+    public static final String COMMAND_ALIAS = "c";
     public static final String MESSAGE_SUCCESS = "Address book has been cleared!";
 
 

src/main/java/seedu/address/logic/commands/DeleteCommand.java

@@ -18,6 +18,8 @@ public class DeleteCommand extends UndoableCommand {
 
     public static final String COMMAND_WORD = "delete";
 
+    public static final String COMMAND_ALIAS = "d";
+
     public static final String MESSAGE_USAGE = COMMAND_WORD
             + ": Deletes the person identified by the index number used in the last person listing.\n"
             + "Parameters: INDEX (must be a positive integer)\n"

src/main/java/seedu/address/logic/commands/EditCommand.java

@@ -35,6 +35,8 @@ public class EditCommand extends UndoableCommand {
 
     public static final String COMMAND_WORD = "edit";
 
+    public static final String COMMAND_ALIAS = "e";
+
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Edits the details of the person identified "
             + "by the index number used in the last person listing. "
             + "Existing values will be overwritten by the input values.\n"

src/main/java/seedu/address/logic/commands/FindCommand.java

@@ -10,6 +10,8 @@ public class FindCommand extends Command {
 
     public static final String COMMAND_WORD = "find";
 
+    public static final String COMMAND_ALIAS = "f";
+
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all persons whose names contain any of "
             + "the specified keywords (case-sensitive) and displays them as a list with index numbers.\n"
             + "Parameters: KEYWORD [MORE_KEYWORDS]...\n"

src/main/java/seedu/address/logic/commands/HistoryCommand.java

@@ -15,6 +15,7 @@
 public class HistoryCommand extends Command {
 
     public static final String COMMAND_WORD = "history";
+    public static final String COMMAND_ALIAS = "h";
     public static final String MESSAGE_SUCCESS = "Entered commands (from most recent to earliest):\n%1$s";
     public static final String MESSAGE_NO_HISTORY = "You have not yet entered any commands.";
 

src/main/java/seedu/address/logic/commands/ListCommand.java

@@ -9,6 +9,8 @@ public class ListCommand extends Command {
 
     public static final String COMMAND_WORD = "list";
 
+    public static final String COMMAND_ALIAS = "l";
+
     public static final String MESSAGE_SUCCESS = "Listed all persons";
 
 

src/main/java/seedu/address/logic/commands/RedoCommand.java

@@ -13,6 +13,7 @@
 public class RedoCommand extends Command {
 
     public static final String COMMAND_WORD = "redo";
+    public static final String COMMAND_ALIAS = "r";
     public static final String MESSAGE_SUCCESS = "Redo success!";
     public static final String MESSAGE_FAILURE = "No more commands to redo!";
 

src/main/java/seedu/address/logic/commands/SelectCommand.java

@@ -16,6 +16,8 @@ public class SelectCommand extends Command {
 
     public static final String COMMAND_WORD = "select";
 
+    public static final String COMMAND_ALIAS = "s";
+
     public static final String MESSAGE_USAGE = COMMAND_WORD
             + ": Selects the person identified by the index number used in the last person listing.\n"
             + "Parameters: INDEX (must be a positive integer)\n"

src/main/java/seedu/address/logic/commands/UndoCommand.java

@@ -13,6 +13,7 @@
 public class UndoCommand extends Command {
 
     public static final String COMMAND_WORD = "undo";
+    public static final String COMMAND_ALIAS = "u";
     public static final String MESSAGE_SUCCESS = "Undo success!";
     public static final String MESSAGE_FAILURE = "No more commands to undo!";
 

src/main/java/seedu/address/logic/parser/AddressBookParser.java

@@ -51,27 +51,51 @@ public Command parseCommand(String userInput) throws ParseException {
         case AddCommand.COMMAND_WORD:
             return new AddCommandParser().parse(arguments);
 
+        case AddCommand.COMMAND_ALIAS:
+            return new AddCommandParser().parse(arguments);
+
         case EditCommand.COMMAND_WORD:
             return new EditCommandParser().parse(arguments);
 
+        case EditCommand.COMMAND_ALIAS:
+            return new EditCommandParser().parse(arguments);
+
         case SelectCommand.COMMAND_WORD:
             return new SelectCommandParser().parse(arguments);
 
+        case SelectCommand.COMMAND_ALIAS:
+            return new SelectCommandParser().parse(arguments);
+
         case DeleteCommand.COMMAND_WORD:
             return new DeleteCommandParser().parse(arguments);
 
+        case DeleteCommand.COMMAND_ALIAS:
+            return new DeleteCommandParser().parse(arguments);
+
         case ClearCommand.COMMAND_WORD:
             return new ClearCommand();
 
+        case ClearCommand.COMMAND_ALIAS:
+            return new ClearCommand();
+
         case FindCommand.COMMAND_WORD:
             return new FindCommandParser().parse(arguments);
 
+        case FindCommand.COMMAND_ALIAS:
+            return new FindCommandParser().parse(arguments);
+
         case ListCommand.COMMAND_WORD:
             return new ListCommand();
 
+        case ListCommand.COMMAND_ALIAS:
+            return new ListCommand();
+
         case HistoryCommand.COMMAND_WORD:
             return new HistoryCommand();
 
+        case HistoryCommand.COMMAND_ALIAS:
+            return new HistoryCommand();
+
         case ExitCommand.COMMAND_WORD:
             return new ExitCommand();
 
@@ -81,9 +105,15 @@ public Command parseCommand(String userInput) throws ParseException {
         case UndoCommand.COMMAND_WORD:
             return new UndoCommand();
 
+        case UndoCommand.COMMAND_ALIAS:
+            return new UndoCommand();
+
         case RedoCommand.COMMAND_WORD:
             return new RedoCommand();
 
+        case RedoCommand.COMMAND_ALIAS:
+            return new RedoCommand();
+
         default:
             throw new ParseException(MESSAGE_UNKNOWN_COMMAND);
         }

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

@@ -41,4 +41,11 @@ public interface AddressBookStorage {
      */
     void saveAddressBook(ReadOnlyAddressBook addressBook, String filePath) throws IOException;
 
+    /**
+     * Saves the given {@link ReadOnlyAddressBook} to a temporary local backup file.
+     * @param addressBook cannot be null.
+     * @throws IOException if there was any problem writing to the file.
+     */
+    void backupAddressBook(ReadOnlyAddressBook addressBook) throws IOException;
+
 }

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

@@ -77,6 +77,12 @@ public void saveAddressBook(ReadOnlyAddressBook addressBook, String filePath) th
         addressBookStorage.saveAddressBook(addressBook, filePath);
     }
 
+    @Override
+    public void backupAddressBook(ReadOnlyAddressBook addressBook) throws IOException {
+        logger.fine("Attempting to write to backup local data file");
+        addressBookStorage.backupAddressBook(addressBook);
+    }
+
 
     @Override
     @Subscribe

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

@@ -79,4 +79,14 @@ public void saveAddressBook(ReadOnlyAddressBook addressBook, String filePath) th
         XmlFileStorage.saveDataToFile(file, new XmlSerializableAddressBook(addressBook));
     }
 
+    /**
+     * Similar to {@link #saveAddressBook(ReadOnlyAddressBook)}
+     * @param addressBook addressBook. Cannot be null
+     */
+    @Override
+    public void backupAddressBook(ReadOnlyAddressBook addressBook) throws IOException {
+        requireNonNull(addressBook);
+        saveAddressBook(addressBook, filePath + ".backup");
+    }
+
 }