Merge pull request #62 from schrom01/feature_taskList_m2

completed Tests for GardenScheduleTest and new Structure of Task

src/main/java/ch/zhaw/gartenverwaltung/models/GardenSchedule.java

@@ -9,6 +9,7 @@ import java.time.LocalDate;
 import java.util.ArrayList;
 import java.util.Comparator;
 import java.util.List;
+import java.util.function.Consumer;
 import java.util.stream.Collectors;
 
 public class GardenSchedule {
@@ -19,6 +20,7 @@ public class GardenSchedule {
      * Comparators to create sorted Task List
      */
     static final Comparator<Task> sortByStartDate = Comparator.comparing(Task::getStartDate);
+    static final Comparator<Task> sortByNextExecution = Comparator.comparing(Task::getNextExecution);
 
     /**
      * Constructor to create Database Objects.
@@ -46,7 +48,8 @@ public class GardenSchedule {
      */
     public void planTasksForCrop(Crop crop) throws PlantNotFoundException, HardinessZoneNotSetException, IOException {
         Plant plant = plantList.getPlantById(Settings.getInstance().getCurrentHardinessZone(), crop.getPlantId()).orElseThrow(PlantNotFoundException::new);
-        for (GrowthPhase growthPhase : plant.lifecycle()) {
+        int growPhaseGroup = plant.getGrowphaseGroupForDate(crop.getStartDate());
+        for (GrowthPhase growthPhase : plant.lifecycleForGroup(growPhaseGroup)) {
             for (TaskTemplate taskTemplate : growthPhase.taskTemplates()) {
                 addTask(taskTemplate.generateTask(crop.getStartDate(), crop.getCropId().orElse(0L)));
             }
@@ -135,10 +138,22 @@ public class GardenSchedule {
      * @throws IOException If the database cannot be accessed
      */
     public List<List<Task>> getTasksUpcomingWeek() throws IOException {
+        final int listLength = 7;
+        List<Task> weekTasks = taskList.getTaskList(LocalDate.now(), LocalDate.now().plusDays(listLength - 1));
         List<List<Task>> dayTaskList = new ArrayList<>();
-        for(int i = 0; i < 7; i++) {
+        for(int i = 0; i < listLength; i++) {
             LocalDate date = LocalDate.now().plusDays(i);
-            dayTaskList.add(taskList.getTaskList(date, date));
+            dayTaskList.add(new ArrayList<>());
+            final int finalI = i;
+            weekTasks.forEach(task -> {
+                LocalDate checkDate = task.getNextExecution();
+                do {
+                    if (date.equals(checkDate) && !date.isAfter(task.getEndDate().orElse(LocalDate.MIN))) {
+                        dayTaskList.get(finalI).add(task);
+                    }
+                    checkDate = checkDate.plusDays(task.getInterval().orElse(0));
+                } while (task.getInterval().isPresent() && checkDate.isBefore(LocalDate.now().plusDays(listLength)));
+            });
         }
         return dayTaskList;
     }
@@ -149,11 +164,8 @@ public class GardenSchedule {
      * @throws IOException If the database cannot be accessed
      */
     public List<List<Task>> getTasksUpcomingWeekForCrop(Long cropId) throws IOException {
-        List<List<Task>> dayTaskList = new ArrayList<>();
+        List<List<Task>> dayTaskList = getTasksUpcomingWeek();
-        for(int i = 0; i < 7; i++) {
+        dayTaskList.forEach(taskList -> taskList.removeIf(task -> task.getCropId() != cropId));
-            LocalDate date = LocalDate.now().plusDays(i);
-            dayTaskList.add(filterListByCrop(taskList.getTaskList(date, date), cropId));
-        }
         return dayTaskList;
     }
 
@@ -165,7 +177,7 @@ public class GardenSchedule {
      * @throws IOException If the database cannot be accessed
      */
     public List<Task> getFilteredTaskList(LocalDate start, LocalDate end) throws IOException {
-        return getSortedTaskList(taskList.getTaskList(start, end), sortByStartDate);
+        return getSortedTaskList(taskList.getTaskList(start, end), sortByNextExecution);
     }
 
     /**

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

@@ -39,6 +39,16 @@ public record Plant(
                 .collect(Collectors.toList());
     }
 
+    public int getGrowphaseGroupForDate(LocalDate date) {
+        for(GrowthPhase growthPhase : lifecycle){
+            MonthDay plantingDate = MonthDay.of(date.getMonth().getValue(), date.getDayOfMonth());
+            if(plantingDate.isAfter(growthPhase.startDate()) && plantingDate.isBefore(growthPhase.endDate())){
+                return growthPhase.group();
+            }
+        }
+        return 0; // TODO implement
+    }
+
     /**
      * get sow date from given harvest day from lifecycle group
      * @param harvestDate date of the harvest

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

@@ -15,6 +15,8 @@ public class Task {
     private final LocalDate startDate;
     private Integer interval;
     private LocalDate endDate;
+    private LocalDate nextExecution;
+    private LocalDate nextNotification;
     private long cropId;
 
     /**
@@ -25,12 +27,16 @@ public class Task {
         name= "";
         description= "";
         startDate = LocalDate.now();
+        endDate = startDate;
+        nextExecution = startDate;
     }
 
     public Task(String name, String description, LocalDate startDate, long cropId) {
         this.name = name;
         this.description = description;
         this.startDate = startDate;
+        this.endDate = startDate;
+        nextExecution = startDate;
         this.cropId = cropId;
     }
 
@@ -38,6 +44,7 @@ public class Task {
         this.name = name;
         this.description = description;
         this.startDate = startDate;
+        nextExecution = startDate;
         this.endDate = endDate;
         this.interval = interval;
         this.cropId = cropId;
@@ -58,10 +65,32 @@ public class Task {
     }
 
     public boolean isInTimePeriode(LocalDate searchStartDate, LocalDate searchEndDate){
-        return startDate.isAfter(searchStartDate) && startDate.isBefore(searchEndDate);
+        return endDate.isAfter(searchStartDate) && startDate.isBefore(searchEndDate);
+    }
+
+    public void done(){
+        if(interval != null && !nextExecution.plusDays(interval).isAfter(endDate)){
+            nextExecution = nextExecution.plusDays(interval);
+        } else {
+            nextExecution = null;
+        }
+    }
+
+    public boolean isDone(){
+        return nextExecution == null;
+    }
+
+    public void setNextExecution(LocalDate nextExecution) {
+        this.nextExecution = nextExecution;
+    }
+
+    public void setNextNotification(LocalDate nextNotification) {
+        this.nextNotification = nextNotification;
     }
 
     // Getters
+    public LocalDate getNextNotification() { return nextNotification; }
+    public LocalDate getNextExecution() { return nextExecution; }
     public Optional<Long> getId() { return Optional.ofNullable(id); }
     public String getName() { return name; }
     public String getDescription() { return description; }

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

@@ -16,10 +16,6 @@ public class TaskTemplate {
     @JsonProperty
     private Integer interval;
 
-    // TODO: reconsider if we need this
-    @JsonProperty
-    private boolean isOptional = false;
-
     /**
      * Default constructor
      * (Used by deserializer)

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

@@ -32,8 +32,7 @@
             "relativeStartDate": -14,
             "relativeEndDate": null,
             "description": "Take an egg carton and fill it with soil. Put the seedling deep enough so its half covered with soil. Keep it in 10-15 * Celsius with lots of light.",
-            "interval": null,
+            "interval": null
-            "isOptional": false
           }
         ]
       },
@@ -54,8 +53,7 @@
             "relativeStartDate": 0,
             "relativeEndDate": null,
             "description": "When the plants are 20 cm tall, begin hilling the potatoes by gently mounding the soil from the center of your rows around the stems of the plant. Mound up the soil around the plant until just the top few leaves show above the soil. Two weeks later, hill up the soil again when the plants grow another 20 cm.",
-            "interval": 21,
+            "interval": 21
-            "isOptional": false
           }
         ]
       },
@@ -76,8 +74,7 @@
             "relativeStartDate": 0,
             "relativeEndDate": null,
             "description": "Once the foliage has wilted and dried completely, harvest on a dry day. Store in a dark and cool location.",
-            "interval": null,
+            "interval": null
-            "isOptional": false
           }
         ]
       }
@@ -106,8 +103,7 @@
             "relativeStartDate": 0,
             "relativeEndDate": 0,
             "description": "Mound up the soil around the plant until just the top few leaves show above the soil. ",
-            "interval": null,
+            "interval": null
-            "isOptional": false
           }
         ]
       },
@@ -130,8 +126,7 @@
             "relativeStartDate": 0,
             "relativeEndDate": null,
             "description": "Mound up the soil around the plant until just the top few leaves show above the soil. ",
-            "interval": 15,
+            "interval": 15
-            "isOptional": true
           }
         ]
       },
@@ -152,8 +147,7 @@
             "relativeStartDate": 0,
             "relativeEndDate": 14,
             "description": "When the leaves turn to a yellowish brown. Do not harvest earlier. The plant will show when it's ready.",
-            "interval": null,
+            "interval": null
-            "isOptional": false
           }
         ]
       }
@@ -192,8 +186,7 @@
             "relativeStartDate": 0,
             "relativeEndDate": 0,
             "description": "Plant the sets about 5cm deep into the soil.",
-            "interval": null,
+            "interval": null
-            "isOptional": false
           }
         ]
       },
@@ -216,8 +209,7 @@
             "relativeStartDate": 0,
             "relativeEndDate": null,
             "description": "Mound up the soil around the plant until just the top few leaves show above the soil. ",
-            "interval": 15,
+            "interval": 15
-            "isOptional": true
           }
         ]
       },
@@ -239,8 +231,7 @@
             "relativeStartDate": 0,
             "relativeEndDate": 14,
             "description": "When ready for harvest, the leaves on your onion plants will start to flop over. This happens at the \"neck\" of the onion and it signals that the plant has stopped growing and is ready for storage. Onions should be harvested soon thereafter",
-            "interval": null,
+            "interval": null
-            "isOptional": false
           }
         ]
       }

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

@@ -4,8 +4,10 @@
     "name": "sow plant",
     "description": "Plant the seeds, crops in de bed.",
     "startDate": "2022-05-01",
+    "nextExecution": "2022-05-01",
+    "nextNotification": "2022-05-01",
     "endDate": "2022-05-01",
-    "interval": 0,
+    "interval": null,
     "cropId": 0
   },
   {
@@ -13,6 +15,8 @@
     "name": "water plant",
     "description": "water the plant, so that the soil is wet around the plant.",
     "startDate": "2022-05-01",
+    "nextExecution": "2022-05-01",
+    "nextNotification": "2022-05-01",
     "endDate": "2022-09-01",
     "interval": 2,
     "cropId": 0
@@ -22,6 +26,8 @@
     "name": "fertilize plant",
     "description": "The fertilizer has to be mixed with water. Then fertilize the plants soil with the mixture",
     "startDate": "2022-06-01",
+    "nextExecution": "2022-06-01",
+    "nextNotification": "2022-06-01",
     "endDate": "2022-08-01",
     "interval": 28,
     "cropId": 0
@@ -31,8 +37,10 @@
     "name": "covering plant",
     "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",
+    "nextExecution": "2022-07-01",
+    "nextNotification": "2022-07-01",
     "endDate": "2022-07-01",
-    "interval": 0,
+    "interval": null,
     "cropId": 0
   },
   {
@@ -40,6 +48,8 @@
     "name": "look after plant",
     "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",
+    "nextExecution": "2022-05-01",
+    "nextNotification": "2022-05-01",
     "endDate": "2022-09-01",
     "interval": 5,
     "cropId": 0
@@ -49,8 +59,10 @@
     "name": "harvest plant",
     "description": "Pull the ripe vegetables out from the soil. Clean them with clear, fresh water. ",
     "startDate": "2022-09-01",
+    "nextExecution": "2022-09-01",
+    "nextNotification": "2022-09-01",
     "endDate": "2022-09-01",
-    "interval": 0,
+    "interval": null,
     "cropId": 0
   }
 ]

src/test/java/ch/zhaw/gartenverwaltung/models/GardenScheduleTest.java

@@ -1,38 +1,49 @@
-package ch.zhaw.gartenverwaltung.taskList;
+package ch.zhaw.gartenverwaltung.models;
 
 import ch.zhaw.gartenverwaltung.io.*;
 import ch.zhaw.gartenverwaltung.models.GardenSchedule;
-import ch.zhaw.gartenverwaltung.types.HardinessZone;
+import ch.zhaw.gartenverwaltung.types.*;
-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.time.MonthDay;
 import java.util.*;
 
 import static org.junit.jupiter.api.Assertions.*;
 import static org.mockito.Mockito.*;
 
 class GardenScheduleTest {
+    LocalDate exampleStartDate = LocalDate.of(2020, 2, 2);
     TaskList taskList;
     PlantList plantList;
+    List<Plant> examplePlantList;
     List<Task> exampleTaskList;
-    Map<Long, Plant> examplePlantMap;
+    List<TaskTemplate> exampleTaskTemplateList;
     GardenSchedule model;
 
     @BeforeEach
-    void setUp() throws IOException {
+    void setUp() throws IOException, HardinessZoneNotSetException {
         createExampleTaskList();
+        createExampleTaskTemplateList();
+        createExamplePlantList();
         taskList = mockTaskDatabase(exampleTaskList);
-        plantList = mockPlantDatabase(examplePlantMap);
+        plantList = mockPlantDatabase(examplePlantList);
         model = new GardenSchedule(taskList, plantList);
     }
 
+    PlantList mockPlantDatabase(List<Plant> plantList) throws HardinessZoneNotSetException, IOException {
+        PlantList plantDatabase = mock(JsonPlantList.class);
+        when(plantDatabase.getPlantList(HardinessZone.ZONE_8A)).thenReturn(plantList);
+        when(plantDatabase.getPlantById(HardinessZone.ZONE_8A,20)).thenReturn(Optional.of(examplePlantList.get(0)));
+        return plantDatabase;
+    }
+
     private TaskList mockTaskDatabase(List<Task> exampleTaskList) throws IOException {
         TaskList taskList = mock(JsonTaskList.class);
         when(taskList.getTaskList(LocalDate.MIN, LocalDate.MAX)).thenReturn(exampleTaskList);
+        when(taskList.getTaskList(LocalDate.now(), LocalDate.now().plusDays(7 - 1))).thenReturn(exampleTaskList);
 
         when(taskList.getTaskList(LocalDate.now(), LocalDate.MAX)).thenReturn((exampleTaskList.subList(1, 4)));
 
@@ -54,18 +65,39 @@ class GardenScheduleTest {
         return taskList;
     }
 
-    private PlantList mockPlantDatabase(Map<Long, Plant> examplePlantMap) {
+    void createExampleTaskTemplateList(){
-        return new PlantList() {
+        exampleTaskTemplateList = new ArrayList<>();
-            @Override
+        exampleTaskTemplateList.add(mock(TaskTemplate.class));
-            public List<Plant> getPlantList(HardinessZone zone) {
+        exampleTaskTemplateList.add(mock(TaskTemplate.class));
-                return null;
+        exampleTaskTemplateList.add(mock(TaskTemplate.class));
+        exampleTaskTemplateList.add(mock(TaskTemplate.class));
+        when(exampleTaskTemplateList.get(0).generateTask(exampleStartDate, 30)).thenReturn(exampleTaskList.get(0));
+        when(exampleTaskTemplateList.get(1).generateTask(exampleStartDate, 30)).thenReturn(exampleTaskList.get(1));
+        when(exampleTaskTemplateList.get(2).generateTask(exampleStartDate, 30)).thenReturn(exampleTaskList.get(2));
+        when(exampleTaskTemplateList.get(3).generateTask(exampleStartDate, 30)).thenReturn(exampleTaskList.get(3));
     }
 
-            @Override
+    void createExamplePlantList(){
-            public Optional<Plant> getPlantById(HardinessZone zone, long id) {
+        examplePlantList = new ArrayList<>();
-                return Optional.ofNullable(examplePlantMap.get(id));
+        examplePlantList.add(new Plant(
-            }
+                20,
-        };
+                "summertime onion",
+                "Onion, (Allium cepa), herbaceous biennial plant in the amaryllis family (Amaryllidaceae) grown for its edible bulb. The onion is likely native to southwestern Asia but is now grown throughout the world, chiefly in the temperate zones. Onions are low in nutrients but are valued for their flavour and are used widely in cooking. They add flavour to such dishes as stews, roasts, soups, and salads and are also served as a cooked vegetable.",
+                null,
+                "15,30,2",
+                0,
+                "sandy to loamy, loose soil, free of stones",
+                new ArrayList<>(),
+                List.of(
+                        new GrowthPhase(MonthDay.of(6, 4), MonthDay.of(12, 4), 0, new WateringCycle(0, 0, null), GrowthPhaseType.HARVEST, HardinessZone.ZONE_8A, List.of(
+                                exampleTaskTemplateList.get(0),
+                                exampleTaskTemplateList.get(1)
+                        )),
+                        new GrowthPhase(MonthDay.of(4, 3), MonthDay.of(12, 4), 0, new WateringCycle(0, 0, null), GrowthPhaseType.PLANT, HardinessZone.ZONE_8A, List.of(
+                                exampleTaskTemplateList.get(2),
+                                exampleTaskTemplateList.get(3)
+                        ))
+                )));
     }
 
     void createExampleTaskList() {
@@ -74,15 +106,9 @@ class GardenScheduleTest {
         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));
+        exampleTaskList.add(new Task("name", "description", LocalDate.now().minusDays(10), LocalDate.now().plusDays(4),2, 2L));
     }
 
-    void createExamplePlantMap() {
-        examplePlantMap = new HashMap<>();
-    }
-
-
-
     @Test
     void addTask() throws IOException {
         Task taskToAdd = new Task("name", "description", LocalDate.now(), 1L);
@@ -132,19 +158,22 @@ class GardenScheduleTest {
         assertEquals(7, dayList.size());
 
         //Check day 0
-        assertEquals(1, dayList.get(0).size());
+        assertEquals(2, dayList.get(0).size());
-        assertEquals(exampleTaskList.get(2), dayList.get(0).get(0));
+        assertTrue(dayList.get(0).contains(exampleTaskList.get(2)));
+        assertTrue(dayList.get(0).contains(exampleTaskList.get(4)));
 
         //Check day 1
         assertEquals(1, dayList.get(1).size());
-        assertEquals(exampleTaskList.get(1), dayList.get(1).get(0));
+        assertTrue(dayList.get(1).contains(exampleTaskList.get(1)));
 
         //Check day 2
-        assertEquals(0, dayList.get(2).size());
+        assertEquals(1, dayList.get(2).size());
+        assertTrue(dayList.get(2).contains(exampleTaskList.get(4)));
         //Check day 3
         assertEquals(0, dayList.get(3).size());
         //Check day 4
-        assertEquals(0, dayList.get(4).size());
+        assertEquals(1, dayList.get(4).size());
+        assertTrue(dayList.get(4).contains(exampleTaskList.get(4)));
         //Check day 5
         assertEquals(0, dayList.get(5).size());
         //Check day 6
@@ -156,4 +185,17 @@ class GardenScheduleTest {
         model.removeTasksForCrop(1L);
         verify(taskList, times(1)).removeTasksForCrop(1L);
     }
+
+    @Test
+    void planTasksForCrop() throws HardinessZoneNotSetException, PlantNotFoundException, IOException {
+        model.planTasksForCrop(new Crop(20, exampleStartDate).withId(30));
+        verify(exampleTaskTemplateList.get(0), times(1)).generateTask(exampleStartDate, 30);
+        verify(exampleTaskTemplateList.get(1), times(1)).generateTask(exampleStartDate, 30);
+        verify(exampleTaskTemplateList.get(2), times(1)).generateTask(exampleStartDate, 30);
+        verify(exampleTaskTemplateList.get(3), times(1)).generateTask(exampleStartDate, 30);
+        verify(taskList, times(1)).saveTask(exampleTaskList.get(0));
+        verify(taskList, times(1)).saveTask(exampleTaskList.get(1));
+        verify(taskList, times(1)).saveTask(exampleTaskList.get(2));
+        verify(taskList, times(1)).saveTask(exampleTaskList.get(3));
+    }
 }

src/test/resources/ch/zhaw/gartenverwaltung/io/test-plantdb.json

@@ -32,8 +32,7 @@
             "relativeStartDate": -14,
             "relativeEndDate": null,
             "description": "Take an egg carton and fill it with soil. Put the seedling deep enough so its half covered with soil. Keep it in 10-15 * Celsius with lots of light.",
-            "interval": null,
+            "interval": null
-            "isOptional": false
           }
         ]
       },
@@ -54,8 +53,7 @@
             "relativeStartDate": 0,
             "relativeEndDate": null,
             "description": "When the plants are 20 cm tall, begin hilling the potatoes by gently mounding the soil from the center of your rows around the stems of the plant. Mound up the soil around the plant until just the top few leaves show above the soil. Two weeks later, hill up the soil again when the plants grow another 20 cm.",
-            "interval": 21,
+            "interval": 21
-            "isOptional": false
           }
         ]
       },
@@ -76,8 +74,7 @@
             "relativeStartDate": 0,
             "relativeEndDate": null,
             "description": "Once the foliage has wilted and dried completely, harvest on a dry day. Store in a dark and cool location.",
-            "interval": null,
+            "interval": null
-            "isOptional": false
           }
         ]
       }
@@ -106,8 +103,7 @@
             "relativeStartDate": 0,
             "relativeEndDate": 0,
             "description": "Mound up the soil around the plant until just the top few leaves show above the soil. ",
-            "interval": null,
+            "interval": null
-            "isOptional": false
           }
         ]
       },
@@ -130,8 +126,7 @@
             "relativeStartDate": 0,
             "relativeEndDate": null,
             "description": "Mound up the soil around the plant until just the top few leaves show above the soil. ",
-            "interval": 15,
+            "interval": 15
-            "isOptional": true
           }
         ]
       },
@@ -152,8 +147,7 @@
             "relativeStartDate": 0,
             "relativeEndDate": 14,
             "description": "When the leaves turn to a yellowish brown. Do not harvest earlier. The plant will show when it's ready.",
-            "interval": null,
+            "interval": null
-            "isOptional": false
           }
         ]
       }
@@ -193,8 +187,7 @@
             "relativeStartDate": 0,
             "relativeEndDate": 0,
             "description": "Mound up the soil around the plant until just the top few leaves show above the soil. ",
-            "interval": null,
+            "interval": null
-            "isOptional": false
           }
         ]
       },
@@ -217,8 +210,7 @@
             "relativeStartDate": 0,
             "relativeEndDate": null,
             "description": "Mound up the soil around the plant until just the top few leaves show above the soil. ",
-            "interval": 15,
+            "interval": 15
-            "isOptional": true
           }
         ]
       },
@@ -241,8 +233,7 @@
             "relativeStartDate": 0,
             "relativeEndDate": 14,
             "description": "When ready for harvest, the leaves on your onion plants will start to flop over. This happens at the \"neck\" of the onion and it signals that the plant has stopped growing and is ready for storage. Onions should be harvested soon thereafter",
-            "interval": null,
+            "interval": null
-            "isOptional": false
           }
         ]
       }