Merge pull request nus-cs2103-AY2021S1#74 from GeNiaaz/refactor-Project-Address

Refactor Address to ProjectDescription

Author: lucastai98

config/checkstyle/checkstyle.xml

@@ -213,7 +213,8 @@
       some other variants which we don't publicized to promote consistency).
       -->
       <property name="reliefPattern"
-                value="fall through|Fall through|fallthru|Fallthru|falls through|Falls through|fallthrough|Fallthrough|No break|NO break|no break|continue on"/>
+                value="fall through|Fall through|fallthru|Fallthru|falls through|Falls through|fallthrough
+                |Fallthrough|No break|NO break|no break|continue on"/>
     </module>
 
     <module name="MissingSwitchDefault"/>

docs/Configuration.md

@@ -3,4 +3,5 @@ layout: page
 title: Configuration guide
 ---
 
-Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the configuration file (default: `config.json`).
+Certain properties of the application can be controlled (e.g user preferences file location, logging level) through 
+the configuration file (default: `config.json`).

docs/DeveloperGuide (original AB3 tempalte).md

@@ -31,8 +31,10 @@ The ***Architecture Diagram*** given above explains the high-level design of the
 
 </div>
 
-**`Main`** has two classes called [`Main`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/Main.java) and 
-[`MainApp`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java). It is responsible for,
+**`Main`** has two classes called 
+[`Main`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/Main.java) and 
+[`MainApp`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java). 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 methods where necessary.
 

docs/DeveloperGuide.md

@@ -27,7 +27,9 @@ The ***Architecture Diagram*** given above explains the high-level design of the
 
 </div>
 
-**`Main`** has two classes called [`Main`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/Main.java) and [`MainApp`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java). It is responsible for,
+**`Main`** has two classes called [`Main`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java
+/seedu/address/Main.java) and [`MainApp`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu
+/address/MainApp.java). 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 methods where necessary.
 
@@ -326,7 +328,7 @@ Use case ends.
 **MSS:**
 
 1. Team leader create a new team member profile.
-2. TMTS asks for the details of the team member such as projectName, phone number and email address.
+2. TMTS asks for the details of the team member such as projectName, phone number and email projectDescription.
 3. Team leader keys in the details.
 4. TMTS stores the team member's profile into the data file.
 
@@ -351,7 +353,7 @@ Use case ends.
 1. Team leader chooses to edit a team member's profile.
 2. PTS asks for the projectName of the team member whose profile is to be edited.
 3. Team leader keys in the projectName of the team member.
-4. TMTS asks for the new information of team member such as projectName, phone number and email address.
+4. TMTS asks for the new information of team member such as projectName, phone number and email projectDescription.
 5. Team leader keys in the details.
 6. TMTS stores the team member's profile into the data file.
 

docs/_sass/minima/custom-styles.scss

@@ -28,7 +28,8 @@ h2, h3, h4, h5, h6 {
 
 @each $color, $value in $theme-colors {
   .alert-#{$color} {
-    @include alert-variant(color-level($value, $alert-bg-level), color-level($value, $alert-border-level), color-level($value, $alert-color-level));
+    @include alert-variant(color-level($value, $alert-bg-level), color-level($value, $alert-border-level),
+     color-level($value, $alert-color-level));
   }
 }
 

docs/tutorials/AddRemark.md

@@ -93,7 +93,8 @@ We start by modifying the constructor of `RemarkCommand` to accept an `Index` an
 if our code is functioning as intended.
 
 ``` java
-import static seedu.address.commons.util.CollectionUtil.requireAllNonNull;
+import static seedu.address
+.commons.util.CollectionUtil.requireAllNonNull;
 //...
 public class RemarkCommand extends Command {
     //...
@@ -143,7 +144,9 @@ Your code should look something like [this](https://github.com/se-edu/addressboo
 
 Now let’s move on to writing a parser that will extract the index and remark from the input provided by the user.
 
-Create a `RemarkCommandParser` class in the `seedu.address.logic.parser` package. The class must extend the `Parser` interface.
+Create a `RemarkCommandParser` class in the `seedu.address
+.logic.parser` package. The class must extend the `Parser
+` interface.
 
 ![The relationship between Parser and RemarkCommandParser](../images/add-remark/ParserInterface.png)
 
@@ -235,7 +238,9 @@ Now that we have all the information that we need, let’s lay the groundwork fo
 
 ### Add a new `Remark` class
 
-Create a new `Remark` in `seedu.address.model.project`. Since a `Remark` is a field that is similar to `Address`, we can reuse a significant bit of code.
+Create a new `Remark` in `seedu.address
+.model.project`. Since a `Remark` is a field that is similar to `Address`, we can
+ reuse a significant bit of code.
 
 A copy-paste and search-replace later, you should have something like 
 [this](https://github.com/se-edu/addressbook-level3/commit/4516e099699baa9e2d51801bd26f016d812dedcc#diff-af2f075d24dfcd333876f0fbce321f25). Note how `Remark` has no 
@@ -251,7 +256,9 @@ These should be relatively simple changes.
 
 Without getting too deep into `fxml`, let’s go on a 5 minute adventure to get some placeholder text to show up for each project.
 
-Simply add the following to [`seedu.address.ui.ProjectCard`](https://github.com/se-edu/addressbook-level3/commit/850b78879582f38accb05dd20c245963c65ea599#diff-0c6b6abcfac8c205e075294f25e851fe).
+Simply add the following to [`seedu.address
+.ui.ProjectCard`](https://github.com/se-edu/addressbook-level3/commit
+/850b78879582f38accb05dd20c245963c65ea599#diff-0c6b6abcfac8c205e075294f25e851fe).
 
 **`ProjectCard.java`:**
 

docs/tutorials/RemovingFields.md

@@ -9,7 +9,7 @@ title: "Tutorial: Removing Fields"
 
 When working on MainCatalogue, you will most likely find that some features and fields that are no longer necessary. In scenarios like this, you can consider refactoring the existing `Project` model to suit your use case.
 
-In this tutorial, we’ll do exactly just that and remove the `address` field from `Project`.
+In this tutorial, we’ll do exactly just that and remove the `projectDescription` field from `Project`.
 
 * Table of Contents
 {:toc}
@@ -20,7 +20,7 @@ Fortunately, IntelliJ IDEA provides a robust refactoring tool that can identify
 
 ### Assisted refactoring
 
-The `address` field in `Project` is actually an instance of the `seedu.address.model.project.Address` class. Since removing the `Address` class will break the application, we start by identifying `Address`'s usages. This allows us to see code that depends on `Address` to function properly and edit them on a case-by-case basis. Right-click the `Address` class and select `Refactor` \> `Safe Delete` through the menu.
+The `projectDescription` field in `Project` is actually an instance of the `seedu.address.model.project.ProjectDescriptionect.Address` class. Since removing the `Address` class will break the application, we start by identifying `Address`'s usages. This allows us to see code that depends on `Address` to function properly and edit them on a case-by-case basis. Right-click the `Address` class and select `Refactor` \> `Safe Delete` through the menu.
 
 ![Usages detected](../images/remove/UnsafeDelete.png)
 
@@ -32,18 +32,18 @@ Remove usages of `Address` by performing `Safe Delete`s on each entry. You will
 
 Let’s try removing references to `Address` in `EditProjectDescriptor`.
 
-1. Safe delete the field `address` in `EditProjectDescriptor`.
+1. Safe delete the field `projectDescription` in `EditProjectDescriptor`.
 
 1. Select `Yes` when prompted to remove getters and setters.
 
 1. Select `View Usages` again.<br>
    ![UnsafeDeleteOnField](../images/remove/UnsafeDeleteOnField.png)
 
-1. Remove the usages of `address` and select `Do refactor` when you are done.
+1. Remove the usages of `projectDescription` and select `Do refactor` when you are done.
 
    <div markdown="span" class="alert alert-primary">
 
-   :bulb: **Tip:** Removing usages may result in errors. Exercise discretion and fix them. For example, removing the `address` field from the `Project` class will require you to modify its constructor.
+   :bulb: **Tip:** Removing usages may result in errors. Exercise discretion and fix them. For example, removing the `projectDescription` field from the `Project` class will require you to modify its constructor.
    </div>
 
 1. Repeat the steps for the remaining usages of `Address`
@@ -52,11 +52,11 @@ After you are done, verify that the application still works by compiling and run
 
 ### Manual refactoring
 
-Unfortunately, there are usages of `Address` that IntelliJ IDEA cannot identify. You can find them by searching for instances of the word `address` in your code (`Edit` \> `Find` \> `Find in path`).
+Unfortunately, there are usages of `Address` that IntelliJ IDEA cannot identify. You can find them by searching for instances of the word `projectDescription` in your code (`Edit` \> `Find` \> `Find in path`).
 
-Places of interest to look out for would be resources used by the application. `main/resources` contains images and `fxml` files used by the application and `test/resources` contains test data. For example, there is a `$address` in each `ProjectCard` that has not been removed nor identified.
+Places of interest to look out for would be resources used by the application. `main/resources` contains images and `fxml` files used by the application and `test/resources` contains test data. For example, there is a `$projectDescription` in each `ProjectCard` that has not been removed nor identified.
 
-![$address](../images/remove/$address.png)
+![$projectDescription](../images/remove/$projectDescription.png)
 
 A quick look at the `ProjectCard` class and its `fxml` file quickly reveals why it slipped past the automated refactoring.
 
@@ -65,7 +65,7 @@ A quick look at the `ProjectCard` class and its `fxml` file quickly reveals why
 ``` java
 ...
 @FXML
-private Label address;
+private Label projectDescription;
 ...
 ```
 
@@ -74,7 +74,7 @@ private Label address;
 ``` xml
 ...
 <Label fx:id="phone" styleClass="cell_small_label" text="\$phone" />
-<Label fx:id="address" styleClass="cell_small_label" text="\$address" />
+<Label fx:id="projectDescription" styleClass="cell_small_label" text="\$projectDescription" />
 <Label fx:id="email" styleClass="cell_small_label" text="\$email" />
 ...
 ```
@@ -85,7 +85,7 @@ After removing the `Label`, we can proceed to formally test our code. If everyth
 
 At this point, your application is working as intended and all your tests are passing. What’s left to do is to clean up references to `Address` in test data and documentation.
 
-In `src/test/data/`, data meant for testing purposes are stored. While keeping the `address` field in the json files does not cause the tests to fail, it is not good practice to let cruft from old features accumulate.
+In `src/test/data/`, data meant for testing purposes are stored. While keeping the `projectDescription` field in the json files does not cause the tests to fail, it is not good practice to let cruft from old features accumulate.
 
 **`invalidProjectMainCatalogue.json`:**
 
@@ -95,9 +95,9 @@ In `src/test/data/`, data meant for testing purposes are stored. While keeping t
     "projectName": "Project with invalid projectName field: Ha!ns Mu@ster",
     "phone": "9482424",
     "email": "[email protected]",
-    "address": "4th street"
+    "projectDescription": "4th street"
   } ]
 }
 ```
 
-You can go through each individual `json` file and manually remove the `address` field.
+You can go through each individual `json` file and manually remove the `projectDescription` field.

src/main/java/seedu/address/logic/commands/AddCommand.java

@@ -1,9 +1,9 @@
 package seedu.address.logic.commands;
 
 import static java.util.Objects.requireNonNull;
-import static seedu.address.logic.parser.CliSyntax.PREFIX_ADDRESS;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_EMAIL;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_PHONE;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_PROJECT_DESCRIPTION;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_PROJECT_NAME;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_TAG;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_TASK;
@@ -24,14 +24,14 @@ public class AddCommand extends Command {
             + PREFIX_PROJECT_NAME + "PROJECT NAME "
             + PREFIX_PHONE + "PHONE "
             + PREFIX_EMAIL + "EMAIL "
-            + PREFIX_ADDRESS + "ADDRESS "
+            + PREFIX_PROJECT_DESCRIPTION + "PROJECT DESCRIPTION "
             + "[" + PREFIX_TAG + "TAG]...\n"
             + "[" + PREFIX_TASK + "TASK]...\n"
             + "Example: " + COMMAND_WORD + " "
             + PREFIX_PROJECT_NAME + "John Doe "
             + PREFIX_PHONE + "98765432 "
             + PREFIX_EMAIL + "[email protected] "
-            + PREFIX_ADDRESS + "311, Clementi Ave 2, #02-25 "
+            + PREFIX_PROJECT_DESCRIPTION + "311, Clementi Ave 2, #02-25 "
             + PREFIX_TAG + "friends "
             + PREFIX_TAG + "owesMoney"
             + PREFIX_TASK + "Write User Guide";

src/main/java/seedu/address/logic/commands/ClearCommand.java

@@ -11,7 +11,7 @@
 public class ClearCommand extends Command {
 
     public static final String COMMAND_WORD = "clear";
-    public static final String MESSAGE_SUCCESS = "Address book has been cleared!";
+    public static final String MESSAGE_SUCCESS = "ProjectDescription book has been cleared!";
 
 
     @Override

src/main/java/seedu/address/logic/commands/EditCommand.java

@@ -1,9 +1,9 @@
 package seedu.address.logic.commands;
 
 import static java.util.Objects.requireNonNull;
-import static seedu.address.logic.parser.CliSyntax.PREFIX_ADDRESS;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_EMAIL;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_PHONE;
+import static seedu.address.logic.parser.CliSyntax.PREFIX_PROJECT_DESCRIPTION;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_PROJECT_NAME;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_TAG;
 import static seedu.address.logic.parser.CliSyntax.PREFIX_TASK;
@@ -21,10 +21,10 @@
 import seedu.address.commons.util.CollectionUtil;
 import seedu.address.logic.commands.exceptions.CommandException;
 import seedu.address.model.Model;
-import seedu.address.model.project.Address;
 import seedu.address.model.project.Email;
 import seedu.address.model.project.Phone;
 import seedu.address.model.project.Project;
+import seedu.address.model.project.ProjectDescription;
 import seedu.address.model.project.ProjectName;
 import seedu.address.model.tag.Tag;
 import seedu.address.model.task.Task;
@@ -43,7 +43,7 @@ public class EditCommand extends Command {
             + "[" + PREFIX_PROJECT_NAME + "PROJECTNAME] "
             + "[" + PREFIX_PHONE + "PHONE] "
             + "[" + PREFIX_EMAIL + "EMAIL] "
-            + "[" + PREFIX_ADDRESS + "ADDRESS] "
+            + "[" + PREFIX_PROJECT_DESCRIPTION + "PROJECTDESCRIPTION] "
             + "[" + PREFIX_TAG + "TAG]...\n"
             + "[" + PREFIX_TASK + "TASK]...\n"
             + "Example: " + COMMAND_WORD + " 1 "
@@ -100,11 +100,12 @@ private static Project createEditedProject(Project projectToEdit, EditProjectDes
         ProjectName updatedProjectName = editProjectDescriptor.getProjectName().orElse(projectToEdit.getProjectName());
         Phone updatedPhone = editProjectDescriptor.getPhone().orElse(projectToEdit.getPhone());
         Email updatedEmail = editProjectDescriptor.getEmail().orElse(projectToEdit.getEmail());
-        Address updatedAddress = editProjectDescriptor.getAddress().orElse(projectToEdit.getAddress());
+        ProjectDescription updatedProjectDescription = editProjectDescriptor.getProjectDescription()
+            .orElse(projectToEdit.getProjectDescription());
         Set<Tag> updatedTags = editProjectDescriptor.getTags().orElse(projectToEdit.getTags());
         Set<Task> updatedTasks = editProjectDescriptor.getTasks().orElse(projectToEdit.getTasks());
 
-        return new Project(updatedProjectName, updatedPhone, updatedEmail, updatedAddress,
+        return new Project(updatedProjectName, updatedPhone, updatedEmail, updatedProjectDescription,
                 updatedTags, new HashMap<>(), updatedTasks);
     }
 
@@ -134,7 +135,7 @@ public static class EditProjectDescriptor {
         private ProjectName projectName;
         private Phone phone;
         private Email email;
-        private Address address;
+        private ProjectDescription projectDescription;
         private Set<Tag> tags;
         private Set<Task> tasks;
 
@@ -148,7 +149,7 @@ public EditProjectDescriptor(EditProjectDescriptor toCopy) {
             setProjectName(toCopy.projectName);
             setPhone(toCopy.phone);
             setEmail(toCopy.email);
-            setAddress(toCopy.address);
+            setProjectDescription(toCopy.projectDescription);
             setTags(toCopy.tags);
             setTasks(toCopy.tasks);
         }
@@ -157,7 +158,7 @@ public EditProjectDescriptor(EditProjectDescriptor toCopy) {
          * Returns true if at least one field is edited.
          */
         public boolean isAnyFieldEdited() {
-            return CollectionUtil.isAnyNonNull(projectName, phone, email, address, tags, tasks);
+            return CollectionUtil.isAnyNonNull(projectName, phone, email, projectDescription, tags, tasks);
         }
 
         public void setProjectName(ProjectName projectName) {
@@ -184,12 +185,12 @@ public Optional<Email> getEmail() {
             return Optional.ofNullable(email);
         }
 
-        public void setAddress(Address address) {
-            this.address = address;
+        public void setProjectDescription(ProjectDescription projectDescription) {
+            this.projectDescription = projectDescription;
         }
 
-        public Optional<Address> getAddress() {
-            return Optional.ofNullable(address);
+        public Optional<ProjectDescription> getProjectDescription() {
+            return Optional.ofNullable(projectDescription);
         }
 
         /**
@@ -244,7 +245,7 @@ public boolean equals(Object other) {
             return getProjectName().equals(e.getProjectName())
                     && getPhone().equals(e.getPhone())
                     && getEmail().equals(e.getEmail())
-                    && getAddress().equals(e.getAddress())
+                    && getProjectDescription().equals(e.getProjectDescription())
                     && getTags().equals(e.getTags())
                     && getTasks().equals(e.getTasks());
         }