Merge pull request #113 from Maurice2n97/update-UG-1.3

Update ug 1.3

Author: Maurice2n97

docs/UserGuide.md

@@ -171,6 +171,45 @@ Format: `sortp by/FIELD d/DIRECTION`
     * Sort by ascending alphabetical order : `ASC`
     * Sort by descending alphabetical order : `DESC`
 
+Examples
+
+##Timetable feature
+
+### Viewing Timetable: 
+ No command is necessary. Just click on the timetable tab to switch view from meeting list to timetable. The timetable
+ consists of 7 rows, each row corresponds a day of a week in the timetable, which default is from 7 am to 6.59 am on the next day. 
+ Each meeting is represented as an orange rectangular slot that will be placed in the timetable according to the following rules
+ 
+ * If the meetings happen on a date corresponding to a column, it will be slotted into that column
+ * The vertical axis if the timetable is the time, and slots are vertically placed according to their start time.
+ * The length of the meeting slot is proportional to the timespan of the meeting.
+ 
+ Note that it will correctly update and display all meetings. Meetings that fall outside the range of the timetable 
+ will be filtered off. Some things to note:
+ 
+ * Default when starting the application, the timetable will have the first ( leftmost column ) representing today's date.
+ * Meetings can overlap across columns.
+ * Setting small meeting times around the edge of the timetable will cause display issues, For example, setting a meeting 
+ to 6:44-7:01 might cause display issues from the 7 - 7.01 will not display the date or time.
+ * Note that you can scroll to view more slots.
+ 
+ 
+### Set timetable date : `setTimetable`
+ 
+ Sets a timetable to start on a specified date. Updates the display accordingly.
+ 
+ Format: 'setTimetable DATE'
+ 
+ * DATE must be a string strictly following the format `YYYY-mm-dd`
+ 
+ 
+### Profile picture:
+
+Gets the image of contacts from Gravatar. If contact does not have a gravatar account linked to 
+the email address, the what will be shown is a unique robo-hashed image obtained from email.
+There is no need to use any commands, the profile picture will be shown after updating/ adding contact
+If there is a problem establishing connection to the server, a default blue circle icon will be displayed
+instead.
 
 ### Clearing all entries : `clear`
 
@@ -186,11 +225,12 @@ Format: `exit`
 
 ### Saving the data
 
-AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
+MeetBuddy data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
 
 ### Editing the data file
 
 AddressBook data are saved as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file.
+MeetingBook data are saved as a JSON file '[JAR file location]/data/meetingbook.json'. Advanced users are welcome to update data directly by editing that data file.
 
 <div markdown="span" class="alert alert-warning">:exclamation: **Caution:**
 If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run.
@@ -200,7 +240,9 @@ If your changes to the data file makes its format invalid, AddressBook will disc
 
 ### Adding a meeting: `addm`
 
-Adds a meeting to MeetBuddy.
+Adds a meeting to MeetBuddy. Note that meetings must be of minimum length of 15 mins
+and maximum length of 7 days. For example a meeting cannot be 15 March 16:00 - 22 March 16:00,
+but can be from 15 March 16:00 - 22 march 15:59.
 
 Format: `addm n/NAME st/TIME ed/TIME des/DESCRIPTIONS pr/PRIORITY [p/PERSON RELATED]… [g/GROUP]…​`
 
@@ -287,3 +329,4 @@ Action | Format, Examples
 **List** | `list`, `listm`, `listp`
 **Sort** | `sortp by/FIELD d/DIRECTION` <br>  `sortm by/FIELD d/DIRECTION`
 **Help** | `help`
+**SetTimtable**| `setTimetable DATE`

docs/images/Ui.png

@@ -6,6 +6,7 @@
 import seedu.address.model.person.UniquePersonList;
 import seedu.address.model.schedule.Schedulable;
 
+import java.time.Duration;
 import java.time.LocalDateTime;
 import java.util.Collections;
 import java.util.HashSet;
@@ -23,7 +24,9 @@
 public class Meeting implements Schedulable {
 
     public static final String MESSAGE_CONSTRAINTS =
-            "The start date time of a meeting should be strictly earlier than the terminate date time.";
+            "The start date time of a meeting should be strictly earlier than the terminate date time. A meeting "
+                    + "should be at least 15 minutes long. A meeting should be at most one week long. For example:"
+                    + "If the meeting starts on 15 August 7:00 am, it should be at note end later than 22 Aug 6:59am";
 
 
     // Identity fields
@@ -95,10 +98,13 @@ public boolean isSameMeeting(Meeting otherMeeting) {
                 && otherMeeting.getTerminate().equals(getTerminate());
     }
     /**
-     * Returns true if a given date time for the meeting is valid.
+     * Returns true if a given date time for the meeting is valid. Note the meeting must be at
+     * least 15 mins long and at most 7 days long.
      */
     public static boolean isValidStartTerminate(DateTime start, DateTime terminate) {
-        return start.compareTo(terminate) < 0;
+        long minutesBetween = Duration.between(start.toLocalDateTime(), terminate.toLocalDateTime()).toMinutes();
+        long daysBetween = Duration.between(start.toLocalDateTime(), terminate.toLocalDateTime()).toDays();
+        return start.compareTo(terminate) < 0 && (minutesBetween >= 15) && (daysBetween < 7);
     }
     /**
      * Adds new groups from a set. Merge if new group appears.

src/main/java/seedu/address/model/meeting/Meeting.java

@@ -31,8 +31,9 @@
  */
 public class TimetablePlacementPolicy {
 
-    private static final int MINUTES_IN_AN_HOUR = 60;
-    private static final int MINUTES_IN_DAY = 2400;
+    private static final int SECONDS_IN_A_MINUTE = 60;
+    private static final int SECONDS_IN_AN_HOUR = 3600;
+    private static final long SECONDS_IN_DAY = 86400;
 
     public static final double TIMETABLE_DISPLAY_SIZE = 5760;
 
@@ -104,19 +105,19 @@ public TimetableView.Column getColumnPlacement(Schedulable schedulable) {
     }
 
     /**
-     * Gets the number of minutes so far in a day, starting from 00:00
+     * Gets the number of seconds so far in a day, starting from 00:00
      * @param localDateTime
      * @return
      */
 
-    public static int getMinutesInDay(LocalDateTime localDateTime) {
-        return localDateTime.getHour() * MINUTES_IN_AN_HOUR + localDateTime.getMinute();
+    public static int getSecondsInDay(LocalDateTime localDateTime) {
+        return localDateTime.getHour() * SECONDS_IN_AN_HOUR + localDateTime.getMinute() * SECONDS_IN_A_MINUTE + localDateTime.getSecond();
     }
 
     public double getVerticalPosition(Schedulable schedulable) {
         LocalDateTime startingDateTime = schedulable.getStartLocalDateTime();
-        int minutesSoFar = getMinutesInDay(applyOffset(startingDateTime));
-        double ratio = (double) minutesSoFar / MINUTES_IN_DAY;
+        int minutesSoFar = getSecondsInDay(applyOffset(startingDateTime));
+        double ratio = (double) minutesSoFar / SECONDS_IN_DAY;
         return ratio * TIMETABLE_DISPLAY_SIZE;
     }
 
@@ -129,10 +130,10 @@ public double getVerticalPosition(Schedulable schedulable) {
     public double getLengthOfSlot(Schedulable schedulable) {
         LocalDateTime offSetStartDate = applyOffset(schedulable.getStartLocalDateTime());
         LocalDateTime offSetEndDate = applyOffset(schedulable.getTerminateLocalDateTime());
-        int startMinutesSoFar = getMinutesInDay(offSetStartDate);
-        int endMinutesSoFar = getMinutesInDay(offSetEndDate);
-        assert endMinutesSoFar >= startMinutesSoFar;
-        double ratio = (double)(endMinutesSoFar - startMinutesSoFar) / MINUTES_IN_DAY;
+        long startSecondsSoFar = getSecondsInDay(offSetStartDate);
+        long endSecondsSoFar = getSecondsInDay(offSetEndDate);
+        assert endSecondsSoFar >= startSecondsSoFar;
+        double ratio = (double)(endSecondsSoFar - startSecondsSoFar) / SECONDS_IN_DAY;
         return TIMETABLE_DISPLAY_SIZE * ratio;
 
     }

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

@@ -24,7 +24,11 @@ public class TimetableSlot extends UiPart<Region> {
 
     public TimetableSlot(double slotLength, String header) {
         super(FXML);
-        this.meetingLabel.setText(header);
+        if (slotLength < 13) {
+            this.meetingLabel.setText(""); // Prevent overflow of text
+        } else {
+            this.meetingLabel.setText(header);
+        }
         meetingSlot.setPrefHeight(slotLength);
         meetingSlot.setMinHeight(slotLength);
         meetingSlot.setMaxHeight(slotLength);

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

@@ -346,3 +346,12 @@
     -fx-background-radius: 2;
     -fx-font-size: 11;
 }
+
+.meetingcard-header {
+    -fx-text-fill: white;
+    -fx-background-color: #43613d;
+    -fx-padding: 1 3 1 3;
+    -fx-border-radius: 2;
+    -fx-background-radius: 2;
+    -fx-font-size: 18;
+}

src/main/resources/view/DarkTheme.css

@@ -12,7 +12,7 @@
                 <HBox alignment="CENTER_LEFT" spacing="10.0" VBox.vgrow="NEVER">
                     <children>
                         <Label fx:id="id" text="Label"/>
-                        <Label fx:id="name" text="A VERY LONG MEETING" wrapText="true" HBox.hgrow="ALWAYS"/>
+                        <Label fx:id="name" text="A VERY LONG MEETING" wrapText="true" HBox.hgrow="ALWAYS" styleClass="meetingcard-header" stylesheets="@DarkTheme.css"/>
                     </children>
                     <padding>
                         <Insets top="5.0"/>

src/main/resources/view/MeetingCard.fxml

@@ -99,13 +99,13 @@
                         </Label>
                      </children>
                   </VBox>
-                  <AnchorPane fx:id="dayScheduleOne" styleClass="even-timetable-row" stylesheets="@Extensions.css" GridPane.hgrow="ALWAYS" GridPane.rowIndex="1" />
-                  <AnchorPane fx:id="dayScheduleTwo" styleClass="odd-timetable-row" stylesheets="@Extensions.css" GridPane.columnIndex="1" GridPane.hgrow="ALWAYS" GridPane.rowIndex="1" />
-                  <AnchorPane fx:id="dayScheduleThree" styleClass="even-timetable-row" stylesheets="@Extensions.css" GridPane.columnIndex="2" GridPane.hgrow="ALWAYS" GridPane.rowIndex="1" />
-                  <AnchorPane fx:id="dayScheduleFour" styleClass="odd-timetable-row" stylesheets="@Extensions.css" GridPane.columnIndex="3" GridPane.hgrow="ALWAYS" GridPane.rowIndex="1" />
-                  <AnchorPane fx:id="dayScheduleFive" styleClass="even-timetable-row" stylesheets="@Extensions.css" GridPane.columnIndex="4" GridPane.hgrow="ALWAYS" GridPane.rowIndex="1" />
-                  <AnchorPane fx:id="dayScheduleSix" styleClass="odd-timetable-row" stylesheets="@Extensions.css" GridPane.columnIndex="5" GridPane.hgrow="ALWAYS" GridPane.rowIndex="1" />
-                  <AnchorPane fx:id="dayScheduleSeven" styleClass="even-timetable-row" stylesheets="@Extensions.css" GridPane.columnIndex="6" GridPane.hgrow="ALWAYS" GridPane.rowIndex="1" />
+                  <AnchorPane fx:id="dayScheduleOne" minHeight="550.0" styleClass="even-timetable-row" stylesheets="@Extensions.css" GridPane.hgrow="ALWAYS" GridPane.rowIndex="1" GridPane.vgrow="ALWAYS" />
+                  <AnchorPane fx:id="dayScheduleTwo" minHeight="550.0" styleClass="odd-timetable-row" stylesheets="@Extensions.css" GridPane.columnIndex="1" GridPane.hgrow="ALWAYS" GridPane.rowIndex="1" GridPane.vgrow="ALWAYS" />
+                  <AnchorPane fx:id="dayScheduleThree" minHeight="550.0" styleClass="even-timetable-row" stylesheets="@Extensions.css" GridPane.columnIndex="2" GridPane.hgrow="ALWAYS" GridPane.rowIndex="1" GridPane.vgrow="ALWAYS" />
+                  <AnchorPane fx:id="dayScheduleFour" minHeight="550.0" styleClass="odd-timetable-row" stylesheets="@Extensions.css" GridPane.columnIndex="3" GridPane.hgrow="ALWAYS" GridPane.rowIndex="1" GridPane.vgrow="ALWAYS" />
+                  <AnchorPane fx:id="dayScheduleFive" minHeight="550.0" styleClass="even-timetable-row" stylesheets="@Extensions.css" GridPane.columnIndex="4" GridPane.hgrow="ALWAYS" GridPane.rowIndex="1" GridPane.vgrow="ALWAYS" />
+                  <AnchorPane fx:id="dayScheduleSix" minHeight="550.0" styleClass="odd-timetable-row" stylesheets="@Extensions.css" GridPane.columnIndex="5" GridPane.hgrow="ALWAYS" GridPane.rowIndex="1" GridPane.vgrow="ALWAYS" />
+                  <AnchorPane fx:id="dayScheduleSeven" minHeight="550.0" styleClass="even-timetable-row" stylesheets="@Extensions.css" GridPane.columnIndex="6" GridPane.hgrow="ALWAYS" GridPane.rowIndex="1" GridPane.vgrow="ALWAYS" />
                </children>
             </GridPane>
          </content>