Figure 9. Overview of Storage
+ +**API** : [`Storage.java`](../src/main/java/seedu/address/storage/Storage.java) + +The `Storage` component, +* can save `UserPref` objects in json format and read it back. +* can save the SmartyDo data in xml format and read it back. + +### 3.6 Common classes + +You may find classes used by multiple components are in the `seedu.addressbook.commons` package. + +## 4. Implementation + +### 4.1 Logging + +We are using `java.util.logging` package for logging. You can use `LogsCenter` class to manage the logging levels +and logging destinations. + +* You can control the logging level by using the `logLevel` setting in the configuration file + (See [Configuration](#configuration)) +* You can obtain the `Logger` for a class by 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. + +**Logging Levels** +|Level|Details| +|---|---| +| `SEVERE` | Critical problem detected which may possibly cause the termination of the application. +| `WARNING` | Can continue, but with caution. +| `INFO` | Information showing the noteworthy actions by the App. +| `FINE` | Details that are not usually noteworthy but may be useful in debugging e.g. printout of the actual list instead of just its size + +### 4.2 Configuration + +You can control certain properties of the application (e.g App name, logging level) through the configuration file +(default: `config.json`): + + +## 5. Testing + +You can find tests in the `./src/test/java` folder. + +**In Eclipse**: +> If you are not using a recent Eclipse version (i.e. _Neon_ or later), you will need to enable assertions in JUnit tests + as described [here](http://stackoverflow.com/questions/2522897/eclipse-junit-ea-vm-option). + +* You can run all tests by right-clicking on the `src/test/java` folder and choose + `Run as` > `JUnit Test` +* You can also run a subset of tests by right-clicking on a test package, test class, or a test and choose + to run as a JUnit test. + +**Using Gradle**: +* You may refer to [UsingGradle.md](UsingGradle.md) to see how to run tests using Gradle. + +We have two types of tests: + +1. **GUI Tests** - These are _System Tests_ that test the entire App by simulating user actions on the GUI. + These are in the `guitests` package. + +2. **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.UrlUtilTest` + 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 they are connected together.
+ e.g. `seedu.address.logic.LogicManagerTest` + +**Headless GUI Testing** : +Thanks to the [TestFX](https://github.com/TestFX/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.
+ See [UsingGradle.md](UsingGradle.md#running-tests) to learn how to run tests in headless mode. + +## 6. Dev Ops + +### 6.1 Build Automation + +You may read [UsingGradle.md](UsingGradle.md) to learn how to use Gradle for build automation. + +### 6.2 Continuous Integration + +We use [Travis CI](https://travis-ci.org/) to perform _Continuous Integration_ on our projects. +You may read [UsingTravis.md](UsingTravis.md) for more details. + +### 6.3 Making a Release + +Here are the steps to create a new release. + + 1. Generate a JAR file [using Gradle](UsingGradle.md#creating-the-jar-file). + 2. Tag the repo with the version number. e.g. `v0.1` + 2. [Create a new release using GitHub](https://help.github.com/articles/creating-releases/) + and upload the JAR file your created. + +### 6.4 Managing Dependencies + +A project often depends on third-party libraries. For example, SmartyDo depends on the +[Jackson library](http://wiki.fasterxml.com/JacksonHome) for XML parsing. Managing these _dependencies_ +can be automated using Gradle. For example, Gradle can download the dependencies automatically, which +is better than these alternatives.
+a. Include those libraries in the repo (this bloats the repo size)
+b. Require developers to download those libraries manually (this creates extra work for developers)
+ + +## 7. Appendix +``` +###### \DeveloperGuide.md +``` md +## 7.3 Appendix C : Non Functional Requirements + +1. Should work on any [mainstream OS](#mainstream-os) as long as it has Java `1.8.0_60` or higher installed. +2. Should be able to hold up to 2 years of entries estimated to be 8000 entries. +3. Should come with automated unit tests and open source code. +4. Should favor DOS style commands over Unix-style commands. + +``` +###### \UserGuide.md +``` md +## 1. Introduction +SmartyDo is a **to-do-list** application. With SmartyDo, forgetting upcoming deadlines and sleepless nights over incomplete tasks are a thing of the past. SmartyDo **increases your efficiency** by showing the lists of tasks that can be completed simultaneously. Treat SmartyDo like your personal assistant and just focus on **completing your tasks**! + +## 2. Quick Start +**Launch SmartyDo**: Simply double-click on the `SmartyDo.jar` file to start SmartyDo. You will be greeted with a simple interface that has three components: a **Visual Box**, a **Message Box** and a **Command Bar**. + +
Figure 1. Welcome Screen
+ +**Command Bar** is where you enter short commands to tell SmartyDo what to do.
+**Visual Box** is where you can see a comprehensive list of your tasks.
+**Message Box** shows the result of your command.
+``` +###### \UserGuide.md +``` md +### 3.4. **Adding Tasks Into SmartyDo** + +You can add a task into SmartyDo by using the add command. There are number of parameters that you can use to add more details to the task. Below is a summary of the various parameters and their usage:
+ +Here is the summary of the parameters and their usage: + +| Parameter | Flag | Format Requirements | Optional | +| ------------- |:-------------:| -----:|:---:| +| `TASK_NAME` | | _**n;**_ required if `TASK_NAME` is not the first parameter | No | +| `DATE_TIME` | **t;** | [Date] [Start_Time] [End_Time] , delimited by spaces | Yes | +| `TAG` | _**t/**_ | alphanumeric | Yes | +| `LOCATION` | _**a;**_ | alphanumeric | Yes | +| `DESCRIPTION` | _**d;**_ | alphanumeric | Yes | +Table 3.2. Add Command Parameters + +- `TASK_NAME` is the name of the task and this parameter is compulsary. +- `Date` is the date of the task supports date format of +dd/mmm/yyyy eg:20-Jan-2017 and dd/mm/yyyy with `/` interchangleable with `.` and `-` eg: 20-01-2017. +- `START_TIME` and `END_TIME` is the starting time and ending time of the task respectively. You may consider to use these parameters when starting time and/or deadline is known. You may omit the details of 'DATE_TIME' which will result in a task that has no time frame. +- `TAG` is the characteristic you can add to the task. Such tags can be "Urgent", "HighPriority" and etc. +- `LOCATION` is the place of task being done. You can use this parameter to remind you where to go to complete the task. +- 'DESCRIPTION' is where you can include some extra information about your task. + +Format : `add TASK_NAME [t; DATE START_TIME] [a;LOCATION] [t/TAG] [d;` + +> You don't have to enter the optional parameters when you don't need them. The order of the parameters are not fixed. You can enter the parameters in any order. For example, `add t/[TAG] t; DATE START_TIME ` is also correct format. + +**Example:**
+Let's say you want to add task named "Presentation" which is scheduled for 18 July 2016, 9:00AM. All you need to do is enter the following as shown below. + +
Figure 5. Example of add command
+ +After entering the command, MessageBox will show you task is successfully added into SmartyDo and you will see the updated list of task in the Visual Box. +``` +###### \UserGuide.md +``` md +### 3.13. **Clearing Saved Data** +You may clear all data stored in SmartyDo by using the `clear` command. SmartyDo will prompt you to confirm this action. Enter `yes` to complete the command. Entering a different command will cancel the `clear` command. + +Format: `clear` + +**Example**
+If you wish to clear all data in SmartyDo, you many enter `clear` into the CommandBox. + +
Figure 14. Example of locate command
+ +After entering the command, a prompt will appear in the MessageBox asking you to confirm this action. Enter `yes` to proceed. + +### 3.14. **Exiting SmartyDo** + +After using SmartyDo, you can exit the program by using `exit` command. + +Format: `exit` + +By entering `exit` command in the command box, SmartyDo will quit and save the data. + +## 4. Smart Features + +### 4.1. **FlexiCommand** +It is okay if you cannot remember the syntax entirely! As long as you remember the keyword some reshuffling of the parameters entered is fine. Our program will ask you for confirmation if we are unsure what you want. + +### 4.2. **Saving the Data** +SmartyDo will automatically save your data in the hard disk after any command that changes the data. There is no need to save manually. + +``` diff --git a/collated/main/A0121261Y.md b/collated/main/A0121261Y.md new file mode 100644 index 000000000000..3323da24c5a2 --- /dev/null +++ b/collated/main/A0121261Y.md @@ -0,0 +1,1001 @@ +# A0121261Y +###### \java\seedu\address\logic\commands\AddCommand.java +``` java +/** + * Adds a task to the SmartyDo. + */ +public class AddCommand extends Command implements Undoable { + + public static final String COMMAND_WORD = "add"; + + public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a task to the SmartyDo. " + + "Parameters: NAME t;DATE et;TIME d;DESCRIPTION a;LOCATION [tag;TAG]...\n" + + "Example: " + COMMAND_WORD + + " CS2103 t;10-12-2016 10:00AM 11:00AM d;description a;Nus Computing t/sadLife"; + + public static final String MESSAGE_SUCCESS = "New task added: %1$s"; + public static final String MESSAGE_DUPLICATE_TASK = "This task already exists in the SmartyDo"; + + private final Task toAdd; + private boolean isExecutedBefore; + + /** + * Convenience constructor using raw values. + * + * @throws IllegalValueException if any of the raw values are invalid + */ + + public AddCommand(String name, String time, String description, String address, Set