Merge pull request #6 from ncryptedV1/dev

Dev to main

Author: cuvar

README.md

@@ -18,16 +18,17 @@ public class MealPlan {
   private LocalDate end;
 
   public MealPlan(List<Meal> meals, LocalDate start, LocalDate end) {
-    int days = start.until(end).getDays();
+    this.start = start;
+    this.end = end;
+    
+    int days = getDays();
     if (meals.size() != days) {
       throw new IllegalArgumentException(
           "Mahlzeiten-Plan spannt " + days + " Tage, es wurden allerdings nur " + meals.size()
               + " Mahlzeiten übergeben");
     }
 
     this.meals = meals;
-    this.start = start;
-    this.end = end;
   }
 
   public List<Meal> getMeals() {

docs/res/cov.png

@@ -0,0 +1,36 @@
+@startuml
+
+left to right direction
+
+'class MealPlan {
+'  - meals: List<Meal>
+'  - start: LocalDate
+'  - end: LocalDate
+'  + getMeals(): List<Meal>
+'  + getStart(): LocalDate
+'  + getEnd(): LocalDate
+'  + getDays(): int
+'  + getGroceryList(): GroceryList
+'}
+
+class Meal {
+  - recipe: Recipe
+  - adjustedNumberOfPeople:  int
+  + Meal(recipe: Recipe, adjustedNumberOfPeople: int)
+  + getRecipe(): Recipe
+  + setRecipe(recipe: Recipe): void
+  + getAdjustedNumberOfPeople(): int
+  + getGroceryList(): GroceryList
+}
+
+'class GroceryList {
+'  - items: List<GroceryItem>
+'  + addItem(GroceryItem entry): void
+'  + getItems(): List<GroceryItem>
+'}
+'
+'MealPlan <- GroceryList
+'MealPlan <- Meal
+'Meal <- GroceryList
+
+@enduml

src/main/java/de/cunc/autochef/domain/aggregate/MealPlan.java

@@ -0,0 +1,27 @@
+@startuml
+class Recipe {
+  - name: String
+  - groceryList: GroceryList
+  - recipeSteps: List<RecipeStep>
+  + Recipe(name: String, groceryList: GroceryList, recipeSteps: List<RecipeStep>)
+  + Recipe(name: String, groceryList: GroceryList, recipeSteps: RecipeStep...)
+  + getName(): String
+  + getRecipeSteps(): List<RecipeStep>
+  + getGroceryList(): GroceryList
+  + getId(): String
+  + toString(): String
+  + equals(Object o): boolean
+  + hashCode(): int
+}
+
+class GroceryList {
+  // fields and methods
+}
+
+class RecipeStep {
+  // fields and methods
+}
+
+Recipe "1" --> "1" GroceryList
+Recipe "0..*" --> "1" RecipeStep
+@enduml

uml/aggregate.iuml

@@ -0,0 +1,38 @@
+@startuml
+
+left to right direction
+
+class ChefkochRecipeFetcher {
+  +getRecipe(url: String): Recipe
+  -extractRecipeName(content: String): String
+  -extractIngredients(content: String): GroceryList
+  -extractRecipeSteps(content: String): List<RecipeStep>
+}
+
+interface WebsiteFetcher {
+  +getWebsiteBody(urlString: String): String
+}
+
+class BufferedWebsiteFetcher {
+  +getWebsiteBody(urlString: String): String
+}
+
+class Recipe {
+  // fields and methods
+}
+
+class GroceryList {
+  // fields and methods
+}
+
+class RecipeStep {
+  // fields and methods
+}
+
+WebsiteFetcher <-- ChefkochRecipeFetcher
+WebsiteFetcher <|.. BufferedWebsiteFetcher
+Recipe <-- ChefkochRecipeFetcher
+GroceryList <-- ChefkochRecipeFetcher
+RecipeStep <-- ChefkochRecipeFetcher
+
+@enduml

uml/cohesion.iuml

@@ -0,0 +1,33 @@
+@startuml
+
+left to right direction
+
+class ChefkochRecipeFetcher {
+  +getRecipe(url: String): Recipe
+  -extractRecipeName(content: String): String
+  -extractIngredients(content: String): GroceryList
+  -extractRecipeSteps(content: String): List<RecipeStep>
+}
+
+class WebsiteFetcher {
+  +getWebsiteBody(urlString: String): String
+}
+
+class Recipe {
+  // fields and methods
+}
+
+class GroceryList {
+  // fields and methods
+}
+
+class RecipeStep {
+  // fields and methods
+}
+
+WebsiteFetcher <-- ChefkochRecipeFetcher
+Recipe <-- ChefkochRecipeFetcher
+GroceryList <-- ChefkochRecipeFetcher
+RecipeStep <-- ChefkochRecipeFetcher
+
+@enduml

uml/coupling-neg-better.iuml

@@ -0,0 +1,32 @@
+@startuml
+
+interface InputReader {
+  +readLine(): String
+}
+
+interface OutputService {
+  +info(msg: String): void
+  +warning(msg: String): void
+  +severe(msg: String): void
+  +rawOut(msg: Object): void
+  +rawErr(msg: Object): void
+}
+
+interface InputParser {
+  +getInteger(lowerBound: Integer, upperBound: Integer, question: String): Integer
+  +getDate(after: LocalDate, before: LocalDate, question: String): LocalDate
+  +getString(validator: Function<String, String>, question: String): String
+}
+
+class DialogInputParser {
+  -inputReader: InputReader
+  -outputService: OutputService
+  +DialogInputParser(inputReader: InputReader, outputService: OutputService)
+  +getInputWithType(transformFunction: Function<String, T>, question: String): T
+}
+
+InputParser <|.. DialogInputParser
+DialogInputParser --> InputReader
+DialogInputParser --> OutputService
+
+@enduml

uml/coupling-neg.iuml

@@ -0,0 +1,26 @@
+@startuml
+
+class Recipe {
+  // fields and methods
+}
+
+class RecipeFileRepository {
+    -recipesFolder: File
+    +RecipeFileRepository(recipesFolder: File)
+    +saveRecipe(recipe: Recipe): void
+    +deleteRecipe(recipe: Recipe): boolean
+    +getRecipes(): List<Recipe>
+    +getRecipe(id: String): Recipe
+}
+
+interface RecipeRepository {
+    +saveRecipe(recipe: Recipe): void
+    +deleteRecipe(recipe: Recipe): boolean
+    +getRecipes(): List<Recipe>
+    +getRecipe(id: String): Recipe
+}
+
+RecipeFileRepository ..|> RecipeRepository
+RecipeRepository -> Recipe
+
+@enduml

uml/coupling-pos-1.iuml

@@ -0,0 +1,25 @@
+@startuml
+
+left to right direction
+
+package "Infrastructure" {
+  class WebsiteFetcher {
+    + getWebsiteBody(urlString: String)
+  }
+
+  package "Application" {
+    class ChefkochRecipeFetcher {
+      + getRecipe(url: String)
+      - extractRecipeName(content: String)
+      - extractIngredients(content: String)
+      - extractRecipeSteps(content: String)
+    }
+
+    package "Domain" {
+    }
+  }
+}
+
+ChefkochRecipeFetcher -> WebsiteFetcher
+
+@enduml