Merge pull request #78 from schrom01/feature_weather

Feature weather

src/main/java/ch/zhaw/gartenverwaltung/backgroundtasks/weather/WeatherGradenTaskPlanner.java

@@ -20,7 +20,7 @@ public class WeatherGradenTaskPlanner {
     private final PlantList plantList;
     private final CropList cropList;
     WeatherService weatherService;
-    private final LocalDate dateSevereWeather = LocalDate.of(2022,12,15);
+    private final LocalDate dateSevereWeather = LocalDate.now();
 
     public WeatherGradenTaskPlanner(TaskList taskList, PlantList plantList, CropList cropList) {
         this.taskList = taskList;
@@ -64,7 +64,7 @@ public class WeatherGradenTaskPlanner {
 
         Task preHailTask = new Task("Hail",
                                     "During a summer Thunderstorm it could hail heavily. THe Hail could damage the crops. To prevent damage cover the plants with a strong tarpaulin",
-                                    dateSevereWeather.minusDays(1L),dateSevereWeather.plusDays(1L));
+                                    dateSevereWeather.minusDays(1L),dateSevereWeather.plusDays(1L),1L);
         taskList.saveTask(preHailTask);
 
     }
@@ -76,7 +76,7 @@ public class WeatherGradenTaskPlanner {
     private void createPreFrostTask() throws IOException {
         Task preFrostTask = new Task("Frost",
                                     "The temperatur falls below zero degrees, cover especially the root with wool",
-                                    dateSevereWeather.minusDays(1L),dateSevereWeather.plusDays(1L));
+                                    dateSevereWeather.minusDays(1L),dateSevereWeather.plusDays(1L),1L);
         taskList.saveTask(preFrostTask);
     }
 
@@ -87,7 +87,7 @@ public class WeatherGradenTaskPlanner {
     private void createPreSnowTask() throws IOException {
         Task preSnowTask = new Task("Snow",
                                     "The weather brings little snowfall. Cover your crops",
-                                    dateSevereWeather.minusDays(1L),dateSevereWeather.plusDays(1L));
+                                    dateSevereWeather.minusDays(1L),dateSevereWeather.plusDays(1L),1L);
         taskList.saveTask(preSnowTask);
     }
 
@@ -113,9 +113,6 @@ public class WeatherGradenTaskPlanner {
     /**
      * Method to set next execution date of the water plant tasks
      * @param cropTaskList List with tasks from crops
-     * @throws IOException If the database cannot be accessed
-     * @throws HardinessZoneNotSetException If the hardiness zone is not available
-     * @throws PlantNotFoundException if the plant is not available for the watering task
      */
     private void adjustNextExecutionOfWateringTasks(List<Task> cropTaskList){
         for(Task task : cropTaskList){

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

@@ -71,7 +71,7 @@ public class JsonTaskList implements TaskList {
         if(taskMap.isEmpty()) {
             loadTaskListFromFile();
         }
-        return taskMap.values().stream().filter(task -> task.isInTimePeriode(start, end)).toList();
+        return taskMap.values().stream().filter(task -> task.isInTimePeriod(start, end)).toList();
     }
 
     /**

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

@@ -1,12 +1,12 @@
 package ch.zhaw.gartenverwaltung.types;
 
-import ch.zhaw.gartenverwaltung.io.JsonPlantList;
-import ch.zhaw.gartenverwaltung.io.PlantList;
-
 import java.time.LocalDate;
 import java.util.Objects;
 import java.util.Optional;
 
+/**
+ * Represents a crop, meaning a specific plant growing at a specific time.
+ */
 public class Crop {
     private Long cropId = null;
     private final long plantId;

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

@@ -7,7 +7,19 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import java.time.MonthDay;
 import java.util.List;
 
-
+/**
+ * Represents a growth phase of a plant.
+ * Plants go through several phases during their life (sowing, germinating, growing, ..., harvest).
+ * These phases are characterized by what kinds of tasks need to be executed by the gardener to stay alive.
+ * This class represents one such phase.
+ *
+ * @param startDate The earliest date on which this phase can start
+ * @param endDate The latest date on which this phase can start
+ * @param group Which group this phase belongs to (if the growth phase can occur multiple times a year, default: 0)
+ * @param type What {@link GrowthPhaseType} this represents
+ * @param zone The hardiness zone for which this growth phase is valid
+ * @param taskTemplates The (undated) tasks required to be performed by the gardener
+ */
 public record GrowthPhase(
         MonthDay startDate,
         MonthDay endDate,

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

@@ -1,5 +1,9 @@
 package ch.zhaw.gartenverwaltung.types;
 
+/**
+ * Enumerates the different possible types of {@link GrowthPhase}.
+ * (Subject to later expansion)
+ */
 public enum GrowthPhaseType {
     SOW, PLANT, REPLANT, HARVEST
 }

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

@@ -1,4 +1,11 @@
 package ch.zhaw.gartenverwaltung.types;
 
+/**
+ * Represents a pest or pathogen which may afflict a plant.
+ *
+ * @param name The name of the pest
+ * @param description A description of the pest
+ * @param measures Measures that can be taken against the pest.
+ */
 public record Pest(String name, String description, String measures) {
 }

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

@@ -9,6 +9,20 @@ import java.util.stream.Collectors;
 
 import static java.time.temporal.ChronoUnit.DAYS;
 
+/**
+ * Represents a plant
+ *
+ * @param id A unique identifier
+ * @param name The name of the plant
+ * @param description A description of the plant
+ * @param image An image representing the plant
+ * @param spacing The amount of space needed between individual plants of this type
+ * @param light The amount of light preferred by the plant (h/d)
+ * @param soil The type of soil required for the plant
+ * @param pests {@link Pest}s that may afflict the plant
+ * @param wateringCycle The {@link WateringCycle} required by the plant
+ * @param lifecycle A list of {@link GrowthPhase}s constituting the plants lifecycle
+ */
 public record Plant(
         long id,
         String name,
@@ -30,9 +44,10 @@ public record Plant(
     }
 
     /**
-     * get all growthPhases of lifecycle group
-     * @param group lifecycle group
-     * @return list of growthPhases
+     * Get all {@link GrowthPhase}s of a lifecycle group
+     *
+     * @param group The lifecycle group
+     * @return A list of {@link GrowthPhase}s
      */
     public List<GrowthPhase> lifecycleForGroup(int group) {
         return lifecycle.stream()
@@ -40,6 +55,12 @@ public record Plant(
                 .collect(Collectors.toList());
     }
 
+    /**
+     * Given a {@link LocalDate}, determines which lifecycle group contains it.
+     *
+     * @param date The date to look for
+     * @return Which lifecycle group the date is in
+     */
     public int getGrowphaseGroupForDate(LocalDate date) {
         for(GrowthPhase growthPhase : lifecycle){
             MonthDay plantingDate = MonthDay.of(date.getMonth().getValue(), date.getDayOfMonth());
@@ -51,16 +72,18 @@ public record Plant(
     }
 
     /**
-     * get sow date from given harvest day from lifecycle group
+     * Get sow date from given harvest date from lifecycle group
+     *
      * @param harvestDate date of the harvest
-     * @return LocaleDate of sow date
+     * @return {@link LocalDate} of sow date
      */
     public LocalDate sowDateFromHarvestDate(LocalDate harvestDate) {
         return harvestDate.minusDays(timeToHarvest(lifecycleGroupFromHarvestDate(harvestDate)));
     }
 
     /**
-     * calculate the days between sow and harvest day for lifecycle group
+     * Calculate the number of days between sow and harvest date for lifecycle group
+     *
      * @param group the lifecycle group
      * @return Integer number of dates between sow and harvest day
      */
@@ -79,6 +102,12 @@ public record Plant(
         return (int) DAYS.between(sow.startDate().atYear(currentYear),harvest.startDate().atYear(currentYear));
     }
 
+    /**
+     * Given a harvest date, determines which lifecycle group it belongs to.
+     *
+     * @param harvestDate The harvest date
+     * @return Which lifecycle group the harvest date is in
+     */
     public int lifecycleGroupFromHarvestDate(LocalDate harvestDate) {
         return lifecycle.stream()
                 .filter(growthPhase -> growthPhase.type().equals(GrowthPhaseType.HARVEST) &&

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

@@ -2,6 +2,10 @@ package ch.zhaw.gartenverwaltung.types;
 
 import java.time.MonthDay;
 
+/**
+ * Describes the 4 Seasons in terms of {@link java.time.LocalDate}s
+ * Also describes "All Seasons" as the full year.
+ */
 public enum Seasons {
     ALLSEASONS("--01-01", "--12-31", "All Seasons"),
     SPRING("--03-01", "--05-30", "Spring"),

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

@@ -1,11 +1,10 @@
 package ch.zhaw.gartenverwaltung.types;
 
-
 import java.time.LocalDate;
 import java.util.Optional;
 
 /**
- * Models a Task
+ * Represents a Task
  * May be created using the builder pattern.
  */
 public class Task {
@@ -18,10 +17,9 @@ public class Task {
     private LocalDate nextExecution;
     private LocalDate nextNotification;
     private long cropId;
-    private boolean done;
 
     /**
-     * default constructor
+     * Default constructor
      * (used by Json deserializer)
      */
     public Task(){
@@ -32,6 +30,14 @@ public class Task {
         nextExecution = startDate;
     }
 
+    /**
+     * Constructor for a non-repeating task related to a {@link Crop}
+     *
+     * @param name The name of the task
+     * @param description A description of the task
+     * @param startDate The start date of the task
+     * @param cropId The id of the crop to which the task belongs
+     */
     public Task(String name, String description, LocalDate startDate, long cropId) {
         this.name = name;
         this.description = description;
@@ -43,14 +49,30 @@ public class Task {
 
     /**
      * Constructor for weather events
-    */
-    public Task(String name, String description, LocalDate startDate, LocalDate endDate) {
+     *
+     * @param name The name of the task
+     * @param description A description of the task
+     * @param startDate The start date of the task
+     * @param endDate The maximum date on which the task should be executed
+     */
+    public Task(String name, String description, LocalDate startDate, LocalDate endDate, long cropId) {
         this.name = name;
         this.description = description;
         this.startDate = startDate;
+        nextExecution = startDate;
         this.endDate = endDate;
     }
 
+    /**
+     * Full constructor (without id)
+     *
+     * @param name The name of the task
+     * @param description A description of the task
+     * @param startDate The start date of the task
+     * @param endDate The maximum date on which the task should be executed
+     * @param interval The number of days between executions
+     * @param cropId The id of the crop to which the task belongs
+     */
     public Task(String name, String description, LocalDate startDate, LocalDate endDate, int interval, long cropId) {
         this.name = name;
         this.description = description;
@@ -75,10 +97,20 @@ public class Task {
         return this;
     }
 
-    public boolean isInTimePeriode(LocalDate searchStartDate, LocalDate searchEndDate){
+    /**
+     * Checks if the Task is within a specific date range.
+     *
+     * @param searchStartDate The minimum date
+     * @param searchEndDate The maximum date
+     * @return Whether the Task is within the given range
+     */
+    public boolean isInTimePeriod(LocalDate searchStartDate, LocalDate searchEndDate) {
         return endDate.isAfter(searchStartDate) && startDate.isBefore(searchEndDate);
     }
 
+    /**
+     * Marks a specific execution of a Task as done.
+     */
     public void done(){
         if(interval != null && interval != 0 && !nextExecution.plusDays(interval).isAfter(endDate)){
             nextExecution = nextExecution.plusDays(interval);
@@ -117,6 +149,12 @@ public class Task {
         return Optional.ofNullable(endDate);
     }
 
+    /**
+     * Updates the fields of this Task using the values of the given Task
+     *
+     * @param task The task whose fields to copy
+     * @return This task with the fields already updated
+     */
     public Task updateTask(Task task) {
         this.name = task.getName();
         this.description = task.getDescription();

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

@@ -41,6 +41,13 @@ public class TaskTemplate {
         this.relativeStartDate = relativeStartDate;
     }
 
+    /**
+     * Create a concrete {@link Task} given a concrete start date
+     *
+     * @param realStartDate The start date of the {@link GrowthPhase} to which the {@link #relativeStartDate} is relative.
+     * @param cropId The crop for which the task should be generated.
+     * @return The created {@link Task}
+     */
     public Task generateTask(LocalDate realStartDate, long cropId) {
         LocalDate endDate = relativeEndDate != null ? realStartDate.plusDays(relativeEndDate) : realStartDate;
 

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

@@ -1,5 +1,12 @@
 package ch.zhaw.gartenverwaltung.types;
 
+/**
+ * Describes the cycle in which a {@link Plant} should be watered
+ *
+ * @param litersPerSqM How many litres of water per square metre of ground
+ * @param interval The interval (days)
+ * @param notes Notes on the cycle
+ */
 public record WateringCycle(
         int litersPerSqM,
         int interval,

src/test/java/ch/zhaw/gartenverwaltung/backgroundtasks/weather/WeatherGardenTaskPlannerTest.java

@@ -0,0 +1,91 @@
+package ch.zhaw.gartenverwaltung.backgroundtasks.weather;
+
+import ch.zhaw.gartenverwaltung.io.*;
+import ch.zhaw.gartenverwaltung.models.PlantNotFoundException;
+import ch.zhaw.gartenverwaltung.types.*;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
+
+import java.io.IOException;
+import java.net.URL;
+import java.time.LocalDate;
+import java.time.MonthDay;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+public class WeatherGardenTaskPlannerTest {
+    private final URL testFile = JsonCropListTest.class.getResource("test-taskdb.json");
+    Plant examplePlantOnion;
+    Crop exampleCropOnion;
+    Task exampleTask;
+    Task exampleWeatherTask;
+    List<Crop> cropList;
+    List<Plant> plantList;
+    TaskList taskList;
+
+    @BeforeEach
+    void setUp() {
+        examplePlantOnion = 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<>(),
+                new WateringCycle(15, 3, null),
+                List.of(new GrowthPhase(MonthDay.of(6, 4), MonthDay.of(12, 4), 0, GrowthPhaseType.HARVEST, HardinessZone.ZONE_8A, new ArrayList<>()),
+                        new GrowthPhase(MonthDay.of(4, 3), MonthDay.of(12, 4), 0, GrowthPhaseType.PLANT, HardinessZone.ZONE_8A, new ArrayList<>()),
+                        new GrowthPhase(MonthDay.of(8, 5), MonthDay.of(12, 4), 0, GrowthPhaseType.PLANT, HardinessZone.ZONE_8A, new ArrayList<>()),
+                        new GrowthPhase(MonthDay.of(2, 8), MonthDay.of(12, 4), 0, GrowthPhaseType.PLANT, HardinessZone.ZONE_8A, new ArrayList<>()),
+                        new GrowthPhase(MonthDay.of(10, 2), MonthDay.of(12, 4), 0, GrowthPhaseType.PLANT, HardinessZone.ZONE_8A, new ArrayList<>())));
+
+        exampleCropOnion = new Crop(examplePlantOnion.id(), LocalDate.of(2022, 12, 5))
+                .withId(3L);
+        exampleTask = new Task("water plant","water the plant until the ground is wet enough",LocalDate.now(), LocalDate.now().plusDays(2L),3L);
+        exampleTask.setNextExecution(LocalDate.now().plusDays(1L));
+        exampleWeatherTask = new Task("Hail",
+                "During a summer Thunderstorm it could hail heavily. THe Hail could damage the crops. To prevent damage cover the plants with a strong tarpaulin",
+                LocalDate.now().minusDays(1L),LocalDate.now().plusDays(1L),3L);
+
+        taskList = new JsonTaskList(testFile);
+
+        plantList = new ArrayList<>();
+        plantList.add(examplePlantOnion);
+
+        cropList = new ArrayList<>();
+        cropList.add(exampleCropOnion);
+
+    }
+
+    CropList mockCropList(List<Crop> cropList) throws IOException {
+        CropList croplist = mock(CropList.class);
+        when(croplist.getCrops()).thenReturn(cropList);
+        when(croplist.getCropById(3)).thenReturn(java.util.Optional.ofNullable(exampleCropOnion));
+        return croplist;
+    }
+
+    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(plantList.get(0)));
+        return plantDatabase;
+    }
+
+    @Test
+    void refreshtasks() throws HardinessZoneNotSetException, IOException, PlantNotFoundException {
+        WeatherGradenTaskPlanner weatherGradenTaskPlanner = new WeatherGradenTaskPlanner(taskList, mockPlantDatabase(plantList), mockCropList(cropList));
+        taskList.saveTask(exampleTask);
+        weatherGradenTaskPlanner.refreshTasks();
+        assertEquals(exampleTask.getName(),taskList.getTaskList(LocalDate.now(),LocalDate.now().plusDays(7)).get(0).getName());
+        assertEquals(LocalDate.now().plusDays(2L),taskList.getTaskList(LocalDate.now(),LocalDate.now().plusDays(7)).get(0).getNextExecution());
+        assertEquals(exampleWeatherTask.getName(),taskList.getTaskList(LocalDate.now(),LocalDate.now().plusDays(7)).get(1).getName());
+        assertEquals(exampleWeatherTask.getStartDate(),taskList.getTaskList(LocalDate.now(),LocalDate.now().plusDays(7)).get(1).getStartDate());
+    }
+}

src/test/resources/ch/zhaw/gartenverwaltung/backgroundtask/weather/test-taskdb.json

@@ -0,0 +1,2 @@
+[
+]