} DayOfActivities
+ *
+ */
+
/**
* Sort a list of trip activities by date.
- * @param {Array} tripActivities Array of activities.
- * @returns List of trip activities in the form
- * [ ['MM/DD/YYYY', [activities on that day]], ...] in chronological order by date.
+ * @param {Activity[]} tripActivities Array of activities.
+ * @return {DayOfActivities[]} List of trip activities in the form
+ * [ , ...]
+ * in chronological order by date.
*/
export function sortByDate(tripActivities) {
let activities = new Map(); // { MM/DD/YYYY: [activities] }.
@@ -31,8 +49,10 @@ export function sortByDate(tripActivities) {
/**
* Put a and b in display order.
- * @param {dictionary} a Dictionary representing activity a and its fields.
- * @param {dictionary} b Dictionary representing activity b and its fields.
+ * This function is a comparator.
+ * @param {Activity} a Dictionary representing activity a and its fields.
+ * @param {Activity} b Dictionary representing activity b and its fields.
+ * @return {int} -1 if a comes before b, else 1.
*/
export function compareActivities(a, b) {
if (a[DB.ACTIVITIES_START_TIME] < b[DB.ACTIVITIES_START_TIME]) {
@@ -47,12 +67,12 @@ export function compareActivities(a, b) {
/**
- * Get the field of field name `fieldName` from `activity or the default value.
+ * Get the field of field name fieldName from activity or the default value.
*
- * @param {Object} activity
- * @param {string} fieldName
- * @param defaultValue
- * @returns `activity[fieldName]` if possible, else `defaultValue`.
+ * @param {Activity} activity The activity from which to get the field.
+ * @param {string} fieldName Name of field to get.
+ * @param {*} defaultValue Value if field is not found/is null.
+ * @returns {*} activity[fieldName] if possible, else defaultValue.
*/
export function getField(activity, fieldName, defaultValue){
if (activity[fieldName] === null || activity[fieldName] === undefined) {
@@ -67,7 +87,7 @@ export function getField(activity, fieldName, defaultValue){
* @param {string} tripId Database ID of the trip whose actiivty should be modified.
* @param {string} activityId Database ID of the activity to be modified.
* @param {Object} newValues Dictionary of the new values in {fieldName: newValue} form
- * @returns true if the write was successful, false otherwise.
+ * @returns {boolean} `true` if the write was successful, `false` otherwise.
*/
export async function writeActivity(tripId, activityId, newValues) {
// todo: check if tripId or activityId is not valid. (#58)
@@ -87,4 +107,4 @@ export async function writeActivity(tripId, activityId, newValues) {
console.log(e);
return false;
}
-}
+}
\ No newline at end of file
From 34607807938ada8ca41a4e78157af8918d841657 Mon Sep 17 00:00:00 2001
From: Ananya Y <14322650+ananyeet@users.noreply.github.com>
Date: Tue, 21 Jul 2020 20:09:37 -0500
Subject: [PATCH 18/24] activityfns documentation
---
.../src/components/ViewActivities/activityfns.js | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/frontend/src/components/ViewActivities/activityfns.js b/frontend/src/components/ViewActivities/activityfns.js
index d3f8cd70..75f570a9 100644
--- a/frontend/src/components/ViewActivities/activityfns.js
+++ b/frontend/src/components/ViewActivities/activityfns.js
@@ -17,7 +17,7 @@ const db = app.firestore();
/**
* A single activity day. A single instance looks like:
- * ['MM/DD/YYYY', [activities on that day]]
+ * ['MM/DD/YYYY', [activities on that day]]
* @typedef {Array.} DayOfActivities
*
*/
@@ -26,7 +26,7 @@ const db = app.firestore();
* Sort a list of trip activities by date.
* @param {Activity[]} tripActivities Array of activities.
* @return {DayOfActivities[]} List of trip activities in the form
- * [ , ...]
+ * [ , ...]
* in chronological order by date.
*/
export function sortByDate(tripActivities) {
@@ -48,11 +48,11 @@ export function sortByDate(tripActivities) {
}
/**
- * Put a and b in display order.
+ * Put a and b in display order.
* This function is a comparator.
* @param {Activity} a Dictionary representing activity a and its fields.
* @param {Activity} b Dictionary representing activity b and its fields.
- * @return {int} -1 if a comes before b, else 1.
+ * @return {int} -1 if a comes before b, else 1.
*/
export function compareActivities(a, b) {
if (a[DB.ACTIVITIES_START_TIME] < b[DB.ACTIVITIES_START_TIME]) {
@@ -72,7 +72,7 @@ export function compareActivities(a, b) {
* @param {Activity} activity The activity from which to get the field.
* @param {string} fieldName Name of field to get.
* @param {*} defaultValue Value if field is not found/is null.
- * @returns {*} activity[fieldName] if possible, else defaultValue.
+ * @returns {*} activity[fieldName] if possible, else defaultValue.
*/
export function getField(activity, fieldName, defaultValue){
if (activity[fieldName] === null || activity[fieldName] === undefined) {
@@ -82,12 +82,12 @@ export function getField(activity, fieldName, defaultValue){
}
/**
- * Write contents into an activity in the database.
+ * Write contents into an activity already existing in the database.
*
* @param {string} tripId Database ID of the trip whose actiivty should be modified.
* @param {string} activityId Database ID of the activity to be modified.
- * @param {Object} newValues Dictionary of the new values in {fieldName: newValue} form
- * @returns {boolean} `true` if the write was successful, `false` otherwise.
+ * @param {Object} newValues Dictionary of the new values in {fieldName: newValue} form
+ * @returns {boolean} true if the write was successful, false otherwise.
*/
export async function writeActivity(tripId, activityId, newValues) {
// todo: check if tripId or activityId is not valid. (#58)
From 2448d919f1dc23e8dbde3dc72c3e0a80797a8fb9 Mon Sep 17 00:00:00 2001
From: Ananya Y <14322650+ananyeet@users.noreply.github.com>
Date: Tue, 21 Jul 2020 20:12:23 -0500
Subject: [PATCH 19/24] time.js comments.
---
frontend/src/components/Utils/time.js | 28 ++++++++++++++-------------
1 file changed, 15 insertions(+), 13 deletions(-)
diff --git a/frontend/src/components/Utils/time.js b/frontend/src/components/Utils/time.js
index 27eca202..a0e70d01 100644
--- a/frontend/src/components/Utils/time.js
+++ b/frontend/src/components/Utils/time.js
@@ -1,9 +1,10 @@
/**
- * Format a timestamp (in milliseconds) into a pretty string with just the time.
+ * Format a timestamp (in milliseconds) into a pretty string with just the time like
+ * '10.19 AM'.
*
- * @param {int} msTimestamp
- * @param {string} timezone
- * @returns {string} Time formatted into a string like '10:19 AM'.
+ * @param {int} msTimestamp Timestamp in milliseconds of desired date.
+ * @param {string} timezone Timezone in which to convert.
+ * @returns {string} Time formatted into desired pretty string.
*/
export function timestampToTimeFormatted(msTimestamp, timezone = 'America/New_York') {
const date = new Date(msTimestamp);
@@ -17,11 +18,12 @@ export function timestampToTimeFormatted(msTimestamp, timezone = 'America/New_Yo
}
/**
- * Format a timestamp (in milliseconds) into a pretty string with just the date.
+ * Format a timestamp (in milliseconds) into a pretty string with just the date, like
+ * 'Monday, January 19, 1970'.
*
- * @param {int} msTimestamp
- * @param {string} timezone
- * @returns {string} Time formatted into a string like 'Monday, January 19, 1970'.
+ * @param {int} msTimestamp Timestamp in milliseconds of desired date.
+ * @param {string} timezone Timezone in which to convert.
+ * @returns {string} Time formatted into desired pretty string.
*/
export function timestampToDateFormatted(msTimestamp, timezone='America/New_York') {
const date = new Date(msTimestamp);
@@ -37,12 +39,12 @@ export function timestampToDateFormatted(msTimestamp, timezone='America/New_York
}
/**
- * Format a timestamp (in milliseconds) into a pretty string.
+ * Format a timestamp (in milliseconds) into a pretty string like
+ * 'Monday, January 19, 1970, 02:48 AM'.
*
- * @param {int} msTimestamp
- * @param {string} timezone
- * @returns {string} Time formatted into a string like
- * 'Monday, January 19, 1970, 02:48 AM'
+ * @param {int} msTimestamp Timestamp in milliseconds of desired date.
+ * @param {string} timezone Timezone in which to convert.
+ * @returns {string} Time formatted into desired pretty string.
*/
export function timestampToFormatted(msTimestamp, timezone = 'America/New_York') {
let date = new Date(msTimestamp);
From 4c24e687403e06a73d6751b3ce316dda89bd4d79 Mon Sep 17 00:00:00 2001
From: Ananya Y <14322650+ananyeet@users.noreply.github.com>
Date: Tue, 21 Jul 2020 21:03:54 -0500
Subject: [PATCH 20/24] Exhaustive comments
---
.../src/components/ViewActivities/activity.js | 16 ++++++++++------
.../src/components/ViewActivities/activityday.js | 10 +++++-----
.../src/components/ViewActivities/activityfns.js | 12 ++++++------
.../components/ViewActivities/activitylist.js | 13 +++++++------
4 files changed, 28 insertions(+), 23 deletions(-)
diff --git a/frontend/src/components/ViewActivities/activity.js b/frontend/src/components/ViewActivities/activity.js
index dc98f42b..9fa46cae 100644
--- a/frontend/src/components/ViewActivities/activity.js
+++ b/frontend/src/components/ViewActivities/activity.js
@@ -6,7 +6,9 @@ import { getField, writeActivity } from './activityfns.js';
import { Accordion, Button, Card, Col, Form, Row } from 'react-bootstrap';
/**
- * Returns a dropdown of all the timezones.
+ * Return a dropdown of all the timezones.
+ *
+ * @return {HTML} Dropdown of all the timezones.
*/
function timezonePicker() {
// TODO: Make this dropdown. (#51)
@@ -14,14 +16,14 @@ function timezonePicker() {
}
/**
- * A single activity.
+ * React component for a single activity.
*
- * @param {Object} props This component expects the following props:
- * - `activity` {Object} The activity to display.
+ * @property {Object} props ReactJS props.
+ * @property {ActivityInfo} props.activity The activity to display.
* (MUST contain 'id' field with database activity id and 'tripId' field.)
*/
class Activity extends React.Component {
- /** {@inheritdoc} */
+ /** @override */
constructor(props) {
super(props);
@@ -66,6 +68,8 @@ class Activity extends React.Component {
/**
* Set the activity into viewing mode.
+ *
+ * @param {event} event The form's event.
*/
finishEditActivity(event) {
this.setState({editing: false});
@@ -118,7 +122,7 @@ class Activity extends React.Component {
}
}
- /** @inheritdoc */
+ /** @override */
render() {
const activity = this.props.activity;
return (
diff --git a/frontend/src/components/ViewActivities/activityday.js b/frontend/src/components/ViewActivities/activityday.js
index 21b8a2a5..58b221ca 100644
--- a/frontend/src/components/ViewActivities/activityday.js
+++ b/frontend/src/components/ViewActivities/activityday.js
@@ -4,14 +4,14 @@ import * as activityFns from './activityfns.js';
import * as time from '../Utils/time.js'
/**
- * One single day of activities.
+ * React component for a single day of activities.
*
- * @param {Object} props This component expects the following props:
- * - `activities` The list of activities for 'today'.
- * - `date` The date, formatted as 'MM/DD/YYYY'.
+ * @property {Object} props ReactJS props.
+ * @property {ActivityInfo[]} props.activities The list of activities for 'today'.
+ * @property {string} props.date The date, formatted as 'MM/DD/YYYY'.
*/
class ActivityDay extends React.Component {
- /** @inheritdoc */
+ /** @override */
render() {
const sortedActivities = Array.from(this.props.activities)
.sort(activityFns.compareActivities);
diff --git a/frontend/src/components/ViewActivities/activityfns.js b/frontend/src/components/ViewActivities/activityfns.js
index 75f570a9..465533f9 100644
--- a/frontend/src/components/ViewActivities/activityfns.js
+++ b/frontend/src/components/ViewActivities/activityfns.js
@@ -6,7 +6,7 @@ const db = app.firestore();
/**
* An activity object.
- * @typedef {Object} Activity
+ * @typedef {Object} ActivityInfo
* @property {string} id The activity's ID in the database.
* @property {string} tripId The activity's tripId in the database.
* @property {string} title The activity's title.
@@ -18,13 +18,13 @@ const db = app.firestore();
/**
* A single activity day. A single instance looks like:
* ['MM/DD/YYYY', [activities on that day]]
- * @typedef {Array.} DayOfActivities
+ * @typedef {Array.} DayOfActivities
*
*/
/**
* Sort a list of trip activities by date.
- * @param {Activity[]} tripActivities Array of activities.
+ * @param {ActivityInfo[]} tripActivities Array of activities.
* @return {DayOfActivities[]} List of trip activities in the form
* [ , ...]
* in chronological order by date.
@@ -50,8 +50,8 @@ export function sortByDate(tripActivities) {
/**
* Put a and b in display order.
* This function is a comparator.
- * @param {Activity} a Dictionary representing activity a and its fields.
- * @param {Activity} b Dictionary representing activity b and its fields.
+ * @param {ActivityInfo} a Dictionary representing activity a and its fields.
+ * @param {ActivityInfo} b Dictionary representing activity b and its fields.
* @return {int} -1 if a comes before b, else 1.
*/
export function compareActivities(a, b) {
@@ -69,7 +69,7 @@ export function compareActivities(a, b) {
/**
* Get the field of field name fieldName from activity or the default value.
*
- * @param {Activity} activity The activity from which to get the field.
+ * @param {ActivityInfo} activity The activity from which to get the field.
* @param {string} fieldName Name of field to get.
* @param {*} defaultValue Value if field is not found/is null.
* @returns {*} activity[fieldName] if possible, else defaultValue.
diff --git a/frontend/src/components/ViewActivities/activitylist.js b/frontend/src/components/ViewActivities/activitylist.js
index 3adb9f30..9dad6f86 100644
--- a/frontend/src/components/ViewActivities/activitylist.js
+++ b/frontend/src/components/ViewActivities/activitylist.js
@@ -11,6 +11,7 @@ const db = app.firestore();
* Gets the list of activities from the server.
*
* @param {string} tripId The trip ID.
+ * @return {ActivityInfo[]} The list of trip activities.
*/
export async function getActivityList(tripId) {
return new Promise(function(resolve, reject) {
@@ -42,20 +43,20 @@ export async function getActivityList(tripId) {
}
/**
- * The list of activities.
+ * React component for the list of activities.
*
- * @param {Object} props This component expects the following props:
- * - `tripId` {string} The trip's ID.
+ * @param {Object} props ReactJS props.
+ * @param {string} props.tripId The trip's ID.
*/
class ActivityList extends React.Component {
- /** @inheritdoc */
+ /** @override */
constructor(props) {
super(props);
this.state = { days : [] };
}
/**
- * @inheritdoc
+ * @override
*
* Get sorted list of activities from the database.
*
@@ -75,7 +76,7 @@ class ActivityList extends React.Component {
this.setState({days: activityFns.sortByDate(tripActivities)});
}
- /** @inheritdoc */
+ /** @override */
render() {
if (this.state === null) { return (); }
if (this.state.days === null) {
From 26184ff617795fe713869cb7fdf1b363e3d8995a Mon Sep 17 00:00:00 2001
From: Ananya Y <14322650+ananyeet@users.noreply.github.com>
Date: Tue, 21 Jul 2020 21:21:39 -0500
Subject: [PATCH 21/24] to
---
frontend/src/components/ViewActivities/activityfns.js | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/frontend/src/components/ViewActivities/activityfns.js b/frontend/src/components/ViewActivities/activityfns.js
index 465533f9..327f7e1f 100644
--- a/frontend/src/components/ViewActivities/activityfns.js
+++ b/frontend/src/components/ViewActivities/activityfns.js
@@ -52,7 +52,7 @@ export function sortByDate(tripActivities) {
* This function is a comparator.
* @param {ActivityInfo} a Dictionary representing activity a and its fields.
* @param {ActivityInfo} b Dictionary representing activity b and its fields.
- * @return {int} -1 if a comes before b, else 1.
+ * @return {int} -1 if a comes before b, else 1.
*/
export function compareActivities(a, b) {
if (a[DB.ACTIVITIES_START_TIME] < b[DB.ACTIVITIES_START_TIME]) {
@@ -72,7 +72,7 @@ export function compareActivities(a, b) {
* @param {ActivityInfo} activity The activity from which to get the field.
* @param {string} fieldName Name of field to get.
* @param {*} defaultValue Value if field is not found/is null.
- * @returns {*} activity[fieldName] if possible, else defaultValue.
+ * @returns {*} activity[fieldName] if possible, else defaultValue.
*/
export function getField(activity, fieldName, defaultValue){
if (activity[fieldName] === null || activity[fieldName] === undefined) {
@@ -86,8 +86,8 @@ export function getField(activity, fieldName, defaultValue){
*
* @param {string} tripId Database ID of the trip whose actiivty should be modified.
* @param {string} activityId Database ID of the activity to be modified.
- * @param {Object} newValues Dictionary of the new values in {fieldName: newValue} form
- * @returns {boolean} true if the write was successful, false otherwise.
+ * @param {Object} newValues Dictionary of the new values in {fieldName: newValue} form
+ * @returns {boolean} true if the write was successful, false otherwise.
*/
export async function writeActivity(tripId, activityId, newValues) {
// todo: check if tripId or activityId is not valid. (#58)
From 2e3427d0268da0e708611a7e55e68f83004489f1 Mon Sep 17 00:00:00 2001
From: Ananya Y <14322650+ananyeet@users.noreply.github.com>
Date: Fri, 24 Jul 2020 17:37:23 -0500
Subject: [PATCH 22/24] address PR comments
---
frontend/src/components/ViewActivities/activity.js | 2 +-
frontend/src/components/ViewActivities/activityday.js | 2 +-
frontend/src/components/ViewActivities/activityfns.js | 4 ++--
3 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/frontend/src/components/ViewActivities/activity.js b/frontend/src/components/ViewActivities/activity.js
index 51c290fe..862102ec 100644
--- a/frontend/src/components/ViewActivities/activity.js
+++ b/frontend/src/components/ViewActivities/activity.js
@@ -111,7 +111,7 @@ class Activity extends React.Component {
{timezonePicker()}