Merge pull request #51 from schrom01/feature_taskList_m2

TaskListModel

src/main/java/ch/zhaw/gartenverwaltung/Config.java

@@ -0,0 +1,19 @@
+package ch.zhaw.gartenverwaltung;
+
+import ch.zhaw.gartenverwaltung.types.HardinessZone;
+
+public class Config {
+    private static HardinessZone currentHardinessZone;
+
+    static {
+        currentHardinessZone = HardinessZone.ZONE_8A;
+    }
+
+    public static HardinessZone getCurrentHardinessZone() {
+        return currentHardinessZone;
+    }
+
+    public static void setCurrentHardinessZone(HardinessZone currentHardinessZone) {
+        Config.currentHardinessZone = currentHardinessZone;
+    }
+}

src/main/java/ch/zhaw/gartenverwaltung/io/JsonTaskDatabase.java

@@ -1,5 +1,6 @@
 package ch.zhaw.gartenverwaltung.io;
 
+import ch.zhaw.gartenverwaltung.types.Crop;
 import ch.zhaw.gartenverwaltung.types.Task;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
@@ -51,6 +52,31 @@ public class JsonTaskDatabase implements TaskDatabase{
         return taskMap.values().stream().filter(task -> task.isInTimePeriode(start, end)).toList();
     }
 
+    /**
+     * Method get all Tasks for a specific Crop
+     * @param cropId the cropId
+     * @return List of Tasks for given Crop
+     */
+    @Override
+    public List<Task> getTaskForCrop(long cropId) throws IOException {
+        if(taskMap.isEmpty()) {
+            loadTaskListFromFile();
+        }
+        return taskMap.values().stream().filter(task -> task.getCropId() == cropId).toList();
+    }
+
+    /**
+     * Method remove all Tasks for a specific Crop
+     * @param cropId the crop
+     */
+    @Override
+    public void removeTasksForCrop(long cropId) throws IOException {
+        if(taskMap.isEmpty()) {
+            loadTaskListFromFile();
+        }
+        taskMap.values().removeIf(task -> task.getCropId() == cropId);
+    }
+
     /**
      * If no data is currently loaded, data is loaded from {@link #dataSource}.
      * If the {@link Task} has an id than the task is added to the {@link #taskMap}

src/main/java/ch/zhaw/gartenverwaltung/io/TaskDatabase.java

@@ -1,5 +1,6 @@
 package ch.zhaw.gartenverwaltung.io;
 
+import ch.zhaw.gartenverwaltung.types.Crop;
 import ch.zhaw.gartenverwaltung.types.HardinessZone;
 import ch.zhaw.gartenverwaltung.types.Plant;
 import ch.zhaw.gartenverwaltung.types.Task;
@@ -24,6 +25,21 @@ public interface TaskDatabase {
      */
     List<Task> getTaskList(LocalDate start, LocalDate end) throws IOException;
 
+    /**
+     * Method get all Tasks for a specific Crop
+     * @param cropId the cropId
+     * @return List of Tasks for given Crop
+     * @throws IOException If the database cannot be accessed
+     */
+    List<Task> getTaskForCrop(long cropId) throws IOException;
+
+    /**
+     * Method remove all Tasks for a specific Crop
+     * @param cropId the cropId
+     * @throws IOException If the database cannot be accessed
+     */
+    void removeTasksForCrop(long cropId) throws IOException;
+
     /**
      * Saves the {@link Task} in the Cache.
      *

src/main/java/ch/zhaw/gartenverwaltung/taskList/PlantNotFoundException.java

@@ -0,0 +1,7 @@
+package ch.zhaw.gartenverwaltung.taskList;
+
+public class PlantNotFoundException extends Exception {
+    public PlantNotFoundException() {
+        super("The selected Plant was not found in Database!");
+    }
+}

src/main/java/ch/zhaw/gartenverwaltung/taskList/TaskListModel.java

@@ -0,0 +1,188 @@
+package ch.zhaw.gartenverwaltung.taskList;
+
+import ch.zhaw.gartenverwaltung.Config;
+import ch.zhaw.gartenverwaltung.io.HardinessZoneNotSetException;
+import ch.zhaw.gartenverwaltung.io.JsonTaskDatabase;
+import ch.zhaw.gartenverwaltung.io.PlantDatabase;
+import ch.zhaw.gartenverwaltung.io.TaskDatabase;
+import ch.zhaw.gartenverwaltung.types.*;
+
+import java.io.IOException;
+import java.time.LocalDate;
+import java.util.ArrayList;
+import java.util.Comparator;
+import java.util.List;
+import java.util.function.Predicate;
+import java.util.stream.Collectors;
+
+public class TaskListModel {
+    private TaskDatabase taskDatabase;
+    private PlantDatabase plantDatabase;
+
+    /**
+     * Comparators to create sorted Task List
+     */
+    static final Comparator<Task> sortByStartDate = Comparator.comparing(Task::getStartDate);
+
+    public TaskListModel(){
+        taskDatabase = new JsonTaskDatabase();
+    }
+
+    /**
+     * Constructor to create Database Objects.
+     */
+    public TaskListModel(TaskDatabase taskDatabase, PlantDatabase plantDatabase) {
+        this.taskDatabase = taskDatabase;
+        this.plantDatabase = plantDatabase;
+    }
+
+    /**
+     * Method to save a new Task to Task Database
+     * @param task the Task to save
+     * @throws IOException If the database cannot be accessed
+     */
+    public void addTask(Task task) throws IOException {
+        taskDatabase.saveTask(task);
+    }
+
+    /**
+     * Method to add all Tasks for a new crop
+     * @param crop the crop which is added
+     * @throws PlantNotFoundException if the plantId in the crop doesn't exist in Plant Database
+     * @throws HardinessZoneNotSetException If there is no Hardiness Zone Set in Plant Database
+     * @throws IOException If the database cannot be accessed
+     */
+    public void planTasksForCrop(Crop crop) throws PlantNotFoundException, HardinessZoneNotSetException, IOException {
+        Plant plant = plantDatabase.getPlantById(Config.getCurrentHardinessZone(), crop.getPlantId()).orElseThrow(PlantNotFoundException::new);
+        for (GrowthPhase growthPhase : plant.lifecycle()) {
+            for (TaskTemplate taskTemplate : growthPhase.taskTemplates()) {
+                addTask(taskTemplate.generateTask(crop.getStartDate(), crop.getCropId().orElse(0L)));
+            }
+        }
+    }
+
+    /**
+     * Method to remove all Tasks for a specific Crop
+     * @param cropId The crop which is removed
+     * @throws IOException If the database cannot be accessed
+     */
+    public void removeTasksForCrop(long cropId) throws IOException {
+        taskDatabase.removeTasksForCrop(cropId);
+    }
+
+    /**
+     * Method to remove a Task from Database
+     * @param task the Task to remove
+     * @throws IOException If the database cannot be accessed
+     */
+    public void removeTask(Task task) throws IOException {
+        taskDatabase.removeTask(task);
+    }
+
+    private List<Task> filterListByCrop(List<Task> taskList, Long cropId) {
+        return taskList.stream().filter(task -> task.getCropId() == cropId).collect(Collectors.toList());
+    }
+
+    /**
+     * Method to get all Tasks
+     * @return List of all Tasks
+     * @throws IOException If the database cannot be accessed
+     */
+    public List<Task> getTaskList() throws IOException {
+        return getFilteredTaskList(LocalDate.MIN, LocalDate.MAX);
+    }
+
+    /**
+     * Method to get all Tasks for specific Crop
+     * @return List of all Tasks for with given CropID
+     * @throws IOException If the database cannot be accessed
+     */
+    public List<Task> getTaskListForCrop(Long cropId) throws IOException {
+        return filterListByCrop(getTaskList(), cropId);
+    }
+
+    /**
+     * Method to get all Tasks which are today or in future
+     * @return List of Tasks
+     * @throws IOException If the database cannot be accessed
+     */
+    public List<Task> getFutureTasks() throws IOException {
+        return getFilteredTaskList(LocalDate.now(), LocalDate.MAX);
+    }
+
+    /**
+     * Method to get all Tasks which are today or in future for specific Crop
+     * @return List of Tasks with given crop ID
+     * @throws IOException If the database cannot be accessed
+     */
+    public List<Task> getFutureTasksForCrop(Long cropId) throws IOException {
+        return filterListByCrop(getFutureTasks(), cropId);
+    }
+
+    /**
+     * Method to get all Tasks which are today or in past
+     * @return List of Tasks
+     * @throws IOException If the database cannot be accessed
+     */
+    public List<Task> getPastTasks() throws IOException {
+        return getFilteredTaskList(LocalDate.MIN, LocalDate.now());
+    }
+
+    /**
+     * Method to get all Tasks which are today or in past for specifc crop
+     * @return List of Tasks with given grop id
+     * @throws IOException If the database cannot be accessed
+     */
+    public List<Task> getPastTasksForCrop(Long cropId) throws IOException {
+        return filterListByCrop(getPastTasks(), cropId);
+    }
+
+    /**
+     * Method to get an List of 7 Tasklists for the next 7 days. Index 0 is Tasklist for Today.
+     * @return List with length 7 (List<List<Task>>)
+     * @throws IOException If the database cannot be accessed
+     */
+    public List<List<Task>> getTasksUpcomingWeek() throws IOException {
+        List<List<Task>> dayTaskList = new ArrayList<>();
+        for(int i = 0; i < 7; i++) {
+            LocalDate date = LocalDate.now().plusDays(i);
+            dayTaskList.add(taskDatabase.getTaskList(date, date));
+        }
+        return dayTaskList;
+    }
+
+    /**
+     * Method to get an List of 7 Tasklists for the next 7 days. (Filtered Index 0 is Tasklist for Today.
+     * @return List with length 7 (List<List<Task>>)
+     * @throws IOException If the database cannot be accessed
+     */
+    public List<List<Task>> getTasksUpcomingWeekForCrop(Long cropId) throws IOException {
+        List<List<Task>> dayTaskList = new ArrayList<>();
+        for(int i = 0; i < 7; i++) {
+            LocalDate date = LocalDate.now().plusDays(i);
+            dayTaskList.add(filterListByCrop(taskDatabase.getTaskList(date, date), cropId));
+        }
+        return dayTaskList;
+    }
+
+    /**
+     * Method to get Tasklist filtered by date.
+     * @param start the start date for the filter
+     * @param end the end date for the filter
+     * @return List of Tasks matched by the filter
+     * @throws IOException If the database cannot be accessed
+     */
+    public List<Task> getFilteredTaskList(LocalDate start, LocalDate end) throws IOException {
+        return getSortedTaskList(taskDatabase.getTaskList(start, end), sortByStartDate);
+    }
+
+    /**
+     * Method to sort a Tasklist by a given Comparator
+     * @param taskList The Tasklist to sort
+     * @param comparator the comparator to sort
+     * @return a sorted coppy of the given Tasklist
+     */
+    private List<Task> getSortedTaskList(List<Task> taskList, Comparator<Task> comparator) {
+        return taskList.stream().sorted(comparator).collect(Collectors.toList());
+    }
+}

src/main/java/ch/zhaw/gartenverwaltung/types/Task.java

@@ -15,29 +15,33 @@ public class Task {
     private final LocalDate startDate;
     private Integer interval;
     private LocalDate endDate;
+    private long cropId;
 
     /**
      * default constructor
      * (used by Json deserializer)
      */
-    public Task(){
+    public Task(long cropId){
         name= "";
         description= "";
         startDate = LocalDate.now();
+        this.cropId = cropId;
     }
 
-    public Task(String name, String description, LocalDate startDate) {
+    public Task(String name, String description, LocalDate startDate, long cropId) {
         this.name = name;
         this.description = description;
         this.startDate = startDate;
+        this.cropId = cropId;
     }
 
-    public Task(String name, String description, LocalDate startDate, LocalDate endDate, int interval) {
+    public Task(String name, String description, LocalDate startDate, LocalDate endDate, int interval, long cropId) {
         this.name = name;
         this.description = description;
         this.startDate = startDate;
         this.endDate = endDate;
         this.interval = interval;
+        this.cropId = cropId;
     }
 
     // Builder-pattern-style setters
@@ -55,10 +59,7 @@ public class Task {
     }
 
     public boolean isInTimePeriode(LocalDate searchStartDate, LocalDate searchEndDate){
-        if(startDate.isAfter(searchStartDate) &&startDate.isBefore(searchEndDate)){
-            return true;
-        }
-        return false;
+        return startDate.isAfter(searchStartDate) && startDate.isBefore(searchEndDate);
     }
 
     // Getters
@@ -66,6 +67,7 @@ public class Task {
     public String getName() { return name; }
     public String getDescription() { return description; }
     public LocalDate getStartDate() { return startDate; }
+    public long getCropId() { return cropId; }
 
     public Optional<Integer> getInterval() {
         return Optional.ofNullable(interval);

src/main/java/ch/zhaw/gartenverwaltung/types/TaskTemplate.java

@@ -44,8 +44,8 @@ public class TaskTemplate {
         this.relativeStartDate = relativeStartDate;
     }
 
-    public Task generateTask(LocalDate realStartDate) {
-        Task task = new Task(name, description, realStartDate.plusDays(relativeStartDate));
+    public Task generateTask(LocalDate realStartDate, long cropId) {
+        Task task = new Task(name, description, realStartDate.plusDays(relativeStartDate), cropId);
         if (relativeEndDate != null) {
             task.withEndDate(realStartDate.plusDays(relativeEndDate));
         }

src/main/resources/ch/zhaw/gartenverwaltung/io/taskdb.json

@@ -5,7 +5,8 @@
   "description": "Plant the seeds, crops in de bed.",
   "startDate" : "2022-05-01",
   "endDate" : "2022-05-01",
-  "interval" : 0
+  "interval" : 0,
+    "cropID" : 0
   },
   {
     "id" : 2,
@@ -13,7 +14,8 @@
     "description": "water the plant, so that the soil is wet around the plant.",
     "startDate" : "2022-05-01",
     "endDate" : "2022-09-01",
-    "interval" : 2
+    "interval" : 2,
+    "cropID" : 0
   },
   {
     "id" : 3,
@@ -21,7 +23,8 @@
     "description": "The fertilizer has to be mixed with water. Then fertilize the plants soil with the mixture",
     "startDate" : "2022-06-01",
     "endDate" : "2022-08-01",
-    "interval" : 28
+    "interval" : 28,
+    "cropID" : 0
   },
   {
     "id" : 4,
@@ -29,7 +32,8 @@
     "description": "Take a big enough coverage for the plants. Cover the whole plant with a bit space between the plant and the coverage",
     "startDate" : "2022-07-01",
     "endDate" : "2022-07-01",
-    "interval" : 0
+    "interval" : 0,
+    "cropID" : 0
   },
   {
     "id" : 5,
@@ -37,7 +41,8 @@
     "description": "Look for pest or illness at the leaves of the plant. Check the soil around the plant, if the roots are enough covered with soil",
     "startDate" : "2022-05-01",
     "endDate" : "2022-09-01",
-    "interval" : 5
+    "interval" : 5,
+    "cropID" : 0
   },
   {
     "id" : 6,
@@ -45,6 +50,7 @@
     "description": "Pull the ripe vegetables out from the soil. Clean them with clear, fresh water. ",
     "startDate" : "2022-09-01",
     "endDate" : "2022-09-01",
-    "interval" : 0
+    "interval" : 0,
+    "cropID" : 0
   }
 ]

src/test/java/ch/zhaw/gartenverwaltung/io/JsonTaskDatabaseTest.java

@@ -34,4 +34,14 @@ public class JsonTaskDatabaseTest {
         Assertions.assertTrue(taskList.size()>0);
         */
     }
+
+    @Test
+    void getTaskForCrop() {
+        // TODO implement Test
+    }
+
+    @Test
+    void removeTasksForCrop() {
+        // TODO implement Test
+    }
 }

src/test/java/ch/zhaw/gartenverwaltung/taskList/TaskListModelTest.java

@@ -0,0 +1,158 @@
+package ch.zhaw.gartenverwaltung.taskList;
+
+import ch.zhaw.gartenverwaltung.io.*;
+import ch.zhaw.gartenverwaltung.types.HardinessZone;
+import ch.zhaw.gartenverwaltung.types.Plant;
+import ch.zhaw.gartenverwaltung.types.Task;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+import java.time.LocalDate;
+import java.util.*;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.Mockito.*;
+
+class TaskListModelTest {
+    TaskDatabase taskDatabase;
+    PlantDatabase plantDatabase;
+    List<Task> exampleTaskList;
+    Map<Long, Plant> examplePlantMap;
+    TaskListModel model;
+
+    @BeforeEach
+    void setUp() throws IOException {
+        createExampleTaskList();
+        taskDatabase = mockTaskDatabase(exampleTaskList);
+        plantDatabase = mockPlantDatabase(examplePlantMap);
+        model = new TaskListModel(taskDatabase, plantDatabase);
+    }
+
+    private TaskDatabase mockTaskDatabase(List<Task> exampleTaskList) throws IOException {
+        TaskDatabase taskDatabase = mock(JsonTaskDatabase.class);
+        when(taskDatabase.getTaskList(LocalDate.MIN, LocalDate.MAX)).thenReturn(exampleTaskList);
+
+        when(taskDatabase.getTaskList(LocalDate.now(), LocalDate.MAX)).thenReturn((exampleTaskList.subList(1, 4)));
+
+        List<Task> pastTasks = new ArrayList<>();
+        pastTasks.add(exampleTaskList.get(0));
+        pastTasks.add(exampleTaskList.get(2));
+        pastTasks.add(exampleTaskList.get(4));
+        when(taskDatabase.getTaskList(LocalDate.MIN, LocalDate.now())).thenReturn(pastTasks);
+
+
+        when(taskDatabase.getTaskList(LocalDate.now(), LocalDate.now())).thenReturn(List.of(exampleTaskList.get(2)));
+        when(taskDatabase.getTaskList(LocalDate.now().plusDays(1L), LocalDate.now().plusDays(1L))).thenReturn(List.of(exampleTaskList.get(1)));
+        when(taskDatabase.getTaskList(LocalDate.now().plusDays(2L), LocalDate.now().plusDays(2L))).thenReturn(List.of());
+        when(taskDatabase.getTaskList(LocalDate.now().plusDays(3L), LocalDate.now().plusDays(3L))).thenReturn(List.of());
+        when(taskDatabase.getTaskList(LocalDate.now().plusDays(4L), LocalDate.now().plusDays(4L))).thenReturn(List.of());
+        when(taskDatabase.getTaskList(LocalDate.now().plusDays(5L), LocalDate.now().plusDays(5L))).thenReturn(List.of());
+        when(taskDatabase.getTaskList(LocalDate.now().plusDays(6L), LocalDate.now().plusDays(6L))).thenReturn(List.of());
+
+        return taskDatabase;
+    }
+
+    private PlantDatabase mockPlantDatabase(Map<Long, Plant> examplePlantMap) {
+        return new PlantDatabase() {
+            @Override
+            public List<Plant> getPlantList(HardinessZone zone) {
+                return null;
+            }
+
+            @Override
+            public Optional<Plant> getPlantById(HardinessZone zone, long id) {
+                return Optional.ofNullable(examplePlantMap.get(id));
+            }
+        };
+    }
+
+    void createExampleTaskList() {
+        exampleTaskList = new ArrayList<>();
+        exampleTaskList.add(new Task("name", "description", LocalDate.now().minusDays(1), 1L));
+        exampleTaskList.add(new Task("name", "description", LocalDate.now().plusDays(1), 2L));
+        exampleTaskList.add(new Task("name", "description", LocalDate.now(), 1L));
+        exampleTaskList.add(new Task("name", "description", LocalDate.of(9019, 5, 5), 1L));
+        exampleTaskList.add(new Task("name", "description", LocalDate.of(2019, 5, 5), 2L));
+    }
+
+    void createExamplePlantMap() {
+        examplePlantMap = new HashMap<>();
+    }
+
+
+
+    @Test
+    void addTask() throws IOException {
+        Task taskToAdd = new Task("name", "description", LocalDate.now(), 1L);
+        model.addTask(taskToAdd);
+        verify(taskDatabase, times(1)).saveTask(taskToAdd);
+    }
+
+    @Test
+    void removeTask() throws IOException {
+        Task taskToRemove = new Task("name", "description", LocalDate.now(), 1L);
+        model.removeTask(taskToRemove);
+        verify(taskDatabase, times(1)).removeTask(taskToRemove);
+    }
+
+    @Test
+    void getTaskList() throws IOException {
+        List<Task> listToCheck = model.getTaskList();
+        assertEquals(5, listToCheck.size());
+        assertEquals(exampleTaskList.get(4), listToCheck.get(0));
+        assertEquals(exampleTaskList.get(0), listToCheck.get(1));
+        assertEquals(exampleTaskList.get(2), listToCheck.get(2));
+        assertEquals(exampleTaskList.get(1), listToCheck.get(3));
+        assertEquals(exampleTaskList.get(3), listToCheck.get(4));
+    }
+
+    @Test
+    void getFutureTasks() throws IOException {
+        List<Task> listToCheck = model.getFutureTasks();
+        assertEquals(3, listToCheck.size());
+        assertEquals(exampleTaskList.get(2), listToCheck.get(0));
+        assertEquals(exampleTaskList.get(1), listToCheck.get(1));
+        assertEquals(exampleTaskList.get(3), listToCheck.get(2));
+    }
+
+    @Test
+    void getPastTasks() throws IOException {
+        List<Task> listToCheck = model.getPastTasks();
+        assertEquals(3, listToCheck.size());
+        assertEquals(exampleTaskList.get(4), listToCheck.get(0));
+        assertEquals(exampleTaskList.get(0), listToCheck.get(1));
+        assertEquals(exampleTaskList.get(2), listToCheck.get(2));
+    }
+
+    @Test
+    void getTasksUpcomingWeek() throws IOException {
+        List<List<Task>> dayList = model.getTasksUpcomingWeek();
+        assertEquals(7, dayList.size());
+
+        //Check day 0
+        assertEquals(1, dayList.get(0).size());
+        assertEquals(exampleTaskList.get(2), dayList.get(0).get(0));
+
+        //Check day 1
+        assertEquals(1, dayList.get(1).size());
+        assertEquals(exampleTaskList.get(1), dayList.get(1).get(0));
+
+        //Check day 2
+        assertEquals(0, dayList.get(2).size());
+        //Check day 3
+        assertEquals(0, dayList.get(3).size());
+        //Check day 4
+        assertEquals(0, dayList.get(4).size());
+        //Check day 5
+        assertEquals(0, dayList.get(5).size());
+        //Check day 6
+        assertEquals(0, dayList.get(6).size());
+    }
+
+    @Test
+    void removeTasksForCrop() throws IOException {
+        model.removeTasksForCrop(1L);
+        verify(taskDatabase, times(1)).removeTasksForCrop(1L);
+    }
+}