Windrich - Project Portfolio

PROJECT: Efficient Learning Scheduler

Overview

Efficient Learning Scheduler is a desktop application targeting NUS School of Computing (SoC) students who wish to improve their learning schedule. It is especially useful for students who tend to do last-minute studying for exams and are not able to manage their busy schedules to include incremental learning throughout a semester. Users interact with the application using a CLI and it has a GUI which is created using JavaFX. It is written in Java. Our scheduler implements Insitute for Application of Learning Science and Educational Technology (ALSET)'s learning strategy such as spacing. Users can also keep track of the events in NUS such as recruitment talks or career festival which might interest of the users.

Summary of contributions

Major enhancement: added the event calendar component to the application, including AddEvent, ListEvent, and CheckAvailEvent [Coming in v2.0] Command.
- What it does: allows users to keep track of the interesting events happening in NUS and check whether they are available to attend the event.
  - When a user is interested in an event in NUS, he/she can add the event with the relevant details such as title, time, date and venue to the application by the addevent command.
  - Next, he/she can use the checkavailevent [Coming in v2.0] command to check whether there is anything that clashes with the event.
  - Alternatively, if he/she wants to look at a list of interesting events (previously stored events), the listevent command will list the events at the left pane of the GUI.
- Justification: This feature improves the product because an NUS SoC student should keep up to date to the events happening in NUS which may be beneficial to him/her in the future.
- Highlights: This enhancement requires adding many classes in all 4 components of the application - Logic, Model, UI and Storage, thus it requires me to have a good understanding of the whole application.
- Credits: Regex expression for date including leap years validation from online library.
Minor enhancement: included checking for the user inputs for certain attributes of AddEvent command, such as time (has to contain start time and end time), date and title.
Code contributed: [Functional code] [Test code] {give links to collated code files}
Other contributions:
- Project management:
  - Managed release v1.3 on GitHub
- Enhancements to existing features:
- Documentation:
  - Did cosmetic tweaks to existing contents of the User Guide: #14
- Community:
  - PRs reviewed (with non-trivial review comments): #12, #32, #19, #42
- Tools:
  - Integrated a Github plugin (Netlify) to the project [Link]

Contributions to the User Guide

Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users.

Adding an event to the event calendar : `addevent`

Adds an event to the event calendar.
Format: addevent ett/TITLE ed/DATE etm/TIME ev/VENUE \[eta/AUDIENCE] \[edc/DRESSCODE] \[eds/DESCRIPTION]

Target audience, dress code and description are not compulsory. Event can still be added to the calendar without these attributes.

Examples:

addevent ett/UBS - Unlock Your Potential with us ed/01/04/2019 etm/15:00-16:00 ev/UBS Office eta/All Year 1 female students edc/Business Formal eds/Unlock Your Potential with us.
addevent ett/Career Festival ed/05/06/2019 etm/10:00-12:00 ev/MPSH

Listing all events : `listevent`

Shows a list of all events in the event calendar in the left panel of the application UI.
Format: listevent

Filter events on a given date : `filterevent`

Shows a list of all events that are happening on a given date in the left panel of the application UI.

The date in the input has to follow the DD/MM/YYYY format. If not, an error message will be shown.

Format: filterevent DATE
Example: filterevent 15/04/2019

Check availability of a person to attend an event : `checkAvailEvent`

Checks if a person can attend an event, i.e. checks if there is an activity in the person’s timetable that clashes with the event. The choice of person and choice of event are done using the indexes of the person and event in the last shown list (left panel of the application UI).
The results of this command will be shown in the Results Display part of the application UI (right below the Command Box).

The indexes must be lower than the size of the person and event list. If not, an error message will be shown.

Format: checkAvailEvent person/PERSON_INDEX event/EVENT_INDEX
Example: checkAvailEvent person/1 event/1 === Listing all activities for a person : listactivity

Shows a list of all activities in the timetable of a specific person in the left panel of the application UI. The command is followed by an index of a person in the current person list to choose which person’s timetable to be shown.
Format: listactivity PERSON_INDEX
Example: listactivity 1

Contributions to the Developer Guide

Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project.

Check Availability for Events feature

Current Implementation

This is a feature to check if the current user’s schedule has any clashes with a particular event in NUS. This is executed by getting the time and date of the event that user is interested in. This time and date will then be used to check if the user has any events or other commitments scheduled during the particular time slot. The program will then print on the Command Box whether the user is available to attend that event.

Given below is an example usage scenario and how the availability checking mechanism behaves at each step:

Step 1. User opens the application and views the upcoming events in NUS for the week of 18th March.
Step 2. User chooses an event that he/she is interested in. User executes the checkAvailEvent command
Step 3. The time and date of the event is stored in a Time and a Date object.
Step 4. Get the user’s Timetable array from the Model component of the application.
Step 5. Using the Time and Date object, get the corresponding day and time and check if there is any activity scheduled during the event timing in the user’s timetable.
Step 6. Print the availability (whether the user can attend the event) into the Command Box.

The following activity diagram summarizes what happens when a user executes the command:

Design considerations:

Alternative 1 (current choice): check availability for one particular event
- Pros: checking mechanism is faster, because we are only interested in 1 particular slot and no need to use the results display part of the UI
- Cons: troublesome if user wants to check for more than 1 event
Alternative 2: check availability for the whole week
- Pros: user can check availability for the whole week (more than 1 event at one time)
- Cons: checking mechanism is longer and need to change the view of the result display (implementation is harder) = Efficient Learning Scheduler - Developer Guide :site-section: DeveloperGuide :toc: :toc-title: :toc-placement: preamble :sectnums: :imagesDir: images :stylesDir: stylesheets :xrefstyle: full :repoURL: https://github.com/CS2113-AY1819S2-T11-1/main

By: CS2113-AY1819S2-T11-1 Since: Jun 2019 Licence: MIT

Setting up

Prerequisites

JDK 9 or later

JDK 10 on Windows will fail to run tests in headless mode due to a JavaFX bug. Windows developers are highly recommended to use JDK 9.
IntelliJ IDE

IntelliJ by default has Gradle and JavaFx plugins installed.
Do not disable them. If you have disabled them, go to File > Settings > Plugins to re-enable them.

Setting up the project in your computer

Fork this repo, and clone the fork to your computer
Open IntelliJ (if you are not in the welcome screen, click File > Close Project to close the existing project dialog first)
Set up the correct JDK version for Gradle
1. Click Configure > Project Defaults > Project Structure
2. Click New… and find the directory of the JDK
Click Import Project
Locate the build.gradle file and select it. Click OK
Click Open as Project
Click OK to accept the default settings
Open a console and run the command gradlew processResources (Mac/Linux: ./gradlew processResources). It should finish with the BUILD SUCCESSFUL message.
This will generate all resources required by the application and tests.
Open MainWindow.java and check for any code errors
1. Due to an ongoing issue with some of the newer versions of IntelliJ, code errors may be detected even if the project can be built and run successfully
2. To resolve this, place your cursor over any of the code section highlighted in red. Press ALT+ENTER, and select Add '--add-modules=…' to module compiler options for each error
Repeat this for the test folder as well (e.g. check HelpWindowTest.java for code errors, and if so, resolve it the same way)

Verifying the setup

Run the seedu.address.MainApp and try a few commands
Run the tests to ensure they all pass.

Configurations to do before writing code

Configuring the coding style

This project follows oss-generic coding standards. IntelliJ’s default style is mostly compliant with ours but it uses a different import order from ours. To rectify,

Go to File > Settings… (Windows/Linux), or IntelliJ IDEA > Preferences… (macOS)
Select Editor > Code Style > Java
Click on the Imports tab to set the order
- For Class count to use import with '*' and Names count to use static import with '*': Set to 999 to prevent IntelliJ from contracting the import statements
- For Import Layout: The order is import static all other imports, import java.*, import javax.*, import org.*, import com.*, import all other imports. Add a <blank line> between each import

Optionally, you can follow the UsingCheckstyle.adoc document to configure Intellij to check style-compliance as you write code.

Updating documentation to match your fork

After forking the repo, the documentation will still have the SE-EDU branding and refer to the se-edu/addressbook-level4 repo.

If you plan to develop this fork as a separate product (i.e. instead of contributing to se-edu/addressbook-level4), you should do the following:

Configure the site-wide documentation settings in build.gradle, such as the site-name, to suit your own project.
Replace the URL in the attribute repoURL in DeveloperGuide.adoc and UserGuide.adoc with the URL of your fork.

Setting up CI

Set up Travis to perform Continuous Integration (CI) for your fork. See UsingTravis.adoc to learn how to set it up.

After setting up Travis, you can optionally set up coverage reporting for your team fork (see UsingCoveralls.adoc).

Coverage reporting could be useful for a team repository that hosts the final version but it is not that useful for your personal fork.

Optionally, you can set up AppVeyor as a second CI (see UsingAppVeyor.adoc).

Having both Travis and AppVeyor ensures your App works on both Unix-based platforms and Windows-based platforms (Travis is Unix-based and AppVeyor is Windows-based)

Getting started with coding

When you are ready to start coding,

Get some sense of the overall design by reading Architecture.
Take a look at Suggested Programming Tasks to Get Started.

Design

Architecture

Figure 1. Architecture Diagram

The Architecture Diagram given above explains the high-level design of the App. Given below is a quick overview of each component.

The .pptx files used to create diagrams in this document can be found in the diagrams folder. To update a diagram, modify the diagram in the pptx file, select the objects of the diagram, and choose Save as picture.

Main has only one class called MainApp. It is responsible for,

At app launch: Initializes the components in the correct sequence, and connects them up with each other.
At shut down: Shuts down the components and invokes cleanup method where necessary.

Commons represents a collection of classes used by multiple other components. The following class plays an important role at the architecture level:

LogsCenter : Used by many classes to write log messages to the App’s log file.

The rest of the App consists of four components.

UI: The UI of the App.
Logic: The command executor.
Model: Holds the data of the App in-memory.
Storage: Reads data from, and writes data to, the hard disk.

Each of the four components

Defines its API in an interface with the same name as the Component.
Exposes its functionality using a {Component Name}Manager class.

For example, the Logic component (see the class diagram given below) defines it’s API in the Logic.java interface and exposes its functionality using the LogicManager.java class.

Figure 2. Class Diagram of the Logic Component

How the architecture components interact with each other

The Sequence Diagram below shows how the components interact with each other for the scenario where the user issues the command delete 1.

Figure 3. Component interactions for delete 1 command

The sections below give more details of each component.

UI component

Figure 4. Structure of the UI Component

API : Ui.java

The UI consists of a MainWindow that is made up of parts e.g.CommandBox, ResultDisplay, PersonListPanel, StatusBarFooter, BrowserPanel etc. All these, including the MainWindow, inherit from the abstract UiPart class.

The UI component uses JavaFx UI framework. The layout of these UI parts are defined in matching .fxml files that are in the src/main/resources/view folder. For example, the layout of the MainWindow is specified in MainWindow.fxml

The UI component,

Executes user commands using the Logic component.
Listens for changes to Model data so that the UI can be updated with the modified data.

Logic component

Figure 5. Structure of the Logic Component

API : Logic.java

Logic uses the AddressBookParser class to parse the user command.
This results in a Command object which is executed by the LogicManager.
The command execution can affect the Model (e.g. adding a person).
The result of the command execution is encapsulated as a CommandResult object which is passed back to the Ui.
In addition, the CommandResult object can also instruct the Ui to perform certain actions, such as displaying help to the user.

Given below is the Sequence Diagram for interactions within the Logic component for the execute("delete 1") API call.

Figure 6. Interactions Inside the Logic Component for the delete 1 Command

Model component

Figure 7. Structure of the Model Component

API : Model.java

The Model,

stores a UserPref object that represents the user’s preferences.
stores the Address Book data.
exposes an unmodifiable ObservableList<Person> that can be 'observed' e.g. the UI can be bound to this list so that the UI automatically updates when the data in the list change.
does not depend on any of the other three components.

As a more OOP model, we can store a Tag list in Address Book, which Person can reference. This would allow Address Book to only require one Tag object per unique Tag, instead of each Person needing their own Tag object. An example of how such a model may look like is given below.

Storage component

Figure 8. Structure of the Storage Component

API : Storage.java

The Storage component,

can save UserPref objects in json format and read it back.
can save the Address Book data in json format and read it back.

Common classes

Classes used by multiple components are in the seedu.addressbook.commons package.

Implementation

This section describes some noteworthy details on how certain features are implemented.

Generate interleaved schedule

Future implementation

The scheduling is facilitated by interleaver, consisting of the following operations.

ExtractSelfStudyHours() — extract all self study hours.
split() — split hours into 30 mins blocks.
interleave() — interleave blocks.
generate() — for each block, insert them into free time slots.

Given below is a activity diagram showing how the methods above work together:

The Sequence Diagram below shows how the components interact with each other for the scenario where the user issues the command interleave. Maximum 10 modules, until integration with CORs

Figure 9. Component interactions for interleave command

The Sequence Diagram below shows the interactions within the Logic component for the interleave() API call.

Figure 10. Interactions Inside the Logic Component for the interleave Command

Use the unmodifiable ObservableList<Person> in Model.java to update UI? Save the scheduler data in json format (Storage.java) and read it back?

Design Considerations

Aspect: How to split hours

Alternative 1 (current choice): Split into 30 mins blocks.
- Pros: Easy to implement.
- Cons: Some people might find 30 mins to be too long/short.
Alternative 2: Let user decide duration of each block.
- Pros: More flexibility.
- Cons: Harder to implement.

Aspect: How to train users to study with maximum focus period setting.

Alternative 1 (current choice): Progressive training.
- Increase in focus period weekly, starting from minimum settings.
- Users should be comfortable with 1 hour focus periods by mid semester, to help with midterms.
- Continue increasing to maximum setting for finals.

Logging

We are using java.util.logging package for logging. The LogsCenter class is used to manage the logging levels and logging destinations. The logging level can be controlled using the logLevel setting in the configuration file. The Logger for a class can be obtained using LogsCenter.getLogger(Class) which will log messages according to the specified logging level. Currently log messages are output through: Console and to a .log file.

Configuration

Certain properties of the application can be controlled (e.g user prefs file location, logging level) through the configuration file (default: config.json).

This feature adds an activity to the Student’s timetable.

Current Implementation

The addActivity mechanism adds a new activity to the students timetable whenever there’s a free time slot. This is executed by inserting time, date and name for a particular activity, then the addActivityCommand parser facilitates the addition of the new activity to a 2d array that stores activities. Given below is an example usage scenario and how the Check availability behaves at each step.

Step 1. The user launches the application for the first time.
Step 2. The user adds a person to the timetable.
Step 3. The user executes the addActivity command which requires a day(integer value from 0-6), a time (integer value from 0 - 48) and the name of the activity.
Step 4. The Efficient Learning Scheduler through the addActivityCommandParser, then checks if that slot is available then proceeds to add the activity.
Step 5. The activity is added to a 2 dimensional array, whose rows represent the day of the week and columns represent the 30 minute block within a day.
Step 6. A success message is then displayed to the user in the Command box.

Design Considerations

Aspect: How addActivity executes

Alternative 1 (current choice): Edits the persons current timetable.
- Pros: It is Easy to implement.
- Cons: May have performance issues in terms of memory usage.
Alternative 2: Generates a new timetable whenever the user adds something to it.
- Pros: Will use more memory.
- Cons: May have a higher running time depending on how convoluted the schedule is.

Aspect: Data structure to support the addActivity Command

Alternative 1 (current choice): Use a 2d Array of fixed size for each array.
- Pros: Easy to implement and understand.
- Cons: Null spaces in the array consume unnecessary space.
Alternative 2: Use a hashMap with days representing the Key, and the values being the hours in the day.
- Pros: Null spaces are avoided.
- Cons: HashMap is harder to implement. ===== Certain properties of the application can be controlled (e.g user prefs file location, logging level) through the configuration file (default: config.json).

Check Availability for Events feature

Current Implementation

This is a feature to check if the current user’s schedule has any clashes with a particular event in NUS. This is executed by getting the time and date of the event that user is interested in. This time and date will then be used to check if the user has any events or other commitments scheduled during the particular time slot. The program will then print on the Command Box whether the user is available to attend that event.

Given below is an example usage scenario and how the availability checking mechanism behaves at each step:

Step 1. User opens the application and views the upcoming events in NUS for the week of 18th March.
Step 2. User chooses an event that he/she is interested in. User executes the checkAvailEvent command
Step 3. The time and date of the event is stored in a Time and a Date object.
Step 4. Get the user’s Timetable array from the Model component of the application.
Step 5. Using the Time and Date object, get the corresponding day and time and check if there is any activity scheduled during the event timing in the user’s timetable.
Step 6. Print the availability (whether the user can attend the event) into the Command Box.

The following activity diagram summarizes what happens when a user executes the command:

Design considerations:

Alternative 1 (current choice): check availability for one particular event
- Pros: checking mechanism is faster, because we are only interested in 1 particular slot and no need to use the results display part of the UI
- Cons: troublesome if user wants to check for more than 1 event
Alternative 2: check availability for the whole week
- Pros: user can check availability for the whole week (more than 1 event at one time)
- Cons: checking mechanism is longer and need to change the view of the result display (implementation is harder)

List Activity feature

Current Implementation

This is a feature to list the activities of a person within the current week. This is executed by getting the index of the person from the input command. Using this index, the corresponding person’s timetable will be extracted. For every time slot in the timetable, if there is an activity scheduled, show it in the left pane of the application UI.

Given below is an example usage scenario and how the listing activity mechanism works at each step:

Step 1. User opens the application and finds his/her index in the list of persons in the application.
Step 2. User executes the listactivity PERSON_INDEX command.
Step 3. Using the person index, extract person and get the person’s Timetable array from the Model component.
Step 4. Iterate through the 2D Timetable array and check for each of the time slot.
Step 5. If there is an activity scheduled in each of the time slot, add it to the activityList.
Step 6. For each of the activity in the activityList, creates an ActivityCard in the UI component and shows it in the left panel of the application UI.

The following activity diagram summarizes what happens when a user executes the command:

Design considerations:

Alternative 1 (current choice): create one ActivityListPanel (UI component) for each person in the database
- Pros: easy to implement and easy to access
- Cons: might take up more memory space because of the ActivityListPanel List in the UI component (MainWindow)
Alternative 2: create one ActivityListPanel and contains the activities of every person in the database
- Pros: takes up less memory
- Cons: harder to implement, need to filter the activities by a specific person every time ListActivity command is called.

Documentation

We use asciidoc for writing documentation.

We chose asciidoc over Markdown because asciidoc, although a bit more complex than Markdown, provides more flexibility in formatting.

Editing Documentation

See UsingGradle.adoc to learn how to render .adoc files locally to preview the end result of your edits. Alternatively, you can download the AsciiDoc plugin for IntelliJ, which allows you to preview the changes you have made to your .adoc files in real-time.

Publishing Documentation

See UsingTravis.adoc to learn how to deploy GitHub Pages using Travis.

Converting Documentation to PDF format

We use Google Chrome for converting documentation to PDF format, as Chrome’s PDF engine preserves hyperlinks used in webpages.

Here are the steps to convert the project documentation files to PDF format.

Follow the instructions in UsingGradle.adoc to convert the AsciiDoc files in the docs/ directory to HTML format.
Go to your generated HTML files in the build/docs folder, right click on them and select Open with → Google Chrome.
Within Chrome, click on the Print option in Chrome’s menu.
Set the destination to Save as PDF, then click Save to save a copy of the file in PDF format. For best results, use the settings indicated in the screenshot below.

Figure 11. Saving documentation as PDF files in Chrome

Site-wide Documentation Settings

The build.gradle file specifies some project-specific asciidoc attributes which affects how all documentation files within this project are rendered.

Attributes left unset in the build.gradle file will use their default value, if any.

Table 1. List of site-wide attributes
Attribute name	Description	Default value
`site-name`	The name of the website. If set, the name will be displayed near the top of the page.	not set
`site-githuburl`	URL to the site’s repository on GitHub. Setting this will add a "View on GitHub" link in the navigation bar.	not set
`site-seedu`	Define this attribute if the project is an official SE-EDU project. This will render the SE-EDU navigation bar at the top of the page, and add some SE-EDU-specific navigation items.	not set

Per-file Documentation Settings

Each .adoc file may also specify some file-specific asciidoc attributes which affects how the file is rendered.

Asciidoctor’s built-in attributes may be specified and used as well.

Attributes left unset in .adoc files will use their default value, if any.

Table 2. List of per-file attributes, excluding Asciidoctor’s built-in attributes
Attribute name	Description	Default value
`site-section`	Site section that the document belongs to. This will cause the associated item in the navigation bar to be highlighted. One of: `UserGuide`, `DeveloperGuide`, `LearningOutcomes`, `AboutUs`, `ContactUs` Official SE-EDU projects only	not set
`no-site-header`	Set this attribute to remove the site navigation bar.	not set

Site Template

The files in docs/stylesheets are the CSS stylesheets of the site. You can modify them to change some properties of the site’s design.

The files in docs/templates controls the rendering of .adoc files into HTML5. These template files are written in a mixture of Ruby and Slim.

Modifying the template files in docs/templates requires some knowledge and experience with Ruby and Asciidoctor’s API. You should only modify them if you need greater control over the site’s layout than what stylesheets can provide. The SE-EDU team does not provide support for modified template files.

Testing

Running Tests

There are three ways to run tests.

The most reliable way to run tests is the 3rd one. The first two methods might fail some GUI tests due to platform/resolution-specific idiosyncrasies.

Method 1: Using IntelliJ JUnit test runner

To run all tests, right-click on the src/test/java folder and choose Run 'All Tests'
To run a subset of tests, you can right-click on a test package, test class, or a test and choose Run 'ABC'

Method 2: Using Gradle

Open a console and run the command gradlew clean allTests (Mac/Linux: ./gradlew clean allTests)

See UsingGradle.adoc for more info on how to run tests using Gradle.

Method 3: Using Gradle (headless)

Thanks to the TestFX library we use, our GUI tests can be run in the headless mode. In the headless mode, GUI tests do not show up on the screen. That means the developer can do other things on the Computer while the tests are running.

To run tests in headless mode, open a console and run the command gradlew clean headless allTests (Mac/Linux: ./gradlew clean headless allTests)

Types of tests

We have two types of tests:

GUI Tests - These are tests involving the GUI. They include,
1. System Tests that test the entire App by simulating user actions on the GUI. These are in the systemtests package.
2. Unit tests that test the individual components. These are in seedu.address.ui package.
Non-GUI Tests - These are tests not involving the GUI. They include,
1. Unit tests targeting the lowest level methods/classes.
  e.g. seedu.address.commons.StringUtilTest
2. Integration tests that are checking the integration of multiple code units (those code units are assumed to be working).
  e.g. seedu.address.storage.StorageManagerTest
3. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.
  e.g. seedu.address.logic.LogicManagerTest

Troubleshooting Testing

Problem: HelpWindowTest fails with a NullPointerException.

Reason: One of its dependencies, HelpWindow.html in src/main/resources/docs is missing.
Solution: Execute Gradle task processResources.

Dev Ops

Build Automation

See UsingGradle.adoc to learn how to use Gradle for build automation.

Continuous Integration

We use Travis CI and AppVeyor to perform Continuous Integration on our projects. See UsingTravis.adoc and UsingAppVeyor.adoc for more details.

Coverage Reporting

We use Coveralls to track the code coverage of our projects. See UsingCoveralls.adoc for more details.

Documentation Previews

When a pull request has changes to asciidoc files, you can use Netlify to see a preview of how the HTML version of those asciidoc files will look like when the pull request is merged. See UsingNetlify.adoc for more details.

Making a Release

Here are the steps to create a new release.

Update the version number in MainApp.java.
Generate a JAR file using Gradle.
Tag the repo with the version number. e.g. v0.1
Create a new release using GitHub and upload the JAR file you created.

Managing Dependencies

A project often depends on third-party libraries. For example, Address Book depends on the Jackson library for JSON parsing. Managing these dependencies can be automated using Gradle. For example, Gradle can download the dependencies automatically, which is better than these alternatives:

Include those libraries in the repo (this bloats the repo size)
Require developers to download those libraries manually (this creates extra work for developers)

Appendix A: Suggested Programming Tasks to Get Started

Suggested path for new programmers:

First, add small local-impact (i.e. the impact of the change does not go beyond the component) enhancements to one component at a time. Some suggestions are given in Improving each component.
Next, add a feature that touches multiple components to learn how to implement an end-to-end feature across all components. Creating a new command: remark explains how to go about adding such a feature.

Improving each component

Each individual exercise in this section is component-based (i.e. you would not need to modify the other components to get it to work).

`Logic` component

Scenario: You are in charge of logic. During dog-fooding, your team realize that it is troublesome for the user to type the whole command in order to execute a command. Your team devise some strategies to help cut down the amount of typing necessary, and one of the suggestions was to implement aliases for the command words. Your job is to implement such aliases.

Do take a look at Logic component before attempting to modify the Logic component.

Add a shorthand equivalent alias for each of the individual commands. For example, besides typing clear, the user can also type c to remove all persons in the list.
- Hints
  
  Just like we store each individual command word constant COMMAND_WORD inside *Command.java (e.g. FindCommand#COMMAND_WORD, DeleteCommand#COMMAND_WORD), you need a new constant for aliases as well (e.g. FindCommand#COMMAND_ALIAS).
  
  AddressBookParser is responsible for analyzing command words.
- Solution
  
  Modify the switch statement in AddressBookParser#parseCommand(String) such that both the proper command word and alias can be used to execute the same intended command.
  
  Add new tests for each of the aliases that you have added.
  
  Update the user guide to document the new aliases.
  
  See this PR for the full solution.

`Model` component

Scenario: You are in charge of model. One day, the logic-in-charge approaches you for help. He wants to implement a command such that the user is able to remove a particular tag from everyone in the address book, but the model API does not support such a functionality at the moment. Your job is to implement an API method, so that your teammate can use your API to implement his command.

Do take a look at Model component before attempting to modify the Model component.

Add a removeTag(Tag) method. The specified tag will be removed from everyone in the address book.
- Hints
  
  The Model and the AddressBook API need to be updated.
  
  Think about how you can use SLAP to design the method. Where should we place the main logic of deleting tags?
  
  Find out which of the existing API methods in AddressBook and Person classes can be used to implement the tag removal logic. AddressBook allows you to update a person, and Person allows you to update the tags.
- Solution
  
  Implement a removeTag(Tag) method in AddressBook. Loop through each person, and remove the tag from each person.
  
  Add a new API method deleteTag(Tag) in ModelManager. Your ModelManager should call AddressBook#removeTag(Tag).
  
  Add new tests for each of the new public methods that you have added.
  
  See this PR for the full solution.

`Ui` component

Scenario: You are in charge of ui. During a beta testing session, your team is observing how the users use your address book application. You realize that one of the users occasionally tries to delete non-existent tags from a contact, because the tags all look the same visually, and the user got confused. Another user made a typing mistake in his command, but did not realize he had done so because the error message wasn’t prominent enough. A third user keeps scrolling down the list, because he keeps forgetting the index of the last person in the list. Your job is to implement improvements to the UI to solve all these problems.

Do take a look at UI component before attempting to modify the UI component.

Use different colors for different tags inside person cards. For example, friends tags can be all in brown, and colleagues tags can be all in yellow.

Before

After
- Hints
  
  The tag labels are created inside the PersonCard constructor (new Label(tag.tagName)). JavaFX’s Label class allows you to modify the style of each Label, such as changing its color.
  
  Use the .css attribute -fx-background-color to add a color.
  
  You may wish to modify DarkTheme.css to include some pre-defined colors using css, especially if you have experience with web-based css.
- Solution
  
  You can modify the existing test methods for PersonCard 's to include testing the tag’s color as well.
  
  See this PR for the full solution.
  
  The PR uses the hash code of the tag names to generate a color. This is deliberately designed to ensure consistent colors each time the application runs. You may wish to expand on this design to include additional features, such as allowing users to set their own tag colors, and directly saving the colors to storage, so that tags retain their colors even if the hash code algorithm changes.
Modify NewResultAvailableEvent such that ResultDisplay can show a different style on error (currently it shows the same regardless of errors).

Before

After
- Hints
  
  NewResultAvailableEvent is raised by CommandBox which also knows whether the result is a success or failure, and is caught by ResultDisplay which is where we want to change the style to.
  
  Refer to CommandBox for an example on how to display an error.
- Solution
  
  Modify NewResultAvailableEvent 's constructor so that users of the event can indicate whether an error has occurred.
  
  Modify ResultDisplay#handleNewResultAvailableEvent(NewResultAvailableEvent) to react to this event appropriately.
  
  You can write two different kinds of tests to ensure that the functionality works:
  
  The unit tests for ResultDisplay can be modified to include verification of the color.
  
  The system tests AddressBookSystemTest#assertCommandBoxShowsDefaultStyle() and AddressBookSystemTest#assertCommandBoxShowsErrorStyle() to include verification for ResultDisplay as well.
  
  See this PR for the full solution.
  
  Do read the commits one at a time if you feel overwhelmed.
Modify the StatusBarFooter to show the total number of people in the address book.

Before

After
- Hints
  
  StatusBarFooter.fxml will need a new StatusBar. Be sure to set the GridPane.columnIndex properly for each StatusBar to avoid misalignment!
  
  StatusBarFooter needs to initialize the status bar on application start, and to update it accordingly whenever the address book is updated.
- Solution
  
  Modify the constructor of StatusBarFooter to take in the number of persons when the application just started.
  
  Use StatusBarFooter#handleAddressBookChangedEvent(AddressBookChangedEvent) to update the number of persons whenever there are new changes to the addressbook.
  
  For tests, modify StatusBarFooterHandle by adding a state-saving functionality for the total number of people status, just like what we did for save location and sync status.
  
  For system tests, modify AddressBookSystemTest to also verify the new total number of persons status bar.
  
  See this PR for the full solution.

`Storage` component

Scenario: You are in charge of storage. For your next project milestone, your team plans to implement a new feature of saving the address book to the cloud. However, the current implementation of the application constantly saves the address book after the execution of each command, which is not ideal if the user is working on limited internet connection. Your team decided that the application should instead save the changes to a temporary local backup file first, and only upload to the cloud after the user closes the application. Your job is to implement a backup API for the address book storage.

Do take a look at Storage component before attempting to modify the Storage component.

Add a new method backupAddressBook(ReadOnlyAddressBook), so that the address book can be saved in a fixed temporary location.
- Hint
  
  Add the API method in AddressBookStorage interface.
  
  Implement the logic in StorageManager and JsonAddressBookStorage class.
- Solution
  
  See this PR for the full solution.

Creating a new command: `remark`

By creating this command, you will get a chance to learn how to implement a feature end-to-end, touching all major components of the app.

Scenario: You are a software maintainer for addressbook, as the former developer team has moved on to new projects. The current users of your application have a list of new feature requests that they hope the software will eventually have. The most popular request is to allow adding additional comments/notes about a particular contact, by providing a flexible remark field for each contact, rather than relying on tags alone. After designing the specification for the remark command, you are convinced that this feature is worth implementing. Your job is to implement the remark command.

Description

Edits the remark for a person specified in the INDEX.
Format: remark INDEX r/[REMARK]

Examples:

remark 1 r/Likes to drink coffee.
Edits the remark for the first person to Likes to drink coffee.
remark 1 r/
Removes the remark for the first person.

Step-by-step Instructions

[Step 1] Logic: Teach the app to accept 'remark' which does nothing

Let’s start by teaching the application how to parse a remark command. We will add the logic of remark later.

Main:

Add a RemarkCommand that extends Command. Upon execution, it should just throw an Exception.
Modify AddressBookParser to accept a RemarkCommand.

Tests:

Add RemarkCommandTest that tests that execute() throws an Exception.
Add new test method to AddressBookParserTest, which tests that typing "remark" returns an instance of RemarkCommand.

[Step 2] Logic: Teach the app to accept 'remark' arguments

Let’s teach the application to parse arguments that our remark command will accept. E.g. 1 r/Likes to drink coffee.

Main:

Modify RemarkCommand to take in an Index and String and print those two parameters as the error message.
Add RemarkCommandParser that knows how to parse two arguments, one index and one with prefix 'r/'.
Modify AddressBookParser to use the newly implemented RemarkCommandParser.

Tests:

Modify RemarkCommandTest to test the RemarkCommand#equals() method.
Add RemarkCommandParserTest that tests different boundary values for RemarkCommandParser.
Modify AddressBookParserTest to test that the correct command is generated according to the user input.

[Step 3] Ui: Add a placeholder for remark in `PersonCard`

Let’s add a placeholder on all our PersonCard s to display a remark for each person later.

Main:

Add a Label with any random text inside PersonListCard.fxml.
Add FXML annotation in PersonCard to tie the variable to the actual label.

Tests:

Modify PersonCardHandle so that future tests can read the contents of the remark label.

[Step 4] Model: Add `Remark` class

We have to properly encapsulate the remark in our Person class. Instead of just using a String, let’s follow the conventional class structure that the codebase already uses by adding a Remark class.

Main:

Add Remark to model component (you can copy from Address, remove the regex and change the names accordingly).
Modify RemarkCommand to now take in a Remark instead of a String.

Tests:

Add test for Remark, to test the Remark#equals() method.

[Step 5] Model: Modify `Person` to support a `Remark` field

Now we have the Remark class, we need to actually use it inside Person.

Main:

Add getRemark() in Person.
You may assume that the user will not be able to use the add and edit commands to modify the remarks field (i.e. the person will be created without a remark).
Modify SampleDataUtil to add remarks for the sample data (delete your data/addressbook.json so that the application will load the sample data when you launch it.)

[Step 6] Storage: Add `Remark` field to `JsonAdaptedPerson` class

We now have Remark s for Person s, but they will be gone when we exit the application. Let’s modify JsonAdaptedPerson to include a Remark field so that it will be saved.

Main:

Add a new JSON field for Remark.

Tests:

Fix invalidAndValidPersonAddressBook.json, typicalPersonsAddressBook.json, validAddressBook.json etc., such that the JSON tests will not fail due to a missing remark field.

[Step 6b] Test: Add withRemark() for `PersonBuilder`

Since Person can now have a Remark, we should add a helper method to PersonBuilder, so that users are able to create remarks when building a Person.

Tests:

Add a new method withRemark() for PersonBuilder. This method will create a new Remark for the person that it is currently building.
Try and use the method on any sample Person in TypicalPersons.

[Step 7] Ui: Connect `Remark` field to `PersonCard`

Our remark label in PersonCard is still a placeholder. Let’s bring it to life by binding it with the actual remark field.

Main:

Modify PersonCard's constructor to bind the Remark field to the Person 's remark.

Tests:

Modify GuiTestAssert#assertCardDisplaysPerson(…) so that it will compare the now-functioning remark label.

[Step 8] Logic: Implement `RemarkCommand#execute()` logic

We now have everything set up… but we still can’t modify the remarks. Let’s finish it up by adding in actual logic for our remark command.

Main:

Replace the logic in RemarkCommand#execute() (that currently just throws an Exception), with the actual logic to modify the remarks of a person.

Tests:

Update RemarkCommandTest to test that the execute() logic works.

Full Solution

See this PR for the step-by-step solution.

Appendix B: Product Scope

Target user profile:

has a need to manage personal study schedule
prefer desktop apps over other types
can type fast
prefers typing over mouse input
is reasonably comfortable using CLI apps

Value proposition: manages timetable faster than a typical mouse/GUI driven app

Appendix C: User Stories

Priorities: High (must have) - * * *, Medium (nice to have) - * *, Low (unlikely to have) - *

Priority As a … I want to … So that I can…

Priority	As a …	I want to …	So that I can…
`* * *`	new user	modify the time table	allow for more flexibility
`* * *`	new user	add the modules I am taking this semester	have a calendar-like view of my timetable
`* * *`	new user	choose the level of learning intensity (no of hours spent per week is based on that)	suit my studying style
`* * *`	new user	add the different commitments such as CCAs	schedule not just my studies, but my life too
`* * *`	new user	generate study schedules by typing a command	learn better via interleaving/spacing
`* *`	student	view my sleeping patterns	be advised better on when to sleep.
`* *`	student	view available internships	I know what jobs to apply for.
`* *`	student	form groups with other people in the class	collaborate more efficiently.
`* *`	student	get a suggested list of modules	know how to prepare for next semester.
`* *`	student	view a video on the importance of learning concepts	learn more efficiently
`* *`	student	modify my timetable	update my schedule when plans change.
`*`	existing/expert user	find websites	get free pdfs of textbooks for mods.
`*`	professor	collect data	analyze how students learn
`*`	student	practice questions	Study for modules on the app.
`*`	student	view the mods I’m taking this semester	prepare more efficiently for classes.

* * *

new user

modify the time table

allow for more flexibility

* * *

new user

add the modules I am taking this semester

have a calendar-like view of my timetable

* * *

new user

choose the level of learning intensity (no of hours spent per week is based on that)

suit my studying style

* * *

new user

add the different commitments such as CCAs

schedule not just my studies, but my life too

* * *

new user

generate study schedules by typing a command

learn better via interleaving/spacing

* *

student

view my sleeping patterns

be advised better on when to sleep.

* *

student

view available internships

I know what jobs to apply for.

* *

student

form groups with other people in the class

collaborate more efficiently.

* *

student

get a suggested list of modules

know how to prepare for next semester.

* *

student

view a video on the importance of learning concepts

learn more efficiently

* *

student

modify my timetable

update my schedule when plans change.

*

existing/expert user

find websites

get free pdfs of textbooks for mods.

*

professor

collect data

analyze how students learn

*

student

practice questions

Study for modules on the app.

*

student

view the mods I’m taking this semester

prepare more efficiently for classes.

{More to be added}

Appendix D: Use Cases

(For all use cases below, the System is the AddressBook and the Actor is the user, unless specified otherwise)

Use case: Generate a time table

MSS

User requests to generate a schedule
App shows a list of available modules
User requests to add specific module to the time table
App generates the time table for the users

Use case ends.

Extensions

2a. Efficient Learning Scheduler can’t pull module data from CORS 2a1. Efficient Learning Scheduler shows an error message.

Use case ends.

{More to be added}

Appendix E: Non Functional Requirements

Should work on any mainstream OS as long as it has Java 9 or higher installed.
Able to accommodate 100 persons without slowing the performance for typical usage
Able to suit the needs of a NUS student with fast typing speed.

{More to be added}

Appendix F: explanation of enhancement

1.By adding the timetable class, users can search for the module they want, and UI will generate the timetable for the specific module
- 1a.Module class- extract data from ALSET database, Module Class will be the subclass of TimeSlot
- 2a.Activity Class - stores modules as activities in the User’s timetable.
- 3a.TimeTable Class-contain all the activities in the user’s timetable.

Appendix G: Glossary

Mainstream OS: Windows, Linux, Unix, OS-X
Private contact detail: A contact detail that is not meant to be shared with others

ALSET aims to become a leading hub for learning science and education technology research in Asia, and a provider of impactful programming to support lifelong learning. For more info, visit http://nus.edu.sg/alset/index.html

Value proposition: Help NUS students learn in the most efficient way by helping them generate an efficient studying schedule
Problem scope: NUS Students who are lazy and would like to check their schedule through the CLI.
Work patterns: Work Alone
Target users: NUS students who prefer typing to create a schedule.

Appendix H: Product Survey

Product Name

Author: …

Pros:

…
…

Cons:

…
…

Appendix I: Instructions for Manual Testing

Given below are instructions to test the app manually.

These instructions only provide a starting point for testers to work on; testers are expected to do more exploratory testing.

Launch and Shutdown

Initial launch
1. Download the jar file and copy into an empty folder
2. Double-click the jar file
  Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.
Saving window preferences
1. Resize the window to an optimum size. Move the window to a different location. Close the window.
2. Re-launch the app by double-clicking the jar file.
  Expected: The most recent window size and location is retained.

Add an activity to a person.

adds an activity to a persons Timetable.
1. Prerequisites: List all persons using the list command. Multiple persons in the list.
2. Test case: addActivity 1 act/CS2113 day/0 time/13 Expected: an activity 'CS2113' to the first person in the Efficient learning scheduler.
3. Test case: addActivity 0 act/CS2113 day/0 time/130
  Expected: No activity is added to anyone. Error details shown in the status message.
4. Other incorrect addActivity commands to try: addActivity, addActivity x (where x is larger than the list size) {give more}
  Expected: Similar to previous.

Adding an event

Adding an event to the event calendar
1. Test case: addevent ett/UBS - Unlock Your Potential with us ed/01/04/2019 etm/15:00-16:00 ev/UBS Office Expected: the event will be successfully added even though there are some missing input arguments, because the rest of the arguments are optional.
2. Test case: addevent ett/UBS - Unlock Your Potential with us ed/01/04/2019 etm/15:00-16:00 eta/All Year 1 female students edc/Business Formal eds/Unlock Your Potential with us. Expected: the event will not be successfully added because the ev/ argument which is compulsory is missing.
3. Test case: addevent ett/UBS - Unlock Your Potential with us ed/29/02/2019 etm/15:00-16:00 ev/UBS Office Expected: the error message will be shown indicating wrong date (there is no 29th February in 2019).
4. Other incorrect addevent commands to try: starting time without end time, impossible time (HH more than 24 and MM more than 60) Expected: the error message will be shown indicating wrong time. = Efficient Learning Scheduler - Developer Guide :site-section: DeveloperGuide :toc: :toc-title: :toc-placement: preamble :sectnums: :imagesDir: images :stylesDir: stylesheets :xrefstyle: full :repoURL: https://github.com/CS2113-AY1819S2-T11-1/main

By: CS2113-AY1819S2-T11-1 Since: Jun 2019 Licence: MIT

Setting up

Prerequisites

JDK 9 or later

JDK 10 on Windows will fail to run tests in headless mode due to a JavaFX bug. Windows developers are highly recommended to use JDK 9.
IntelliJ IDE

IntelliJ by default has Gradle and JavaFx plugins installed.
Do not disable them. If you have disabled them, go to File > Settings > Plugins to re-enable them.

Setting up the project in your computer

Fork this repo, and clone the fork to your computer
Open IntelliJ (if you are not in the welcome screen, click File > Close Project to close the existing project dialog first)
Set up the correct JDK version for Gradle
1. Click Configure > Project Defaults > Project Structure
2. Click New… and find the directory of the JDK
Click Import Project
Locate the build.gradle file and select it. Click OK
Click Open as Project
Click OK to accept the default settings
Open a console and run the command gradlew processResources (Mac/Linux: ./gradlew processResources). It should finish with the BUILD SUCCESSFUL message.
This will generate all resources required by the application and tests.
Open MainWindow.java and check for any code errors
1. Due to an ongoing issue with some of the newer versions of IntelliJ, code errors may be detected even if the project can be built and run successfully
2. To resolve this, place your cursor over any of the code section highlighted in red. Press ALT+ENTER, and select Add '--add-modules=…' to module compiler options for each error
Repeat this for the test folder as well (e.g. check HelpWindowTest.java for code errors, and if so, resolve it the same way)

Verifying the setup

Run the seedu.address.MainApp and try a few commands
Run the tests to ensure they all pass.

Configurations to do before writing code

Configuring the coding style

This project follows oss-generic coding standards. IntelliJ’s default style is mostly compliant with ours but it uses a different import order from ours. To rectify,

Go to File > Settings… (Windows/Linux), or IntelliJ IDEA > Preferences… (macOS)
Select Editor > Code Style > Java
Click on the Imports tab to set the order
- For Class count to use import with '*' and Names count to use static import with '*': Set to 999 to prevent IntelliJ from contracting the import statements
- For Import Layout: The order is import static all other imports, import java.*, import javax.*, import org.*, import com.*, import all other imports. Add a <blank line> between each import

Optionally, you can follow the UsingCheckstyle.adoc document to configure Intellij to check style-compliance as you write code.

Updating documentation to match your fork

After forking the repo, the documentation will still have the SE-EDU branding and refer to the se-edu/addressbook-level4 repo.

If you plan to develop this fork as a separate product (i.e. instead of contributing to se-edu/addressbook-level4), you should do the following:

Configure the site-wide documentation settings in build.gradle, such as the site-name, to suit your own project.
Replace the URL in the attribute repoURL in DeveloperGuide.adoc and UserGuide.adoc with the URL of your fork.

Setting up CI

Set up Travis to perform Continuous Integration (CI) for your fork. See UsingTravis.adoc to learn how to set it up.

After setting up Travis, you can optionally set up coverage reporting for your team fork (see UsingCoveralls.adoc).

Coverage reporting could be useful for a team repository that hosts the final version but it is not that useful for your personal fork.

Optionally, you can set up AppVeyor as a second CI (see UsingAppVeyor.adoc).

Having both Travis and AppVeyor ensures your App works on both Unix-based platforms and Windows-based platforms (Travis is Unix-based and AppVeyor is Windows-based)

Getting started with coding

When you are ready to start coding,

Get some sense of the overall design by reading Architecture.
Take a look at Suggested Programming Tasks to Get Started.

Design

Architecture

Figure 12. Architecture Diagram

The Architecture Diagram given above explains the high-level design of the App. Given below is a quick overview of each component.

The .pptx files used to create diagrams in this document can be found in the diagrams folder. To update a diagram, modify the diagram in the pptx file, select the objects of the diagram, and choose Save as picture.

Main has only one class called MainApp. It is responsible for,

At app launch: Initializes the components in the correct sequence, and connects them up with each other.
At shut down: Shuts down the components and invokes cleanup method where necessary.

Commons represents a collection of classes used by multiple other components. The following class plays an important role at the architecture level:

LogsCenter : Used by many classes to write log messages to the App’s log file.

The rest of the App consists of four components.

UI: The UI of the App.
Logic: The command executor.
Model: Holds the data of the App in-memory.
Storage: Reads data from, and writes data to, the hard disk.

Each of the four components

Defines its API in an interface with the same name as the Component.
Exposes its functionality using a {Component Name}Manager class.

For example, the Logic component (see the class diagram given below) defines it’s API in the Logic.java interface and exposes its functionality using the LogicManager.java class.

Figure 13. Class Diagram of the Logic Component

How the architecture components interact with each other

The Sequence Diagram below shows how the components interact with each other for the scenario where the user issues the command delete 1.

Figure 14. Component interactions for delete 1 command

The sections below give more details of each component.

UI component

Figure 15. Structure of the UI Component

API : Ui.java

The UI consists of a MainWindow that is made up of parts e.g.CommandBox, ResultDisplay, PersonListPanel, StatusBarFooter, BrowserPanel etc. All these, including the MainWindow, inherit from the abstract UiPart class.

The UI component uses JavaFx UI framework. The layout of these UI parts are defined in matching .fxml files that are in the src/main/resources/view folder. For example, the layout of the MainWindow is specified in MainWindow.fxml

The UI component,

Executes user commands using the Logic component.
Listens for changes to Model data so that the UI can be updated with the modified data.

Logic component

Figure 16. Structure of the Logic Component

API : Logic.java

Logic uses the AddressBookParser class to parse the user command.
This results in a Command object which is executed by the LogicManager.
The command execution can affect the Model (e.g. adding a person).
The result of the command execution is encapsulated as a CommandResult object which is passed back to the Ui.
In addition, the CommandResult object can also instruct the Ui to perform certain actions, such as displaying help to the user.

Given below is the Sequence Diagram for interactions within the Logic component for the execute("delete 1") API call.

Figure 17. Interactions Inside the Logic Component for the delete 1 Command

Model component

Figure 18. Structure of the Model Component

API : Model.java

The Model,

stores a UserPref object that represents the user’s preferences.
stores the Address Book data.
exposes an unmodifiable ObservableList<Person> that can be 'observed' e.g. the UI can be bound to this list so that the UI automatically updates when the data in the list change.
does not depend on any of the other three components.

As a more OOP model, we can store a Tag list in Address Book, which Person can reference. This would allow Address Book to only require one Tag object per unique Tag, instead of each Person needing their own Tag object. An example of how such a model may look like is given below.

Storage component

Figure 19. Structure of the Storage Component

API : Storage.java

The Storage component,

can save UserPref objects in json format and read it back.
can save the Address Book data in json format and read it back.

Common classes

Classes used by multiple components are in the seedu.addressbook.commons package.

Implementation

This section describes some noteworthy details on how certain features are implemented.

Generate interleaved schedule

Future implementation

The scheduling is facilitated by interleaver, consisting of the following operations.

ExtractSelfStudyHours() — extract all self study hours.
split() — split hours into 30 mins blocks.
interleave() — interleave blocks.
generate() — for each block, insert them into free time slots.

Given below is a activity diagram showing how the methods above work together:

The Sequence Diagram below shows how the components interact with each other for the scenario where the user issues the command interleave. Maximum 10 modules, until integration with CORs

Figure 20. Component interactions for interleave command

The Sequence Diagram below shows the interactions within the Logic component for the interleave() API call.

Figure 21. Interactions Inside the Logic Component for the interleave Command

Use the unmodifiable ObservableList<Person> in Model.java to update UI? Save the scheduler data in json format (Storage.java) and read it back?

Design Considerations

Aspect: How to split hours

Alternative 1 (current choice): Split into 30 mins blocks.
- Pros: Easy to implement.
- Cons: Some people might find 30 mins to be too long/short.
Alternative 2: Let user decide duration of each block.
- Pros: More flexibility.
- Cons: Harder to implement.

Aspect: How to train users to study with maximum focus period setting.

Alternative 1 (current choice): Progressive training.
- Increase in focus period weekly, starting from minimum settings.
- Users should be comfortable with 1 hour focus periods by mid semester, to help with midterms.
- Continue increasing to maximum setting for finals.

Logging

We are using java.util.logging package for logging. The LogsCenter class is used to manage the logging levels and logging destinations. The logging level can be controlled using the logLevel setting in the configuration file. The Logger for a class can be obtained using LogsCenter.getLogger(Class) which will log messages according to the specified logging level. Currently log messages are output through: Console and to a .log file.

Configuration

Certain properties of the application can be controlled (e.g user prefs file location, logging level) through the configuration file (default: config.json).

This feature adds an activity to the Student’s timetable.

Current Implementation

The addActivity mechanism adds a new activity to the students timetable whenever there’s a free time slot. This is executed by inserting time, date and name for a particular activity, then the addActivityCommand parser facilitates the addition of the new activity to a 2d array that stores activities. Given below is an example usage scenario and how the Check availability behaves at each step.

Step 1. The user launches the application for the first time.
Step 2. The user adds a person to the timetable.
Step 3. The user executes the addActivity command which requires a day(integer value from 0-6), a time (integer value from 0 - 48) and the name of the activity.
Step 4. The Efficient Learning Scheduler through the addActivityCommandParser, then checks if that slot is available then proceeds to add the activity.
Step 5. The activity is added to a 2 dimensional array, whose rows represent the day of the week and columns represent the 30 minute block within a day.
Step 6. A success message is then displayed to the user in the Command box.

Design Considerations

Aspect: How addActivity executes

Alternative 1 (current choice): Edits the persons current timetable.
- Pros: It is Easy to implement.
- Cons: May have performance issues in terms of memory usage.
Alternative 2: Generates a new timetable whenever the user adds something to it.
- Pros: Will use more memory.
- Cons: May have a higher running time depending on how convoluted the schedule is.

Aspect: Data structure to support the addActivity Command

Alternative 1 (current choice): Use a 2d Array of fixed size for each array.
- Pros: Easy to implement and understand.
- Cons: Null spaces in the array consume unnecessary space.
Alternative 2: Use a hashMap with days representing the Key, and the values being the hours in the day.
- Pros: Null spaces are avoided.
- Cons: HashMap is harder to implement. ===== Certain properties of the application can be controlled (e.g user prefs file location, logging level) through the configuration file (default: config.json).

Check Availability for Events feature

Current Implementation

This is a feature to check if the current user’s schedule has any clashes with a particular event in NUS. This is executed by getting the time and date of the event that user is interested in. This time and date will then be used to check if the user has any events or other commitments scheduled during the particular time slot. The program will then print on the Command Box whether the user is available to attend that event.

Given below is an example usage scenario and how the availability checking mechanism behaves at each step:

Step 1. User opens the application and views the upcoming events in NUS for the week of 18th March.
Step 2. User chooses an event that he/she is interested in. User executes the checkAvailEvent command
Step 3. The time and date of the event is stored in a Time and a Date object.
Step 4. Get the user’s Timetable array from the Model component of the application.
Step 5. Using the Time and Date object, get the corresponding day and time and check if there is any activity scheduled during the event timing in the user’s timetable.
Step 6. Print the availability (whether the user can attend the event) into the Command Box.

The following activity diagram summarizes what happens when a user executes the command:

Design considerations:

Alternative 1 (current choice): check availability for one particular event
- Pros: checking mechanism is faster, because we are only interested in 1 particular slot and no need to use the results display part of the UI
- Cons: troublesome if user wants to check for more than 1 event
Alternative 2: check availability for the whole week
- Pros: user can check availability for the whole week (more than 1 event at one time)
- Cons: checking mechanism is longer and need to change the view of the result display (implementation is harder)

List Activity feature

Current Implementation

This is a feature to list the activities of a person within the current week. This is executed by getting the index of the person from the input command. Using this index, the corresponding person’s timetable will be extracted. For every time slot in the timetable, if there is an activity scheduled, show it in the left pane of the application UI.

Given below is an example usage scenario and how the listing activity mechanism works at each step:

Step 1. User opens the application and finds his/her index in the list of persons in the application.
Step 2. User executes the listactivity PERSON_INDEX command.
Step 3. Using the person index, extract person and get the person’s Timetable array from the Model component.
Step 4. Iterate through the 2D Timetable array and check for each of the time slot.
Step 5. If there is an activity scheduled in each of the time slot, add it to the activityList.
Step 6. For each of the activity in the activityList, creates an ActivityCard in the UI component and shows it in the left panel of the application UI.

The following activity diagram summarizes what happens when a user executes the command:

Design considerations:

Alternative 1 (current choice): create one ActivityListPanel (UI component) for each person in the database
- Pros: easy to implement and easy to access
- Cons: might take up more memory space because of the ActivityListPanel List in the UI component (MainWindow)
Alternative 2: create one ActivityListPanel and contains the activities of every person in the database
- Pros: takes up less memory
- Cons: harder to implement, need to filter the activities by a specific person every time ListActivity command is called.

Documentation

We use asciidoc for writing documentation.

We chose asciidoc over Markdown because asciidoc, although a bit more complex than Markdown, provides more flexibility in formatting.

Editing Documentation

See UsingGradle.adoc to learn how to render .adoc files locally to preview the end result of your edits. Alternatively, you can download the AsciiDoc plugin for IntelliJ, which allows you to preview the changes you have made to your .adoc files in real-time.

Publishing Documentation

See UsingTravis.adoc to learn how to deploy GitHub Pages using Travis.

Converting Documentation to PDF format

We use Google Chrome for converting documentation to PDF format, as Chrome’s PDF engine preserves hyperlinks used in webpages.

Here are the steps to convert the project documentation files to PDF format.

Follow the instructions in UsingGradle.adoc to convert the AsciiDoc files in the docs/ directory to HTML format.
Go to your generated HTML files in the build/docs folder, right click on them and select Open with → Google Chrome.
Within Chrome, click on the Print option in Chrome’s menu.
Set the destination to Save as PDF, then click Save to save a copy of the file in PDF format. For best results, use the settings indicated in the screenshot below.

Figure 22. Saving documentation as PDF files in Chrome

Site-wide Documentation Settings

The build.gradle file specifies some project-specific asciidoc attributes which affects how all documentation files within this project are rendered.

Attributes left unset in the build.gradle file will use their default value, if any.

Table 3. List of site-wide attributes
Attribute name	Description	Default value
`site-name`	The name of the website. If set, the name will be displayed near the top of the page.	not set
`site-githuburl`	URL to the site’s repository on GitHub. Setting this will add a "View on GitHub" link in the navigation bar.	not set
`site-seedu`	Define this attribute if the project is an official SE-EDU project. This will render the SE-EDU navigation bar at the top of the page, and add some SE-EDU-specific navigation items.	not set

Per-file Documentation Settings

Each .adoc file may also specify some file-specific asciidoc attributes which affects how the file is rendered.

Asciidoctor’s built-in attributes may be specified and used as well.

Attributes left unset in .adoc files will use their default value, if any.

Table 4. List of per-file attributes, excluding Asciidoctor’s built-in attributes
Attribute name	Description	Default value
`site-section`	Site section that the document belongs to. This will cause the associated item in the navigation bar to be highlighted. One of: `UserGuide`, `DeveloperGuide`, `LearningOutcomes`, `AboutUs`, `ContactUs` Official SE-EDU projects only	not set
`no-site-header`	Set this attribute to remove the site navigation bar.	not set

Site Template

The files in docs/stylesheets are the CSS stylesheets of the site. You can modify them to change some properties of the site’s design.

The files in docs/templates controls the rendering of .adoc files into HTML5. These template files are written in a mixture of Ruby and Slim.

Modifying the template files in docs/templates requires some knowledge and experience with Ruby and Asciidoctor’s API. You should only modify them if you need greater control over the site’s layout than what stylesheets can provide. The SE-EDU team does not provide support for modified template files.

Testing

Running Tests

There are three ways to run tests.

The most reliable way to run tests is the 3rd one. The first two methods might fail some GUI tests due to platform/resolution-specific idiosyncrasies.

Method 1: Using IntelliJ JUnit test runner

To run all tests, right-click on the src/test/java folder and choose Run 'All Tests'
To run a subset of tests, you can right-click on a test package, test class, or a test and choose Run 'ABC'

Method 2: Using Gradle

Open a console and run the command gradlew clean allTests (Mac/Linux: ./gradlew clean allTests)

See UsingGradle.adoc for more info on how to run tests using Gradle.

Method 3: Using Gradle (headless)

Thanks to the TestFX library we use, our GUI tests can be run in the headless mode. In the headless mode, GUI tests do not show up on the screen. That means the developer can do other things on the Computer while the tests are running.

To run tests in headless mode, open a console and run the command gradlew clean headless allTests (Mac/Linux: ./gradlew clean headless allTests)

Types of tests

We have two types of tests:

GUI Tests - These are tests involving the GUI. They include,
1. System Tests that test the entire App by simulating user actions on the GUI. These are in the systemtests package.
2. Unit tests that test the individual components. These are in seedu.address.ui package.
Non-GUI Tests - These are tests not involving the GUI. They include,
1. Unit tests targeting the lowest level methods/classes.
  e.g. seedu.address.commons.StringUtilTest
2. Integration tests that are checking the integration of multiple code units (those code units are assumed to be working).
  e.g. seedu.address.storage.StorageManagerTest
3. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.
  e.g. seedu.address.logic.LogicManagerTest

Troubleshooting Testing

Problem: HelpWindowTest fails with a NullPointerException.

Reason: One of its dependencies, HelpWindow.html in src/main/resources/docs is missing.
Solution: Execute Gradle task processResources.

Dev Ops

Build Automation

See UsingGradle.adoc to learn how to use Gradle for build automation.

Continuous Integration

We use Travis CI and AppVeyor to perform Continuous Integration on our projects. See UsingTravis.adoc and UsingAppVeyor.adoc for more details.

Coverage Reporting

We use Coveralls to track the code coverage of our projects. See UsingCoveralls.adoc for more details.

Documentation Previews

When a pull request has changes to asciidoc files, you can use Netlify to see a preview of how the HTML version of those asciidoc files will look like when the pull request is merged. See UsingNetlify.adoc for more details.

Making a Release

Here are the steps to create a new release.

Update the version number in MainApp.java.
Generate a JAR file using Gradle.
Tag the repo with the version number. e.g. v0.1
Create a new release using GitHub and upload the JAR file you created.

Managing Dependencies

A project often depends on third-party libraries. For example, Address Book depends on the Jackson library for JSON parsing. Managing these dependencies can be automated using Gradle. For example, Gradle can download the dependencies automatically, which is better than these alternatives:

Include those libraries in the repo (this bloats the repo size)
Require developers to download those libraries manually (this creates extra work for developers)

Appendix J: Suggested Programming Tasks to Get Started

Suggested path for new programmers:

First, add small local-impact (i.e. the impact of the change does not go beyond the component) enhancements to one component at a time. Some suggestions are given in Improving each component.
Next, add a feature that touches multiple components to learn how to implement an end-to-end feature across all components. Creating a new command: remark explains how to go about adding such a feature.

Improving each component

Each individual exercise in this section is component-based (i.e. you would not need to modify the other components to get it to work).

`Logic` component

Scenario: You are in charge of logic. During dog-fooding, your team realize that it is troublesome for the user to type the whole command in order to execute a command. Your team devise some strategies to help cut down the amount of typing necessary, and one of the suggestions was to implement aliases for the command words. Your job is to implement such aliases.

Do take a look at Logic component before attempting to modify the Logic component.

Add a shorthand equivalent alias for each of the individual commands. For example, besides typing clear, the user can also type c to remove all persons in the list.
- Hints
  
  Just like we store each individual command word constant COMMAND_WORD inside *Command.java (e.g. FindCommand#COMMAND_WORD, DeleteCommand#COMMAND_WORD), you need a new constant for aliases as well (e.g. FindCommand#COMMAND_ALIAS).
  
  AddressBookParser is responsible for analyzing command words.
- Solution
  
  Modify the switch statement in AddressBookParser#parseCommand(String) such that both the proper command word and alias can be used to execute the same intended command.
  
  Add new tests for each of the aliases that you have added.
  
  Update the user guide to document the new aliases.
  
  See this PR for the full solution.

`Model` component

Scenario: You are in charge of model. One day, the logic-in-charge approaches you for help. He wants to implement a command such that the user is able to remove a particular tag from everyone in the address book, but the model API does not support such a functionality at the moment. Your job is to implement an API method, so that your teammate can use your API to implement his command.

Do take a look at Model component before attempting to modify the Model component.

Add a removeTag(Tag) method. The specified tag will be removed from everyone in the address book.
- Hints
  
  The Model and the AddressBook API need to be updated.
  
  Think about how you can use SLAP to design the method. Where should we place the main logic of deleting tags?
  
  Find out which of the existing API methods in AddressBook and Person classes can be used to implement the tag removal logic. AddressBook allows you to update a person, and Person allows you to update the tags.
- Solution
  
  Implement a removeTag(Tag) method in AddressBook. Loop through each person, and remove the tag from each person.
  
  Add a new API method deleteTag(Tag) in ModelManager. Your ModelManager should call AddressBook#removeTag(Tag).
  
  Add new tests for each of the new public methods that you have added.
  
  See this PR for the full solution.

`Ui` component

Scenario: You are in charge of ui. During a beta testing session, your team is observing how the users use your address book application. You realize that one of the users occasionally tries to delete non-existent tags from a contact, because the tags all look the same visually, and the user got confused. Another user made a typing mistake in his command, but did not realize he had done so because the error message wasn’t prominent enough. A third user keeps scrolling down the list, because he keeps forgetting the index of the last person in the list. Your job is to implement improvements to the UI to solve all these problems.

Do take a look at UI component before attempting to modify the UI component.

Use different colors for different tags inside person cards. For example, friends tags can be all in brown, and colleagues tags can be all in yellow.

Before

After
- Hints
  
  The tag labels are created inside the PersonCard constructor (new Label(tag.tagName)). JavaFX’s Label class allows you to modify the style of each Label, such as changing its color.
  
  Use the .css attribute -fx-background-color to add a color.
  
  You may wish to modify DarkTheme.css to include some pre-defined colors using css, especially if you have experience with web-based css.
- Solution
  
  You can modify the existing test methods for PersonCard 's to include testing the tag’s color as well.
  
  See this PR for the full solution.
  
  The PR uses the hash code of the tag names to generate a color. This is deliberately designed to ensure consistent colors each time the application runs. You may wish to expand on this design to include additional features, such as allowing users to set their own tag colors, and directly saving the colors to storage, so that tags retain their colors even if the hash code algorithm changes.
Modify NewResultAvailableEvent such that ResultDisplay can show a different style on error (currently it shows the same regardless of errors).

Before

After
- Hints
  
  NewResultAvailableEvent is raised by CommandBox which also knows whether the result is a success or failure, and is caught by ResultDisplay which is where we want to change the style to.
  
  Refer to CommandBox for an example on how to display an error.
- Solution
  
  Modify NewResultAvailableEvent 's constructor so that users of the event can indicate whether an error has occurred.
  
  Modify ResultDisplay#handleNewResultAvailableEvent(NewResultAvailableEvent) to react to this event appropriately.
  
  You can write two different kinds of tests to ensure that the functionality works:
  
  The unit tests for ResultDisplay can be modified to include verification of the color.
  
  The system tests AddressBookSystemTest#assertCommandBoxShowsDefaultStyle() and AddressBookSystemTest#assertCommandBoxShowsErrorStyle() to include verification for ResultDisplay as well.
  
  See this PR for the full solution.
  
  Do read the commits one at a time if you feel overwhelmed.
Modify the StatusBarFooter to show the total number of people in the address book.

Before

After
- Hints
  
  StatusBarFooter.fxml will need a new StatusBar. Be sure to set the GridPane.columnIndex properly for each StatusBar to avoid misalignment!
  
  StatusBarFooter needs to initialize the status bar on application start, and to update it accordingly whenever the address book is updated.
- Solution
  
  Modify the constructor of StatusBarFooter to take in the number of persons when the application just started.
  
  Use StatusBarFooter#handleAddressBookChangedEvent(AddressBookChangedEvent) to update the number of persons whenever there are new changes to the addressbook.
  
  For tests, modify StatusBarFooterHandle by adding a state-saving functionality for the total number of people status, just like what we did for save location and sync status.
  
  For system tests, modify AddressBookSystemTest to also verify the new total number of persons status bar.
  
  See this PR for the full solution.

`Storage` component

Scenario: You are in charge of storage. For your next project milestone, your team plans to implement a new feature of saving the address book to the cloud. However, the current implementation of the application constantly saves the address book after the execution of each command, which is not ideal if the user is working on limited internet connection. Your team decided that the application should instead save the changes to a temporary local backup file first, and only upload to the cloud after the user closes the application. Your job is to implement a backup API for the address book storage.

Do take a look at Storage component before attempting to modify the Storage component.

Add a new method backupAddressBook(ReadOnlyAddressBook), so that the address book can be saved in a fixed temporary location.
- Hint
  
  Add the API method in AddressBookStorage interface.
  
  Implement the logic in StorageManager and JsonAddressBookStorage class.
- Solution
  
  See this PR for the full solution.

Creating a new command: `remark`

By creating this command, you will get a chance to learn how to implement a feature end-to-end, touching all major components of the app.

Scenario: You are a software maintainer for addressbook, as the former developer team has moved on to new projects. The current users of your application have a list of new feature requests that they hope the software will eventually have. The most popular request is to allow adding additional comments/notes about a particular contact, by providing a flexible remark field for each contact, rather than relying on tags alone. After designing the specification for the remark command, you are convinced that this feature is worth implementing. Your job is to implement the remark command.

Description

Edits the remark for a person specified in the INDEX.
Format: remark INDEX r/[REMARK]

Examples:

remark 1 r/Likes to drink coffee.
Edits the remark for the first person to Likes to drink coffee.
remark 1 r/
Removes the remark for the first person.

Step-by-step Instructions

[Step 1] Logic: Teach the app to accept 'remark' which does nothing

Let’s start by teaching the application how to parse a remark command. We will add the logic of remark later.

Main:

Add a RemarkCommand that extends Command. Upon execution, it should just throw an Exception.
Modify AddressBookParser to accept a RemarkCommand.

Tests:

Add RemarkCommandTest that tests that execute() throws an Exception.
Add new test method to AddressBookParserTest, which tests that typing "remark" returns an instance of RemarkCommand.

[Step 2] Logic: Teach the app to accept 'remark' arguments

Let’s teach the application to parse arguments that our remark command will accept. E.g. 1 r/Likes to drink coffee.

Main:

Modify RemarkCommand to take in an Index and String and print those two parameters as the error message.
Add RemarkCommandParser that knows how to parse two arguments, one index and one with prefix 'r/'.
Modify AddressBookParser to use the newly implemented RemarkCommandParser.

Tests:

Modify RemarkCommandTest to test the RemarkCommand#equals() method.
Add RemarkCommandParserTest that tests different boundary values for RemarkCommandParser.
Modify AddressBookParserTest to test that the correct command is generated according to the user input.

[Step 3] Ui: Add a placeholder for remark in `PersonCard`

Let’s add a placeholder on all our PersonCard s to display a remark for each person later.

Main:

Add a Label with any random text inside PersonListCard.fxml.
Add FXML annotation in PersonCard to tie the variable to the actual label.

Tests:

Modify PersonCardHandle so that future tests can read the contents of the remark label.

[Step 4] Model: Add `Remark` class

We have to properly encapsulate the remark in our Person class. Instead of just using a String, let’s follow the conventional class structure that the codebase already uses by adding a Remark class.

Main:

Add Remark to model component (you can copy from Address, remove the regex and change the names accordingly).
Modify RemarkCommand to now take in a Remark instead of a String.

Tests:

Add test for Remark, to test the Remark#equals() method.

[Step 5] Model: Modify `Person` to support a `Remark` field

Now we have the Remark class, we need to actually use it inside Person.

Main:

Add getRemark() in Person.
You may assume that the user will not be able to use the add and edit commands to modify the remarks field (i.e. the person will be created without a remark).
Modify SampleDataUtil to add remarks for the sample data (delete your data/addressbook.json so that the application will load the sample data when you launch it.)

[Step 6] Storage: Add `Remark` field to `JsonAdaptedPerson` class

We now have Remark s for Person s, but they will be gone when we exit the application. Let’s modify JsonAdaptedPerson to include a Remark field so that it will be saved.

Main:

Add a new JSON field for Remark.

Tests:

Fix invalidAndValidPersonAddressBook.json, typicalPersonsAddressBook.json, validAddressBook.json etc., such that the JSON tests will not fail due to a missing remark field.

[Step 6b] Test: Add withRemark() for `PersonBuilder`

Since Person can now have a Remark, we should add a helper method to PersonBuilder, so that users are able to create remarks when building a Person.

Tests:

Add a new method withRemark() for PersonBuilder. This method will create a new Remark for the person that it is currently building.
Try and use the method on any sample Person in TypicalPersons.

[Step 7] Ui: Connect `Remark` field to `PersonCard`

Our remark label in PersonCard is still a placeholder. Let’s bring it to life by binding it with the actual remark field.

Main:

Modify PersonCard's constructor to bind the Remark field to the Person 's remark.

Tests:

Modify GuiTestAssert#assertCardDisplaysPerson(…) so that it will compare the now-functioning remark label.

[Step 8] Logic: Implement `RemarkCommand#execute()` logic

We now have everything set up… but we still can’t modify the remarks. Let’s finish it up by adding in actual logic for our remark command.

Main:

Replace the logic in RemarkCommand#execute() (that currently just throws an Exception), with the actual logic to modify the remarks of a person.

Tests:

Update RemarkCommandTest to test that the execute() logic works.

Full Solution

See this PR for the step-by-step solution.

Appendix K: Product Scope

Target user profile:

has a need to manage personal study schedule
prefer desktop apps over other types
can type fast
prefers typing over mouse input
is reasonably comfortable using CLI apps

Value proposition: manages timetable faster than a typical mouse/GUI driven app

Appendix L: User Stories

Priorities: High (must have) - * * *, Medium (nice to have) - * *, Low (unlikely to have) - *

Priority As a … I want to … So that I can…

Priority	As a …	I want to …	So that I can…
`* * *`	new user	modify the time table	allow for more flexibility
`* * *`	new user	add the modules I am taking this semester	have a calendar-like view of my timetable
`* * *`	new user	choose the level of learning intensity (no of hours spent per week is based on that)	suit my studying style
`* * *`	new user	add the different commitments such as CCAs	schedule not just my studies, but my life too
`* * *`	new user	generate study schedules by typing a command	learn better via interleaving/spacing
`* *`	student	view my sleeping patterns	be advised better on when to sleep.
`* *`	student	view available internships	I know what jobs to apply for.
`* *`	student	form groups with other people in the class	collaborate more efficiently.
`* *`	student	get a suggested list of modules	know how to prepare for next semester.
`* *`	student	view a video on the importance of learning concepts	learn more efficiently
`* *`	student	modify my timetable	update my schedule when plans change.
`*`	existing/expert user	find websites	get free pdfs of textbooks for mods.
`*`	professor	collect data	analyze how students learn
`*`	student	practice questions	Study for modules on the app.
`*`	student	view the mods I’m taking this semester	prepare more efficiently for classes.

* * *

new user

modify the time table

allow for more flexibility

* * *

new user

add the modules I am taking this semester

have a calendar-like view of my timetable

* * *

new user

choose the level of learning intensity (no of hours spent per week is based on that)

suit my studying style

* * *

new user

add the different commitments such as CCAs

schedule not just my studies, but my life too

* * *

new user

generate study schedules by typing a command

learn better via interleaving/spacing

* *

student

view my sleeping patterns

be advised better on when to sleep.

* *

student

view available internships

I know what jobs to apply for.

* *

student

form groups with other people in the class

collaborate more efficiently.

* *

student

get a suggested list of modules

know how to prepare for next semester.

* *

student

view a video on the importance of learning concepts

learn more efficiently

* *

student

modify my timetable

update my schedule when plans change.

*

existing/expert user

find websites

get free pdfs of textbooks for mods.

*

professor

collect data

analyze how students learn

*

student

practice questions

Study for modules on the app.

*

student

view the mods I’m taking this semester

prepare more efficiently for classes.

{More to be added}

Appendix M: Use Cases

(For all use cases below, the System is the AddressBook and the Actor is the user, unless specified otherwise)

Use case: Generate a time table

MSS

User requests to generate a schedule
App shows a list of available modules
User requests to add specific module to the time table
App generates the time table for the users

Use case ends.

Extensions

2a. Efficient Learning Scheduler can’t pull module data from CORS 2a1. Efficient Learning Scheduler shows an error message.

Use case ends.

{More to be added}

Appendix N: Non Functional Requirements

Should work on any mainstream OS as long as it has Java 9 or higher installed.
Able to accommodate 100 persons without slowing the performance for typical usage
Able to suit the needs of a NUS student with fast typing speed.

{More to be added}

Appendix O: explanation of enhancement

1.By adding the timetable class, users can search for the module they want, and UI will generate the timetable for the specific module
- 1a.Module class- extract data from ALSET database, Module Class will be the subclass of TimeSlot
- 2a.Activity Class - stores modules as activities in the User’s timetable.
- 3a.TimeTable Class-contain all the activities in the user’s timetable.

Appendix P: Glossary

Mainstream OS: Windows, Linux, Unix, OS-X
Private contact detail: A contact detail that is not meant to be shared with others

ALSET aims to become a leading hub for learning science and education technology research in Asia, and a provider of impactful programming to support lifelong learning. For more info, visit http://nus.edu.sg/alset/index.html

Value proposition: Help NUS students learn in the most efficient way by helping them generate an efficient studying schedule
Problem scope: NUS Students who are lazy and would like to check their schedule through the CLI.
Work patterns: Work Alone
Target users: NUS students who prefer typing to create a schedule.

Appendix Q: Product Survey

Product Name

Author: …

Pros:

…
…

Cons:

…
…

Appendix R: Instructions for Manual Testing

Given below are instructions to test the app manually.

These instructions only provide a starting point for testers to work on; testers are expected to do more exploratory testing.

Launch and Shutdown

Initial launch
1. Download the jar file and copy into an empty folder
2. Double-click the jar file
  Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.
Saving window preferences
1. Resize the window to an optimum size. Move the window to a different location. Close the window.
2. Re-launch the app by double-clicking the jar file.
  Expected: The most recent window size and location is retained.

Add an activity to a person.

adds an activity to a persons Timetable.
1. Prerequisites: List all persons using the list command. Multiple persons in the list.
2. Test case: addActivity 1 act/CS2113 day/0 time/13 Expected: an activity 'CS2113' to the first person in the Efficient learning scheduler.
3. Test case: addActivity 0 act/CS2113 day/0 time/130
  Expected: No activity is added to anyone. Error details shown in the status message.
4. Other incorrect addActivity commands to try: addActivity, addActivity x (where x is larger than the list size) {give more}
  Expected: Similar to previous.

Adding an event

Adding an event to the event calendar
1. Test case: addevent ett/UBS - Unlock Your Potential with us ed/01/04/2019 etm/15:00-16:00 ev/UBS Office Expected: the event will be successfully added even though there are some missing input arguments, because the rest of the arguments are optional.
2. Test case: addevent ett/UBS - Unlock Your Potential with us ed/01/04/2019 etm/15:00-16:00 eta/All Year 1 female students edc/Business Formal eds/Unlock Your Potential with us. Expected: the event will not be successfully added because the ev/ argument which is compulsory is missing.
3. Test case: addevent ett/UBS - Unlock Your Potential with us ed/29/02/2019 etm/15:00-16:00 ev/UBS Office Expected: the error message will be shown indicating wrong date (there is no 29th February in 2019).
4. Other incorrect addevent commands to try: starting time without end time, impossible time (HH more than 24 and MM more than 60) Expected: the error message will be shown indicating wrong time.

Windrich - Project Portfolio

How the architecture components interact with each other

Logic component

Model component

Ui component

Storage component

Use case: Generate a time table

How the architecture components interact with each other

`Logic` component

`Model` component

`Ui` component

`Storage` component