Merge pull request nus-cs2103-AY2021S1#79 from khor-jingqian/find-and-list-routine

nicholasyeo · web-flow · commit 99adc01982e6 · 2020-10-21T00:31:01.000+08:00
Find and list Routine
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -1,3 +1,12 @@
+---
+layout: page
+title: User Guide
+---
+
+
+* Table of Contents
+{:toc}
+
 ## 1. Introduction
 
 fitNUS is tailored for **NUS students** that are interested in staying healthy and keeping fit. It is suitable for **all
@@ -137,12 +146,39 @@ Format: `routine_view INDEX`
 Examples:
 * `routine_view 2` Views routine with the index 2.
 
+##### Before input:
+
+![Routine View](./images/routine_view.png)
+
+
+#### After input:
+
+![Routine View After](./images/routine_view_after.png)
+
 #### 3.2.6 List routines : `routine_list`
 
 Lists out all the routines in fitNUS.
 
 Format: `routine_list`
 
+![Routine List](./images/routine_list.png)
+
+#### 3.2.7 Find routines : `find_routines`
+
+Finds all routines with matching keyword given.
+
+Format: `find_routines KEYWORD`
+
+Example:
+* `find_routines upper` Finds all routines with the keyword "upper" in its name, regardless of uppercase or lowercase.
+
+##### Input:
+![Find Routines](./images/routine_find.png)
+
+##### Result:
+
+![Find Routines Result](./images/routine_find_after.png)
+
 ### 3.3 Lesson
 
 #### 3.3.1 Create new lesson : `lesson_add`
@@ -225,6 +261,10 @@ Deletes the routine or lesson scheduled on Monday, 1600-1800.
 
 ![Timetable Delete](./images/timetable_delete.png)
 
+### BMI
+
+#### Add or edit height : `height`
+
 #### 3.4.4 View timetable : `timetable_view`
 
 Views the timetable in fitNUS.
@@ -297,27 +337,50 @@ _{explain the feature here}_
 
 ## 4. Command summary
 
+### 4.1 Miscellaneous
+
+Action | Format |
+--------|-------|
+**Link to User Guide** | `help` 
+**Save and exit fitNUS** | `exit`
+
+### 4.2 Exercise 
 Action | Format | Examples
 --------|-------|-----------
-**Link to User Guide** | `help`
 **Create Exercise** | `exercise_add n/EXERCISE_NAME [t/TAG]` | `exercise_add n/Bench Press t/Upper`
 **Delete Exercise** | `exercise_delete INDEX` | `exercise_delete 1`
-**List Exercises** | `list_exercises`
 **Find Exercises** | `find_exercises KEYWORD [MORE_KEYWORDS]` | `find_exercises Bench Press`
+**List Exercises** | `list_exercises`
+
+### 4.3 Routine 
+Action | Format | Examples
+--------|-------|-----------
 **Create Routine** | `routine_create r/ROUTINE_NAME` | `routine_create r/Leg Day Session`
 **Delete Routine** | `routine_delete INDEX` | `routine delete 10`
+**View Routine details** | `routine view INDEX` | `routine view 2`
 **Add Exercise to Routine** | `routine_add r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME` | `routine_add r/Leg Day Session e/Squats`
 **Delete Exercise from Routine** | `routine_delete_exercise r/NAME_OF_TARGET_ROUTINE e/EXERCISE_NAME` | `routine_delete_exercise r/Leg Day Session e/Squats`
-**View Routine details** | `routine view INDEX` | `routine view 2`
 **List Routines** | `routine list`
+
+### 4.4 Lesson
+Action | Format | Examples
+--------|-------|-----------
 **Create Lesson** | `lesson_add n/EXERCISE_NAME [t/TAG]` | `lesson_add n/CS2100 t/Thursday t/0900 t/1hours`
 **Delete Lesson** | `lesson_delete INDEX` | `lesson_delete 1`
 **List Lessons** | `list_lessons`
 **Find Lessons** | `find_lessons KEYWORD [MORE_KEYWORDS]` | `find_lessons CS2103T`
+
+### 4.5 Timetable
+Action | Format | Examples
+--------|-------|-----------
 **Add Routine to Timetable** | `timetable_add_routine r/ROUTINE_NAME d/DAY_OF_THE_WEEK T/TIMING` | `timetable_add_routine add r/Leg Day Session d/Monday T/1600-1800`
 **Add Lesson to Timetable** | `timetable_add_lesson n/LESSON_NAME d/DAY_OF_THE_WEEK T/TIMING` | `timetable_add_lesson n/CS2103T d/Monday T/1200-1400` 
 **Delete Routine or Lesson from Timetable** | `timetable_delete d/DAY_OF_THE_WEEK T/TIMING` | `timetable_delete d/Monday T/1600-1800`
 **View timetable** | `timetable view`
+
+### 4.6 BMI
+Action | Format | Examples
+--------|-------|-----------
 **Add or edit Height** | `height h/HEIGHT` | `height h/170`
 **Add or edit Weight** | `weight w/WEIGHT` | `weight w/70`
 **View BMI** | `bmi`
diff --git a/docs/images/routine_find.png b/docs/images/routine_find.png
diff --git a/docs/images/routine_find_after.png b/docs/images/routine_find_after.png
diff --git a/docs/images/routine_list.png b/docs/images/routine_list.png
diff --git a/docs/images/routine_view.png b/docs/images/routine_view.png
diff --git a/docs/images/routine_view_after.png b/docs/images/routine_view_after.png
diff --git a/src/main/java/seedu/address/commons/core/Messages.java b/src/main/java/seedu/address/commons/core/Messages.java
@@ -11,6 +11,7 @@ public class Messages {
     public static final String MESSAGE_INVALID_EXERCISE_DISPLAYED_INDEX = "The exercise index provided is invalid";
     public static final String MESSAGE_INVALID_LESSON_DISPLAYED_INDEX = "The lesson index provided is invalid";
     public static final String MESSAGE_PERSONS_LISTED_OVERVIEW = "%1$d persons listed!";
+    public static final String MESSAGE_ROUTINES_LISTED_OVERVIEW = "%1$d routines listed!";
     public static final String MESSAGE_EXERCISES_LISTED_OVERVIEW = "%1$d exercises listed!";
     public static final String MESSAGE_LESSONS_LISTED_OVERVIEW = "%1$d lessons listed!";
     public static final String MESSAGE_INVALID_ROUTINE_DISPLAYED_INDEX = "The routine index provided is invalid";
diff --git a/src/main/java/seedu/address/logic/commands/routines/FindRoutinesCommand.java b/src/main/java/seedu/address/logic/commands/routines/FindRoutinesCommand.java
@@ -0,0 +1,44 @@
+package seedu.address.logic.commands.routines;
+
+import static java.util.Objects.requireNonNull;
+
+import seedu.address.commons.core.Messages;
+import seedu.address.logic.commands.Command;
+import seedu.address.logic.commands.CommandResult;
+import seedu.address.model.Model;
+import seedu.address.model.person.RoutineNameContainsKeywordsPredicate;
+
+/**
+ * Finds and lists all routines in fitNUS whose name contains any of the argument keywords.
+ * Keyword matching is case insensitive.
+ */
+public class FindRoutinesCommand extends Command {
+
+    public static final String COMMAND_WORD = "find_routines";
+
+    public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all routines whose names contain any of "
+            + "the specified keywords (case-insensitive) and displays them as a list with index numbers.\n"
+            + "Parameters: KEYWORD [MORE_KEYWORDS]...\n"
+            + "Example: " + COMMAND_WORD + " Lower";
+
+    private final RoutineNameContainsKeywordsPredicate predicate;
+
+    public FindRoutinesCommand(RoutineNameContainsKeywordsPredicate predicate) {
+        this.predicate = predicate;
+    }
+
+    @Override
+    public CommandResult execute(Model model) {
+        requireNonNull(model);
+        model.updateFilteredRoutineList(predicate);
+        return new CommandResult(
+                String.format(Messages.MESSAGE_ROUTINES_LISTED_OVERVIEW, model.getFilteredRoutineList().size()));
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        return other == this // short circuit if same object
+                || (other instanceof FindRoutinesCommand // instanceof handles nulls
+                && predicate.equals(((FindRoutinesCommand) other).predicate)); // state check
+    }
+}
diff --git a/src/main/java/seedu/address/logic/commands/routines/RoutineListCommand.java b/src/main/java/seedu/address/logic/commands/routines/RoutineListCommand.java
@@ -11,7 +11,7 @@
  */
 public class RoutineListCommand extends Command {
 
-    public static final String COMMAND_WORD = "routine_list";
+    public static final String COMMAND_WORD = "list_routines";
 
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Shows all routines in fitNUS.\n"
             + "Example: " + COMMAND_WORD;
@@ -21,10 +21,7 @@ public class RoutineListCommand extends Command {
     @Override
     public CommandResult execute(Model model) {
 
-        String routineList = model.listRoutines();
-        model.updateFilteredExerciseList(unused -> false);
-        model.updateFilteredPersonList(unused -> false);
         model.updateFilteredRoutineList(PREDICATE_SHOW_ALL_ROUTINES);
-        return new CommandResult(SHOWING_LIST_MESSAGE + "\n" + routineList);
+        return new CommandResult(SHOWING_LIST_MESSAGE);
     }
 }
diff --git a/src/main/java/seedu/address/logic/commands/routines/RoutineViewCommand.java b/src/main/java/seedu/address/logic/commands/routines/RoutineViewCommand.java
@@ -25,7 +25,7 @@ public class RoutineViewCommand extends Command {
             + "Example: " + COMMAND_WORD + " "
             + "3 ";
 
-    public static final String MESSAGE_SUCCESS = "Routine requested: %1$s";
+    public static final String MESSAGE_SUCCESS = "Routine requested:";
     public static final String MESSAGE_OUT_OF_BOUNDS_ROUTINE = "This routine index is out of bounds!";
 
     private final Index toView;
@@ -48,7 +48,8 @@ public CommandResult execute(Model model) throws CommandException {
         }
 
         Routine routineToView = lastShownList.get(toView.getZeroBased());
-        return new CommandResult(String.format(MESSAGE_SUCCESS, routineToView));
+        model.viewRoutine(routineToView);
+        return new CommandResult(String.format(MESSAGE_SUCCESS));
     }
 
     @Override
diff --git a/src/main/java/seedu/address/logic/parser/AddressBookParser.java b/src/main/java/seedu/address/logic/parser/AddressBookParser.java
@@ -28,13 +28,15 @@
 import seedu.address.logic.commands.TimetableAddLessonCommand;
 import seedu.address.logic.commands.TimetableAddRoutineCommand;
 import seedu.address.logic.commands.TimetableDeleteSlotCommand;
+import seedu.address.logic.commands.routines.FindRoutinesCommand;
 import seedu.address.logic.commands.routines.RoutineAddExerciseCommand;
 import seedu.address.logic.commands.routines.RoutineCreateCommand;
 import seedu.address.logic.commands.routines.RoutineDeleteCommand;
 import seedu.address.logic.commands.routines.RoutineDeleteExerciseCommand;
 import seedu.address.logic.commands.routines.RoutineListCommand;
 import seedu.address.logic.commands.routines.RoutineViewCommand;
 import seedu.address.logic.parser.exceptions.ParseException;
+import seedu.address.logic.parser.routines.FindRoutinesCommandParser;
 import seedu.address.logic.parser.routines.RoutineAddExerciseCommandParser;
 import seedu.address.logic.parser.routines.RoutineCreateCommandParser;
 import seedu.address.logic.parser.routines.RoutineDeleteCommandParser;
@@ -150,6 +152,9 @@ public Command parseCommand(String userInput) throws ParseException {
         case RoutineDeleteExerciseCommand.COMMAND_WORD:
             return new RoutineDeleteExerciseCommandParser().parse(arguments);
 
+        case FindRoutinesCommand.COMMAND_WORD:
+            return new FindRoutinesCommandParser().parse(arguments);
+
         default:
             throw new ParseException(MESSAGE_UNKNOWN_COMMAND);
         }
diff --git a/src/main/java/seedu/address/logic/parser/routines/FindRoutinesCommandParser.java b/src/main/java/seedu/address/logic/parser/routines/FindRoutinesCommandParser.java
@@ -0,0 +1,35 @@
+package seedu.address.logic.parser.routines;
+
+import static seedu.address.commons.core.Messages.MESSAGE_INVALID_COMMAND_FORMAT;
+
+import java.util.Arrays;
+
+import seedu.address.logic.commands.FindExercisesCommand;
+import seedu.address.logic.commands.routines.FindRoutinesCommand;
+import seedu.address.logic.parser.Parser;
+import seedu.address.logic.parser.exceptions.ParseException;
+import seedu.address.model.person.RoutineNameContainsKeywordsPredicate;
+
+/**
+ * Parses input arguments and creates a new FindExercisesCommand object
+ */
+public class FindRoutinesCommandParser implements Parser<FindRoutinesCommand> {
+
+    /**
+     * Parses the given {@code String} of arguments in the context of the FindExercisesCommand
+     * and returns a FindExercisesCommand object for execution.
+     * @throws ParseException if the user input does not conform the expected format
+     */
+    public FindRoutinesCommand parse(String args) throws ParseException {
+        String trimmedArgs = args.trim();
+        if (trimmedArgs.isEmpty()) {
+            throw new ParseException(
+                    String.format(MESSAGE_INVALID_COMMAND_FORMAT, FindExercisesCommand.MESSAGE_USAGE));
+        }
+
+        String[] nameKeywords = trimmedArgs.split("\\s+");
+
+        return new FindRoutinesCommand(new RoutineNameContainsKeywordsPredicate(Arrays.asList(nameKeywords)));
+    }
+
+}
diff --git a/src/main/java/seedu/address/model/Model.java b/src/main/java/seedu/address/model/Model.java
@@ -236,4 +236,6 @@ public interface Model {
      * {@code exercise} must already exist within fitNUS.
      */
     void deleteExerciseToRoutine(Routine routine, Exercise exercise);
+
+    void viewRoutine(Routine routineToView);
 }
diff --git a/src/main/java/seedu/address/model/ModelManager.java b/src/main/java/seedu/address/model/ModelManager.java
@@ -4,6 +4,7 @@
 import static seedu.address.commons.util.CollectionUtil.requireAllNonNull;
 
 import java.nio.file.Path;
+import java.util.Arrays;
 import java.util.function.Predicate;
 import java.util.logging.Logger;
 
@@ -15,6 +16,7 @@
 import seedu.address.model.person.Lesson;
 import seedu.address.model.person.Person;
 import seedu.address.model.person.Routine;
+import seedu.address.model.person.RoutineNameContainsKeywordsPredicate;
 import seedu.address.model.person.Slot;
 
 /**
@@ -244,6 +246,15 @@ public Routine retrieveRoutine(Routine routine) {
         return addressBook.retrieveRoutine(routine);
     }
 
+    @Override
+    public void viewRoutine(Routine r) {
+        String argument = r.getName().fullName;
+        String[] nameKeywords = argument.split("\\s+");
+        filteredRoutine.setPredicate(
+                new RoutineNameContainsKeywordsPredicate(Arrays.asList(nameKeywords)
+        ));
+    }
+
     //=========== Filtered Person List Accessors =============================================================
     /**
      * Returns an unmodifiable view of the list of {@code Person} backed by the internal list of
diff --git a/src/main/java/seedu/address/model/person/RoutineNameContainsKeywordsPredicate.java b/src/main/java/seedu/address/model/person/RoutineNameContainsKeywordsPredicate.java
@@ -0,0 +1,31 @@
+package seedu.address.model.person;
+
+import java.util.List;
+import java.util.function.Predicate;
+
+import seedu.address.commons.util.StringUtil;
+
+/**
+ * Tests that a {@code Person}'s {@code Name} matches any of the keywords given.
+ */
+public class RoutineNameContainsKeywordsPredicate implements Predicate<Routine> {
+    private final List<String> keywords;
+
+    public RoutineNameContainsKeywordsPredicate(List<String> keywords) {
+        this.keywords = keywords;
+    }
+
+    @Override
+    public boolean test(Routine routine) {
+        return keywords.stream()
+                .anyMatch(keyword -> StringUtil.containsWordIgnoreCase(routine.getName().fullName, keyword));
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        return other == this // short circuit if same object
+                || (other instanceof RoutineNameContainsKeywordsPredicate // instanceof handles nulls
+                && keywords.equals(((RoutineNameContainsKeywordsPredicate) other).keywords)); // state check
+    }
+
+}
diff --git a/src/main/java/seedu/address/model/person/UniqueRoutineList.java b/src/main/java/seedu/address/model/person/UniqueRoutineList.java
@@ -66,10 +66,12 @@ public void addExercise(Routine r, Exercise exercise) {
             for (Routine routine : internalList) {
                 if (routine.isSameActivity(r)) {
                     Set<Exercise> routineExercises = routine.getExercises();
+                    internalList.remove(routine);
                     if (routineExercises.contains(exercise)) {
                         throw new DuplicateExerciseException();
                     }
                     routine.addExercise(exercise);
+                    internalList.add(routine);
                     break;
                 }
             }
@@ -225,7 +227,9 @@ public void deleteExerciseFromRoutine(Routine retrievedRoutine, Exercise retriev
         } else {
             for (Routine routine : internalList) {
                 if (routine.isSameActivity(retrievedRoutine)) {
+                    internalList.remove(routine);
                     routine.deleteExercise(retrievedExercise);
+                    internalList.add(routine);
                     break;
                 }
             }
diff --git a/src/test/java/seedu/address/logic/commands/AddCommandTest.java b/src/test/java/seedu/address/logic/commands/AddCommandTest.java
@@ -252,6 +252,11 @@ public void deleteExerciseToRoutine(Routine routine, Exercise exercise) {
             throw new AssertionError("This method should not be called.");
         }
 
+        @Override
+        public void viewRoutine(Routine routineToView) {
+            throw new AssertionError("This method should not be called.");
+        }
+
         @Override
         public ObservableList<Person> getFilteredPersonList() {
             throw new AssertionError("This method should not be called.");

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ public class RoutineViewCommand extends Command {`
`25`	`25`	`+ "Example: " + COMMAND_WORD + " "`
`26`	`26`	`+ "3 ";`
`27`	`27`
`28`		`- public static final String MESSAGE_SUCCESS = "Routine requested: %1$s";`
	`28`	`+ public static final String MESSAGE_SUCCESS = "Routine requested:";`
`29`	`29`	`public static final String MESSAGE_OUT_OF_BOUNDS_ROUTINE = "This routine index is out of bounds!";`
`30`	`30`
`31`	`31`	`private final Index toView;`
`@@ -48,7 +48,8 @@ public CommandResult execute(Model model) throws CommandException {`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`Routine routineToView = lastShownList.get(toView.getZeroBased());`
`51`		`- return new CommandResult(String.format(MESSAGE_SUCCESS, routineToView));`
	`51`	`+ model.viewRoutine(routineToView);`
	`52`	`+ return new CommandResult(String.format(MESSAGE_SUCCESS));`
`52`	`53`	`}`
`53`	`54`
`54`	`55`	`@Override`