Merge pull request #104 from hengyiqun/branch-notes

Branch notes

Author: hengyiqun

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

@@ -21,14 +21,18 @@
 import seedu.address.model.UserPrefs;
 import seedu.address.model.meeting.MeetingBook;
 import seedu.address.model.meeting.ReadOnlyMeetingBook;
+import seedu.address.model.note.NoteBook;
+import seedu.address.model.note.ReadOnlyNoteBook;
 import seedu.address.model.person.AddressBook;
 import seedu.address.model.person.ReadOnlyAddressBook;
 import seedu.address.model.util.SampleDataUtil;
 import seedu.address.storage.AddressBookStorage;
 import seedu.address.storage.JsonAddressBookStorage;
 import seedu.address.storage.JsonMeetingBookStorage;
+import seedu.address.storage.JsonNoteBookStorage;
 import seedu.address.storage.JsonUserPrefsStorage;
 import seedu.address.storage.MeetingBookStorage;
+import seedu.address.storage.NoteBookStorage;
 import seedu.address.storage.Storage;
 import seedu.address.storage.StorageManager;
 import seedu.address.storage.UserPrefsStorage;
@@ -63,7 +67,8 @@ public void init() throws Exception {
         UserPrefs userPrefs = initPrefs(userPrefsStorage);
         AddressBookStorage addressBookStorage = new JsonAddressBookStorage(userPrefs.getAddressBookFilePath());
         MeetingBookStorage meetingBookStorage = new JsonMeetingBookStorage(userPrefs.getMeetingBookFilePath());
-        storage = new StorageManager(addressBookStorage, meetingBookStorage, userPrefsStorage);
+        NoteBookStorage noteBookStorage = new JsonNoteBookStorage(userPrefs.getNoteBookFilePath());
+        storage = new StorageManager(addressBookStorage, meetingBookStorage, noteBookStorage, userPrefsStorage);
 
         initLogging(config);
 
@@ -82,8 +87,10 @@ public void init() throws Exception {
     private Model initModelManager(Storage storage, ReadOnlyUserPrefs userPrefs) {
         Optional<ReadOnlyAddressBook> addressBookOptional;
         Optional<ReadOnlyMeetingBook> meetingBookOptional;
+        Optional<ReadOnlyNoteBook> noteBookOptional;
         ReadOnlyAddressBook initialDataAddressBook;
         ReadOnlyMeetingBook initialDataMeetingBook;
+        ReadOnlyNoteBook initialDataNoteBook;
 
         try {
             addressBookOptional = storage.readAddressBook();
@@ -115,8 +122,23 @@ private Model initModelManager(Storage storage, ReadOnlyUserPrefs userPrefs) {
             initialDataMeetingBook = new MeetingBook();
         }
 
+        //--============= NOTE ==================================================================================
 
-        return new ModelManager(initialDataAddressBook, initialDataMeetingBook, userPrefs);
+        try {
+            noteBookOptional = storage.readNoteBook();
+            if (!noteBookOptional.isPresent()) {
+                logger.info("Data file not found. Will be starting with a sample NoteBook");
+            }
+            initialDataNoteBook = noteBookOptional.orElseGet(SampleDataUtil::getSampleNoteBook);
+        } catch (DataConversionException e) {
+            logger.warning("Data file not in the correct format. Will be starting with an empty NoteBook");
+            initialDataNoteBook = new NoteBook();
+        } catch (IOException e) {
+            logger.warning("Problem while reading from the file. Will be starting with an empty NoteBook");
+            initialDataNoteBook = new NoteBook();
+        }
+
+        return new ModelManager(initialDataAddressBook, initialDataMeetingBook, initialDataNoteBook, userPrefs);
     }
 
     private void initLogging(Config config) {

src/main/java/seedu/address/logic/Logic.java

@@ -12,6 +12,8 @@
 import seedu.address.model.Model;
 import seedu.address.model.meeting.Meeting;
 import seedu.address.model.meeting.ReadOnlyMeetingBook;
+import seedu.address.model.note.Note;
+import seedu.address.model.note.ReadOnlyNoteBook;
 import seedu.address.model.person.Person;
 import seedu.address.model.person.ReadOnlyAddressBook;
 
@@ -53,6 +55,12 @@ public interface Logic {
     /** Returns an unmodifiable view of the filtered list of meetings */
     ObservableList<Meeting> getFilteredMeetingList();
 
+    ReadOnlyNoteBook getNoteBook();
+
+    ObservableList<Note> getFilteredNoteList();
+
+    Path getNoteBookFilePath();
+
     /**
      * Returns the user prefs' GUI settings.
      */

src/main/java/seedu/address/logic/LogicManager.java

@@ -17,6 +17,8 @@
 import seedu.address.model.Model;
 import seedu.address.model.meeting.Meeting;
 import seedu.address.model.meeting.ReadOnlyMeetingBook;
+import seedu.address.model.note.Note;
+import seedu.address.model.note.ReadOnlyNoteBook;
 import seedu.address.model.person.Person;
 import seedu.address.model.person.ReadOnlyAddressBook;
 import seedu.address.storage.Storage;
@@ -52,6 +54,7 @@ public CommandResult execute(String commandText) throws CommandException, ParseE
         try {
             storage.saveAddressBook(model.getAddressBook());
             storage.saveMeetingBook(model.getMeetingBook());
+            storage.saveNoteBook(model.getNoteBook());
         } catch (IOException ioe) {
             throw new CommandException(FILE_OPS_ERROR_MESSAGE + ioe, ioe);
         }
@@ -93,6 +96,24 @@ public GuiSettings getGuiSettings() {
     public void setGuiSettings(GuiSettings guiSettings) {
         model.setGuiSettings(guiSettings);
     }
+
+    //======================================Notebook methods ============================================
+    @Override
+    public ReadOnlyNoteBook getNoteBook() {
+        return model.getNoteBook();
+    }
+
+    @Override
+    public ObservableList<Note> getFilteredNoteList() {
+        return model.getFilteredNoteList();
+    }
+
+    @Override
+    public Path getNoteBookFilePath() {
+        return model.getNoteBookFilePath();
+    }
+
+
     //======================================Timetable UI methods ============================================
 
     @Override

src/main/java/seedu/address/logic/commands/notes/AddNoteCommand.java

@@ -0,0 +1,60 @@
+package seedu.address.logic.commands.notes;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_ADDRESS;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_EMAIL;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_GROUP;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_NAME;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_PHONE;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_PRIORITY;
+
+import seedu.address.logic.commands.Command;
+import seedu.address.logic.commands.CommandResult;
+import seedu.address.logic.commands.exceptions.CommandException;
+import seedu.address.model.Model;
+import seedu.address.model.note.Note;
+
+public class AddNoteCommand extends Command {
+
+    public static final String COMMAND_WORD = "addn";
+
+    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a note to the note book. "
+            + "Parameters: "
+            + PREFIX_NAME + "NAME "
+            + "[" + PREFIX_PRIORITY + "PRIORITY]...\n"
+            + "Example: " + COMMAND_WORD + " "
+            + PREFIX_NAME + "Complete CS2103 Tutorial "
+            + PREFIX_PRIORITY + "5 ";
+
+    public static final String MESSAGE_SUCCESS = "New note added: %1$s";
+    public static final String MESSAGE_DUPLICATE_NOTE = "This note already exists in the note book";
+
+    private final Note toAdd;
+
+    /**
+     * Creates an AddNoteCommand to add the specified {@code Note}
+     */
+    public AddNoteCommand(Note note) {
+        requireNonNull(note);
+        this.toAdd = note;
+    }
+
+    @Override
+    public CommandResult execute(Model model) throws CommandException {
+        requireNonNull(model);
+
+        if (model.hasNote(toAdd)) {
+            throw new CommandException(MESSAGE_DUPLICATE_NOTE);
+        }
+
+        model.addNote(toAdd);
+        return new CommandResult(String.format(MESSAGE_SUCCESS, toAdd));
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        return other == this // short circuit if same object
+                || (other instanceof AddNoteCommand // instanceof handles nulls
+                && toAdd.equals(((AddNoteCommand) other).toAdd));
+    }
+}

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

@@ -13,6 +13,7 @@
 import seedu.address.logic.commands.HelpCommand;
 import seedu.address.logic.commands.ListAllCommand;
 import seedu.address.logic.commands.meetings.*;
+import seedu.address.logic.commands.notes.AddNoteCommand;
 import seedu.address.logic.commands.persons.AddPersonCommand;
 import seedu.address.logic.commands.persons.ClearPersonCommand;
 import seedu.address.logic.commands.persons.DeletePersonCommand;
@@ -27,6 +28,7 @@
 import seedu.address.logic.parser.connections.DeletePersonToMeetingConnectionParser;
 import seedu.address.logic.parser.exceptions.ParseException;
 import seedu.address.logic.parser.meetings.*;
+import seedu.address.logic.parser.notes.AddNoteCommandParser;
 import seedu.address.logic.parser.persons.AddPersonCommandParser;
 import seedu.address.logic.parser.persons.DeletePersonCommandParser;
 import seedu.address.logic.parser.persons.EditPersonCommandParser;
@@ -107,6 +109,11 @@ public Command parseCommand(String userInput) throws ParseException {
 
         case UnsortMeetingCommand.COMMAND_WORD:
             return new UnsortMeetingCommand();
+
+        //======================= Note =====================================
+        case AddNoteCommand.COMMAND_WORD:
+            return new AddNoteCommandParser().parse(arguments);
+
         //======================= Timetable =====================================
 
         case SetTimetableCommand.COMMAND_WORD:

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

@@ -8,6 +8,7 @@
 import seedu.address.model.meeting.Description;
 import seedu.address.model.meeting.MeetingName;
 import seedu.address.model.meeting.Priority;
+import seedu.address.model.note.Content;
 import seedu.address.model.person.Address;
 import seedu.address.model.person.Email;
 import seedu.address.model.person.PersonName;
@@ -196,4 +197,18 @@ public static Set<Index> parsePersonsConnection(Collection<String> oneBasedIndex
         }
         return indexSet;
     }
+
+    // =========================== ParserUtil for Note ==============================
+
+    /**
+     * Parses a {@code String content} into a {@code Content}.
+     * Leading and trailing whitespaces will be trimmed.
+     *
+     */
+    public static Content parseNoteContent(String content) {
+        requireNonNull(content);
+        String trimmedContent = content.trim();
+        return new Content(trimmedContent);
+    }
+
 }

src/main/java/seedu/address/logic/parser/notes/AddNoteCommandParser.java

@@ -0,0 +1,61 @@
+package seedu.address.logic.parser.notes;
+
+import static seedu.address.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_NAME;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_PRIORITY;
+
+import java.util.stream.Stream;
+
+import seedu.address.logic.commands.notes.AddNoteCommand;
+import seedu.address.logic.parser.ArgumentMultimap;
+import seedu.address.logic.parser.ArgumentTokenizer;
+import seedu.address.logic.parser.Parser;
+import seedu.address.logic.parser.ParserUtil;
+import seedu.address.logic.parser.Prefix;
+import seedu.address.logic.parser.exceptions.ParseException;
+import seedu.address.model.meeting.Priority;
+import seedu.address.model.note.Content;
+import seedu.address.model.note.Note;
+
+/**
+ * Parses input arguments and creates a new AddNoteCommand object
+ */
+public class AddNoteCommandParser implements Parser<AddNoteCommand> {
+
+    /**
+     * Parses the given {@code String} of arguments in the context of the AddNoteCommand
+     * and returns an AddNoteCommand object for execution.
+     * @throws ParseException if the user input does not conform the expected format
+     */
+    public AddNoteCommand parse(String args) throws ParseException {
+        ArgumentMultimap argMultimap =
+                ArgumentTokenizer.tokenize(args, PREFIX_NAME, PREFIX_PRIORITY);
+
+        if (!arePrefixesPresent(argMultimap, PREFIX_NAME)
+                || !argMultimap.getPreamble().isEmpty()) {
+            throw new ParseException(String.format(MESSAGE_INVALID_COMMAND_FORMAT, AddNoteCommand.MESSAGE_USAGE));
+        }
+
+        Content content = ParserUtil.parseNoteContent(argMultimap.getValue(PREFIX_NAME).get());
+        Priority priority;
+
+        if (!arePrefixesPresent(argMultimap, PREFIX_PRIORITY)) {
+            priority = new Priority("1");
+        } else {
+            priority = ParserUtil.parseMeetingPriority(argMultimap.getValue(PREFIX_PRIORITY).get());
+        }
+
+        Note note = new Note(content, priority);
+
+        return new AddNoteCommand(note);
+    }
+
+    /**
+     * Returns true if none of the prefixes contains empty {@code Optional} values in the given
+     * {@code ArgumentMultimap}.
+     */
+    private static boolean arePrefixesPresent(ArgumentMultimap argumentMultimap, Prefix... prefixes) {
+        return Stream.of(prefixes).allMatch(prefix -> argumentMultimap.getValue(prefix).isPresent());
+    }
+
+}

src/main/java/seedu/address/model/Model.java

@@ -1,5 +1,7 @@
 package seedu.address.model;
 
+import static java.util.Objects.requireNonNull;
+
 import java.nio.file.Path;
 import java.time.LocalDate;
 import java.time.LocalDateTime;
@@ -16,6 +18,8 @@
 import seedu.address.model.group.Group;
 import seedu.address.model.meeting.Meeting;
 import seedu.address.model.meeting.ReadOnlyMeetingBook;
+import seedu.address.model.note.Note;
+import seedu.address.model.note.ReadOnlyNoteBook;
 import seedu.address.model.person.Person;
 import seedu.address.model.person.ReadOnlyAddressBook;
 import seedu.address.model.reminder.ReadOnlyReminderBook;
@@ -27,6 +31,7 @@ public interface Model {
     /** {@code Predicate} that always evaluate to true */
     Predicate<Person> PREDICATE_SHOW_ALL_PERSONS = unused -> true;
     Predicate<Meeting> PREDICATE_SHOW_ALL_MEETINGS = unused -> true;
+    Predicate<Note> PREDICATE_SHOW_ALL_NOTES = unused -> true;
 
     /**
      * Replaces user prefs data with the data in {@code userPrefs}.
@@ -223,6 +228,52 @@ public interface Model {
      */
     ObservableList<Person> getFilteredPersonListByMeetingConnection(Meeting meeting);
 
+    // ======================= Note part of the note Model interface ============================ //
+
+    /**
+     * Replaces note book data with the data in {@code noteBook}.
+     */
+    void setNoteBook(ReadOnlyNoteBook noteBook);
+
+    /** Returns the NoteBook */
+    ReadOnlyNoteBook getNoteBook();
+
+    /**
+     * Returns true if a note with the same content as {@code note} exists in the note book.
+     */
+    boolean hasNote(Note note);
+
+    /**
+     * Deletes the given note.
+     * The note must exist in the note book.
+     */
+    void deleteNote(Note target);
+
+    /**
+     * Adds the given note.
+     * {@code note} must not already exist in the note book.
+     */
+    void addNote(Note note);
+
+    /**
+     * Replaces the given note {@code target} with {@code editedNote}.
+     * {@code target} must exist in the note book.
+     * The content of {@code editedNote} must not be the same as another existing note in the note book.
+     */
+    void setNote(Note target, Note editedNote);
+
+    /** Returns an unmodifiable view of the filtered note list */
+    ObservableList<Note> getFilteredNoteList();
+
+    /**
+     * Updates the filter of the filtered note list to filter by the given {@code predicate}.
+     * @throws NullPointerException if {@code predicate} is null.
+     */
+    void updateFilteredNoteList(Predicate<Note> predicate);
+
+    Path getNoteBookFilePath();
+
+    void setNoteBookFilePath(Path noteBookFilePath);
 
     //============================= Timetable settings =====================================